diff options
author | schwarze <> | 2016-11-04 15:29:03 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-04 15:29:03 +0000 |
commit | e23d00ab37299e14c06d5d2b599a3793e3d0575c (patch) | |
tree | f91172cf4f459119421ea45c97eb6fa4aec563bc /src/lib/libcrypto/doc/X509_VERIFY_PARAM_set_flags.pod | |
parent | f34ab28d6356aae4d0458dd2076438a042314790 (diff) | |
download | openbsd-e23d00ab37299e14c06d5d2b599a3793e3d0575c.tar.gz openbsd-e23d00ab37299e14c06d5d2b599a3793e3d0575c.tar.bz2 openbsd-e23d00ab37299e14c06d5d2b599a3793e3d0575c.zip |
convert X509 manuals from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/doc/X509_VERIFY_PARAM_set_flags.pod')
-rw-r--r-- | src/lib/libcrypto/doc/X509_VERIFY_PARAM_set_flags.pod | 172 |
1 files changed, 0 insertions, 172 deletions
diff --git a/src/lib/libcrypto/doc/X509_VERIFY_PARAM_set_flags.pod b/src/lib/libcrypto/doc/X509_VERIFY_PARAM_set_flags.pod deleted file mode 100644 index 6c88aec49e..0000000000 --- a/src/lib/libcrypto/doc/X509_VERIFY_PARAM_set_flags.pod +++ /dev/null | |||
@@ -1,172 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | X509_VERIFY_PARAM_set_flags, X509_VERIFY_PARAM_clear_flags, | ||
6 | X509_VERIFY_PARAM_get_flags, X509_VERIFY_PARAM_set_purpose, | ||
7 | X509_VERIFY_PARAM_set_trust, X509_VERIFY_PARAM_set_depth, | ||
8 | X509_VERIFY_PARAM_get_depth, X509_VERIFY_PARAM_set_time, | ||
9 | X509_VERIFY_PARAM_add0_policy, X509_VERIFY_PARAM_set1_policies - X509 | ||
10 | verification parameters | ||
11 | |||
12 | =head1 SYNOPSIS | ||
13 | |||
14 | #include <openssl/x509_vfy.h> | ||
15 | |||
16 | int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags); | ||
17 | int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param, | ||
18 | unsigned long flags); | ||
19 | unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param); | ||
20 | |||
21 | int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose); | ||
22 | int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust); | ||
23 | |||
24 | void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t); | ||
25 | |||
26 | int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param, | ||
27 | ASN1_OBJECT *policy); | ||
28 | int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param, | ||
29 | STACK_OF(ASN1_OBJECT) *policies); | ||
30 | |||
31 | void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth); | ||
32 | int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param); | ||
33 | |||
34 | =head1 DESCRIPTION | ||
35 | |||
36 | These functions manipulate the B<X509_VERIFY_PARAM> structure associated with | ||
37 | a certificate verification operation. | ||
38 | |||
39 | The X509_VERIFY_PARAM_set_flags() function sets the flags in B<param> by oring | ||
40 | it with B<flags>. See the B<VERIFICATION FLAGS> section for a complete | ||
41 | description of values the B<flags> parameter can take. | ||
42 | |||
43 | X509_VERIFY_PARAM_get_flags() returns the flags in B<param>. | ||
44 | |||
45 | X509_VERIFY_PARAM_clear_flags() clears the flags B<flags> in B<param>. | ||
46 | |||
47 | X509_VERIFY_PARAM_set_purpose() sets the verification purpose in B<param> | ||
48 | to B<purpose>. This determines the acceptable purpose of the certificate | ||
49 | chain, for example SSL client or SSL server. | ||
50 | |||
51 | X509_VERIFY_PARAM_set_trust() sets the trust setting in B<param> to | ||
52 | B<trust>. | ||
53 | |||
54 | X509_VERIFY_PARAM_set_time() sets the verification time in B<param> to | ||
55 | B<t>. Normally the current time is used. | ||
56 | |||
57 | X509_VERIFY_PARAM_add0_policy() enables policy checking (it is disabled | ||
58 | by default) and adds B<policy> to the acceptable policy set. | ||
59 | |||
60 | X509_VERIFY_PARAM_set1_policies() enables policy checking (it is disabled | ||
61 | by default) and sets the acceptable policy set to B<policies>. Any existing | ||
62 | policy set is cleared. The B<policies> parameter can be B<NULL> to clear | ||
63 | an existing policy set. | ||
64 | |||
65 | X509_VERIFY_PARAM_set_depth() sets the maximum verification depth to B<depth>. | ||
66 | That is the maximum number of untrusted CA certificates that can appear in a | ||
67 | chain. | ||
68 | |||
69 | =head1 RETURN VALUES | ||
70 | |||
71 | X509_VERIFY_PARAM_set_flags(), X509_VERIFY_PARAM_clear_flags(), | ||
72 | X509_VERIFY_PARAM_set_purpose(), X509_VERIFY_PARAM_set_trust(), | ||
73 | X509_VERIFY_PARAM_add0_policy() and X509_VERIFY_PARAM_set1_policies() return 1 | ||
74 | for success and 0 for failure. | ||
75 | |||
76 | X509_VERIFY_PARAM_get_flags() returns the current verification flags. | ||
77 | |||
78 | X509_VERIFY_PARAM_set_time() and X509_VERIFY_PARAM_set_depth() do not return | ||
79 | values. | ||
80 | |||
81 | X509_VERIFY_PARAM_get_depth() returns the current verification depth. | ||
82 | |||
83 | =head1 VERIFICATION FLAGS | ||
84 | |||
85 | The verification flags consists of zero or more of the following flags | ||
86 | ored together. | ||
87 | |||
88 | B<X509_V_FLAG_CRL_CHECK> enables CRL checking for the certificate chain leaf | ||
89 | certificate. An error occurs if a suitable CRL cannot be found. | ||
90 | |||
91 | B<X509_V_FLAG_CRL_CHECK_ALL> enables CRL checking for the entire certificate | ||
92 | chain. | ||
93 | |||
94 | B<X509_V_FLAG_IGNORE_CRITICAL> disabled critical extension checking. By default | ||
95 | any unhandled critical extensions in certificates or (if checked) CRLs results | ||
96 | in a fatal error. If this flag is set unhandled critical extensions are | ||
97 | ignored. B<WARNING> setting this option for anything other than debugging | ||
98 | purposes can be a security risk. Finer control over which extensions are | ||
99 | supported can be performed in the verification callback. | ||
100 | |||
101 | THe B<X509_V_FLAG_X509_STRICT> flag disables workarounds for some broken | ||
102 | certificates and makes the verification strictly apply B<X509> rules. | ||
103 | |||
104 | B<X509_V_FLAG_ALLOW_PROXY_CERTS> enables proxy certificate verification. | ||
105 | |||
106 | B<X509_V_FLAG_POLICY_CHECK> enables certificate policy checking, by default | ||
107 | no policy checking is performed. Additional information is sent to the | ||
108 | verification callback relating to policy checking. | ||
109 | |||
110 | B<X509_V_FLAG_EXPLICIT_POLICY>, B<X509_V_FLAG_INHIBIT_ANY> and | ||
111 | B<X509_V_FLAG_INHIBIT_MAP> set the B<require explicit policy>, B<inhibit any | ||
112 | policy> and B<inhibit policy mapping> flags respectively as defined in | ||
113 | B<RFC3280>. Policy checking is automatically enabled if any of these flags | ||
114 | are set. | ||
115 | |||
116 | If B<X509_V_FLAG_NOTIFY_POLICY> is set and the policy checking is successful | ||
117 | a special status code is set to the verification callback. This permits it | ||
118 | to examine the valid policy tree and perform additional checks or simply | ||
119 | log it for debugging purposes. | ||
120 | |||
121 | By default some additional features such as indirect CRLs and CRLs signed by | ||
122 | different keys are disabled. If B<X509_V_FLAG_EXTENDED_CRL_SUPPORT> is set | ||
123 | they are enabled. | ||
124 | |||
125 | If B<X509_V_FLAG_USE_DELTAS> ise set delta CRLs (if present) are used to | ||
126 | determine certificate status. If not set deltas are ignored. | ||
127 | |||
128 | B<X509_V_FLAG_CHECK_SS_SIGNATURE> enables checking of the root CA self signed | ||
129 | certificate signature. By default this check is disabled because it doesn't | ||
130 | add any additional security but in some cases applications might want to | ||
131 | check the signature anyway. A side effect of not checking the root CA | ||
132 | signature is that disabled or unsupported message digests on the root CA | ||
133 | are not treated as fatal errors. | ||
134 | |||
135 | The B<X509_V_FLAG_CB_ISSUER_CHECK> flag enables debugging of certificate | ||
136 | issuer checks. It is B<not> needed unless you are logging certificate | ||
137 | verification. If this flag is set then additional status codes will be sent | ||
138 | to the verification callback and it B<must> be prepared to handle such cases | ||
139 | without assuming they are hard errors. | ||
140 | |||
141 | =head1 NOTES | ||
142 | |||
143 | The above functions should be used to manipulate verification parameters | ||
144 | instead of legacy functions which work in specific structures such as | ||
145 | X509_STORE_CTX_set_flags(). | ||
146 | |||
147 | =head1 BUGS | ||
148 | |||
149 | Delta CRL checking is currently primitive. Only a single delta can be used and | ||
150 | (partly due to limitations of B<X509_STORE>) constructed CRLs are not | ||
151 | maintained. | ||
152 | |||
153 | If CRLs checking is enable CRLs are expected to be available in the | ||
154 | corresponding B<X509_STORE> structure. No attempt is made to download | ||
155 | CRLs from the CRL distribution points extension. | ||
156 | |||
157 | =head1 EXAMPLE | ||
158 | |||
159 | Enable CRL checking when performing certificate verification during SSL | ||
160 | connections associated with an B<SSL_CTX> structure B<ctx>: | ||
161 | |||
162 | X509_VERIFY_PARAM *param; | ||
163 | param = X509_VERIFY_PARAM_new(); | ||
164 | X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK); | ||
165 | SSL_CTX_set1_param(ctx, param); | ||
166 | X509_VERIFY_PARAM_free(param); | ||
167 | |||
168 | =head1 SEE ALSO | ||
169 | |||
170 | L<X509_verify_cert(3)|X509_verify_cert(3)> | ||
171 | |||
172 | =cut | ||