summaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/RAND_DRBG_new.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/RAND_DRBG_new.3')
-rw-r--r--secure/lib/libcrypto/man/RAND_DRBG_new.356
1 files changed, 30 insertions, 26 deletions
diff --git a/secure/lib/libcrypto/man/RAND_DRBG_new.3 b/secure/lib/libcrypto/man/RAND_DRBG_new.3
index 93ca440b6e30e..226c2b5ac9b9e 100644
--- a/secure/lib/libcrypto/man/RAND_DRBG_new.3
+++ b/secure/lib/libcrypto/man/RAND_DRBG_new.3
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
+.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -54,16 +54,20 @@
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
-.if !\nF .nr F 0
-.if \nF>0 \{\
-. de IX
-. tm Index:\\$1\t\\n%\t"\\$2"
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
..
-. if !\nF==2 \{\
-. nr % 0
-. nr F 2
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
. \}
.\}
+.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
@@ -129,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "RAND_DRBG_NEW 3"
-.TH RAND_DRBG_NEW 3 "2018-11-20" "1.1.1a" "OpenSSL"
+.TH RAND_DRBG_NEW 3 "2019-02-26" "1.1.1b" "OpenSSL"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -164,14 +168,14 @@ RAND_DRBG_new, RAND_DRBG_secure_new, RAND_DRBG_set, RAND_DRBG_set_defaults, RAND
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
-\&\fIRAND_DRBG_new()\fR and \fIRAND_DRBG_secure_new()\fR
+\&\fBRAND_DRBG_new()\fR and \fBRAND_DRBG_secure_new()\fR
create a new \s-1DRBG\s0 instance of the given \fBtype\fR, allocated from the heap resp.
the secure heap
-(using \fIOPENSSL_zalloc()\fR resp. \fIOPENSSL_secure_zalloc()\fR).
+(using \fBOPENSSL_zalloc()\fR resp. \fBOPENSSL_secure_zalloc()\fR).
.PP
-\&\fIRAND_DRBG_set()\fR initializes the \fBdrbg\fR with the given \fBtype\fR and \fBflags\fR.
+\&\fBRAND_DRBG_set()\fR initializes the \fBdrbg\fR with the given \fBtype\fR and \fBflags\fR.
.PP
-\&\fIRAND_DRBG_set_defaults()\fR sets the default \fBtype\fR and \fBflags\fR for new \s-1DRBG\s0
+\&\fBRAND_DRBG_set_defaults()\fR sets the default \fBtype\fR and \fBflags\fR for new \s-1DRBG\s0
instances.
.PP
Currently, all \s-1DRBG\s0 types are based on AES-CTR, so \fBtype\fR can be one of the
@@ -189,26 +193,26 @@ the default entropy source for reseeding the \fBdrbg\fR. It is said that the
\&\fBdrbg\fR is \fIchained\fR to its \fBparent\fR.
For more information, see the \s-1NOTES\s0 section.
.PP
-\&\fIRAND_DRBG_instantiate()\fR
+\&\fBRAND_DRBG_instantiate()\fR
seeds the \fBdrbg\fR instance using random input from trusted entropy sources.
Optionally, a personalization string \fBpers\fR of length \fBperslen\fR can be
specified.
To omit the personalization string, set \fBpers\fR=NULL and \fBperslen\fR=0;
.PP
-\&\fIRAND_DRBG_uninstantiate()\fR
+\&\fBRAND_DRBG_uninstantiate()\fR
clears the internal state of the \fBdrbg\fR and puts it back in the
uninstantiated state.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
-\&\fIRAND_DRBG_new()\fR and \fIRAND_DRBG_secure_new()\fR return a pointer to a \s-1DRBG\s0
+\&\fBRAND_DRBG_new()\fR and \fBRAND_DRBG_secure_new()\fR return a pointer to a \s-1DRBG\s0
instance allocated on the heap, resp. secure heap.
.PP
-\&\fIRAND_DRBG_set()\fR,
-\&\fIRAND_DRBG_instantiate()\fR, and
-\&\fIRAND_DRBG_uninstantiate()\fR
+\&\fBRAND_DRBG_set()\fR,
+\&\fBRAND_DRBG_instantiate()\fR, and
+\&\fBRAND_DRBG_uninstantiate()\fR
return 1 on success, and 0 on failure.
.PP
-\&\fIRAND_DRBG_free()\fR does not return a value.
+\&\fBRAND_DRBG_free()\fR does not return a value.
.SH "NOTES"
.IX Header "NOTES"
The \s-1DRBG\s0 design supports \fIchaining\fR, which means that a \s-1DRBG\s0 instance can
@@ -216,23 +220,23 @@ use another \fBparent\fR \s-1DRBG\s0 instance instead of the default entropy sou
to obtain fresh random input for reseeding, provided that \fBparent\fR \s-1DRBG\s0
instance was properly instantiated, either from a trusted entropy source,
or from yet another parent \s-1DRBG\s0 instance.
-For a detailed description of the reseeding process, see \s-1\fIRAND_DRBG\s0\fR\|(7).
+For a detailed description of the reseeding process, see \s-1\fBRAND_DRBG\s0\fR\|(7).
.PP
The default \s-1DRBG\s0 type and flags are applied only during creation of a \s-1DRBG\s0
instance.
To ensure that they are applied to the global and thread-local \s-1DRBG\s0 instances
(<master>, resp. <public> and <private>), it is necessary to call
-\&\fIRAND_DRBG_set_defaults()\fR before creating any thread and before calling any
+\&\fBRAND_DRBG_set_defaults()\fR before creating any thread and before calling any
cryptographic routines that obtain random data directly or indirectly.
.SH "HISTORY"
.IX Header "HISTORY"
The \s-1RAND_DRBG\s0 functions were added in OpenSSL 1.1.1.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-\&\fIOPENSSL_zalloc\fR\|(3),
-\&\fIOPENSSL_secure_zalloc\fR\|(3),
-\&\fIRAND_DRBG_generate\fR\|(3),
-\&\s-1\fIRAND_DRBG\s0\fR\|(7)
+\&\fBOPENSSL_zalloc\fR\|(3),
+\&\fBOPENSSL_secure_zalloc\fR\|(3),
+\&\fBRAND_DRBG_generate\fR\|(3),
+\&\s-1\fBRAND_DRBG\s0\fR\|(7)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved.