summaryrefslogtreecommitdiffstats
path: root/lib/libcrypto/man
diff options
context:
space:
mode:
authorschwarze <schwarze@openbsd.org>2016-12-10 21:17:09 +0000
committerschwarze <schwarze@openbsd.org>2016-12-10 21:17:09 +0000
commit699bb6074b14f89f0693a46f12ac8800128eb93f (patch)
treef9633d5583cec7defe57a066c8ceb30d966cb303 /lib/libcrypto/man
parentreplace all references to bn(3) with BN_new(3), (diff)
downloadwireguard-openbsd-699bb6074b14f89f0693a46f12ac8800128eb93f.tar.xz
wireguard-openbsd-699bb6074b14f89f0693a46f12ac8800128eb93f.zip
Merge bn(3) into BN_new(3).
OpenSSL removed bn(3) without replacement, but the introductory text does seem helpful, and it is good for a sub-library to have a central page pointing to all other pages and pointed at from all other pages of the sub-library.
Diffstat (limited to 'lib/libcrypto/man')
-rw-r--r--lib/libcrypto/man/BN_new.344
-rw-r--r--lib/libcrypto/man/Makefile3
-rw-r--r--lib/libcrypto/man/bn.370
3 files changed, 41 insertions, 76 deletions
diff --git a/lib/libcrypto/man/BN_new.3 b/lib/libcrypto/man/BN_new.3
index 2a3ce2f453e..04cd1dbc2ef 100644
--- a/lib/libcrypto/man/BN_new.3
+++ b/lib/libcrypto/man/BN_new.3
@@ -1,5 +1,6 @@
-.\" $OpenBSD: BN_new.3,v 1.4 2016/11/20 17:47:18 schwarze Exp $
-.\" OpenSSL 2457c19d Mar 6 08:43:36 2004 +0000
+.\" $OpenBSD: BN_new.3,v 1.5 2016/12/10 21:17:09 schwarze Exp $
+.\" OpenSSL doc/man3/BN_new.pod 2457c19d Mar 6 08:43:36 2004 +0000
+.\" OpenSSL doc/man7/bn.pod 05ea606a May 20 20:52:46 2016 -0400
.\"
.\" This file was written by Ulf Moeller <ulf@openssl.org>.
.\" Copyright (c) 2000, 2004 The OpenSSL Project. All rights reserved.
@@ -48,7 +49,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: November 20 2016 $
+.Dd $Mdocdate: December 10 2016 $
.Dt BN_NEW 3
.Os
.Sh NAME
@@ -81,6 +82,22 @@
.Fa "BIGNUM *a"
.Fc
.Sh DESCRIPTION
+The BN library performs arithmetic operations on integers of arbitrary
+size.
+It was written for use in public key cryptography, such as RSA and
+Diffie-Hellman.
+.Pp
+It uses dynamic memory allocation for storing its data structures.
+That means that there is no limit on the size of the numbers manipulated
+by these functions, but return values must always be checked in case a
+memory allocation error has occurred.
+.Pp
+The basic object in this library is a
+.Vt BIGNUM .
+It is used to hold a single large integer.
+This type should be considered opaque and fields should not be modified
+or accessed directly.
+.Pp
.Fn BN_new
allocates and initializes a
.Vt BIGNUM
@@ -119,7 +136,26 @@ If the allocation fails, it returns
and sets an error code that can be obtained by
.Xr ERR_get_error 3 .
.Sh SEE ALSO
-.Xr bn 3 ,
+.Xr BN_add 3 ,
+.Xr BN_add_word 3 ,
+.Xr BN_BLINDING_new 3 ,
+.Xr BN_bn2bin 3 ,
+.Xr BN_cmp 3 ,
+.Xr BN_copy 3 ,
+.Xr BN_CTX_new 3 ,
+.Xr BN_CTX_start 3 ,
+.Xr bn_dump 3 ,
+.Xr BN_generate_prime 3 ,
+.Xr BN_get0_nist_prime_521 3 ,
+.Xr BN_mod_inverse 3 ,
+.Xr BN_mod_mul_montgomery 3 ,
+.Xr BN_mod_mul_reciprocal 3 ,
+.Xr BN_num_bytes 3 ,
+.Xr BN_rand 3 ,
+.Xr BN_set_bit 3 ,
+.Xr BN_set_negative 3 ,
+.Xr BN_swap 3 ,
+.Xr BN_zero 3 ,
.Xr ERR_get_error 3
.Sh HISTORY
.Fn BN_new ,
diff --git a/lib/libcrypto/man/Makefile b/lib/libcrypto/man/Makefile
index 3878d948e16..e09095dc62d 100644
--- a/lib/libcrypto/man/Makefile
+++ b/lib/libcrypto/man/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.68 2016/12/06 12:54:19 schwarze Exp $
+# $OpenBSD: Makefile,v 1.69 2016/12/10 21:17:09 schwarze Exp $
.include <bsd.own.mk>
@@ -197,7 +197,6 @@ MAN= \
X509_sign.3 \
X509_verify_cert.3 \
X509v3_get_ext_by_NID.3 \
- bn.3 \
bn_dump.3 \
crypto.3 \
d2i_ASN1_OBJECT.3 \
diff --git a/lib/libcrypto/man/bn.3 b/lib/libcrypto/man/bn.3
deleted file mode 100644
index 61ea3ee6fe3..00000000000
--- a/lib/libcrypto/man/bn.3
+++ /dev/null
@@ -1,70 +0,0 @@
-.\" $OpenBSD: bn.3,v 1.4 2016/11/06 15:52:50 jmc Exp $
-.\"
-.Dd $Mdocdate: November 6 2016 $
-.Dt BN 3
-.Os
-.Sh NAME
-.Nm bn
-.Nd multiprecision integer arithmetics
-.Sh SYNOPSIS
-.In openssl/bn.h
-.Sh DESCRIPTION
-This library performs arithmetic operations on integers of arbitrary size.
-It was written for use in public key cryptography, such as RSA and
-Diffie-Hellman.
-.Pp
-It uses dynamic memory allocation for storing its data structures.
-That means that there is no limit on the size of the numbers manipulated
-by these functions, but return values must always be checked in case a
-memory allocation error has occurred.
-.Pp
-The basic object in this library is a
-.Vt BIGNUM .
-It is used to hold a single large integer.
-This type should be considered opaque and fields should not be modified
-or accessed directly.
-.Pp
-The creation of
-.Vt BIGNUM
-objects is described in
-.Xr BN_new 3 ;
-.Xr BN_add 3
-describes most of the arithmetic operations.
-Comparison is described in
-.Xr BN_cmp 3 ;
-.Xr BN_zero 3
-describes certain assignments,
-.Xr BN_rand 3
-the generation of random numbers,
-.Xr BN_generate_prime 3
-deals with prime numbers and
-.Xr BN_set_bit 3
-with bit operations.
-The conversion of
-.Vt BIGNUM Ns s
-to external formats is described in
-.Xr BN_bn2bin 3 .
-.Sh SEE ALSO
-.Xr BN_add 3 ,
-.Xr BN_add_word 3 ,
-.Xr BN_BLINDING_new 3 ,
-.Xr BN_bn2bin 3 ,
-.Xr BN_cmp 3 ,
-.Xr BN_copy 3 ,
-.Xr BN_CTX_new 3 ,
-.Xr BN_CTX_start 3 ,
-.Xr bn_dump 3 ,
-.Xr BN_generate_prime 3 ,
-.Xr BN_mod_inverse 3 ,
-.Xr BN_mod_mul_montgomery 3 ,
-.Xr BN_mod_mul_reciprocal 3 ,
-.Xr BN_new 3 ,
-.Xr BN_num_bytes 3 ,
-.Xr BN_rand 3 ,
-.Xr BN_set_bit 3 ,
-.Xr BN_set_negative 3 ,
-.Xr BN_swap 3 ,
-.Xr BN_zero 3 ,
-.Xr dh 3 ,
-.Xr ERR 3 ,
-.Xr rsa 3