doc/apps/verify.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 verify - Utility to verify certificates.
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<verify>
  10 [B<-CAfile file>]
  11 [B<-CApath directory>]
  12 [B<-no-CAfile>]
  13 [B<-no-CApath>]
  14 [B<-attime timestamp>]
  15 [B<-check_ss_sig>]
  16 [B<-CRLfile file>]
  17 [B<-crl_download>]
  18 [B<-crl_check>]
  19 [B<-crl_check_all>]
  20 [B<-explicit_policy>]
  21 [B<-extended_crl>]
  22 [B<-help>]
  23 [B<-ignore_critical>]
  24 [B<-inhibit_any>]
  25 [B<-inhibit_map>]
  26 [B<-issuer_checks>]
  27 [B<-partial_chain>]
  28 [B<-policy arg>]
  29 [B<-policy_check>]
  30 [B<-policy_print>]
  31 [B<-purpose purpose>]
  32 [B<-suiteB_128>]
  33 [B<-suiteB_128_only>]
  34 [B<-suiteB_192>]
  35 [B<-trusted_first>]
  36 [B<-no_alt_chains>]
  37 [B<-untrusted file>]
  38 [B<-trusted file>]
  39 [B<-use_deltas>]
  40 [B<-verbose>]
  41 [B<-verify_depth num>]
  42 [B<-verify_email email>]
  43 [B<-verify_hostname hostname>]
  44 [B<-verify_ip ip>]
  45 [B<-verify_name name>]
  46 [B<-x509_strict>]
  47 [B<-show_chain>]
  48 [B<->]
  49 [certificates]
  50
  51
  52 =head1 DESCRIPTION
  53
  54 The B<verify> command verifies certificate chains.
  55
  56 =head1 COMMAND OPTIONS
  57
  58 =over 4
  59
  60 =item B<-CAfile file>
  61
  62 A file of trusted certificates. The file should contain multiple certificates
  63 in PEM format concatenated together.
  64
  65 =item B<-CApath directory>
  66
  67 A directory of trusted certificates. The certificates should have names
  68 of the form: hash.0 or have symbolic links to them of this
  69 form ("hash" is the hashed certificate subject name: see the B<-hash> option
  70 of the B<x509> utility). Under Unix the B<c_rehash> script will automatically
  71 create symbolic links to a directory of certificates.
  72
  73 =item B<-no-CAfile>
  74
  75 Do not load the trusted CA certificates from the default file location
  76
  77 =item B<-no-CApath>
  78
  79 Do not load the trusted CA certificates from the default directory location
  80
  81 =item B<-attime timestamp>
  82
  83 Perform validation checks using time specified by B<timestamp> and not
  84 current system time. B<timestamp> is the number of seconds since
  85 01.01.1970 (UNIX time).
  86
  87 =item B<-check_ss_sig>
  88
  89 Verify the signature on the self-signed root CA. This is disabled by default
  90 because it doesn't add any security.
  91
  92 =item B<-CRLfile file>
  93
  94 File containing one or more CRL's (in PEM format) to load.
  95
  96 =item B<-crl_download>
  97
  98 Attempt to download CRL information for this certificate.
  99
 100 =item B<-crl_check>
 101
 102 Checks end entity certificate validity by attempting to look up a valid CRL.
 103 If a valid CRL cannot be found an error occurs.
 104
 105 =item B<-crl_check_all>
 106
 107 Checks the validity of B<all> certificates in the chain by attempting
 108 to look up valid CRLs.
 109
 110 =item B<-explicit_policy>
 111
 112 Set policy variable require-explicit-policy (see RFC5280).
 113
 114 =item B<-extended_crl>
 115
 116 Enable extended CRL features such as indirect CRLs and alternate CRL
 117 signing keys.
 118
 119 =item B<-help>
 120
 121 Print out a usage message.
 122
 123 =item B<-ignore_critical>
 124
 125 Normally if an unhandled critical extension is present which is not
 126 supported by OpenSSL the certificate is rejected (as required by RFC5280).
 127 If this option is set critical extensions are ignored.
 128
 129 =item B<-inhibit_any>
 130
 131 Set policy variable inhibit-any-policy (see RFC5280).
 132
 133 =item B<-inhibit_map>
 134
 135 Set policy variable inhibit-policy-mapping (see RFC5280).
 136
 137 =item B<-issuer_checks>
 138
 139 Print out diagnostics relating to searches for the issuer certificate of the
 140 current certificate. This shows why each candidate issuer certificate was
 141 rejected. The presence of rejection messages does not itself imply that
 142 anything is wrong; during the normal verification process, several
 143 rejections may take place.
 144
 145 =item B<-partial_chain>
 146
 147 Allow partial certificate chain if at least one certificate is in trusted store.
 148
 149 =item B<-policy arg>
 150
 151 Enable policy processing and add B<arg> to the user-initial-policy-set (see
 152 RFC5280). The policy B<arg> can be an object name an OID in numeric form.
 153 This argument can appear more than once.
 154
 155 =item B<-policy_check>
 156
 157 Enables certificate policy processing.
 158
 159 =item B<-policy_print>
 160
 161 Print out diagnostics related to policy processing.
 162
 163 =item B<-purpose purpose>
 164
 165 The intended use for the certificate. If this option is not specified,
 166 B<verify> will not consider certificate purpose during chain verification.
 167 Currently accepted uses are B<sslclient>, B<sslserver>, B<nssslserver>,
 168 B<smimesign>, B<smimeencrypt>. See the B<VERIFY OPERATION> section for more
 169 information.
 170
 171 =item B<-suiteB_128_only>, B<-suiteB_128>, B<-suiteB_192>
 172
 173 enable the Suite B mode operation at 128 bit Level of Security, 128 bit or
 174 192 bit, or only 192 bit Level of Security respectively.
 175 See RFC6460 for details. In particular the supported signature algorithms are
 176 reduced to support only ECDSA and SHA256 or SHA384 and only the elliptic curves
 177 P-256 and P-384.
 178
 179 =item B<-trusted_first>
 180
 181 Use certificates in CA file or CA directory before certificates in untrusted
 182 file when building the trust chain to verify certificates.
 183 This is mainly useful in environments with Bridge CA or Cross-Certified CAs.
 184
 185 =item B<-no_alt_chains>
 186
 187 When building a certificate chain, if the first certificate chain found is not
 188 trusted, then OpenSSL will continue to check to see if an alternative chain can
 189 be found that is trusted. With this option that behaviour is suppressed so that
 190 only the first chain found is ever used. Using this option will force the
 191 behaviour to match that of OpenSSL versions prior to 1.1.0.
 192
 193 =item B<-untrusted file>
 194
 195 A file of untrusted certificates. The file should contain one or more
 196 certificates in PEM format.
 197
 198 =item B<-trusted file>
 199
 200 A file of trusted certificates. The file contain one or more
 201 certificates in PEM format.
 202 With this option, no additional (e.g., default) certificate lists
 203 are consulted. That is, the only trusted issuers are those listed
 204 in B<file>.
 205 This option cannot be used with the B<-CAfile> or B<-CApath> options.
 206
 207 =item B<-use_deltas>
 208
 209 Enable support for delta CRLs.
 210
 211 =item B<-verbose>
 212
 213 Print extra information about the operations being performed.
 214
 215 =item B<-verify_depth num>
 216
 217 Limit the maximum depth of the certificate chain to B<num> certificates.
 218
 219 =item B<-verify_email email>
 220
 221 Verify if the B<email> matches the email address in Subject Alternative Name or
 222 the email in the subject Distinguished Name.
 223
 224 =item B<-verify_hostname hostname>
 225
 226 Verify if the B<hostname> matches DNS name in Subject Alternative Name or
 227 Common Name in the subject certificate.
 228
 229 =item B<-verify_ip ip>
 230
 231 Verify if the B<ip> matches the IP address in Subject Alternative Name of
 232 the subject certificate.
 233
 234 =item B<-verify_name name>
 235
 236 Use default verification options like trust model and required certificate
 237 policies identified by B<name>.
 238 Supported usages include: default, pkcs7, smime_sign, ssl_client, ssl_server.
 239
 240 =item B<-x509_strict>
 241
 242 For strict X.509 compliance, disable non-compliant workarounds for broken
 243 certificates.
 244
 245 =item B<-show_chain>
 246
 247 Display information about the certificate chain that has been built (if
 248 successful). Certificates in the chain that came from the untrusted list will be
 249 flagged as "untrusted".
 250
 251 =item B<->
 252
 253 Indicates the last option. All arguments following this are assumed to be
 254 certificate files. This is useful if the first certificate filename begins
 255 with a B<->.
 256
 257 =item B<certificates>
 258
 259 One or more certificates to verify. If no certificates are given, B<verify>
 260 will attempt to read a certificate from standard input. Certificates must be
 261 in PEM format.
 262
 263 =back
 264
 265 =head1 VERIFY OPERATION
 266
 267 The B<verify> program uses the same functions as the internal SSL and S/MIME
 268 verification, therefore this description applies to these verify operations
 269 too.
 270
 271 There is one crucial difference between the verify operations performed
 272 by the B<verify> program: wherever possible an attempt is made to continue
 273 after an error whereas normally the verify operation would halt on the
 274 first error. This allows all the problems with a certificate chain to be
 275 determined.
 276
 277 The verify operation consists of a number of separate steps.
 278
 279 Firstly a certificate chain is built up starting from the supplied certificate
 280 and ending in the root CA. It is an error if the whole chain cannot be built
 281 up. The chain is built up by looking up the issuers certificate of the current
 282 certificate. If a certificate is found which is its own issuer it is assumed
 283 to be the root CA.
 284
 285 The process of 'looking up the issuers certificate' itself involves a number
 286 of steps.
 287 Ater all certificates
 288 whose subject name matches the issuer name of the current certificate are
 289 subject to further tests. The relevant authority key identifier components
 290 of the current certificate (if present) must match the subject key identifier
 291 (if present) and issuer and serial number of the candidate issuer, in addition
 292 the keyUsage extension of the candidate issuer (if present) must permit
 293 certificate signing.
 294
 295 The lookup first looks in the list of untrusted certificates and if no match
 296 is found the remaining lookups are from the trusted certificates. The root CA
 297 is always looked up in the trusted certificate list: if the certificate to
 298 verify is a root certificate then an exact match must be found in the trusted
 299 list.
 300
 301 The second operation is to check every untrusted certificate's extensions for
 302 consistency with the supplied purpose. If the B<-purpose> option is not included
 303 then no checks are done. The supplied or "leaf" certificate must have extensions
 304 compatible with the supplied purpose and all other certificates must also be valid
 305 CA certificates. The precise extensions required are described in more detail in
 306 the B<CERTIFICATE EXTENSIONS> section of the B<x509> utility.
 307
 308 The third operation is to check the trust settings on the root CA. The root
 309 CA should be trusted for the supplied purpose. For compatibility with previous
 310 versions of SSLeay and OpenSSL a certificate with no trust settings is considered
 311 to be valid for all purposes.
 312
 313 The final operation is to check the validity of the certificate chain. The validity
 314 period is checked against the current system time and the notBefore and notAfter
 315 dates in the certificate. The certificate signatures are also checked at this
 316 point.
 317
 318 If all operations complete successfully then certificate is considered valid. If
 319 any operation fails then the certificate is not valid.
 320
 321 =head1 DIAGNOSTICS
 322
 323 When a verify operation fails the output messages can be somewhat cryptic. The
 324 general form of the error message is:
 325
 326  server.pem: /C=AU/ST=Queensland/O=CryptSoft Pty Ltd/CN=Test CA (1024 bit)
 327  error 24 at 1 depth lookup:invalid CA certificate
 328
 329 The first line contains the name of the certificate being verified followed by
 330 the subject name of the certificate. The second line contains the error number
 331 and the depth. The depth is number of the certificate being verified when a
 332 problem was detected starting with zero for the certificate being verified itself
 333 then 1 for the CA that signed the certificate and so on. Finally a text version
 334 of the error number is presented.
 335
 336 An exhaustive list of the error codes and messages is shown below, this also
 337 includes the name of the error code as defined in the header file x509_vfy.h
 338 Some of the error codes are defined but never returned: these are described
 339 as "unused".
 340
 341 =over 4
 342
 343 =item B<0 X509_V_OK: ok>
 344
 345 the operation was successful.
 346
 347 =item B<2 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT: unable to get issuer certificate>
 348
 349 the issuer certificate of a looked up certificate could not be found. This
 350 normally means the list of trusted certificates is not complete.
 351
 352 =item B<3 X509_V_ERR_UNABLE_TO_GET_CRL: unable to get certificate CRL>
 353
 354 the CRL of a certificate could not be found.
 355
 356 =item B<4 X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE: unable to decrypt certificate's signature>
 357
 358 the certificate signature could not be decrypted. This means that the actual signature value
 359 could not be determined rather than it not matching the expected value, this is only
 360 meaningful for RSA keys.
 361
 362 =item B<5 X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE: unable to decrypt CRL's signature>
 363
 364 the CRL signature could not be decrypted: this means that the actual signature value
 365 could not be determined rather than it not matching the expected value. Unused.
 366
 367 =item B<6 X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY: unable to decode issuer public key>
 368
 369 the public key in the certificate SubjectPublicKeyInfo could not be read.
 370
 371 =item B<7 X509_V_ERR_CERT_SIGNATURE_FAILURE: certificate signature failure>
 372
 373 the signature of the certificate is invalid.
 374
 375 =item B<8 X509_V_ERR_CRL_SIGNATURE_FAILURE: CRL signature failure>
 376
 377 the signature of the certificate is invalid.
 378
 379 =item B<9 X509_V_ERR_CERT_NOT_YET_VALID: certificate is not yet valid>
 380
 381 the certificate is not yet valid: the notBefore date is after the current time.
 382
 383 =item B<10 X509_V_ERR_CERT_HAS_EXPIRED: certificate has expired>
 384
 385 the certificate has expired: that is the notAfter date is before the current time.
 386
 387 =item B<11 X509_V_ERR_CRL_NOT_YET_VALID: CRL is not yet valid>
 388
 389 the CRL is not yet valid.
 390
 391 =item B<12 X509_V_ERR_CRL_HAS_EXPIRED: CRL has expired>
 392
 393 the CRL has expired.
 394
 395 =item B<13 X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD: format error in certificate's notBefore field>
 396
 397 the certificate notBefore field contains an invalid time.
 398
 399 =item B<14 X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD: format error in certificate's notAfter field>
 400
 401 the certificate notAfter field contains an invalid time.
 402
 403 =item B<15 X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD: format error in CRL's lastUpdate field>
 404
 405 the CRL lastUpdate field contains an invalid time.
 406
 407 =item B<16 X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD: format error in CRL's nextUpdate field>
 408
 409 the CRL nextUpdate field contains an invalid time.
 410
 411 =item B<17 X509_V_ERR_OUT_OF_MEM: out of memory>
 412
 413 an error occurred trying to allocate memory. This should never happen.
 414
 415 =item B<18 X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT: self signed certificate>
 416
 417 the passed certificate is self signed and the same certificate cannot be found in the list of
 418 trusted certificates.
 419
 420 =item B<19 X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN: self signed certificate in certificate chain>
 421
 422 the certificate chain could be built up using the untrusted certificates but the root could not
 423 be found locally.
 424
 425 =item B<20 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY: unable to get local issuer certificate>
 426
 427 the issuer certificate could not be found: this occurs if the issuer
 428 certificate of an untrusted certificate cannot be found.
 429
 430 =item B<21 X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE: unable to verify the first certificate>
 431
 432 no signatures could be verified because the chain contains only one certificate and it is not
 433 self signed.
 434
 435 =item B<22 X509_V_ERR_CERT_CHAIN_TOO_LONG: certificate chain too long>
 436
 437 the certificate chain length is greater than the supplied maximum depth. Unused.
 438
 439 =item B<23 X509_V_ERR_CERT_REVOKED: certificate revoked>
 440
 441 the certificate has been revoked.
 442
 443 =item B<24 X509_V_ERR_INVALID_CA: invalid CA certificate>
 444
 445 a CA certificate is invalid. Either it is not a CA or its extensions are not consistent
 446 with the supplied purpose.
 447
 448 =item B<25 X509_V_ERR_PATH_LENGTH_EXCEEDED: path length constraint exceeded>
 449
 450 the basicConstraints pathlength parameter has been exceeded.
 451
 452 =item B<26 X509_V_ERR_INVALID_PURPOSE: unsupported certificate purpose>
 453
 454 the supplied certificate cannot be used for the specified purpose.
 455
 456 =item B<27 X509_V_ERR_CERT_UNTRUSTED: certificate not trusted>
 457
 458 the root CA is not marked as trusted for the specified purpose.
 459
 460 =item B<28 X509_V_ERR_CERT_REJECTED: certificate rejected>
 461
 462 the root CA is marked to reject the specified purpose.
 463
 464 =item B<29 X509_V_ERR_SUBJECT_ISSUER_MISMATCH: subject issuer mismatch>
 465
 466 the current candidate issuer certificate was rejected because its subject name
 467 did not match the issuer name of the current certificate. Only displayed when
 468 the B<-issuer_checks> option is set.
 469
 470 =item B<30 X509_V_ERR_AKID_SKID_MISMATCH: authority and subject key identifier mismatch>
 471
 472 the current candidate issuer certificate was rejected because its subject key
 473 identifier was present and did not match the authority key identifier current
 474 certificate. Only displayed when the B<-issuer_checks> option is set.
 475
 476 =item B<31 X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH: authority and issuer serial number mismatch>
 477
 478 the current candidate issuer certificate was rejected because its issuer name
 479 and serial number was present and did not match the authority key identifier
 480 of the current certificate. Only displayed when the B<-issuer_checks> option is set.
 481
 482 =item B<32 X509_V_ERR_KEYUSAGE_NO_CERTSIGN:key usage does not include certificate signing>
 483
 484 the current candidate issuer certificate was rejected because its keyUsage extension
 485 does not permit certificate signing.
 486
 487 =item B<50 X509_V_ERR_APPLICATION_VERIFICATION: application verification failure>
 488
 489 an application specific error. Unused.
 490
 491 =back
 492
 493 =head1 BUGS
 494
 495 Although the issuer checks are a considerable improvement over the old technique they still
 496 suffer from limitations in the underlying X509_LOOKUP API. One consequence of this is that
 497 trusted certificates with matching subject name must either appear in a file (as specified by the
 498 B<-CAfile> option) or a directory (as specified by B<-CApath>). If they occur in both then only
 499 the certificates in the file will be recognised.
 500
 501 Previous versions of OpenSSL assume certificates with matching subject name are identical and
 502 mishandled them.
 503
 504 Previous versions of this documentation swapped the meaning of the
 505 B<X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT> and
 506 B<20 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY> error codes.
 507
 508 =head1 SEE ALSO
 509
 510 L<x509(1)>
 511
 512 =head1 HISTORY
 513
 514 The -show_chain option was first added to OpenSSL 1.1.0.
 515
 516 =cut