summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man/RSA_new.3
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-04 10:17:18 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-04 10:17:18 +0000
commitf6c04f3c81cd15d2577d6a86697114166bcf694e (patch)
tree9dd46668bb03a513af0c9d5289c26b1a2b58e4b7 /lib/libcrypto/man/RSA_new.3
parenta79e19e7d709421b1d5b4f7b9fdb8e53890fcf0e (diff)
convert RSA manuals from pod to mdoc
Diffstat (limited to 'lib/libcrypto/man/RSA_new.3')
-rw-r--r--lib/libcrypto/man/RSA_new.346
1 files changed, 46 insertions, 0 deletions
diff --git a/lib/libcrypto/man/RSA_new.3 b/lib/libcrypto/man/RSA_new.3
new file mode 100644
index 00000000000..b01c8cd089b
--- /dev/null
+++ b/lib/libcrypto/man/RSA_new.3
@@ -0,0 +1,46 @@
+.Dd $Mdocdate: November 4 2016 $
+.Dt RSA_NEW 3
+.Os
+.Sh NAME
+.Nm RSA_new ,
+.Nm RSA_free
+.Nd allocate and free RSA objects
+.Sh SYNOPSIS
+.In openssl/rsa.h
+.Ft RSA *
+.Fn RSA_new void
+.Ft void
+.Fo RSA_free
+.Fa "RSA *rsa"
+.Fc
+.Sh DESCRIPTION
+.Fn RSA_new
+allocates and initializes an
+.Vt RSA
+structure.
+It is equivalent to calling
+.Fn RSA_new_method NULL .
+.Pp
+.Fn RSA_free
+frees the
+.Vt RSA
+structure and its components.
+The key is erased before the memory is returned to the system.
+.Sh RETURN VALUES
+If the allocation fails,
+.Fn RSA_new
+returns
+.Dv NULL
+and sets an error code that can be obtained by
+.Xr ERR_get_error 3 .
+Otherwise it returns a pointer to the newly allocated structure.
+.Sh SEE ALSO
+.Xr ERR_get_error 3 ,
+.Xr rsa 3 ,
+.Xr RSA_generate_key 3 ,
+.Xr RSA_new_method 3
+.Sh HISTORY
+.Fn RSA_new
+and
+.Fn RSA_free
+are available in all versions of SSLeay and OpenSSL.