secure/lib/libcrypto/man/BN_generate_prime.3

   1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "BN_generate_prime 3"
 127 .TH BN_generate_prime 3 "2010-12-02" "1.0.0c" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 BN_generate_prime, BN_is_prime, BN_is_prime_fasttest \- generate primes and test for primality
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 1
 137 \& #include <openssl/bn.h>
 138 \&
 139 \& BIGNUM *BN_generate_prime(BIGNUM *ret, int num, int safe, BIGNUM *add,
 140 \&     BIGNUM *rem, void (*callback)(int, int, void *), void *cb_arg);
 141 \&
 142 \& int BN_is_prime(const BIGNUM *a, int checks, void (*callback)(int, int,
 143 \&     void *), BN_CTX *ctx, void *cb_arg);
 144 \&
 145 \& int BN_is_prime_fasttest(const BIGNUM *a, int checks,
 146 \&     void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg,
 147 \&     int do_trial_division);
 148 .Ve
 149 .SH "DESCRIPTION"
 150 .IX Header "DESCRIPTION"
 151 \&\fIBN_generate_prime()\fR generates a pseudo-random prime number of \fBnum\fR
 152 bits.
 153 If \fBret\fR is not \fB\s-1NULL\s0\fR, it will be used to store the number.
 154 .PP
 155 If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it is called as follows:
 156 .IP "\(bu" 4
 157 \&\fBcallback(0, i, cb_arg)\fR is called after generating the i\-th
 158 potential prime number.
 159 .IP "\(bu" 4
 160 While the number is being tested for primality, \fBcallback(1, j,
 161 cb_arg)\fR is called as described below.
 162 .IP "\(bu" 4
 163 When a prime has been found, \fBcallback(2, i, cb_arg)\fR is called.
 164 .PP
 165 The prime may have to fulfill additional requirements for use in
 166 Diffie-Hellman key exchange:
 167 .PP
 168 If \fBadd\fR is not \fB\s-1NULL\s0\fR, the prime will fulfill the condition p % \fBadd\fR
 169 == \fBrem\fR (p % \fBadd\fR == 1 if \fBrem\fR == \fB\s-1NULL\s0\fR) in order to suit a given
 170 generator.
 171 .PP
 172 If \fBsafe\fR is true, it will be a safe prime (i.e. a prime p so
 173 that (p\-1)/2 is also prime).
 174 .PP
 175 The \s-1PRNG\s0 must be seeded prior to calling \fIBN_generate_prime()\fR.
 176 The prime number generation has a negligible error probability.
 177 .PP
 178 \&\fIBN_is_prime()\fR and \fIBN_is_prime_fasttest()\fR test if the number \fBa\fR is
 179 prime.  The following tests are performed until one of them shows that
 180 \&\fBa\fR is composite; if \fBa\fR passes all these tests, it is considered
 181 prime.
 182 .PP
 183 \&\fIBN_is_prime_fasttest()\fR, when called with \fBdo_trial_division == 1\fR,
 184 first attempts trial division by a number of small primes;
 185 if no divisors are found by this test and \fBcallback\fR is not \fB\s-1NULL\s0\fR,
 186 \&\fBcallback(1, \-1, cb_arg)\fR is called.
 187 If \fBdo_trial_division == 0\fR, this test is skipped.
 188 .PP
 189 Both \fIBN_is_prime()\fR and \fIBN_is_prime_fasttest()\fR perform a Miller-Rabin
 190 probabilistic primality test with \fBchecks\fR iterations. If
 191 \&\fBchecks == BN_prime_checks\fR, a number of iterations is used that
 192 yields a false positive rate of at most 2^\-80 for random input.
 193 .PP
 194 If \fBcallback\fR is not \fB\s-1NULL\s0\fR, \fBcallback(1, j, cb_arg)\fR is called
 195 after the j\-th iteration (j = 0, 1, ...). \fBctx\fR is a
 196 pre-allocated \fB\s-1BN_CTX\s0\fR (to save the overhead of allocating and
 197 freeing the structure in a loop), or \fB\s-1NULL\s0\fR.
 198 .SH "RETURN VALUES"
 199 .IX Header "RETURN VALUES"
 200 \&\fIBN_generate_prime()\fR returns the prime number on success, \fB\s-1NULL\s0\fR otherwise.
 201 .PP
 202 \&\fIBN_is_prime()\fR returns 0 if the number is composite, 1 if it is
 203 prime with an error probability of less than 0.25^\fBchecks\fR, and
 204 \&\-1 on error.
 205 .PP
 206 The error codes can be obtained by \fIERR_get_error\fR\|(3).
 207 .SH "SEE ALSO"
 208 .IX Header "SEE ALSO"
 209 \&\fIbn\fR\|(3), \fIERR_get_error\fR\|(3), \fIrand\fR\|(3)
 210 .SH "HISTORY"
 211 .IX Header "HISTORY"
 212 The \fBcb_arg\fR arguments to \fIBN_generate_prime()\fR and to \fIBN_is_prime()\fR
 213 were added in SSLeay 0.9.0. The \fBret\fR argument to \fIBN_generate_prime()\fR
 214 was added in SSLeay 0.9.1.
 215 \&\fIBN_is_prime_fasttest()\fR was added in OpenSSL 0.9.5.