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