From 9cb1a51933a1847042ee88e16d560485f682bcad Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Mon, 23 Feb 2015 17:43:24 +0000 Subject: fourth batch of perlpod(1) to mdoc(7) conversion --- src/lib/libcrypto/man/BN_new.3 | 84 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 src/lib/libcrypto/man/BN_new.3 (limited to 'src/lib/libcrypto/man/BN_new.3') diff --git a/src/lib/libcrypto/man/BN_new.3 b/src/lib/libcrypto/man/BN_new.3 new file mode 100644 index 0000000000..ad8ce886d9 --- /dev/null +++ b/src/lib/libcrypto/man/BN_new.3 @@ -0,0 +1,84 @@ +.Dd $Mdocdate: February 23 2015 $ +.Dt BN_NEW 3 +.Os +.Sh NAME +.Nm BN_new , +.Nm BN_init , +.Nm BN_clear , +.Nm BN_free , +.Nm BN_clear_free +.Nd allocate and free BIGNUMs +.Sh SYNOPSIS +.In openssl/bn.h +.Ft BIGNUM * +.Fo BN_new +.Fa void +.Fc +.Ft void +.Fo BN_init +.Fa "BIGNUM *" +.Fc +.Ft void +.Fo BN_clear +.Fa "BIGNUM *a" +.Fc +.Ft void +.Fo BN_free +.Fa "BIGNUM *a" +.Fc +.Ft void +.Fo BN_clear_free +.Fa "BIGNUM *a" +.Fc +.Sh DESCRIPTION +.Fn BN_new +allocates and initializes a +.Vt BIGNUM +structure. +.Fn BN_init +initializes an existing uninitialized +.Vt BIGNUM . +.Pp +.Fn BN_clear +is used to destroy sensitive data such as keys when they are no longer +needed. +It erases the memory used by +.Fa a +and sets it to the value 0. +.Pp +.Fn BN_free +frees the components of the +.Vt BIGNUM , +and if it was created by +.Fn BN_new , +also the structure itself. +.Fn BN_clear_free +additionally overwrites the data before the memory is returned to the +system. +.Sh RETURN VALUES +.Fn BN_new +returns a pointer to the +.Vt BIGNUM . +If the allocation fails, it returns +.Dv NULL +and sets an error code that can be obtained by +.Xr ERR_get_error 3 . +.Pp +.Fn BN_init , +.Fn BN_clear , +.Fn BN_free , +and +.Fn BN_clear_free +return no values. +.Sh SEE ALSO +.Xr bn 3 , +.Xr ERR_get_error 3 +.Sh HISTORY +.Fn BN_new , +.Fn BN_clear , +.Fn BN_free , +and +.Fn BN_clear_free +are available in all versions on SSLeay and OpenSSL. +.Fn BN_init +was added in SSLeay 0.9.1b. -- cgit v1.2.3-55-g6feb