diff options
author | tb <> | 2023-04-30 14:49:47 +0000 |
---|---|---|
committer | tb <> | 2023-04-30 14:49:47 +0000 |
commit | 434ee8b2e118b54fb98a6bfd425bb9da625fc656 (patch) | |
tree | f5bf74640d29271fd29c78d1dc3775bf87e45e0d /src/lib/libcrypto/man/X509_policy_tree_level_count.3 | |
parent | 98a37f6a03d427a2f861a266cc7cdf37f00f1de6 (diff) | |
download | openbsd-434ee8b2e118b54fb98a6bfd425bb9da625fc656.tar.gz openbsd-434ee8b2e118b54fb98a6bfd425bb9da625fc656.tar.bz2 openbsd-434ee8b2e118b54fb98a6bfd425bb9da625fc656.zip |
The policy tree is no more
Mop up documentation mentioning it or any of its numerous accessors that
almost nothing ever used.
Diffstat (limited to 'src/lib/libcrypto/man/X509_policy_tree_level_count.3')
-rw-r--r-- | src/lib/libcrypto/man/X509_policy_tree_level_count.3 | 178 |
1 files changed, 0 insertions, 178 deletions
diff --git a/src/lib/libcrypto/man/X509_policy_tree_level_count.3 b/src/lib/libcrypto/man/X509_policy_tree_level_count.3 deleted file mode 100644 index ff2036c40f..0000000000 --- a/src/lib/libcrypto/man/X509_policy_tree_level_count.3 +++ /dev/null | |||
@@ -1,178 +0,0 @@ | |||
1 | .\" $OpenBSD: X509_policy_tree_level_count.3,v 1.5 2022/09/10 08:50:53 jsg 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: September 10 2022 $ | ||
18 | .Dt X509_POLICY_TREE_LEVEL_COUNT 3 | ||
19 | .Os | ||
20 | .Sh NAME | ||
21 | .Nm X509_policy_tree_level_count , | ||
22 | .Nm X509_policy_tree_get0_level , | ||
23 | .Nm X509_policy_level_node_count , | ||
24 | .Nm X509_policy_level_get0_node , | ||
25 | .Nm X509_policy_node_get0_policy , | ||
26 | .Nm X509_policy_node_get0_qualifiers , | ||
27 | .Nm X509_policy_node_get0_parent | ||
28 | .Nd inspect X.509 policy tree objects | ||
29 | .Sh SYNOPSIS | ||
30 | .In openssl/x509_vfy.h | ||
31 | .Ft int | ||
32 | .Fn X509_policy_tree_level_count "const X509_POLICY_TREE *tree" | ||
33 | .Ft X509_POLICY_LEVEL * | ||
34 | .Fn X509_policy_tree_get0_level "const X509_POLICY_TREE *tree" "int index" | ||
35 | .Ft int | ||
36 | .Fn X509_policy_level_node_count "X509_POLICY_LEVEL *level" | ||
37 | .Ft X509_POLICY_NODE * | ||
38 | .Fn X509_policy_level_get0_node "X509_POLICY_LEVEL *level" "int index" | ||
39 | .Ft const ASN1_OBJECT * | ||
40 | .Fn X509_policy_node_get0_policy "const X509_POLICY_NODE *node" | ||
41 | .Ft STACK_OF(POLICYQUALINFO) * | ||
42 | .Fn X509_policy_node_get0_qualifiers "const X509_POLICY_NODE *node" | ||
43 | .Ft const X509_POLICY_NODE * | ||
44 | .Fn X509_policy_node_get0_parent "const X509_POLICY_NODE *node" | ||
45 | .Sh DESCRIPTION | ||
46 | The | ||
47 | .Vt X509_POLICY_TREE | ||
48 | object represents a | ||
49 | .Vt valid_policy_tree | ||
50 | as described in RFC 5280 section 6.1. | ||
51 | .Pp | ||
52 | The | ||
53 | .Vt X509_POLICY_LEVEL | ||
54 | object represents one level of such a tree, | ||
55 | corresponding to one certificate. | ||
56 | .Pp | ||
57 | The | ||
58 | .Vt X509_POLICY_NODE | ||
59 | object represents one node in the tree. | ||
60 | .Sh RETURN VALUES | ||
61 | .Fn X509_policy_tree_level_count | ||
62 | returns the number of levels in the | ||
63 | .Fa tree | ||
64 | or 0 if the | ||
65 | .Fa tree | ||
66 | argument is | ||
67 | .Dv NULL . | ||
68 | If it is not 0, it equals the number of certificates in the | ||
69 | certification path the tree was created from, including both | ||
70 | the target certificate and the trust anchor. | ||
71 | .Pp | ||
72 | .Fn X509_policy_tree_get0_level | ||
73 | returns an internal pointer to the level of the | ||
74 | .Fa tree | ||
75 | with the given | ||
76 | .Fa index | ||
77 | or | ||
78 | .Dv NULL | ||
79 | if the | ||
80 | .Fa tree | ||
81 | argument is | ||
82 | .Dv NULL | ||
83 | or the | ||
84 | .Fa index | ||
85 | is less than 0 or greater than or equal to the number of levels in the | ||
86 | .Fa tree . | ||
87 | An | ||
88 | .Fa index | ||
89 | of 0 corresponds to the trust anchor | ||
90 | and the last level corresponds to the target certificate. | ||
91 | .Pp | ||
92 | .Fn X509_policy_level_node_count | ||
93 | returns the number of nodes on the | ||
94 | .Fa level , | ||
95 | including an | ||
96 | .Sy anyPolicy | ||
97 | node if it is present, or 0 if the | ||
98 | .Fa level | ||
99 | argument is | ||
100 | .Dv NULL . | ||
101 | .Pp | ||
102 | .Fn X509_policy_level_get0_node | ||
103 | returns an internal pointer to the node on the | ||
104 | .Fa level | ||
105 | with the given | ||
106 | .Fa index | ||
107 | or | ||
108 | .Dv NULL | ||
109 | if the | ||
110 | .Fa level | ||
111 | argument is | ||
112 | .Dv NULL | ||
113 | or the | ||
114 | .Fa index | ||
115 | is less than 0 or greater than or equal to the number of nodes on the level. | ||
116 | If an | ||
117 | .Sy anyPolicy | ||
118 | node is present on the level, it can be retrieved by passing an | ||
119 | .Fa index | ||
120 | of 0. | ||
121 | .Pp | ||
122 | .Fn X509_policy_node_get0_policy | ||
123 | returns an internal pointer to the | ||
124 | .Fa valid_policy | ||
125 | child object of the node or | ||
126 | .Dv NULL | ||
127 | if the | ||
128 | .Fa node | ||
129 | argument is | ||
130 | .Dv NULL . | ||
131 | It represents a single policy that is valid for the path | ||
132 | from the trust anchor to the certificate corresponding | ||
133 | to the level containing the | ||
134 | .Fa node . | ||
135 | .Pp | ||
136 | .Fn X509_policy_node_get0_qualifiers | ||
137 | returns an internal pointer to the | ||
138 | .Fa qualifier_set | ||
139 | child object of the node or | ||
140 | .Dv NULL | ||
141 | if the | ||
142 | .Fa node | ||
143 | argument is | ||
144 | .Dv NULL . | ||
145 | It contains the policy qualifiers associated with the | ||
146 | .Fa valid_policy | ||
147 | of the | ||
148 | .Fa node | ||
149 | in the certificate corresponding to the level containing the | ||
150 | .Fa node . | ||
151 | .Pp | ||
152 | .Fn X509_policy_node_get0_parent | ||
153 | returns | ||
154 | .Dv NULL | ||
155 | if the | ||
156 | .Fa node | ||
157 | argument is | ||
158 | .Dv NULL | ||
159 | or located on level 0. | ||
160 | Otherwise, it returns an internal pointer to the parent node of the | ||
161 | .Fa node | ||
162 | argument. | ||
163 | The parent node is always located on the previous level. | ||
164 | .Sh SEE ALSO | ||
165 | .Xr ASN1_OBJECT_new 3 , | ||
166 | .Xr OBJ_obj2txt 3 , | ||
167 | .Xr POLICYQUALINFO_new 3 , | ||
168 | .Xr STACK_OF 3 , | ||
169 | .Xr X509_new 3 , | ||
170 | .Xr X509_policy_check 3 , | ||
171 | .Xr X509_policy_tree_get0_policies 3 | ||
172 | .Sh STANDARDS | ||
173 | RFC 5280: Internet X.509 Public Key Infrastructure Certificate | ||
174 | and Certificate Revocation List (CRL) Profile, | ||
175 | section 6.1: Basic Path Validation | ||
176 | .Sh HISTORY | ||
177 | These function first appeared in OpenSSL 0.9.8 and have been available since | ||
178 | .Ox 4.5 . | ||