secure/lib/libcrypto/man/BN_generate_prime.3

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