doc/man3/X509_VERIFY_PARAM_set_flags.pod

   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_get_inh_flags, X509_VERIFY_PARAM_set_inh_flags,
   8 X509_VERIFY_PARAM_set_trust, X509_VERIFY_PARAM_set_depth,
   9 X509_VERIFY_PARAM_get_depth, X509_VERIFY_PARAM_set_auth_level,
  10 X509_VERIFY_PARAM_get_auth_level, X509_VERIFY_PARAM_set_time,
  11 X509_VERIFY_PARAM_get_time,
  12 X509_VERIFY_PARAM_add0_policy, X509_VERIFY_PARAM_set1_policies,
  13 X509_VERIFY_PARAM_set1_host, X509_VERIFY_PARAM_add1_host,
  14 X509_VERIFY_PARAM_set_hostflags, X509_VERIFY_PARAM_get0_peername,
  15 X509_VERIFY_PARAM_set1_email, X509_VERIFY_PARAM_set1_ip,
  16 X509_VERIFY_PARAM_set1_ip_asc
  17 - X509 verification parameters
  18
  19 =head1 SYNOPSIS
  20
  21  #include <openssl/x509_vfy.h>
  22
  23  int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param,
  24                                  unsigned long flags);
  25  int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
  26                                    unsigned long flags);
  27  unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param);
  28
  29  int X509_VERIFY_PARAM_set_inh_flags(X509_VERIFY_PARAM *param,
  30                                      uint32_t flags);
  31  uint32_t X509_VERIFY_PARAM_get_inh_flags(const X509_VERIFY_PARAM *param);
  32
  33  int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose);
  34  int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust);
  35
  36  void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t);
  37  time_t X509_VERIFY_PARAM_get_time(const X509_VERIFY_PARAM *param);
  38
  39  int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
  40                                    ASN1_OBJECT *policy);
  41  int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
  42                                      STACK_OF(ASN1_OBJECT) *policies);
  43
  44  void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth);
  45  int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param);
  46
  47  void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param,
  48                                        int auth_level);
  49  int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param);
  50
  51  int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
  52                                  const char *name, size_t namelen);
  53  int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
  54                                  const char *name, size_t namelen);
  55  void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
  56                                       unsigned int flags);
  57  char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param);
  58  int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
  59                                   const char *email, size_t emaillen);
  60  int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
  61                                const unsigned char *ip, size_t iplen);
  62  int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc);
  63
  64 =head1 DESCRIPTION
  65
  66 These functions manipulate the B<X509_VERIFY_PARAM> structure associated with
  67 a certificate verification operation.
  68
  69 The X509_VERIFY_PARAM_set_flags() function sets the flags in B<param> by oring
  70 it with B<flags>. See the B<VERIFICATION FLAGS> section for a complete
  71 description of values the B<flags> parameter can take.
  72
  73 X509_VERIFY_PARAM_get_flags() returns the flags in B<param>.
  74
  75 X509_VERIFY_PARAM_get_inh_flags() returns the inheritance flags in B<param>
  76 which specifies how verification flags are copied from one structure to
  77 another. X509_VERIFY_PARAM_set_inh_flags() sets the inheritance flags.
  78 See the B<INHERITANCE FLAGS> section for a description of these bits.
  79
  80 X509_VERIFY_PARAM_clear_flags() clears the flags B<flags> in B<param>.
  81
  82 X509_VERIFY_PARAM_set_purpose() sets the verification purpose in B<param>
  83 to B<purpose>. This determines the acceptable purpose of the certificate
  84 chain, for example SSL client or SSL server.
  85
  86 X509_VERIFY_PARAM_set_trust() sets the trust setting in B<param> to
  87 B<trust>.
  88
  89 X509_VERIFY_PARAM_set_time() sets the verification time in B<param> to
  90 B<t>. Normally the current time is used.
  91
  92 X509_VERIFY_PARAM_add0_policy() enables policy checking (it is disabled
  93 by default) and adds B<policy> to the acceptable policy set.
  94
  95 X509_VERIFY_PARAM_set1_policies() enables policy checking (it is disabled
  96 by default) and sets the acceptable policy set to B<policies>. Any existing
  97 policy set is cleared. The B<policies> parameter can be B<NULL> to clear
  98 an existing policy set.
  99
 100 X509_VERIFY_PARAM_set_depth() sets the maximum verification depth to B<depth>.
 101 That is the maximum number of intermediate CA certificates that can appear in a
 102 chain.
 103 A maximal depth chain contains 2 more certificates than the limit, since
 104 neither the end-entity certificate nor the trust-anchor count against this
 105 limit.
 106 Thus a B<depth> limit of 0 only allows the end-entity certificate to be signed
 107 directly by the trust-anchor, while with a B<depth> limit of 1 there can be one
 108 intermediate CA certificate between the trust-anchor and the end-entity
 109 certificate.
 110
 111 X509_VERIFY_PARAM_set_auth_level() sets the authentication security level to
 112 B<auth_level>.
 113 The authentication security level determines the acceptable signature and public
 114 key strength when verifying certificate chains.
 115 For a certificate chain to validate, the public keys of all the certificates
 116 must meet the specified security level.
 117 The signature algorithm security level is not enforced for the chain's I<trust
 118 anchor> certificate, which is either directly trusted or validated by means other
 119 than its signature.
 120 See L<SSL_CTX_set_security_level(3)> for the definitions of the available
 121 levels.
 122 The default security level is -1, or "not set".
 123 At security level 0 or lower all algorithms are acceptable.
 124 Security level 1 requires at least 80-bit-equivalent security and is broadly
 125 interoperable, though it will, for example, reject MD5 signatures or RSA keys
 126 shorter than 1024 bits.
 127
 128 X509_VERIFY_PARAM_set1_host() sets the expected DNS hostname to
 129 B<name> clearing any previously specified host name or names.  If
 130 B<name> is NULL, or empty the list of hostnames is cleared, and
 131 name checks are not performed on the peer certificate.  If B<name>
 132 is NUL-terminated, B<namelen> may be zero, otherwise B<namelen>
 133 must be set to the length of B<name>.  When a hostname is specified,
 134 certificate verification automatically invokes L<X509_check_host(3)>
 135 with flags equal to the B<flags> argument given to
 136 X509_VERIFY_PARAM_set_hostflags() (default zero).  Applications
 137 are strongly advised to use this interface in preference to explicitly
 138 calling L<X509_check_host(3)>, hostname checks are out of scope
 139 with the DANE-EE(3) certificate usage, and the internal check will
 140 be suppressed as appropriate when DANE support is added to OpenSSL.
 141
 142 X509_VERIFY_PARAM_add1_host() adds B<name> as an additional reference
 143 identifier that can match the peer's certificate.  Any previous names
 144 set via X509_VERIFY_PARAM_set1_host() or X509_VERIFY_PARAM_add1_host()
 145 are retained, no change is made if B<name> is NULL or empty.  When
 146 multiple names are configured, the peer is considered verified when
 147 any name matches.
 148
 149 X509_VERIFY_PARAM_get0_peername() returns the DNS hostname or subject
 150 CommonName from the peer certificate that matched one of the reference
 151 identifiers.  When wildcard matching is not disabled, or when a
 152 reference identifier specifies a parent domain (starts with ".")
 153 rather than a hostname, the peer name may be a wildcard name or a
 154 sub-domain of the reference identifier respectively.  The return
 155 string is allocated by the library and is no longer valid once the
 156 associated B<param> argument is freed.  Applications must not free
 157 the return value.
 158
 159 X509_VERIFY_PARAM_set1_email() sets the expected RFC822 email address to
 160 B<email>.  If B<email> is NUL-terminated, B<emaillen> may be zero, otherwise
 161 B<emaillen> must be set to the length of B<email>.  When an email address
 162 is specified, certificate verification automatically invokes
 163 L<X509_check_email(3)>.
 164
 165 X509_VERIFY_PARAM_set1_ip() sets the expected IP address to B<ip>.
 166 The B<ip> argument is in binary format, in network byte-order and
 167 B<iplen> must be set to 4 for IPv4 and 16 for IPv6.  When an IP
 168 address is specified, certificate verification automatically invokes
 169 L<X509_check_ip(3)>.
 170
 171 X509_VERIFY_PARAM_set1_ip_asc() sets the expected IP address to
 172 B<ipasc>.  The B<ipasc> argument is a NUL-terminal ASCII string:
 173 dotted decimal quad for IPv4 and colon-separated hexadecimal for
 174 IPv6.  The condensed "::" notation is supported for IPv6 addresses.
 175
 176 =head1 RETURN VALUES
 177
 178 X509_VERIFY_PARAM_set_flags(), X509_VERIFY_PARAM_clear_flags(),
 179 X509_VERIFY_PARAM_set_inh_flags(),
 180 X509_VERIFY_PARAM_set_purpose(), X509_VERIFY_PARAM_set_trust(),
 181 X509_VERIFY_PARAM_add0_policy() X509_VERIFY_PARAM_set1_policies(),
 182 X509_VERIFY_PARAM_set1_host(), X509_VERIFY_PARAM_add1_host(),
 183 X509_VERIFY_PARAM_set1_email(), X509_VERIFY_PARAM_set1_ip() and
 184 X509_VERIFY_PARAM_set1_ip_asc() return 1 for success and 0 for
 185 failure.
 186
 187 X509_VERIFY_PARAM_get_flags() returns the current verification flags.
 188
 189 X509_VERIFY_PARAM_get_inh_flags() returns the current inheritance flags.
 190
 191 X509_VERIFY_PARAM_set_time() and X509_VERIFY_PARAM_set_depth() do not return
 192 values.
 193
 194 X509_VERIFY_PARAM_get_depth() returns the current verification depth.
 195
 196 X509_VERIFY_PARAM_get_auth_level() returns the current authentication security
 197 level.
 198
 199 =head1 VERIFICATION FLAGS
 200
 201 The verification flags consists of zero or more of the following flags
 202 ored together.
 203
 204 B<X509_V_FLAG_CRL_CHECK> enables CRL checking for the certificate chain leaf
 205 certificate. An error occurs if a suitable CRL cannot be found.
 206
 207 B<X509_V_FLAG_CRL_CHECK_ALL> enables CRL checking for the entire certificate
 208 chain.
 209
 210 B<X509_V_FLAG_IGNORE_CRITICAL> disabled critical extension checking. By default
 211 any unhandled critical extensions in certificates or (if checked) CRLs results
 212 in a fatal error. If this flag is set unhandled critical extensions are
 213 ignored. B<WARNING> setting this option for anything other than debugging
 214 purposes can be a security risk. Finer control over which extensions are
 215 supported can be performed in the verification callback.
 216
 217 The B<X509_V_FLAG_X509_STRICT> flag disables workarounds for some broken
 218 certificates and makes the verification strictly apply B<X509> rules.
 219
 220 B<X509_V_FLAG_ALLOW_PROXY_CERTS> enables proxy certificate verification.
 221
 222 B<X509_V_FLAG_POLICY_CHECK> enables certificate policy checking, by default
 223 no policy checking is performed. Additional information is sent to the
 224 verification callback relating to policy checking.
 225
 226 B<X509_V_FLAG_EXPLICIT_POLICY>, B<X509_V_FLAG_INHIBIT_ANY> and
 227 B<X509_V_FLAG_INHIBIT_MAP> set the B<require explicit policy>, B<inhibit any
 228 policy> and B<inhibit policy mapping> flags respectively as defined in
 229 B<RFC3280>. Policy checking is automatically enabled if any of these flags
 230 are set.
 231
 232 If B<X509_V_FLAG_NOTIFY_POLICY> is set and the policy checking is successful
 233 a special status code is set to the verification callback. This permits it
 234 to examine the valid policy tree and perform additional checks or simply
 235 log it for debugging purposes.
 236
 237 By default some additional features such as indirect CRLs and CRLs signed by
 238 different keys are disabled. If B<X509_V_FLAG_EXTENDED_CRL_SUPPORT> is set
 239 they are enabled.
 240
 241 If B<X509_V_FLAG_USE_DELTAS> is set delta CRLs (if present) are used to
 242 determine certificate status. If not set deltas are ignored.
 243
 244 B<X509_V_FLAG_CHECK_SS_SIGNATURE> enables checking of the root CA self signed
 245 certificate signature. By default this check is disabled because it doesn't
 246 add any additional security but in some cases applications might want to
 247 check the signature anyway. A side effect of not checking the root CA
 248 signature is that disabled or unsupported message digests on the root CA
 249 are not treated as fatal errors.
 250
 251 When B<X509_V_FLAG_TRUSTED_FIRST> is set, construction of the certificate chain
 252 in L<X509_verify_cert(3)> will search the trust store for issuer certificates
 253 before searching the provided untrusted certificates.
 254 Local issuer certificates are often more likely to satisfy local security
 255 requirements and lead to a locally trusted root.
 256 This is especially important when some certificates in the trust store have
 257 explicit trust settings (see "TRUST SETTINGS" in L<x509(1)>).
 258 As of OpenSSL 1.1.0 this option is on by default.
 259
 260 The B<X509_V_FLAG_NO_ALT_CHAINS> flag suppresses checking for alternative
 261 chains.
 262 By default, unless B<X509_V_FLAG_TRUSTED_FIRST> is set, when building a
 263 certificate chain, if the first certificate chain found is not trusted, then
 264 OpenSSL will attempt to replace untrusted certificates supplied by the peer
 265 with certificates from the trust store to see if an alternative chain can be
 266 found that is trusted.
 267 As of OpenSSL 1.1.0, with B<X509_V_FLAG_TRUSTED_FIRST> always set, this option
 268 has no effect.
 269
 270 The B<X509_V_FLAG_PARTIAL_CHAIN> flag causes intermediate certificates in the
 271 trust store to be treated as trust-anchors, in the same way as the self-signed
 272 root CA certificates.
 273 This makes it possible to trust certificates issued by an intermediate CA
 274 without having to trust its ancestor root CA.
 275 With OpenSSL 1.1.0 and later and <X509_V_FLAG_PARTIAL_CHAIN> set, chain
 276 construction stops as soon as the first certificate from the trust store is
 277 added to the chain, whether that certificate is a self-signed "root"
 278 certificate or a not self-signed intermediate certificate.
 279 Thus, when an intermediate certificate is found in the trust store, the
 280 verified chain passed to callbacks may be shorter than it otherwise would
 281 be without the B<X509_V_FLAG_PARTIAL_CHAIN> flag.
 282
 283 The B<X509_V_FLAG_NO_CHECK_TIME> flag suppresses checking the validity period
 284 of certificates and CRLs against the current time. If X509_VERIFY_PARAM_set_time()
 285 is used to specify a verification time, the check is not suppressed.
 286
 287 =head1 INHERITANCE FLAGS
 288
 289 These flags specify how parameters are "inherited" from one structure to
 290 another.
 291
 292 If B<X509_VP_FLAG_ONCE> is set then the current setting is zeroed
 293 after the next call.
 294
 295 If B<X509_VP_FLAG_LOCKED> is set then no values are copied.  This overrides
 296 all of the following flags.
 297
 298 If B<X509_VP_FLAG_DEFAULT> is set then anything set in the source is copied
 299 to the destination. Effectively the values in "to" become default values
 300 which will be used only if nothing new is set in "from".  This is the
 301 default.
 302
 303 If B<X509_VP_FLAG_OVERWRITE> is set then all value are copied across whether
 304 they are set or not. Flags is still Ored though.
 305
 306 If B<X509_VP_FLAG_RESET_FLAGS> is set then the flags value is copied instead
 307 of ORed.
 308
 309 =head1 NOTES
 310
 311 The above functions should be used to manipulate verification parameters
 312 instead of functions which work in specific structures such as
 313 X509_STORE_CTX_set_flags() which are likely to be deprecated in a future
 314 release.
 315
 316 =head1 BUGS
 317
 318 Delta CRL checking is currently primitive. Only a single delta can be used and
 319 (partly due to limitations of B<X509_STORE>) constructed CRLs are not
 320 maintained.
 321
 322 If CRLs checking is enable CRLs are expected to be available in the
 323 corresponding B<X509_STORE> structure. No attempt is made to download
 324 CRLs from the CRL distribution points extension.
 325
 326 =head1 EXAMPLE
 327
 328 Enable CRL checking when performing certificate verification during SSL
 329 connections associated with an B<SSL_CTX> structure B<ctx>:
 330
 331  X509_VERIFY_PARAM *param;
 332
 333  param = X509_VERIFY_PARAM_new();
 334  X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK);
 335  SSL_CTX_set1_param(ctx, param);
 336  X509_VERIFY_PARAM_free(param);
 337
 338 =head1 SEE ALSO
 339
 340 L<X509_verify_cert(3)>,
 341 L<X509_check_host(3)>,
 342 L<X509_check_email(3)>,
 343 L<X509_check_ip(3)>,
 344 L<x509(1)>
 345
 346 =head1 HISTORY
 347
 348 The B<X509_V_FLAG_NO_ALT_CHAINS> flag was added in OpenSSL 1.1.0
 349 The flag B<X509_V_FLAG_CB_ISSUER_CHECK> was deprecated in
 350 OpenSSL 1.1.0, and has no effect.
 351
 352 =head1 COPYRIGHT
 353
 354 Copyright 2009-2018 The OpenSSL Project Authors. All Rights Reserved.
 355
 356 Licensed under the OpenSSL license (the "License").  You may not use
 357 this file except in compliance with the License.  You can obtain a copy
 358 in the file LICENSE in the source distribution or at
 359 L<https://www.openssl.org/source/license.html>.
 360
 361 =cut