RT3802: Fixes typos in doc/crypto/
[openssl.git] / doc / crypto / X509_VERIFY_PARAM_set_flags.pod
1 =pod
2
3 =head1 NAME
4
5 X509_VERIFY_PARAM_set_flags, X509_VERIFY_PARAM_clear_flags, X509_VERIFY_PARAM_get_flags, X509_VERIFY_PARAM_set_purpose, X509_VERIFY_PARAM_set_trust, X509_VERIFY_PARAM_set_depth, X509_VERIFY_PARAM_get_depth, X509_VERIFY_PARAM_set_time, X509_VERIFY_PARAM_add0_policy, X509_VERIFY_PARAM_set1_policies, X509_VERIFY_PARAM_set1_host, X509_VERIFY_PARAM_add1_host, X509_VERIFY_PARAM_set_hostflags, X509_VERIFY_PARAM_get0_peername, X509_VERIFY_PARAM_set1_email, X509_VERIFY_PARAM_set1_ip, X509_VERIFY_PARAM_set1_ip_asc - X509 verification parameters
6
7 =head1 SYNOPSIS
8
9  #include <openssl/x509_vfy.h>
10
11  int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags);
12  int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
13                                                         unsigned long flags);
14  unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param);
15
16  int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose);
17  int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust);
18
19  void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t);
20
21  int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
22                                                 ASN1_OBJECT *policy);
23  int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param, 
24                                         STACK_OF(ASN1_OBJECT) *policies);
25
26  void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth);
27  int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param);
28
29  int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
30                                  const char *name, size_t namelen);
31  int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
32                                  const char *name, size_t namelen);
33  void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
34                                       unsigned int flags);
35  char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param);
36  int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
37                                  const char *email, size_t emaillen);
38  int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
39                                const unsigned char *ip, size_t iplen);
40  int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc);
41
42 =head1 DESCRIPTION
43
44 These functions manipulate the B<X509_VERIFY_PARAM> structure associated with
45 a certificate verification operation. 
46
47 The X509_VERIFY_PARAM_set_flags() function sets the flags in B<param> by oring
48 it with B<flags>. See the B<VERIFICATION FLAGS> section for a complete
49 description of values the B<flags> parameter can take.
50
51 X509_VERIFY_PARAM_get_flags() returns the flags in B<param>.
52
53 X509_VERIFY_PARAM_clear_flags() clears the flags B<flags> in B<param>.
54
55 X509_VERIFY_PARAM_set_purpose() sets the verification purpose in B<param>
56 to B<purpose>. This determines the acceptable purpose of the certificate
57 chain, for example SSL client or SSL server.
58
59 X509_VERIFY_PARAM_set_trust() sets the trust setting in B<param> to 
60 B<trust>.
61
62 X509_VERIFY_PARAM_set_time() sets the verification time in B<param> to
63 B<t>. Normally the current time is used.
64
65 X509_VERIFY_PARAM_add0_policy() enables policy checking (it is disabled
66 by default) and adds B<policy> to the acceptable policy set.
67
68 X509_VERIFY_PARAM_set1_policies() enables policy checking (it is disabled
69 by default) and sets the acceptable policy set to B<policies>. Any existing
70 policy set is cleared. The B<policies> parameter can be B<NULL> to clear
71 an existing policy set.
72
73 X509_VERIFY_PARAM_set_depth() sets the maximum verification depth to B<depth>.
74 That is the maximum number of untrusted CA certificates that can appear in a
75 chain.
76
77 X509_VERIFY_PARAM_set1_host() sets the expected DNS hostname to
78 B<name> clearing any previously specified host name or names.  If
79 B<name> is NULL, or empty the list of hostnames is cleared, and
80 name checks are not performed on the peer certificate.  If B<name>
81 is NUL-terminated, B<namelen> may be zero, otherwise B<namelen>
82 must be set to the length of B<name>.  When a hostname is specified,
83 certificate verification automatically invokes L<X509_check_host(3)>
84 with flags equal to the B<flags> argument given to
85 B<X509_VERIFY_PARAM_set_hostflags()> (default zero).  Applications
86 are strongly advised to use this interface in preference to explicitly
87 calling L<X509_check_host(3)>, hostname checks are out of scope
88 with the DANE-EE(3) certificate usage, and the internal check will
89 be suppressed as appropriate when DANE support is added to OpenSSL.
90
91 X509_VERIFY_PARAM_add1_host() adds B<name> as an additional reference
92 identifier that can match the peer's certificate.  Any previous names
93 set via X509_VERIFY_PARAM_set1_host() or X509_VERIFY_PARAM_add1_host()
94 are retained, no change is made if B<name> is NULL or empty.  When
95 multiple names are configured, the peer is considered verified when
96 any name matches.
97
98 X509_VERIFY_PARAM_get0_peername() returns the DNS hostname or subject
99 CommonName from the peer certificate that matched one of the reference
100 identifiers.  When wildcard matching is not disabled, or when a
101 reference identifier specifies a parent domain (starts with ".")
102 rather than a hostname, the peer name may be a wildcard name or a
103 sub-domain of the reference identifier respectively.  The return
104 string is allocated by the library and is no longer valid once the
105 associated B<param> argument is freed.  Applications must not free
106 the return value.
107
108 X509_VERIFY_PARAM_set1_email() sets the expected RFC822 email address to
109 B<email>.  If B<email> is NUL-terminated, B<emaillen> may be zero, otherwise
110 B<emaillen> must be set to the length of B<email>.  When an email address
111 is specified, certificate verification automatically invokes
112 L<X509_check_email(3)>.
113
114 X509_VERIFY_PARAM_set1_ip() sets the expected IP address to B<ip>.
115 The B<ip> argument is in binary format, in network byte-order and
116 B<iplen> must be set to 4 for IPv4 and 16 for IPv6.  When an IP
117 address is specified, certificate verification automatically invokes
118 L<X509_check_ip(3)>.
119
120 X509_VERIFY_PARAM_set1_ip_asc() sets the expected IP address to
121 B<ipasc>.  The B<ipasc> argument is a NUL-terminal ASCII string:
122 dotted decimal quad for IPv4 and colon-separated hexadecimal for
123 IPv6.  The condensed "::" notation is supported for IPv6 addresses.
124
125 =head1 RETURN VALUES
126
127 X509_VERIFY_PARAM_set_flags(), X509_VERIFY_PARAM_clear_flags(),
128 X509_VERIFY_PARAM_set_purpose(), X509_VERIFY_PARAM_set_trust(),
129 X509_VERIFY_PARAM_add0_policy() X509_VERIFY_PARAM_set1_policies(),
130 X509_VERIFY_PARAM_set1_host(), X509_VERIFY_PARAM_set_hostflags(),
131 X509_VERIFY_PARAM_set1_email(), X509_VERIFY_PARAM_set1_ip() and
132 X509_VERIFY_PARAM_set1_ip_asc() return 1 for success and 0 for
133 failure.
134
135 X509_VERIFY_PARAM_get_flags() returns the current verification flags.
136
137 X509_VERIFY_PARAM_set_time() and X509_VERIFY_PARAM_set_depth() do not return
138 values.
139
140 X509_VERIFY_PARAM_get_depth() returns the current verification depth.
141
142 =head1 VERIFICATION FLAGS
143
144 The verification flags consists of zero or more of the following flags
145 ored together.
146
147 B<X509_V_FLAG_CRL_CHECK> enables CRL checking for the certificate chain leaf
148 certificate. An error occurs if a suitable CRL cannot be found. 
149
150 B<X509_V_FLAG_CRL_CHECK_ALL> enables CRL checking for the entire certificate
151 chain.
152
153 B<X509_V_FLAG_IGNORE_CRITICAL> disabled critical extension checking. By default
154 any unhandled critical extensions in certificates or (if checked) CRLs results
155 in a fatal error. If this flag is set unhandled critical extensions are
156 ignored. B<WARNING> setting this option for anything other than debugging
157 purposes can be a security risk. Finer control over which extensions are
158 supported can be performed in the verification callback.
159
160 The B<X509_V_FLAG_X509_STRICT> flag disables workarounds for some broken
161 certificates and makes the verification strictly apply B<X509> rules.
162
163 B<X509_V_FLAG_ALLOW_PROXY_CERTS> enables proxy certificate verification.
164
165 B<X509_V_FLAG_POLICY_CHECK> enables certificate policy checking, by default
166 no policy checking is performed. Additional information is sent to the
167 verification callback relating to policy checking.
168
169 B<X509_V_FLAG_EXPLICIT_POLICY>, B<X509_V_FLAG_INHIBIT_ANY> and
170 B<X509_V_FLAG_INHIBIT_MAP> set the B<require explicit policy>, B<inhibit any
171 policy> and B<inhibit policy mapping> flags respectively as defined in
172 B<RFC3280>. Policy checking is automatically enabled if any of these flags
173 are set.
174
175 If B<X509_V_FLAG_NOTIFY_POLICY> is set and the policy checking is successful
176 a special status code is set to the verification callback. This permits it
177 to examine the valid policy tree and perform additional checks or simply
178 log it for debugging purposes.
179
180 By default some additional features such as indirect CRLs and CRLs signed by
181 different keys are disabled. If B<X509_V_FLAG_EXTENDED_CRL_SUPPORT> is set
182 they are enabled.
183
184 If B<X509_V_FLAG_USE_DELTAS> is set delta CRLs (if present) are used to
185 determine certificate status. If not set deltas are ignored.
186
187 B<X509_V_FLAG_CHECK_SS_SIGNATURE> enables checking of the root CA self signed
188 certificate signature. By default this check is disabled because it doesn't
189 add any additional security but in some cases applications might want to
190 check the signature anyway. A side effect of not checking the root CA
191 signature is that disabled or unsupported message digests on the root CA
192 are not treated as fatal errors.
193
194 The B<X509_V_FLAG_CB_ISSUER_CHECK> flag enables debugging of certificate
195 issuer checks. It is B<not> needed unless you are logging certificate
196 verification. If this flag is set then additional status codes will be sent
197 to the verification callback and it B<must> be prepared to handle such cases
198 without assuming they are hard errors.
199
200 The B<X509_V_FLAG_NO_ALT_CHAINS> flag suppresses checking for alternative
201 chains. By default, when building a certificate chain, if the first certificate
202 chain found is not trusted, then OpenSSL will continue to check to see if an
203 alternative chain can be found that is trusted. With this flag set the behaviour
204 will match that of OpenSSL versions prior to 1.1.0.
205
206 =head1 NOTES
207
208 The above functions should be used to manipulate verification parameters
209 instead of legacy functions which work in specific structures such as
210 X509_STORE_CTX_set_flags().
211
212 =head1 BUGS
213
214 Delta CRL checking is currently primitive. Only a single delta can be used and
215 (partly due to limitations of B<X509_STORE>) constructed CRLs are not 
216 maintained.
217
218 If CRLs checking is enable CRLs are expected to be available in the
219 corresponding B<X509_STORE> structure. No attempt is made to download
220 CRLs from the CRL distribution points extension.
221
222 =head1 EXAMPLE
223
224 Enable CRL checking when performing certificate verification during SSL 
225 connections associated with an B<SSL_CTX> structure B<ctx>:
226
227   X509_VERIFY_PARAM *param;
228   param = X509_VERIFY_PARAM_new();
229   X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK);
230   SSL_CTX_set1_param(ctx, param);
231   X509_VERIFY_PARAM_free(param);
232
233 =head1 SEE ALSO
234
235 L<X509_verify_cert(3)|X509_verify_cert(3)>,
236 L<X509_check_host(3)|X509_check_host(3)>,
237 L<X509_check_email(3)|X509_check_email(3)>,
238 L<X509_check_ip(3)|X509_check_ip(3)>
239
240 =head1 HISTORY
241
242 The B<X509_V_FLAG_NO_ALT_CHAINS> flag was added in OpenSSL 1.1.0
243
244 =cut