diff options
author | tb <> | 2024-09-02 07:57:27 +0000 |
---|---|---|
committer | tb <> | 2024-09-02 07:57:27 +0000 |
commit | c78e20a8f76e3a4648f03c4e85dd439836fb6b66 (patch) | |
tree | d0e4171d9e5d82715a858796fb9481c8c8ae585c /src/lib/libcrypto/man/X509at_get_attr.3 | |
parent | 5cdfa41e87519edab6d3e210d55b8937d742c3cb (diff) | |
download | openbsd-c78e20a8f76e3a4648f03c4e85dd439836fb6b66.tar.gz openbsd-c78e20a8f76e3a4648f03c4e85dd439836fb6b66.tar.bz2 openbsd-c78e20a8f76e3a4648f03c4e85dd439836fb6b66.zip |
The X509at_* manuals are no longer needed
Diffstat (limited to 'src/lib/libcrypto/man/X509at_get_attr.3')
-rw-r--r-- | src/lib/libcrypto/man/X509at_get_attr.3 | 158 |
1 files changed, 0 insertions, 158 deletions
diff --git a/src/lib/libcrypto/man/X509at_get_attr.3 b/src/lib/libcrypto/man/X509at_get_attr.3 deleted file mode 100644 index 03581695b3..0000000000 --- a/src/lib/libcrypto/man/X509at_get_attr.3 +++ /dev/null | |||
@@ -1,158 +0,0 @@ | |||
1 | .\" $OpenBSD: X509at_get_attr.3,v 1.9 2024/08/24 09:23:09 tb Exp $ | ||
2 | .\" | ||
3 | .\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org> | ||
4 | .\" | ||
5 | .\" Permission to use, copy, modify, and distribute this software for any | ||
6 | .\" purpose with or without fee is hereby granted, provided that the above | ||
7 | .\" copyright notice and this permission notice appear in all copies. | ||
8 | .\" | ||
9 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
10 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
11 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
12 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
13 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
16 | .\" | ||
17 | .Dd $Mdocdate: August 24 2024 $ | ||
18 | .Dt X509AT_GET_ATTR 3 | ||
19 | .Os | ||
20 | .Sh NAME | ||
21 | .Nm X509at_get_attr , | ||
22 | .Nm X509at_get_attr_count , | ||
23 | .Nm X509at_get_attr_by_OBJ , | ||
24 | .Nm X509at_get_attr_by_NID , | ||
25 | .Nm X509at_get0_data_by_OBJ | ||
26 | .\" In the following line, "X.501" and "Attribute" are not typos. | ||
27 | .\" The "Attribute" type is defined in X.501, not in X.509. | ||
28 | .\" The type is called "Attribute" with capital "A", not "attribute". | ||
29 | .Nd X.501 Attribute array read accessors | ||
30 | .Sh SYNOPSIS | ||
31 | .In openssl/x509.h | ||
32 | .Ft X509_ATTRIBUTE * | ||
33 | .Fo X509at_get_attr | ||
34 | .Fa "const STACK_OF(X509_ATTRIBUTE) *attrs" | ||
35 | .Fa "int index" | ||
36 | .Fc | ||
37 | .Ft int | ||
38 | .Fo X509at_get_attr_count | ||
39 | .Fa "const STACK_OF(X509_ATTRIBUTE) *attrs" | ||
40 | .Fc | ||
41 | .Ft int | ||
42 | .Fo X509at_get_attr_by_OBJ | ||
43 | .Fa "const STACK_OF(X509_ATTRIBUTE) *attrs" | ||
44 | .Fa "const ASN1_OBJECT *obj" | ||
45 | .Fa "int start_after" | ||
46 | .Fc | ||
47 | .Ft int | ||
48 | .Fo X509at_get_attr_by_NID | ||
49 | .Fa "const STACK_OF(X509_ATTRIBUTE) *attrs" | ||
50 | .Fa "int nid" | ||
51 | .Fa "int start_after" | ||
52 | .Fc | ||
53 | .Ft void * | ||
54 | .Fo X509at_get0_data_by_OBJ | ||
55 | .Fa "STACK_OF(X509_ATTRIBUTE) *attrs" | ||
56 | .Fa "const ASN1_OBJECT *obj" | ||
57 | .Fa "int start_after" | ||
58 | .Fa "int type" | ||
59 | .Fc | ||
60 | .Sh DESCRIPTION | ||
61 | These functions retrieve information from the | ||
62 | .Fa attrs | ||
63 | array of X.501 Attribute objects. | ||
64 | They all fail if | ||
65 | .Fa attrs | ||
66 | is a | ||
67 | .Dv NULL | ||
68 | pointer. | ||
69 | .Pp | ||
70 | .Fn X509at_get_attr | ||
71 | returns the array element at the zero-based | ||
72 | .Fa index . | ||
73 | It fails if the | ||
74 | .Fa index | ||
75 | is negative or greater than or equal to the number of objects in the array. | ||
76 | .Pp | ||
77 | .Fn X509at_get_attr_count | ||
78 | returns the number of objects currently stored in the array. | ||
79 | .Pp | ||
80 | The three remaining functions search the array starting after the index | ||
81 | .Fa start_after . | ||
82 | They fail if no matching object is found. | ||
83 | .Fn X509at_get0_data_by_OBJ | ||
84 | also fails if the data is not of the requested | ||
85 | .Fa type . | ||
86 | .Pp | ||
87 | Additionally, the | ||
88 | .Fa start_after | ||
89 | argument of | ||
90 | .Fn X509at_get0_data_by_OBJ | ||
91 | is interpreted in a special way. | ||
92 | If | ||
93 | .Fa start_after | ||
94 | is \-2 or smaller, | ||
95 | .Fn X509at_get0_data_by_OBJ | ||
96 | also fails if | ||
97 | .Fa attrs | ||
98 | contains more than one matching object. | ||
99 | If | ||
100 | .Fa start_after | ||
101 | is \-3 or smaller, it also fails unless the matching object | ||
102 | contains exactly one value. | ||
103 | .Sh RETURN VALUES | ||
104 | .Fn X509at_get_attr | ||
105 | returns an internal pointer or | ||
106 | .Dv NULL | ||
107 | on failure. | ||
108 | .Pp | ||
109 | .Fn X509at_get_attr_count | ||
110 | returns the number of array elements or \-1 on failure. | ||
111 | .Pp | ||
112 | .Fn X509at_get_attr_by_OBJ | ||
113 | and | ||
114 | .Fn X509at_get_attr_by_NID | ||
115 | return the index of the first object in the array | ||
116 | that has an index greater than | ||
117 | .Fa start_after | ||
118 | and a type matching | ||
119 | .Fa obj | ||
120 | or | ||
121 | .Fa nid , | ||
122 | respectively, or \-1 on failure. | ||
123 | In addition, | ||
124 | .Fn X509at_get_attr_by_NID | ||
125 | returns \-2 | ||
126 | if | ||
127 | .Xr OBJ_nid2obj 3 | ||
128 | fails on the requested | ||
129 | .Fa nid . | ||
130 | .Pp | ||
131 | .Fn X509at_get0_data_by_OBJ | ||
132 | returns an internal pointer to the data contained in the value | ||
133 | of the first object that has an index greater than | ||
134 | .Fa start_after | ||
135 | and a type matching | ||
136 | .Fa obj , | ||
137 | or | ||
138 | .Dv NULL | ||
139 | on failure. | ||
140 | .Sh SEE ALSO | ||
141 | .Xr OBJ_nid2obj 3 , | ||
142 | .Xr PKCS8_pkey_get0_attrs 3 , | ||
143 | .Xr STACK_OF 3 , | ||
144 | .Xr X509_ATTRIBUTE_get0_data 3 , | ||
145 | .Xr X509_ATTRIBUTE_new 3 , | ||
146 | .Xr X509_REQ_get_attr 3 | ||
147 | .Sh HISTORY | ||
148 | .Fn X509at_get_attr , | ||
149 | .Fn X509at_get_attr_count , | ||
150 | .Fn X509at_get_attr_by_OBJ , | ||
151 | and | ||
152 | .Fn X509at_get_attr_by_NID | ||
153 | first appeared in OpenSSL 0.9.5 and have been available since | ||
154 | .Ox 2.7 . | ||
155 | .Pp | ||
156 | .Fn X509at_get0_data_by_OBJ | ||
157 | first appeared in OpenSSL 0.9.8h and has been available since | ||
158 | .Ox 4.5 . | ||