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