diff options
Diffstat (limited to 'src/lib/libcrypto/man/d2i_X509_NAME.3')
-rw-r--r-- | src/lib/libcrypto/man/d2i_X509_NAME.3 | 213 |
1 files changed, 0 insertions, 213 deletions
diff --git a/src/lib/libcrypto/man/d2i_X509_NAME.3 b/src/lib/libcrypto/man/d2i_X509_NAME.3 deleted file mode 100644 index f5cafaee97..0000000000 --- a/src/lib/libcrypto/man/d2i_X509_NAME.3 +++ /dev/null | |||
@@ -1,213 +0,0 @@ | |||
1 | .\" $OpenBSD: d2i_X509_NAME.3,v 1.18 2025/03/14 21:32:15 tb Exp $ | ||
2 | .\" checked up to: | ||
3 | .\" OpenSSL crypto/d2i_X509_NAME 4692340e Jun 7 15:49:08 2016 -0400 and | ||
4 | .\" OpenSSL man3/X509_NAME_get0_der 99d63d46 Oct 26 13:56:48 2016 -0400 | ||
5 | .\" | ||
6 | .\" Copyright (c) 2016, 2018 Ingo Schwarze <schwarze@openbsd.org> | ||
7 | .\" | ||
8 | .\" Permission to use, copy, modify, and distribute this software for any | ||
9 | .\" purpose with or without fee is hereby granted, provided that the above | ||
10 | .\" copyright notice and this permission notice appear in all copies. | ||
11 | .\" | ||
12 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
13 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
14 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
15 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
16 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
17 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
18 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
19 | .\" | ||
20 | .Dd $Mdocdate: March 14 2025 $ | ||
21 | .Dt D2I_X509_NAME 3 | ||
22 | .Os | ||
23 | .Sh NAME | ||
24 | .Nm d2i_X509_NAME , | ||
25 | .Nm i2d_X509_NAME , | ||
26 | .Nm X509_NAME_get0_der , | ||
27 | .Nm X509_NAME_dup , | ||
28 | .Nm X509_NAME_set , | ||
29 | .Nm d2i_X509_NAME_ENTRY , | ||
30 | .Nm i2d_X509_NAME_ENTRY , | ||
31 | .Nm X509_NAME_ENTRY_dup | ||
32 | .\" In the following line, "X.501" and "Name" are not typos. | ||
33 | .\" The "Name" type is defined in X.501, not in X.509. | ||
34 | .\" The type is called "Name" with capital "N", not "name". | ||
35 | .Nd decode and encode X.501 Name objects | ||
36 | .Sh SYNOPSIS | ||
37 | .In openssl/x509.h | ||
38 | .Ft X509_NAME * | ||
39 | .Fo d2i_X509_NAME | ||
40 | .Fa "X509_NAME **val_out" | ||
41 | .Fa "const unsigned char **der_in" | ||
42 | .Fa "long length" | ||
43 | .Fc | ||
44 | .Ft int | ||
45 | .Fo i2d_X509_NAME | ||
46 | .Fa "X509_NAME *val_in" | ||
47 | .Fa "unsigned char **der_out" | ||
48 | .Fc | ||
49 | .Ft int | ||
50 | .Fo X509_NAME_get0_der | ||
51 | .Fa "X509_NAME *val_in" | ||
52 | .Fa "const unsigned char **der_out" | ||
53 | .Fa "size_t *out_len" | ||
54 | .Fc | ||
55 | .Ft X509_NAME * | ||
56 | .Fo X509_NAME_dup | ||
57 | .Fa "X509_NAME *val_in" | ||
58 | .Fc | ||
59 | .Ft int | ||
60 | .Fo X509_NAME_set | ||
61 | .Fa "X509_NAME **val_out" | ||
62 | .Fa "X509_NAME *val_in" | ||
63 | .Fc | ||
64 | .Ft X509_NAME_ENTRY * | ||
65 | .Fo d2i_X509_NAME_ENTRY | ||
66 | .Fa "X509_NAME_ENTRY **val_out" | ||
67 | .Fa "const unsigned char **der_in" | ||
68 | .Fa "long length" | ||
69 | .Fc | ||
70 | .Ft int | ||
71 | .Fo i2d_X509_NAME_ENTRY | ||
72 | .Fa "X509_NAME_ENTRY *val_in" | ||
73 | .Fa "unsigned char **der_out" | ||
74 | .Fc | ||
75 | .Ft X509_NAME_ENTRY * | ||
76 | .Fo X509_NAME_ENTRY_dup | ||
77 | .Fa "X509_NAME_ENTRY *val_in" | ||
78 | .Fc | ||
79 | .Sh DESCRIPTION | ||
80 | These functions decode and encode X.501 | ||
81 | .Vt Name | ||
82 | objects using DER format. | ||
83 | For details about the semantics, examples, caveats, and bugs, see | ||
84 | .Xr ASN1_item_d2i 3 . | ||
85 | .Pp | ||
86 | .Fn d2i_X509_NAME | ||
87 | and | ||
88 | .Fn i2d_X509_NAME | ||
89 | decode and encode an ASN.1 | ||
90 | .Vt Name | ||
91 | structure defined in RFC 5280 section 4.1.2.4. | ||
92 | .Pp | ||
93 | .Fn X509_NAME_get0_der | ||
94 | is a variant of | ||
95 | .Fn i2d_X509_NAME | ||
96 | that does not copy the encoded output but instead returns a pointer | ||
97 | to the internally cached DER-encoded version of the name. | ||
98 | Also, it does not return the length of the output in bytes, | ||
99 | but instead stores it in | ||
100 | .Fa out_len . | ||
101 | If the cached encoded form happens to be out of date, both functions | ||
102 | update it before copying it or returning a pointer to it. | ||
103 | .Pp | ||
104 | .Fn X509_NAME_dup | ||
105 | copies | ||
106 | .Fa val_in | ||
107 | by calling | ||
108 | .Fn i2d_X509_NAME | ||
109 | and | ||
110 | .Fn d2i_X509_NAME . | ||
111 | .Pp | ||
112 | .Fn X509_NAME_set | ||
113 | makes sure that | ||
114 | .Pf * Fa val_out | ||
115 | contains the same data as | ||
116 | .Fa val_in | ||
117 | after the call, except that it fails if | ||
118 | .Fa val_in | ||
119 | is | ||
120 | .Dv NULL . | ||
121 | If | ||
122 | .Pf * Fa val_out | ||
123 | is the same pointer as | ||
124 | .Fa val_in , | ||
125 | the function succeeds without changing anything. | ||
126 | Otherwise, it copies | ||
127 | .Fa val_in | ||
128 | using | ||
129 | .Fn X509_NAME_dup , | ||
130 | and in case of success, it frees | ||
131 | .Pf * Fa val_out | ||
132 | and sets it to a pointer to the new object. | ||
133 | When the function fails, it never changes anything. | ||
134 | In any case, | ||
135 | .Fa val_in | ||
136 | remains valid and may or may not be the same pointer as | ||
137 | .Pf * Fa val_out | ||
138 | after the call. | ||
139 | .Pp | ||
140 | .Fn d2i_X509_NAME_ENTRY | ||
141 | and | ||
142 | .Fn i2d_X509_NAME_ENTRY | ||
143 | decode and encode an ASN.1 | ||
144 | .Vt RelativeDistinguishedName | ||
145 | structure defined in RFC 5280 section 4.1.2.4. | ||
146 | .Pp | ||
147 | .Fn X509_NAME_ENTRY_dup | ||
148 | copies | ||
149 | .Fa val_in | ||
150 | by calling | ||
151 | .Fn i2d_X509_NAME_ENTRY | ||
152 | and | ||
153 | .Fn d2i_X509_NAME_ENTRY . | ||
154 | .Sh RETURN VALUES | ||
155 | .Fn d2i_X509_NAME | ||
156 | and | ||
157 | .Fn X509_NAME_dup | ||
158 | return the new | ||
159 | .Vt X509_NAME | ||
160 | object or | ||
161 | .Dv NULL | ||
162 | if an error occurs. | ||
163 | .Pp | ||
164 | .Fn X509_NAME_set | ||
165 | and | ||
166 | .Fn X509_NAME_get0_der | ||
167 | return 1 on success or 0 if an error occurs. | ||
168 | .Pp | ||
169 | .Fn d2i_X509_NAME_ENTRY | ||
170 | and | ||
171 | .Fn X509_NAME_ENTRY_dup | ||
172 | return the new | ||
173 | .Vt X509_NAME_ENTRY | ||
174 | object or | ||
175 | .Dv NULL | ||
176 | if an error occurs. | ||
177 | .Pp | ||
178 | .Fn i2d_X509_NAME | ||
179 | and | ||
180 | .Fn i2d_X509_NAME_ENTRY | ||
181 | return the number of bytes successfully encoded or a negative value | ||
182 | if an error occurs. | ||
183 | .Sh SEE ALSO | ||
184 | .Xr ASN1_item_d2i 3 , | ||
185 | .Xr X509_NAME_ENTRY_new 3 , | ||
186 | .Xr X509_NAME_new 3 , | ||
187 | .Xr X509_NAME_print_ex 3 | ||
188 | .Sh STANDARDS | ||
189 | RFC 5280: Internet X.509 Public Key Infrastructure Certificate and | ||
190 | Certificate Revocation List (CRL) Profile | ||
191 | .Pp | ||
192 | ITU-T Recommendation X.690, also known as ISO/IEC 8825-1: | ||
193 | Information technology - ASN.1 encoding rules: | ||
194 | Specification of Basic Encoding Rules (BER), Canonical Encoding | ||
195 | Rules (CER) and Distinguished Encoding Rules (DER). | ||
196 | .Sh HISTORY | ||
197 | .Fn X509_NAME_dup | ||
198 | first appeared in SSLeay 0.4.4. | ||
199 | .Fn d2i_X509_NAME , | ||
200 | .Fn i2d_X509_NAME , | ||
201 | .Fn d2i_X509_NAME_ENTRY , | ||
202 | .Fn i2d_X509_NAME_ENTRY , | ||
203 | and | ||
204 | .Fn X509_NAME_ENTRY_dup | ||
205 | first appeared in SSLeay 0.5.1. | ||
206 | .Fn X509_NAME_set | ||
207 | first appeared in SSLeay 0.8.0. | ||
208 | These functions have been available since | ||
209 | .Ox 2.4 . | ||
210 | .Pp | ||
211 | .Fn X509_NAME_get0_der | ||
212 | first appeared in OpenSSL 1.1.0 and has been available since | ||
213 | .Ox 6.3 . | ||