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_set_hostflags, X509_VERIFY_PARAM_set1_email, X509_VERIFY_PARAM_set1_ip, X509_VERIFY_PARAM_set1_ip_asc - X509 verification parameters
9 #include <openssl/x509_vfy.h>
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,
14 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param);
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);
19 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t);
21 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
23 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
24 STACK_OF(ASN1_OBJECT) *policies);
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);
29 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
30 const unsigned char *name, size_t namelen);
31 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
33 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
34 const unsigned char *email, size_t emaillen);
35 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
36 const unsigned char *ip, size_t iplen);
37 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param,
42 These functions manipulate the B<X509_VERIFY_PARAM> structure associated with
43 a certificate verification operation.
45 The X509_VERIFY_PARAM_set_flags() function sets the flags in B<param> by oring
46 it with B<flags>. See the B<VERIFICATION FLAGS> section for a complete
47 description of values the B<flags> parameter can take.
49 X509_VERIFY_PARAM_get_flags() returns the flags in B<param>.
51 X509_VERIFY_PARAM_clear_flags() clears the flags B<flags> in B<param>.
53 X509_VERIFY_PARAM_set_purpose() sets the verification purpose in B<param>
54 to B<purpose>. This determines the acceptable purpose of the certificate
55 chain, for example SSL client or SSL server.
57 X509_VERIFY_PARAM_set_trust() sets the trust setting in B<param> to
60 X509_VERIFY_PARAM_set_time() sets the verification time in B<param> to
61 B<t>. Normally the current time is used.
63 X509_VERIFY_PARAM_add0_policy() enables policy checking (it is disabled
64 by default) and adds B<policy> to the acceptable policy set.
66 X509_VERIFY_PARAM_set1_policies() enables policy checking (it is disabled
67 by default) and sets the acceptable policy set to B<policies>. Any existing
68 policy set is cleared. The B<policies> parameter can be B<NULL> to clear
69 an existing policy set.
71 X509_VERIFY_PARAM_set_depth() sets the maximum verification depth to B<depth>.
72 That is the maximum number of untrusted CA certificates that can appear in a
75 X509_VERIFY_PARAM_set1_host() sets the expected DNS hostname to B<name>. If
76 B<name> is NUL-terminated, B<namelen> may be zero, otherwise B<namelen> must
77 be set to the length of B<name>. When a hostname is specified, certificate
78 verification automatically invokes L<X509_check_host(3)> with flags equal to
79 the B<flags> argument given to B<X509_VERIFY_PARAM_set_hostflags()> (default
80 zero). Applications are strongly advised to use this interface in preference
81 to explicitly calling L<X509_check_host(3)>, hostname checks are
82 out of scope with the DANE-EE(3) certificate usage, and the internal
83 check will be suppressed as appropriate when DANE support is added
86 X509_VERIFY_PARAM_set1_email() sets the expected RFC822 email address to
87 B<email>. If B<email> is NUL-terminated, B<emaillen> may be zero, otherwise
88 B<emaillen> must be set to the length of B<email>. When an email address
89 is specified, certificate verification automatically invokes
90 L<X509_check_email(3)>.
92 X509_VERIFY_PARAM_set1_ip() sets the expected IP address to B<ip>.
93 The B<ip> argument is in binary format, in network byte-order and
94 B<iplen> must be set to 4 for IPv4 and 16 for IPv6. When an IP
95 address is specified, certificate verification automatically invokes
98 X509_VERIFY_PARAM_set1_ip_asc() sets the expected IP address to
99 B<ipasc>. The B<ipasc> argument is a NUL-terminal ASCII string:
100 dotted decimal quad for IPv4 and colon-separated hexadecimal for
101 IPv6. The condensed "::" notation is supported for IPv6 addresses.
105 X509_VERIFY_PARAM_set_flags(), X509_VERIFY_PARAM_clear_flags(),
106 X509_VERIFY_PARAM_set_purpose(), X509_VERIFY_PARAM_set_trust(),
107 X509_VERIFY_PARAM_add0_policy() X509_VERIFY_PARAM_set1_policies(),
108 X509_VERIFY_PARAM_set1_host(), X509_VERIFY_PARAM_set_hostflags(),
109 X509_VERIFY_PARAM_set1_email(), X509_VERIFY_PARAM_set1_ip() and
110 X509_VERIFY_PARAM_set1_ip_asc() return 1 for success and 0 for
113 X509_VERIFY_PARAM_get_flags() returns the current verification flags.
115 X509_VERIFY_PARAM_set_time() and X509_VERIFY_PARAM_set_depth() do not return
118 X509_VERIFY_PARAM_get_depth() returns the current verification depth.
120 =head1 VERIFICATION FLAGS
122 The verification flags consists of zero or more of the following flags
125 B<X509_V_FLAG_CRL_CHECK> enables CRL checking for the certificate chain leaf
126 certificate. An error occurs if a suitable CRL cannot be found.
128 B<X509_V_FLAG_CRL_CHECK_ALL> enables CRL checking for the entire certificate
131 B<X509_V_FLAG_IGNORE_CRITICAL> disabled critical extension checking. By default
132 any unhandled critical extensions in certificates or (if checked) CRLs results
133 in a fatal error. If this flag is set unhandled critical extensions are
134 ignored. B<WARNING> setting this option for anything other than debugging
135 purposes can be a security risk. Finer control over which extensions are
136 supported can be performed in the verification callback.
138 THe B<X509_V_FLAG_X509_STRICT> flag disables workarounds for some broken
139 certificates and makes the verification strictly apply B<X509> rules.
141 B<X509_V_FLAG_ALLOW_PROXY_CERTS> enables proxy certificate verification.
143 B<X509_V_FLAG_POLICY_CHECK> enables certificate policy checking, by default
144 no policy checking is peformed. Additional information is sent to the
145 verification callback relating to policy checking.
147 B<X509_V_FLAG_EXPLICIT_POLICY>, B<X509_V_FLAG_INHIBIT_ANY> and
148 B<X509_V_FLAG_INHIBIT_MAP> set the B<require explicit policy>, B<inhibit any
149 policy> and B<inhibit policy mapping> flags respectively as defined in
150 B<RFC3280>. Policy checking is automatically enabled if any of these flags
153 If B<X509_V_FLAG_NOTIFY_POLICY> is set and the policy checking is successful
154 a special status code is set to the verification callback. This permits it
155 to examine the valid policy tree and perform additional checks or simply
156 log it for debugging purposes.
158 By default some additional features such as indirect CRLs and CRLs signed by
159 different keys are disabled. If B<X509_V_FLAG_EXTENDED_CRL_SUPPORT> is set
162 If B<X509_V_FLAG_USE_DELTAS> ise set delta CRLs (if present) are used to
163 determine certificate status. If not set deltas are ignored.
165 B<X509_V_FLAG_CHECK_SS_SIGNATURE> enables checking of the root CA self signed
166 cerificate signature. By default this check is disabled because it doesn't
167 add any additional security but in some cases applications might want to
168 check the signature anyway. A side effect of not checking the root CA
169 signature is that disabled or unsupported message digests on the root CA
170 are not treated as fatal errors.
172 The B<X509_V_FLAG_CB_ISSUER_CHECK> flag enables debugging of certificate
173 issuer checks. It is B<not> needed unless you are logging certificate
174 verification. If this flag is set then additional status codes will be sent
175 to the verification callback and it B<must> be prepared to handle such cases
176 without assuming they are hard errors.
180 The above functions should be used to manipulate verification parameters
181 instead of legacy functions which work in specific structures such as
182 X509_STORE_CTX_set_flags().
186 Delta CRL checking is currently primitive. Only a single delta can be used and
187 (partly due to limitations of B<X509_STORE>) constructed CRLs are not
190 If CRLs checking is enable CRLs are expected to be available in the
191 corresponding B<X509_STORE> structure. No attempt is made to download
192 CRLs from the CRL distribution points extension.
196 Enable CRL checking when performing certificate verification during SSL
197 connections associated with an B<SSL_CTX> structure B<ctx>:
199 X509_VERIFY_PARAM *param;
200 param = X509_VERIFY_PARAM_new();
201 X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK);
202 SSL_CTX_set1_param(ctx, param);
203 X509_VERIFY_PARAM_free(param);
207 L<X509_verify_cert(3)|X509_verify_cert(3)>,
208 L<X509_check_host(3)|X509_check_host(3)>,
209 L<X509_check_email(3)|X509_check_email(3)>,
210 L<X509_check_ip(3)|X509_check_ip(3)>