diff options
| author | David Benjamin <davidben@google.com> | 2021-03-11 14:43:04 -0500 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2021-04-28 11:40:06 +0200 |
| commit | cdf63a3736a91a534bd3bc952b1dc3ef714604dd (patch) | |
| tree | f1c2986418c09bd6a8933d024475ede09f44c687 /doc | |
| parent | d97adfda2868aeb9e62df96216203e8120a95d6d (diff) | |
| download | openssl-cdf63a3736a91a534bd3bc952b1dc3ef714604dd.tar.gz | |
Add X509 version constants.
The X509 version APIs return the numerical values of the version
numbers, which are one off from the names. This is a bit confusing.
Where they don't get it wrong (accidentally making an "X509v4"
certificate), callers tend to try commenting every call site to explain
the mismatch, including in OpenSSL itself.
Define constants for these values, so code can be self-documenting and
callers are nudged towards the right values.
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14549)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/X509_get_version.pod | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/man3/X509_get_version.pod b/doc/man3/X509_get_version.pod index 2137ad174f..9aadcb7f94 100644 --- a/doc/man3/X509_get_version.pod +++ b/doc/man3/X509_get_version.pod @@ -22,16 +22,18 @@ certificate request or CRL version =head1 DESCRIPTION X509_get_version() returns the numerical value of the version field of -certificate B<x>. Note: this is defined by standards (X.509 et al) to be one -less than the certificate version. So a version 3 certificate will return 2 and -a version 1 certificate will return 0. +certificate B<x>. These correspond to the constants B<X509_VERSION_1>, +B<X509_VERSION_2>, and B<X509_VERSION_3>. Note: the values of these constants +are defined by standards (X.509 et al) to be one less than the certificate +version. So B<X509_VERSION_3> has value 2 and B<X509_VERSION_1> has value 0. X509_set_version() sets the numerical value of the version field of certificate B<x> to B<version>. Similarly X509_REQ_get_version(), X509_REQ_set_version(), X509_CRL_get_version() and X509_CRL_set_version() get and set the version -number of certificate requests and CRLs. +number of certificate requests and CRLs. They use constants +B<X509_REQ_VERSION_1>, B<X509_CRL_VERSION_1>, and B<X509_CRL_VERSION_2>. =head1 NOTES |