Remove get_rfc*_prime_* documentation
authortb <tb@openbsd.org>
Thu, 20 Jul 2023 09:38:45 +0000 (09:38 +0000)
committertb <tb@openbsd.org>
Thu, 20 Jul 2023 09:38:45 +0000 (09:38 +0000)
Their BN_get_rfc*_prime_* aliases from the OpenSSL 1.1 API will remain.
Perhaps the manual should be moved to BN_get_rfc3526_prime_8192.3; that
can be done in a second step.

lib/libcrypto/man/BN_new.3
lib/libcrypto/man/get_rfc3526_prime_8192.3

index 3a3e983..df519c5 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: BN_new.3,v 1.28 2023/07/09 06:45:03 tb Exp $
+.\" $OpenBSD: BN_new.3,v 1.29 2023/07/20 09:38:45 tb Exp $
 .\" full merge up to: OpenSSL man3/BN_new 2457c19d Mar 6 08:43:36 2004 +0000
 .\" selective merge up to: man3/BN_new 681acb31 Sep 29 13:10:34 2017 +0200
 .\" full merge up to: OpenSSL man7/bn 05ea606a May 20 20:52:46 2016 -0400
@@ -50,7 +50,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: July 9 2023 $
+.Dd $Mdocdate: July 20 2023 $
 .Dt BN_NEW 3
 .Os
 .Sh NAME
@@ -155,7 +155,7 @@ and sets an error code that can be obtained by
 .Xr BN_swap 3 ,
 .Xr BN_zero 3 ,
 .Xr crypto 3 ,
-.Xr get_rfc3526_prime_8192 3
+.Xr BN_get_rfc3526_prime_8192 3
 .Sh HISTORY
 .Fn BN_new ,
 .Fn BN_clear ,
index 5ab9571..3543287 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: get_rfc3526_prime_8192.3,v 1.7 2023/04/02 23:33:42 tb Exp $
+.\" $OpenBSD: get_rfc3526_prime_8192.3,v 1.8 2023/07/20 09:38:45 tb Exp $
 .\" checked up to: OpenSSL DH_get_1024_160 99d63d46 Oct 26 13:56:48 2016 -0400
 .\"
 .\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: April 2 2023 $
+.Dd $Mdocdate: July 20 2023 $
 .Dt GET_RFC3526_PRIME_8192 3
 .Os
 .Sh NAME
-.Nm get_rfc2409_prime_768 ,
-.Nm get_rfc2409_prime_1024 ,
-.Nm get_rfc3526_prime_1536 ,
-.Nm get_rfc3526_prime_2048 ,
-.Nm get_rfc3526_prime_3072 ,
-.Nm get_rfc3526_prime_4096 ,
-.Nm get_rfc3526_prime_6144 ,
-.Nm get_rfc3526_prime_8192 ,
 .Nm BN_get_rfc2409_prime_768 ,
 .Nm BN_get_rfc2409_prime_1024 ,
 .Nm BN_get_rfc3526_prime_1536 ,
 .Sh SYNOPSIS
 .In openssl/bn.h
 .Ft BIGNUM *
-.Fn get_rfc2409_prime_768 "BIGNUM *bn"
-.Ft BIGNUM *
-.Fn get_rfc2409_prime_1024 "BIGNUM *bn"
-.Ft BIGNUM *
-.Fn get_rfc3526_prime_1536 "BIGNUM *bn"
-.Ft BIGNUM *
-.Fn get_rfc3526_prime_2048 "BIGNUM *bn"
-.Ft BIGNUM *
-.Fn get_rfc3526_prime_3072 "BIGNUM *bn"
-.Ft BIGNUM *
-.Fn get_rfc3526_prime_4096 "BIGNUM *bn"
-.Ft BIGNUM *
-.Fn get_rfc3526_prime_6144 "BIGNUM *bn"
-.Ft BIGNUM *
-.Fn get_rfc3526_prime_8192 "BIGNUM *bn"
-.Ft BIGNUM *
 .Fn BN_get_rfc2409_prime_768 "BIGNUM *bn"
 .Ft BIGNUM *
 .Fn BN_get_rfc2409_prime_1024 "BIGNUM *bn"
@@ -74,9 +50,6 @@
 Each of these functions returns one specific constant Sophie Germain
 prime number
 .Fa p .
-The names with the prefix
-.Sq BN_
-are aliases for the names without that prefix.
 .Pp
 If
 .Fa bn
@@ -153,22 +126,23 @@ information about these numbers.
 RFC 3526, "More Modular Exponential (MODP) Diffie-Hellman groups
 for Internet Key Exchange (IKE)", defines the other six numbers.
 .Sh HISTORY
-.Fn get_rfc2409_prime_768 ,
-.Fn get_rfc2409_prime_1024 ,
-.Fn get_rfc3526_prime_1536 ,
-.Fn get_rfc3526_prime_2048 ,
-.Fn get_rfc3526_prime_3072 ,
-.Fn get_rfc3526_prime_4096 ,
-.Fn get_rfc3526_prime_6144 ,
+.Fn BN_get_rfc2409_prime_768 ,
+.Fn BN_get_rfc2409_prime_1024 ,
+.Fn BN_get_rfc3526_prime_1536 ,
+.Fn BN_get_rfc3526_prime_2048 ,
+.Fn BN_get_rfc3526_prime_3072 ,
+.Fn BN_get_rfc3526_prime_4096 ,
+.Fn BN_get_rfc3526_prime_6144 ,
 and
-.Fn get_rfc3526_prime_8192
-first appeared in OpenSSL 0.9.8a and have been available since
-.Ox 4.5 .
-.Pp
-The
-.Sy BN_
-aliases first appeared in OpenSSL 1.1.0 and have been available since
+.Fn BN_get_rfc3526_prime_8192
+first appeared in OpenSSL 1.1.0 and have been available since
 .Ox 6.3 .
+The same functions without
+.Sy BN_
+prefix first appeared in OpenSSL 0.9.8a and
+.Ox 4.5 ;
+they were removed in
+.Ox 7.4 .
 .Sh CAVEATS
 As all the memory needed for storing the numbers is dynamically
 allocated, the