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 -}
  22 {- $OpenSSL::safe::opt_v_synopsis -}
  23 {- $OpenSSL::safe::opt_provider_synopsis -}
  24 [B<-->]
  25 [I<certificate> ...]
  26
  27 =for openssl ifdef engine
  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<-CRLfile> I<file>
  42
  43 The I<file> should contain one or more CRLs in PEM format.
  44 This option can be specified more than once to include CRLs from multiple
  45 I<file>s.
  46
  47 =item B<-crl_download>
  48
  49 Attempt to download CRL information for certificates via their CDP entries.
  50
  51 =item B<-show_chain>
  52
  53 Display information about the certificate chain that has been built (if
  54 successful). Certificates in the chain that came from the untrusted list will be
  55 flagged as "untrusted".
  56
  57 =item B<-verbose>
  58
  59 Print extra information about the operations being performed.
  60
  61 =item B<-trusted> I<file>
  62
  63 A file of trusted certificates in PEM format.
  64 This option can be specified more than once to load certificates from multiple
  65 I<file>s.
  66
  67 =item B<-untrusted> I<file>
  68
  69 A file of untrusted certificates in PEM format to use for chain building.
  70 This option can be specified more than once to load certificates from multiple
  71 I<file>s.
  72
  73
  74 =item B<-vfyopt> I<nm>:I<v>
  75
  76 Pass options to the signature algorithm during verify operations.
  77 Names and values of these options are algorithm-specific.
  78
  79 {- $OpenSSL::safe::opt_name_item -}
  80
  81 {- $OpenSSL::safe::opt_engine_item -}
  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
  86 {- $OpenSSL::safe::opt_trust_item -}
  87
  88 {- $OpenSSL::safe::opt_v_item -}
  89
  90 {- $OpenSSL::safe::opt_provider_item -}
  91
  92 =item B<-->
  93
  94 Indicates the last option. All arguments following this are assumed to be
  95 certificate files. This is useful if the first certificate filename begins
  96 with a B<->.
  97
  98 =item I<certificate> ...
  99
 100 One or more certificates to verify. If no certificates are given,
 101 this command will attempt to read a certificate from standard input.
 102 If a certificate chain has multiple problems, this program tries to
 103 display all of them.
 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 certificate being verified itself
 119 then 1 for the CA that signed the certificate and so on. Finally a text version
 120 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(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 =head1 COPYRIGHT
 157
 158 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 159
 160 Licensed under the Apache License 2.0 (the "License").  You may not use
 161 this file except in compliance with the License.  You can obtain a copy
 162 in the file LICENSE in the source distribution or at
 163 L<https://www.openssl.org/source/license.html>.
 164
 165 =cut