doc/man1/openssl-verify.pod.in

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