From 4401e2802e624bbd1dc6cabf425680a3bf203db3 Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Tue, 31 Oct 2017 12:12:58 +0100 Subject: docs: fixup OpenSSL version style Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/4633) --- doc/crypto/BIO_get_data.pod | 2 +- doc/crypto/BIO_meth_new.pod | 2 +- doc/crypto/BIO_push.pod | 2 +- doc/crypto/BIO_should_retry.pod | 2 +- doc/crypto/DH_get0_pqg.pod | 2 +- doc/crypto/DH_meth_new.pod | 2 +- doc/crypto/DSA_get0_pqg.pod | 2 +- doc/crypto/DSA_meth_new.pod | 2 +- doc/crypto/EVP_CIPHER_meth_new.pod | 4 +- doc/crypto/EVP_MD_meth_new.pod | 2 +- doc/crypto/OCSP_response_status.pod | 2 +- doc/crypto/RSA_get0_key.pod | 2 +- doc/crypto/RSA_meth_new.pod | 2 +- doc/crypto/X509_STORE_get0_param.pod | 2 +- doc/crypto/X509_get0_notBefore.pod | 103 +++++++++++++++++++++++++++++++++++ doc/crypto/X509_get_notBefore.pod | 103 ----------------------------------- 16 files changed, 118 insertions(+), 118 deletions(-) create mode 100644 doc/crypto/X509_get0_notBefore.pod delete mode 100644 doc/crypto/X509_get_notBefore.pod (limited to 'doc') diff --git a/doc/crypto/BIO_get_data.pod b/doc/crypto/BIO_get_data.pod index 14f21fa720..c3137c4c55 100644 --- a/doc/crypto/BIO_get_data.pod +++ b/doc/crypto/BIO_get_data.pod @@ -51,7 +51,7 @@ L, L =head1 HISTORY -The functions described here were added in OpenSSL version 1.1.0. +The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/BIO_meth_new.pod b/doc/crypto/BIO_meth_new.pod index 2fe6721660..ec0af8a06e 100644 --- a/doc/crypto/BIO_meth_new.pod +++ b/doc/crypto/BIO_meth_new.pod @@ -117,7 +117,7 @@ L, L, L, L, L =head1 HISTORY -The functions described here were added in OpenSSL version 1.1.0. +The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/BIO_push.pod b/doc/crypto/BIO_push.pod index 762027ff6a..ce56db9836 100644 --- a/doc/crypto/BIO_push.pod +++ b/doc/crypto/BIO_push.pod @@ -75,7 +75,7 @@ L =head1 HISTORY -The BIO_set_next() function was added in OpenSSL version 1.1.0. +The BIO_set_next() function was added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/BIO_should_retry.pod b/doc/crypto/BIO_should_retry.pod index d6ddf48e2c..d01d5bbca1 100644 --- a/doc/crypto/BIO_should_retry.pod +++ b/doc/crypto/BIO_should_retry.pod @@ -118,7 +118,7 @@ L =head1 HISTORY The BIO_get_retry_reason() and BIO_set_retry_reason() functions were added in -OpenSSL version 1.1.0. +OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/DH_get0_pqg.pod b/doc/crypto/DH_get0_pqg.pod index 530f0b28a1..3809813531 100644 --- a/doc/crypto/DH_get0_pqg.pod +++ b/doc/crypto/DH_get0_pqg.pod @@ -96,7 +96,7 @@ L, L, L =head1 HISTORY -The functions described here were added in OpenSSL version 1.1.0. +The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/DH_meth_new.pod b/doc/crypto/DH_meth_new.pod index bcf559215f..d768da8c6e 100644 --- a/doc/crypto/DH_meth_new.pod +++ b/doc/crypto/DH_meth_new.pod @@ -142,7 +142,7 @@ L, L, L =head1 HISTORY -The functions described here were added in OpenSSL version 1.1.0. +The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/DSA_get0_pqg.pod b/doc/crypto/DSA_get0_pqg.pod index e87e42a459..6c1c09a56e 100644 --- a/doc/crypto/DSA_get0_pqg.pod +++ b/doc/crypto/DSA_get0_pqg.pod @@ -88,7 +88,7 @@ L, L, L =head1 HISTORY -The functions described here were added in OpenSSL version 1.1.0. +The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/DSA_meth_new.pod b/doc/crypto/DSA_meth_new.pod index 28d1892371..948ab29b58 100644 --- a/doc/crypto/DSA_meth_new.pod +++ b/doc/crypto/DSA_meth_new.pod @@ -179,7 +179,7 @@ L, L, L =head1 HISTORY -The functions described here were added in OpenSSL version 1.1.0. +The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/EVP_CIPHER_meth_new.pod b/doc/crypto/EVP_CIPHER_meth_new.pod index 6190b71ee6..917fb3edd4 100644 --- a/doc/crypto/EVP_CIPHER_meth_new.pod +++ b/doc/crypto/EVP_CIPHER_meth_new.pod @@ -223,8 +223,8 @@ L =head1 HISTORY The B structure was openly available in OpenSSL before version -1.1. -The functions described here were added in OpenSSL version 1.1. +1.1.0. +The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/EVP_MD_meth_new.pod b/doc/crypto/EVP_MD_meth_new.pod index c15a31e7fc..e0c36cb008 100644 --- a/doc/crypto/EVP_MD_meth_new.pod +++ b/doc/crypto/EVP_MD_meth_new.pod @@ -156,7 +156,7 @@ L, L, L =head1 HISTORY The B structure was openly available in OpenSSL before version -1.1. The functions described here were added in OpenSSL version 1.1. +1.1.0. The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/OCSP_response_status.pod b/doc/crypto/OCSP_response_status.pod index 81946a639b..180ab8d30c 100644 --- a/doc/crypto/OCSP_response_status.pod +++ b/doc/crypto/OCSP_response_status.pod @@ -86,7 +86,7 @@ L =head1 HISTORY The OCSP_RESPID_set_by_name(), OCSP_RESPID_set_by_key() and OCSP_RESPID_match() -functions were added in OpenSSL version 1.1.0a. +functions were added in OpenSSL 1.1.0a. =head1 COPYRIGHT diff --git a/doc/crypto/RSA_get0_key.pod b/doc/crypto/RSA_get0_key.pod index 827c22fa9f..579a2df000 100644 --- a/doc/crypto/RSA_get0_key.pod +++ b/doc/crypto/RSA_get0_key.pod @@ -98,7 +98,7 @@ L, L, L =head1 HISTORY -The functions described here were added in OpenSSL version 1.1.0. +The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/RSA_meth_new.pod b/doc/crypto/RSA_meth_new.pod index e46b3984f6..9970aa6b73 100644 --- a/doc/crypto/RSA_meth_new.pod +++ b/doc/crypto/RSA_meth_new.pod @@ -221,7 +221,7 @@ L, L, L =head1 HISTORY -The functions described here were added in OpenSSL version 1.1.0. +The functions described here were added in OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/X509_STORE_get0_param.pod b/doc/crypto/X509_STORE_get0_param.pod index 2144f2b0ae..0aed725ad6 100644 --- a/doc/crypto/X509_STORE_get0_param.pod +++ b/doc/crypto/X509_STORE_get0_param.pod @@ -43,7 +43,7 @@ L =head1 HISTORY B and B were added in -OpenSSL version 1.1.0. +OpenSSL 1.1.0. =head1 COPYRIGHT diff --git a/doc/crypto/X509_get0_notBefore.pod b/doc/crypto/X509_get0_notBefore.pod new file mode 100644 index 0000000000..82502f6588 --- /dev/null +++ b/doc/crypto/X509_get0_notBefore.pod @@ -0,0 +1,103 @@ +=pod + +=head1 NAME + +X509_get0_notBefore, X509_getm_notBefore, X509_get0_notAfter, +X509_getm_notAfter, X509_set1_notBefore, X509_set1_notAfter, +X509_CRL_get0_lastUpdate, X509_CRL_get0_nextUpdate, X509_CRL_set1_lastUpdate, +X509_CRL_set1_nextUpdate - get or set certificate or CRL dates + +=head1 SYNOPSIS + + #include + + const ASN1_TIME *X509_get0_notBefore(const X509 *x); + const ASN1_TIME *X509_get0_notAfter(const X509 *x); + + ASN1_TIME *X509_getm_notBefore(const X509 *x); + ASN1_TIME *X509_getm_notAfter(const X509 *x); + + int X509_set1_notBefore(X509 *x, const ASN1_TIME *tm); + int X509_set1_notAfter(X509 *x, const ASN1_TIME *tm); + + const ASN1_TIME *X509_CRL_get0_lastUpdate(const X509_CRL *crl); + const ASN1_TIME *X509_CRL_get0_nextUpdate(const X509_CRL *crl); + + int X509_CRL_set1_lastUpdate(X509_CRL *x, const ASN1_TIME *tm); + int X509_CRL_set1_nextUpdate(X509_CRL *x, const ASN1_TIME *tm); + +=head1 DESCRIPTION + +X509_get0_notBefore() and X509_get0_notAfter() return the B +and B fields of certificate B respectively. The value +returned is an internal pointer which must not be freed up after +the call. + +X509_getm_notBefore() and X509_getm_notAfter() are similar to +X509_get0_notBefore() and X509_get0_notAfter() except they return +non-constant mutable references to the associated date field of +the certficate. + +X509_set1_notBefore() and X509_set1_notAfter() set the B +and B fields of B to B. Ownership of the passed +parameter B is not transferred by these functions so it must +be freed up after the call. + +X509_CRL_get0_lastUpdate() and X509_CRL_get0_nextUpdate() return the +B and B fields of B. The value +returned is an internal pointer which must not be freed up after +the call. If the B field is absent from B then +B is returned. + +X509_CRL_set1_lastUpdate() and X509_CRL_set1_nextUpdate() set the B +and B fields of B to B. Ownership of the passed parameter +B is not transferred by these functions so it must be freed up after the +call. + +=head1 RETURN VALUES + +X509_get0_notBefore(), X509_get0_notAfter() and X509_CRL_get0_lastUpdate() +return a pointer to an B structure. + +X509_CRL_get0_lastUpdate() return a pointer to an B structure +or NULL if the B field is absent. + +X509_set1_notBefore(), X509_set1_notAfter(), X509_CRL_set1_lastUpdate() and +X509_CRL_set1_nextUpdate() return 1 for success or 0 for failure. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L + +=head1 HISTORY + +These functions are available in all versions of OpenSSL. + +X509_get_notBefore() and X509_get_notAfter() were deprecated in OpenSSL +1.1.0 + +=head1 COPYRIGHT + +Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/crypto/X509_get_notBefore.pod b/doc/crypto/X509_get_notBefore.pod deleted file mode 100644 index 82502f6588..0000000000 --- a/doc/crypto/X509_get_notBefore.pod +++ /dev/null @@ -1,103 +0,0 @@ -=pod - -=head1 NAME - -X509_get0_notBefore, X509_getm_notBefore, X509_get0_notAfter, -X509_getm_notAfter, X509_set1_notBefore, X509_set1_notAfter, -X509_CRL_get0_lastUpdate, X509_CRL_get0_nextUpdate, X509_CRL_set1_lastUpdate, -X509_CRL_set1_nextUpdate - get or set certificate or CRL dates - -=head1 SYNOPSIS - - #include - - const ASN1_TIME *X509_get0_notBefore(const X509 *x); - const ASN1_TIME *X509_get0_notAfter(const X509 *x); - - ASN1_TIME *X509_getm_notBefore(const X509 *x); - ASN1_TIME *X509_getm_notAfter(const X509 *x); - - int X509_set1_notBefore(X509 *x, const ASN1_TIME *tm); - int X509_set1_notAfter(X509 *x, const ASN1_TIME *tm); - - const ASN1_TIME *X509_CRL_get0_lastUpdate(const X509_CRL *crl); - const ASN1_TIME *X509_CRL_get0_nextUpdate(const X509_CRL *crl); - - int X509_CRL_set1_lastUpdate(X509_CRL *x, const ASN1_TIME *tm); - int X509_CRL_set1_nextUpdate(X509_CRL *x, const ASN1_TIME *tm); - -=head1 DESCRIPTION - -X509_get0_notBefore() and X509_get0_notAfter() return the B -and B fields of certificate B respectively. The value -returned is an internal pointer which must not be freed up after -the call. - -X509_getm_notBefore() and X509_getm_notAfter() are similar to -X509_get0_notBefore() and X509_get0_notAfter() except they return -non-constant mutable references to the associated date field of -the certficate. - -X509_set1_notBefore() and X509_set1_notAfter() set the B -and B fields of B to B. Ownership of the passed -parameter B is not transferred by these functions so it must -be freed up after the call. - -X509_CRL_get0_lastUpdate() and X509_CRL_get0_nextUpdate() return the -B and B fields of B. The value -returned is an internal pointer which must not be freed up after -the call. If the B field is absent from B then -B is returned. - -X509_CRL_set1_lastUpdate() and X509_CRL_set1_nextUpdate() set the B -and B fields of B to B. Ownership of the passed parameter -B is not transferred by these functions so it must be freed up after the -call. - -=head1 RETURN VALUES - -X509_get0_notBefore(), X509_get0_notAfter() and X509_CRL_get0_lastUpdate() -return a pointer to an B structure. - -X509_CRL_get0_lastUpdate() return a pointer to an B structure -or NULL if the B field is absent. - -X509_set1_notBefore(), X509_set1_notAfter(), X509_CRL_set1_lastUpdate() and -X509_CRL_set1_nextUpdate() return 1 for success or 0 for failure. - -=head1 SEE ALSO - -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L, -L - -=head1 HISTORY - -These functions are available in all versions of OpenSSL. - -X509_get_notBefore() and X509_get_notAfter() were deprecated in OpenSSL -1.1.0 - -=head1 COPYRIGHT - -Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the OpenSSL license (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut -- cgit v1.2.3