wbrawner/openssl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openssl/doc/apps/verify.pod

517 lines
17 KiB
Text
Raw Normal View History

Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
=pod
=head1 NAME
Correct the title. This also fooled the automatic documentation builder that this was actually the pkcs7 document...
2000-08-15 17:35:10 +00:00
verify - Utility to verify certificates.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
=head1 SYNOPSIS
B<openssl> B<verify>
[B<-CAfile file>]
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
[B<-CApath directory>]
Document -no-CApath and -no-CAfile Add documentation to all the appropriate apps for the new -no-CApath and -no-CAfile options. Reviewed-by: Andy Polyakov <appro@openssl.org>
2015-09-22 18:43:59 +00:00
[B<-no-CAfile>]
[B<-no-CApath>]
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
[B<-attime timestamp>]
add description of missing options to verify man page The options related to policy used for verification, verification of subject names in certificate and certificate chain handling were missing in the verify(1) man page. This fixes this issue.
2014-06-19 12:17:26 +00:00
[B<-check_ss_sig>]
fix various typo's https://github.com/openssl/openssl/pull/176 (CHANGES) https://rt.openssl.org/Ticket/Display.html?id=3545 (objects.txt) https://rt.openssl.org/Ticket/Display.html?id=3796 (verify.pod) Reviewed-by: Tim Hudson <tjh@openssl.org>
2015-05-02 22:42:29 +00:00
[B<-CRLfile file>]
Add documentation for some missing verify options Fills in a couple of verify options that were lacking documentation. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-06-25 11:34:38 +00:00
[B<-crl_download>]
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
[B<-crl_check>]
[B<-crl_check_all>]
[B<-explicit_policy>]
[B<-extended_crl>]
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
[B<-help>]
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
[B<-ignore_critical>]
[B<-inhibit_any>]
[B<-inhibit_map>]
Update verify docs. New option to verify program to print out diagnostics.
2000-09-08 00:53:58 +00:00
[B<-issuer_checks>]
add description of missing options to verify man page The options related to policy used for verification, verification of subject names in certificate and certificate chain handling were missing in the verify(1) man page. This fixes this issue.
2014-06-19 12:17:26 +00:00
[B<-partial_chain>]
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
[B<-policy arg>]
[B<-policy_check>]
[B<-policy_print>]
[B<-purpose purpose>]
add description of missing options to verify man page The options related to policy used for verification, verification of subject names in certificate and certificate chain handling were missing in the verify(1) man page. This fixes this issue.
2014-06-19 12:17:26 +00:00
[B<-suiteB_128>]
[B<-suiteB_128_only>]
[B<-suiteB_192>]
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
[B<-trusted_first>]
Add documentation for the -no_alt_chains option for various apps, as well as the X509_V_FLAG_NO_ALT_CHAINS flag. Reviewed-by: Dr. Stephen Henson <steve@openssl.org>
2015-01-27 11:15:15 +00:00
[B<-no_alt_chains>]
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
[B<-untrusted file>]
Add documentation for some missing verify options Fills in a couple of verify options that were lacking documentation. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-06-25 11:34:38 +00:00
[B<-trusted file>]
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
[B<-use_deltas>]
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
[B<-verbose>]
add description of missing options to verify man page The options related to policy used for verification, verification of subject names in certificate and certificate chain handling were missing in the verify(1) man page. This fixes this issue.
2014-06-19 12:17:26 +00:00
[B<-verify_depth num>]
[B<-verify_email email>]
[B<-verify_hostname hostname>]
[B<-verify_ip ip>]
[B<-verify_name name>]
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
[B<-x509_strict>]
Extend -show_chain option to verify to show more info The -show_chain flag to the verify command line app shows information about the chain that has been built. This commit adds the text "untrusted" against those certificates that have been used from the untrusted list. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-06-25 11:28:28 +00:00
[B<-show_chain>]
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
[B<->]
[certificates]
=head1 DESCRIPTION
The B<verify> command verifies certificate chains.
=head1 COMMAND OPTIONS
=over 4
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-CAfile file>
A file of trusted certificates. The file should contain multiple certificates
in PEM format concatenated together.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
=item B<-CApath directory>
A directory of trusted certificates. The certificates should have names
of the form: hash.0 or have symbolic links to them of this
form ("hash" is the hashed certificate subject name: see the B<-hash> option
of the B<x509> utility). Under Unix the B<c_rehash> script will automatically
create symbolic links to a directory of certificates.
Document -no-CApath and -no-CAfile Add documentation to all the appropriate apps for the new -no-CApath and -no-CAfile options. Reviewed-by: Andy Polyakov <appro@openssl.org>
2015-09-22 18:43:59 +00:00
=item B<-no-CAfile>
Do not load the trusted CA certificates from the default file location
=item B<-no-CApath>
Do not load the trusted CA certificates from the default directory location
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-attime timestamp>
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
Perform validation checks using time specified by B<timestamp> and not
current system time. B<timestamp> is the number of seconds since
01.01.1970 (UNIX time).
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-check_ss_sig>
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
Verify the signature on the self-signed root CA. This is disabled by default
because it doesn't add any security.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
fix various typo's https://github.com/openssl/openssl/pull/176 (CHANGES) https://rt.openssl.org/Ticket/Display.html?id=3545 (objects.txt) https://rt.openssl.org/Ticket/Display.html?id=3796 (verify.pod) Reviewed-by: Tim Hudson <tjh@openssl.org>
2015-05-02 22:42:29 +00:00
=item B<-CRLfile file>
Close a whole bunch of documentation-related tickets: 298 424 656 882 939 1630 1807 2263 2294 2311 2424 2623 2637 2686 2697 2921 2922 2940 3055 3112 3156 3177 3277
2014-07-03 02:42:40 +00:00
File containing one or more CRL's (in PEM format) to load.
Add documentation for some missing verify options Fills in a couple of verify options that were lacking documentation. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-06-25 11:34:38 +00:00
=item B<-crl_download>
Attempt to download CRL information for this certificate.
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-crl_check>
Document -trusted_first option in man pages and help. Add -trusted_first description to help messages and man pages of tools that deal with certificate verification.
2014-06-18 17:55:03 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
Checks end entity certificate validity by attempting to look up a valid CRL.
If a valid CRL cannot be found an error occurs.
Document -trusted_first option in man pages and help. Add -trusted_first description to help messages and man pages of tools that deal with certificate verification.
2014-06-18 17:55:03 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-crl_check_all>
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
Checks the validity of B<all> certificates in the chain by attempting
to look up valid CRLs.
=item B<-explicit_policy>
Set policy variable require-explicit-policy (see RFC5280).
=item B<-extended_crl>
Enable extended CRL features such as indirect CRLs and alternate CRL
signing keys.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
=item B<-help>
Documentation improvements by Chris Palmer (Google).
2012-12-14 13:28:49 +00:00
Print out a usage message.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-ignore_critical>
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
Normally if an unhandled critical extension is present which is not
supported by OpenSSL the certificate is rejected (as required by RFC5280).
If this option is set critical extensions are ignored.
=item B<-inhibit_any>
Set policy variable inhibit-any-policy (see RFC5280).
=item B<-inhibit_map>
Set policy variable inhibit-policy-mapping (see RFC5280).
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
Update verify docs. New option to verify program to print out diagnostics.
2000-09-08 00:53:58 +00:00
=item B<-issuer_checks>
Documentation improvements by Chris Palmer (Google).
2012-12-14 13:28:49 +00:00
Print out diagnostics relating to searches for the issuer certificate of the
current certificate. This shows why each candidate issuer certificate was
rejected. The presence of rejection messages does not itself imply that
anything is wrong; during the normal verification process, several
rejections may take place.
Update verify docs. New option to verify program to print out diagnostics.
2000-09-08 00:53:58 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-partial_chain>
add description of -attime to man page the verify app man page didn't describe the usage of attime option even though it was listed as a valid option in the -help message. This patch fixes this omission.
2013-09-12 09:37:12 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
Allow partial certificate chain if at least one certificate is in trusted store.
add description of -attime to man page the verify app man page didn't describe the usage of attime option even though it was listed as a valid option in the -help message. This patch fixes this omission.
2013-09-12 09:37:12 +00:00
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
=item B<-policy arg>
Documentation improvements by Chris Palmer (Google).
2012-12-14 13:28:49 +00:00
Enable policy processing and add B<arg> to the user-initial-policy-set (see
RFC5280). The policy B<arg> can be an object name an OID in numeric form.
This argument can appear more than once.
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
=item B<-policy_check>
Enables certificate policy processing.
=item B<-policy_print>
Documentation improvements by Chris Palmer (Google).
2012-12-14 13:28:49 +00:00
Print out diagnostics related to policy processing.
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-purpose purpose>
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
The intended use for the certificate. If this option is not specified,
B<verify> will not consider certificate purpose during chain verification.
Currently accepted uses are B<sslclient>, B<sslserver>, B<nssslserver>,
B<smimesign>, B<smimeencrypt>. See the B<VERIFY OPERATION> section for more
information.
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-suiteB_128_only>, B<-suiteB_128>, B<-suiteB_192>
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
enable the Suite B mode operation at 128 bit Level of Security, 128 bit or
192 bit, or only 192 bit Level of Security respectively.
See RFC6460 for details. In particular the supported signature algorithms are
reduced to support only ECDSA and SHA256 or SHA384 and only the elliptic curves
P-256 and P-384.
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-trusted_first>
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
Use certificates in CA file or CA directory before certificates in untrusted
file when building the trust chain to verify certificates.
This is mainly useful in environments with Bridge CA or Cross-Certified CAs.
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
Add documentation for the -no_alt_chains option for various apps, as well as the X509_V_FLAG_NO_ALT_CHAINS flag. Reviewed-by: Dr. Stephen Henson <steve@openssl.org>
2015-01-27 11:15:15 +00:00
=item B<-no_alt_chains>
When building a certificate chain, if the first certificate chain found is not
trusted, then OpenSSL will continue to check to see if an alternative chain can
be found that is trusted. With this option that behaviour is suppressed so that
only the first chain found is ever used. Using this option will force the
behaviour to match that of OpenSSL versions prior to 1.1.0.
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-untrusted file>
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
Can't use -trusted with -CA{path,file} Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
2015-07-09 18:54:13 +00:00
A file of untrusted certificates. The file should contain one or more
certificates in PEM format.
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
Add documentation for some missing verify options Fills in a couple of verify options that were lacking documentation. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-06-25 11:34:38 +00:00
=item B<-trusted file>
Can't use -trusted with -CA{path,file} Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
2015-07-09 18:54:13 +00:00
A file of trusted certificates. The file contain one or more
certificates in PEM format.
With this option, no additional (e.g., default) certificate lists
are consulted. That is, the only trusted issuers are those listed
in B<file>.
This option cannot be used with the B<-CAfile> or B<-CApath> options.
Add documentation for some missing verify options Fills in a couple of verify options that were lacking documentation. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-06-25 11:34:38 +00:00
Updates from 1.0.0-stable.
2009-04-15 15:27:03 +00:00
=item B<-use_deltas>
Enable support for delta CRLs.
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-verbose>
add description of missing options to verify man page The options related to policy used for verification, verification of subject names in certificate and certificate chain handling were missing in the verify(1) man page. This fixes this issue.
2014-06-19 12:17:26 +00:00
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
Print extra information about the operations being performed.
add description of missing options to verify man page The options related to policy used for verification, verification of subject names in certificate and certificate chain handling were missing in the verify(1) man page. This fixes this issue.
2014-06-19 12:17:26 +00:00
=item B<-verify_depth num>
Limit the maximum depth of the certificate chain to B<num> certificates.
=item B<-verify_email email>
Verify if the B<email> matches the email address in Subject Alternative Name or
Fix minor typos
2014-06-19 22:45:21 +00:00
the email in the subject Distinguished Name.
add description of missing options to verify man page The options related to policy used for verification, verification of subject names in certificate and certificate chain handling were missing in the verify(1) man page. This fixes this issue.
2014-06-19 12:17:26 +00:00
=item B<-verify_hostname hostname>
Verify if the B<hostname> matches DNS name in Subject Alternative Name or
Common Name in the subject certificate.
=item B<-verify_ip ip>
Verify if the B<ip> matches the IP address in Subject Alternative Name of
the subject certificate.
=item B<-verify_name name>
Use default verification options like trust model and required certificate
policies identified by B<name>.
Supported usages include: default, pkcs7, smime_sign, ssl_client, ssl_server.
sort the options in verify man page alphabetically just making sure the options are listed in the alphabetical order both in SYNOPSIS and DESCRIPTION, no text changes
2014-06-19 12:32:53 +00:00
=item B<-x509_strict>
For strict X.509 compliance, disable non-compliant workarounds for broken
certificates.
Extend -show_chain option to verify to show more info The -show_chain flag to the verify command line app shows information about the chain that has been built. This commit adds the text "untrusted" against those certificates that have been used from the untrusted list. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-06-25 11:28:28 +00:00
=item B<-show_chain>
Display information about the certificate chain that has been built (if
successful). Certificates in the chain that came from the untrusted list will be
flagged as "untrusted".
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
=item B<->
Documentation improvements by Chris Palmer (Google).
2012-12-14 13:28:49 +00:00
Indicates the last option. All arguments following this are assumed to be
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
certificate files. This is useful if the first certificate filename begins
with a B<->.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
=item B<certificates>
Documentation improvements by Chris Palmer (Google).
2012-12-14 13:28:49 +00:00
One or more certificates to verify. If no certificates are given, B<verify>
will attempt to read a certificate from standard input. Certificates must be
in PEM format.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
=back
=head1 VERIFY OPERATION
The B<verify> program uses the same functions as the internal SSL and S/MIME
verification, therefore this description applies to these verify operations
too.
There is one crucial difference between the verify operations performed
by the B<verify> program: wherever possible an attempt is made to continue
after an error whereas normally the verify operation would halt on the
first error. This allows all the problems with a certificate chain to be
determined.
The verify operation consists of a number of separate steps.
Firstly a certificate chain is built up starting from the supplied certificate
and ending in the root CA. It is an error if the whole chain cannot be built
Update verify docs. New option to verify program to print out diagnostics.
2000-09-08 00:53:58 +00:00
up. The chain is built up by looking up the issuers certificate of the current
certificate. If a certificate is found which is its own issuer it is assumed
to be the root CA.
The process of 'looking up the issuers certificate' itself involves a number
Remove SSLeay history, etc., from docs If something was "present in all versions" of SSLeay, or if it was added to a version of SSLeay (and therefore predates OpenSSL), remove mention of it. Documentation history now starts with OpenSSL. Remove mention of all history before OpenSSL 0.9.8, inclusive. Remove all AUTHOR sections. Reviewed-by: Tim Hudson <tjh@openssl.org>
2015-10-27 17:40:11 +00:00
of steps.
Ater all certificates
Update verify docs. New option to verify program to print out diagnostics.
2000-09-08 00:53:58 +00:00
whose subject name matches the issuer name of the current certificate are
subject to further tests. The relevant authority key identifier components
of the current certificate (if present) must match the subject key identifier
(if present) and issuer and serial number of the candidate issuer, in addition
the keyUsage extension of the candidate issuer (if present) must permit
certificate signing.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
The lookup first looks in the list of untrusted certificates and if no match
Add some newlines needed for pod2man, and run ispell. Submitted by: Reviewed by: PR:
2000-01-07 01:39:59 +00:00
is found the remaining lookups are from the trusted certificates. The root CA
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
is always looked up in the trusted certificate list: if the certificate to
verify is a root certificate then an exact match must be found in the trusted
list.
The second operation is to check every untrusted certificate's extensions for
consistency with the supplied purpose. If the B<-purpose> option is not included
then no checks are done. The supplied or "leaf" certificate must have extensions
compatible with the supplied purpose and all other certificates must also be valid
CA certificates. The precise extensions required are described in more detail in
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
the B<CERTIFICATE EXTENSIONS> section of the B<x509> utility.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
The third operation is to check the trust settings on the root CA. The root
Add some newlines needed for pod2man, and run ispell. Submitted by: Reviewed by: PR:
2000-01-07 01:39:59 +00:00
CA should be trusted for the supplied purpose. For compatibility with previous
Replace "SSLeay" in API with OpenSSL All instances of SSLeay (any combination of case) were replaced with the case-equivalent OpenSSL. Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-10-27 19:11:48 +00:00
versions of OpenSSL, a certificate with no trust settings is considered
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
to be valid for all purposes.
The final operation is to check the validity of the certificate chain. The validity
period is checked against the current system time and the notBefore and notAfter
dates in the certificate. The certificate signatures are also checked at this
point.
If all operations complete successfully then certificate is considered valid. If
any operation fails then the certificate is not valid.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=head1 DIAGNOSTICS
When a verify operation fails the output messages can be somewhat cryptic. The
general form of the error message is:
server.pem: /C=AU/ST=Queensland/O=CryptSoft Pty Ltd/CN=Test CA (1024 bit)
error 24 at 1 depth lookup:invalid CA certificate
The first line contains the name of the certificate being verified followed by
the subject name of the certificate. The second line contains the error number
and the depth. The depth is number of the certificate being verified when a
problem was detected starting with zero for the certificate being verified itself
then 1 for the CA that signed the certificate and so on. Finally a text version
of the error number is presented.
An exhaustive list of the error codes and messages is shown below, this also
includes the name of the error code as defined in the header file x509_vfy.h
Some of the error codes are defined but never returned: these are described
as "unused".
=over 4
=item B<0 X509_V_OK: ok>
the operation was successful.
=item B<2 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT: unable to get issuer certificate>
The meaning of the X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY and X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT error codes were reversed in the verify application documentation.
2010-02-23 14:09:09 +00:00
the issuer certificate of a looked up certificate could not be found. This
normally means the list of trusted certificates is not complete.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
Add missing colon in manpage Submitted by: Richard Hartmann <richih.mailinglist@gmail.com>
2008-01-30 08:26:59 +00:00
=item B<3 X509_V_ERR_UNABLE_TO_GET_CRL: unable to get certificate CRL>
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
X509 verification fixes. Ignore self issued certificates when checking path length constraints. Duplicate OIDs in policy tree in case they are allocated. Use anyPolicy from certificate cache and not current tree level.
2008-07-13 14:25:36 +00:00
the CRL of a certificate could not be found.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<4 X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE: unable to decrypt certificate's signature>
the certificate signature could not be decrypted. This means that the actual signature value
could not be determined rather than it not matching the expected value, this is only
meaningful for RSA keys.
Add some newlines needed for pod2man, and run ispell. Submitted by: Reviewed by: PR:
2000-01-07 01:39:59 +00:00
=item B<5 X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE: unable to decrypt CRL's signature>
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
the CRL signature could not be decrypted: this means that the actual signature value
could not be determined rather than it not matching the expected value. Unused.
=item B<6 X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY: unable to decode issuer public key>
the public key in the certificate SubjectPublicKeyInfo could not be read.
=item B<7 X509_V_ERR_CERT_SIGNATURE_FAILURE: certificate signature failure>
the signature of the certificate is invalid.
=item B<8 X509_V_ERR_CRL_SIGNATURE_FAILURE: CRL signature failure>
X509 verification fixes. Ignore self issued certificates when checking path length constraints. Duplicate OIDs in policy tree in case they are allocated. Use anyPolicy from certificate cache and not current tree level.
2008-07-13 14:25:36 +00:00
the signature of the certificate is invalid.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<9 X509_V_ERR_CERT_NOT_YET_VALID: certificate is not yet valid>
the certificate is not yet valid: the notBefore date is after the current time.
Small documentation fixes (Howard Lum <howard@pumpkin.canada.sun.com>)
2001-10-08 08:37:24 +00:00
=item B<10 X509_V_ERR_CERT_HAS_EXPIRED: certificate has expired>
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
Small documentation fixes (Howard Lum <howard@pumpkin.canada.sun.com>)
2001-10-08 08:37:24 +00:00
the certificate has expired: that is the notAfter date is before the current time.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
Small documentation fixes (Howard Lum <howard@pumpkin.canada.sun.com>)
2001-10-08 08:37:24 +00:00
=item B<11 X509_V_ERR_CRL_NOT_YET_VALID: CRL is not yet valid>
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
X509 verification fixes. Ignore self issued certificates when checking path length constraints. Duplicate OIDs in policy tree in case they are allocated. Use anyPolicy from certificate cache and not current tree level.
2008-07-13 14:25:36 +00:00
the CRL is not yet valid.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<12 X509_V_ERR_CRL_HAS_EXPIRED: CRL has expired>
X509 verification fixes. Ignore self issued certificates when checking path length constraints. Duplicate OIDs in policy tree in case they are allocated. Use anyPolicy from certificate cache and not current tree level.
2008-07-13 14:25:36 +00:00
the CRL has expired.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<13 X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD: format error in certificate's notBefore field>
the certificate notBefore field contains an invalid time.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<14 X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD: format error in certificate's notAfter field>
the certificate notAfter field contains an invalid time.
=item B<15 X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD: format error in CRL's lastUpdate field>
X509 verification fixes. Ignore self issued certificates when checking path length constraints. Duplicate OIDs in policy tree in case they are allocated. Use anyPolicy from certificate cache and not current tree level.
2008-07-13 14:25:36 +00:00
the CRL lastUpdate field contains an invalid time.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<16 X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD: format error in CRL's nextUpdate field>
X509 verification fixes. Ignore self issued certificates when checking path length constraints. Duplicate OIDs in policy tree in case they are allocated. Use anyPolicy from certificate cache and not current tree level.
2008-07-13 14:25:36 +00:00
the CRL nextUpdate field contains an invalid time.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<17 X509_V_ERR_OUT_OF_MEM: out of memory>
Add some newlines needed for pod2man, and run ispell. Submitted by: Reviewed by: PR:
2000-01-07 01:39:59 +00:00
an error occurred trying to allocate memory. This should never happen.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<18 X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT: self signed certificate>
the passed certificate is self signed and the same certificate cannot be found in the list of
trusted certificates.
=item B<19 X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN: self signed certificate in certificate chain>
the certificate chain could be built up using the untrusted certificates but the root could not
be found locally.
=item B<20 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY: unable to get local issuer certificate>
The meaning of the X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY and X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT error codes were reversed in the verify application documentation.
2010-02-23 14:09:09 +00:00
the issuer certificate could not be found: this occurs if the issuer
certificate of an untrusted certificate cannot be found.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<21 X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE: unable to verify the first certificate>
no signatures could be verified because the chain contains only one certificate and it is not
self signed.
=item B<22 X509_V_ERR_CERT_CHAIN_TOO_LONG: certificate chain too long>
the certificate chain length is greater than the supplied maximum depth. Unused.
=item B<23 X509_V_ERR_CERT_REVOKED: certificate revoked>
X509 verification fixes. Ignore self issued certificates when checking path length constraints. Duplicate OIDs in policy tree in case they are allocated. Use anyPolicy from certificate cache and not current tree level.
2008-07-13 14:25:36 +00:00
the certificate has been revoked.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<24 X509_V_ERR_INVALID_CA: invalid CA certificate>
a CA certificate is invalid. Either it is not a CA or its extensions are not consistent
with the supplied purpose.
=item B<25 X509_V_ERR_PATH_LENGTH_EXCEEDED: path length constraint exceeded>
the basicConstraints pathlength parameter has been exceeded.
=item B<26 X509_V_ERR_INVALID_PURPOSE: unsupported certificate purpose>
the supplied certificate cannot be used for the specified purpose.
=item B<27 X509_V_ERR_CERT_UNTRUSTED: certificate not trusted>
the root CA is not marked as trusted for the specified purpose.
=item B<28 X509_V_ERR_CERT_REJECTED: certificate rejected>
the root CA is marked to reject the specified purpose.
Update verify docs. New option to verify program to print out diagnostics.
2000-09-08 00:53:58 +00:00
=item B<29 X509_V_ERR_SUBJECT_ISSUER_MISMATCH: subject issuer mismatch>
the current candidate issuer certificate was rejected because its subject name
did not match the issuer name of the current certificate. Only displayed when
the B<-issuer_checks> option is set.
=item B<30 X509_V_ERR_AKID_SKID_MISMATCH: authority and subject key identifier mismatch>
the current candidate issuer certificate was rejected because its subject key
identifier was present and did not match the authority key identifier current
certificate. Only displayed when the B<-issuer_checks> option is set.
=item B<31 X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH: authority and issuer serial number mismatch>
the current candidate issuer certificate was rejected because its issuer name
and serial number was present and did not match the authority key identifier
of the current certificate. Only displayed when the B<-issuer_checks> option is set.
=item B<32 X509_V_ERR_KEYUSAGE_NO_CERTSIGN:key usage does not include certificate signing>
the current candidate issuer certificate was rejected because its keyUsage extension
does not permit certificate signing.
Document all possible errors (and some impossible) from the verify program.
1999-11-30 02:28:42 +00:00
=item B<50 X509_V_ERR_APPLICATION_VERIFICATION: application verification failure>
an application specific error. Unused.
=back
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
Update verify docs. New option to verify program to print out diagnostics.
2000-09-08 00:53:58 +00:00
=head1 BUGS
Fix grammar error in verify pod. PR#3355
2014-05-14 21:49:30 +00:00
Although the issuer checks are a considerable improvement over the old technique they still
Update verify docs. New option to verify program to print out diagnostics.
2000-09-08 00:53:58 +00:00
suffer from limitations in the underlying X509_LOOKUP API. One consequence of this is that
trusted certificates with matching subject name must either appear in a file (as specified by the
Fix minor typos
2014-06-19 22:45:21 +00:00
B<-CAfile> option) or a directory (as specified by B<-CApath>). If they occur in both then only
Update verify docs. New option to verify program to print out diagnostics.
2000-09-08 00:53:58 +00:00
the certificates in the file will be recognised.
Previous versions of OpenSSL assume certificates with matching subject name are identical and
mishandled them.
The meaning of the X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY and X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT error codes were reversed in the verify application documentation.
2010-02-23 14:09:09 +00:00
Previous versions of this documentation swapped the meaning of the
B<X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT> and
B<20 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY> error codes.
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
=head1 SEE ALSO
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-17 19:21:33 +00:00
L<x509(1)>
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
Add documentation for the -no_alt_chains option for various apps, as well as the X509_V_FLAG_NO_ALT_CHAINS flag. Reviewed-by: Dr. Stephen Henson <steve@openssl.org>
2015-01-27 11:15:15 +00:00
=head1 HISTORY
Extend -show_chain option to verify to show more info The -show_chain flag to the verify command line app shows information about the chain that has been built. This commit adds the text "untrusted" against those certificates that have been used from the untrusted list. Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-06-25 11:28:28 +00:00
The -show_chain option was first added to OpenSSL 1.1.0.
Add documentation for the -no_alt_chains option for various apps, as well as the X509_V_FLAG_NO_ALT_CHAINS flag. Reviewed-by: Dr. Stephen Henson <steve@openssl.org>
2015-01-27 11:15:15 +00:00
Add part of chain verify SSL support code: not complete or doing anything yet. Add a function X509_STORE_CTX_purpose_inherit() which implements the logic of "inheriting" purpose and trust from a parent structure and using a default: this will be used in the SSL code and possibly future S/MIME. Partial documentation of the 'verify' utility. Still need to document how all the extension checking works and the various error messages.
1999-11-29 01:09:25 +00:00
=cut
Reference in a new issue Copy permalink