doc/man1/openssl-verify.pod.in

   1 =pod
   2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
   3
   4 =head1 NAME
   5
   6 openssl-verify - Utility to verify certificates
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<verify>
  11 [B<-help>]
  12 [B<-CRLfile> I<file>]
  13 [B<-crl_download>]
  14 [B<-show_chain>]
  15 [B<-sm2-id> I<hexstring>]
  16 [B<-sm2-hex-id> I<hexstring>]
  17 [B<-verbose>]
  18 [B<-trusted> I<file>]
  19 [B<-untrusted> I<file>]
  20 {- $OpenSSL::safe::opt_name_synopsis -}
  21 {- $OpenSSL::safe::opt_trust_synopsis -}
  22 {- $OpenSSL::safe::opt_engine_synopsis -}
  23 {- $OpenSSL::safe::opt_v_synopsis -}
  24 [B<-->]
  25 [I<certificate> ...]
  26
  27 =for openssl ifdef engine sm2-id sm2-hex-id
  28
  29 =head1 DESCRIPTION
  30
  31 This command verifies certificate chains.
  32
  33 =head1 OPTIONS
  34
  35 =over 4
  36
  37 =item B<-help>
  38
  39 Print out a usage message.
  40
  41 =item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath>
  42
  43 See L<openssl(1)/Trusted Certificate Options> for more information.
  44
  45 =item B<-CRLfile> I<file>
  46
  47 The I<file> should contain one or more CRLs in PEM format.
  48 This option can be specified more than once to include CRLs from multiple
  49 I<file>s.
  50
  51 =item B<-crl_download>
  52
  53 Attempt to download CRL information for this certificate.
  54
  55 =item B<-show_chain>
  56
  57 Display information about the certificate chain that has been built (if
  58 successful). Certificates in the chain that came from the untrusted list will be
  59 flagged as "untrusted".
  60
  61 =item B<-sm2-id> I<hexstring>
  62
  63 Specify the ID string to use when verifying an SM2 certificate. The ID string is
  64 required by the SM2 signature algorithm for signing and verification.
  65
  66 =item B<-sm2-hex-id> I<hexstring>
  67
  68 Specify a binary ID string to use when signing or verifying using an SM2
  69 certificate. The argument for this option is string of hexadecimal digits.
  70
  71 =item B<-verbose>
  72
  73 Print extra information about the operations being performed.
  74
  75 =item B<-trusted> I<file>
  76
  77 A file of trusted certificates.
  78
  79 =item B<-untrusted> I<file>
  80
  81 A file of untrusted certificates.
  82
  83 {- $OpenSSL::safe::opt_name_item -}
  84
  85 {- $OpenSSL::safe::opt_engine_item -}
  86 To load certificates or CRLs that require engine support, specify the
  87 B<-engine> option before any of the
  88 B<-trusted>, B<-untrusted> or B<-CRLfile> options.
  89
  90 {- $OpenSSL::safe::opt_trust_item -}
  91
  92 {- $OpenSSL::safe::opt_v_item -}
  93
  94 =item B<-->
  95
  96 Indicates the last option. All arguments following this are assumed to be
  97 certificate files. This is useful if the first certificate filename begins
  98 with a B<->.
  99
 100 =item I<certificate> ...
 101
 102 One or more certificates to verify. If no certificates are given,
 103 this command will attempt to read a certificate from standard input.
 104 Certificates must be in PEM format.
 105 If a certificate chain has multiple problems, this program tries to
 106 display all of them.
 107
 108 =back
 109
 110 =head1 DIAGNOSTICS
 111
 112 When a verify operation fails the output messages can be somewhat cryptic. The
 113 general form of the error message is:
 114
 115  server.pem: /C=AU/ST=Queensland/O=CryptSoft Pty Ltd/CN=Test CA (1024 bit)
 116  error 24 at 1 depth lookup:invalid CA certificate
 117
 118 The first line contains the name of the certificate being verified followed by
 119 the subject name of the certificate. The second line contains the error number
 120 and the depth. The depth is number of the certificate being verified when a
 121 problem was detected starting with zero for the certificate being verified itself
 122 then 1 for the CA that signed the certificate and so on. Finally a text version
 123 of the error number is presented.
 124
 125 A list of the error codes and messages can be found in
 126 L<X509_STORE_CTX_get_error(3)>; the full list is defined in the header file
 127 F<< <openssl/x509_vfy.h> >>.
 128
 129 This command ignores many errors, in order to allow all the problems with a
 130 certificate chain to be determined.
 131
 132 =head1 BUGS
 133
 134 Although the issuer checks are a considerable improvement over the old
 135 technique they still suffer from limitations in the underlying X509_LOOKUP
 136 API. One consequence of this is that trusted certificates with matching
 137 subject name must either appear in a file (as specified by the B<-CAfile>
 138 option), a directory (as specified by B<-CApath>), or a store (as specified
 139 by B<-CAstore>). If they occur in more than one location then only the
 140 certificates in the file will be recognised.
 141
 142 Previous versions of OpenSSL assume certificates with matching subject
 143 name are identical and mishandled them.
 144
 145 Previous versions of this documentation swapped the meaning of the
 146 B<X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT> and
 147 B<X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY> error codes.
 148
 149 =head1 SEE ALSO
 150
 151 L<openssl(1)>,
 152 L<openssl-x509(1)>,
 153 L<ossl_store-file(7)>
 154
 155 =head1 HISTORY
 156
 157 The B<-show_chain> option was added in OpenSSL 1.1.0.
 158
 159 The B<-sm2-id> and B<-sm2-hex-id> options were added in OpenSSL 3.0.
 160
 161 =head1 COPYRIGHT
 162
 163 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 164
 165 Licensed under the Apache License 2.0 (the "License").  You may not use
 166 this file except in compliance with the License.  You can obtain a copy
 167 in the file LICENSE in the source distribution or at
 168 L<https://www.openssl.org/source/license.html>.
 169
 170 =cut