summaryrefslogtreecommitdiffstats
path: root/secure/lib/libcrypto/man/BN_generate_prime.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/BN_generate_prime.3')
-rw-r--r--secure/lib/libcrypto/man/BN_generate_prime.355
1 files changed, 24 insertions, 31 deletions
diff --git a/secure/lib/libcrypto/man/BN_generate_prime.3 b/secure/lib/libcrypto/man/BN_generate_prime.3
index f178bcb..0d5fd34 100644
--- a/secure/lib/libcrypto/man/BN_generate_prime.3
+++ b/secure/lib/libcrypto/man/BN_generate_prime.3
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Mar 17 09:38:31 2004
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" Standard preamble:
-.\" ======================================================================
+.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
@@ -15,12 +14,6 @@
.if t .sp .5v
.if n .sp
..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
.de Vb \" Begin verbatim text
.ft CW
.nf
@@ -28,15 +21,14 @@
..
.de Ve \" End verbatim text
.ft R
-
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
-.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
-.\" to do unbreakable dashes and therefore won't be available. \*(C` and
-.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
@@ -56,10 +48,10 @@
. ds R" ''
'br\}
.\"
-.\" If the F register is turned on, we'll generate index entries on stderr
-.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
-.\" index entries marked with X<> in POD. Of course, you'll have to process
-.\" the output yourself in some meaningful fashion.
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
@@ -68,14 +60,13 @@
. rr F
.\}
.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it
-.\" makes way too many mistakes in technical documents.
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
-.bd B 3
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
@@ -135,11 +126,10 @@
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
-.\" ======================================================================
+.\" ========================================================================
.\"
.IX Title "BN_generate_prime 3"
-.TH BN_generate_prime 3 "0.9.7d" "2004-03-17" "OpenSSL"
-.UC
+.TH BN_generate_prime 3 "2005-02-24" "0.9.7d" "OpenSSL"
.SH "NAME"
BN_generate_prime, BN_is_prime, BN_is_prime_fasttest \- generate primes and test for primality
.SH "SYNOPSIS"
@@ -147,14 +137,17 @@ BN_generate_prime, BN_is_prime, BN_is_prime_fasttest \- generate primes and test
.Vb 1
\& #include <openssl/bn.h>
.Ve
+.PP
.Vb 2
\& BIGNUM *BN_generate_prime(BIGNUM *ret, int num, int safe, BIGNUM *add,
\& BIGNUM *rem, void (*callback)(int, int, void *), void *cb_arg);
.Ve
+.PP
.Vb 2
\& int BN_is_prime(const BIGNUM *a, int checks, void (*callback)(int, int,
\& void *), BN_CTX *ctx, void *cb_arg);
.Ve
+.PP
.Vb 3
\& int BN_is_prime_fasttest(const BIGNUM *a, int checks,
\& void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg,
@@ -167,13 +160,13 @@ bits.
If \fBret\fR is not \fB\s-1NULL\s0\fR, it will be used to store the number.
.PP
If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it is called as follows:
-.Ip "\(bu" 4
-\&\fBcallback(0, i, cb_arg)\fR is called after generating the i-th
+.IP "\(bu" 4
+\&\fBcallback(0, i, cb_arg)\fR is called after generating the i\-th
potential prime number.
-.Ip "\(bu" 4
+.IP "\(bu" 4
While the number is being tested for primality, \fBcallback(1, j,
cb_arg)\fR is called as described below.
-.Ip "\(bu" 4
+.IP "\(bu" 4
When a prime has been found, \fBcallback(2, i, cb_arg)\fR is called.
.PP
The prime may have to fulfill additional requirements for use in
@@ -184,7 +177,7 @@ If \fBadd\fR is not \fB\s-1NULL\s0\fR, the prime will fulfill the condition p %
generator.
.PP
If \fBsafe\fR is true, it will be a safe prime (i.e. a prime p so
-that (p-1)/2 is also prime).
+that (p\-1)/2 is also prime).
.PP
The \s-1PRNG\s0 must be seeded prior to calling \fIBN_generate_prime()\fR.
The prime number generation has a negligible error probability.
@@ -206,7 +199,7 @@ probabilistic primality test with \fBchecks\fR iterations. If
yields a false positive rate of at most 2^\-80 for random input.
.PP
If \fBcallback\fR is not \fB\s-1NULL\s0\fR, \fBcallback(1, j, cb_arg)\fR is called
-after the j-th iteration (j = 0, 1, ...). \fBctx\fR is a
+after the j\-th iteration (j = 0, 1, ...). \fBctx\fR is a
pre-allocated \fB\s-1BN_CTX\s0\fR (to save the overhead of allocating and
freeing the structure in a loop), or \fB\s-1NULL\s0\fR.
.SH "RETURN VALUES"
@@ -217,10 +210,10 @@ freeing the structure in a loop), or \fB\s-1NULL\s0\fR.
prime with an error probability of less than 0.25^\fBchecks\fR, and
\&\-1 on error.
.PP
-The error codes can be obtained by ERR_get_error(3).
+The error codes can be obtained by \fIERR_get_error\fR\|(3).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-bn(3), ERR_get_error(3), rand(3)
+\&\fIbn\fR\|(3), \fIERR_get_error\fR\|(3), \fIrand\fR\|(3)
.SH "HISTORY"
.IX Header "HISTORY"
The \fBcb_arg\fR arguments to \fIBN_generate_prime()\fR and to \fIBN_is_prime()\fR
OpenPOWER on IntegriCloud