diff options
Diffstat (limited to 'src/lib/libcrypto/man/X509V3_parse_list.3')
-rw-r--r-- | src/lib/libcrypto/man/X509V3_parse_list.3 | 101 |
1 files changed, 0 insertions, 101 deletions
diff --git a/src/lib/libcrypto/man/X509V3_parse_list.3 b/src/lib/libcrypto/man/X509V3_parse_list.3 deleted file mode 100644 index 447f1a5e94..0000000000 --- a/src/lib/libcrypto/man/X509V3_parse_list.3 +++ /dev/null | |||
@@ -1,101 +0,0 @@ | |||
1 | .\" $OpenBSD: X509V3_parse_list.3,v 1.2 2024/12/24 09:48:56 schwarze Exp $ | ||
2 | .\" | ||
3 | .\" Copyright (c) 2024 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: December 24 2024 $ | ||
18 | .Dt X509V3_PARSE_LIST 3 | ||
19 | .Os | ||
20 | .Sh NAME | ||
21 | .Nm X509V3_parse_list , | ||
22 | .Nm X509V3_conf_free | ||
23 | .Nd create and destroy CONF_VALUE objects | ||
24 | .Sh SYNOPSIS | ||
25 | .In openssl/x509v3.h | ||
26 | .Ft STACK_OF(CONF_VALUE) * | ||
27 | .Fn X509V3_parse_list "const char *string" | ||
28 | .Ft void | ||
29 | .Fn X509V3_conf_free "CONF_VALUE *conf" | ||
30 | .Sh DESCRIPTION | ||
31 | .Fn X509V3_parse_list | ||
32 | parses the | ||
33 | .Fa string | ||
34 | and allocates an array of | ||
35 | .Vt CONF_VALUE | ||
36 | objects according to the following rules. | ||
37 | .Bl -enum -width 2n | ||
38 | .It | ||
39 | The string is split into fields at comma | ||
40 | .Pq Sq \&, | ||
41 | characters. | ||
42 | .It | ||
43 | If a field contains a colon | ||
44 | .Pq Sq \&: | ||
45 | character, the part before the colon is regarded as a name | ||
46 | and the part after the first colon as the associated value. | ||
47 | Otherwise, the whole field is regarded as the name and | ||
48 | .Dv NULL | ||
49 | is used as the associated value. | ||
50 | .It | ||
51 | For each name and each value, leading and trailing whitespace as defined by | ||
52 | .Xr isspace 3 | ||
53 | is ignored. | ||
54 | .It | ||
55 | Parsing ends when a NUL, carriage return, or newline character | ||
56 | is encountered. | ||
57 | .El | ||
58 | .Pp | ||
59 | A new, empty | ||
60 | .Vt STACK_OF(CONF_VALUE) | ||
61 | is allocated and for each parsed name, one | ||
62 | .Vt CONF_VALUE | ||
63 | structure containing the optional value is pushed onto it. | ||
64 | .Pp | ||
65 | .Fn X509V3_conf_free | ||
66 | releases all memory used by | ||
67 | .Fa conf . | ||
68 | If | ||
69 | .Fa conf | ||
70 | is | ||
71 | .Dv NULL , | ||
72 | no action occurs. | ||
73 | .Pp | ||
74 | The typical way to release the memory returned from | ||
75 | .Fn X509V3_parse_list | ||
76 | is by calling | ||
77 | .Fn sk_CONF_VALUE_pop_free | ||
78 | on it, passing a pointer to the function | ||
79 | .Fn X509V3_conf_free | ||
80 | as the second argument. | ||
81 | .Sh RETURN VALUES | ||
82 | .Fn X509V3_parse_list | ||
83 | returns the new | ||
84 | .Vt STACK_OF(CONF_VALUE) | ||
85 | object or | ||
86 | .Dv NULL | ||
87 | if an error occurs, in particular if there isn't any name, | ||
88 | if the name before a colon or after a comma is empty, | ||
89 | if the value after a colon is empty, | ||
90 | or if memory allocation fails. | ||
91 | .Sh SEE ALSO | ||
92 | .Xr isspace 3 , | ||
93 | .Xr sk_pop_free 3 , | ||
94 | .Xr STACK_OF 3 , | ||
95 | .Xr v2i_ASN1_BIT_STRING 3 | ||
96 | .Sh HISTORY | ||
97 | .Fn X509V3_parse_list | ||
98 | and | ||
99 | .Fn X509V3_conf_free | ||
100 | first appeared in OpenSSL 0.9.2 and have been available since | ||
101 | .Ox 2.6 . | ||