Fix off-by-one in BN_rand

[openssl.git] / doc / crypto / BN_generate_prime.pod

diff --git a/doc/crypto/BN_generate_prime.pod b/doc/crypto/BN_generate_prime.pod
index ff32b106765dd59f2b2dcdb0e8cb1c1b924c0a44..7dccacbc1e553f6cf47cbfe4ce1eb9b8eea7404c 100644 (file)
--- a/doc/crypto/BN_generate_prime.pod
+++ b/doc/crypto/BN_generate_prime.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-BN_generate_prime, BN_is_prime, BN_is_prime_fasttest - Generate primes and test for primality
+BN_generate_prime, BN_is_prime, BN_is_prime_fasttest - generate primes and test for primality
 
 =head1 SYNOPSIS
 
@@ -11,11 +11,12 @@ BN_generate_prime, BN_is_prime, BN_is_prime_fasttest - Generate primes and test
  BIGNUM *BN_generate_prime(BIGNUM *ret, int num, int safe, BIGNUM *add,
      BIGNUM *rem, void (*callback)(int, int, void *), void *cb_arg);
 
- int BN_is_prime(BIGNUM *a, int checks, void (*callback)(int, int, 
+ int BN_is_prime(const BIGNUM *a, int checks, void (*callback)(int, int, 
      void *), BN_CTX *ctx, void *cb_arg);
 
- int BN_is_prime_fasttest(BIGNUM *a, int checks, void (*callback)(int, int, 
-     void *), BN_CTX *ctx, BN_CTX *ctx2, void *cb_arg, int do_trial_division);
+ int BN_is_prime_fasttest(const BIGNUM *a, int checks,
+     void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg,
+     int do_trial_division);
 
 =head1 DESCRIPTION
 
@@ -56,36 +57,26 @@ that (p-1)/2 is also prime).
 The PRNG must be seeded prior to calling BN_generate_prime().
 The prime number generation has a negligible error probability.
 
-BN_is_prime() and BN_is_prime_fasttest test if the number B<a> is
+BN_is_prime() and BN_is_prime_fasttest() test if the number B<a> is
 prime.  The following tests are performed until one of them shows that
 B<a> is composite; if B<a> passes all these tests, it is considered
 prime.
 
-=over 4
-
-=item *
-
 BN_is_prime_fasttest(), when called with B<do_trial_division == 1>,
 first attempts trial division by a number of small primes;
 if no divisors are found by this test and B<callback> is not B<NULL>,
 B<callback(1, -1, cb_arg)> is called.
 If B<do_trial_division == 0>, this test is skipped.
 
-=item *
-
 Both BN_is_prime() and BN_is_prime_fasttest() perform a Miller-Rabin
 probabilistic primality test with B<checks> iterations. If
-B<checks == BN_prime_check>, a number of iterations is used that
+B<checks == BN_prime_checks>, a number of iterations is used that
 yields a false positive rate of at most 2^-80 for random input.
 
 If B<callback> is not B<NULL>, B<callback(1, j, cb_arg)> is called
 after the j-th iteration (j = 0, 1, ...). B<ctx> is a
 pre-allocated B<BN_CTX> (to save the overhead of allocating and
-freeing the structure in a loop), or B<NULL>. For
-BN_is_prime_fasttest(), B<ctx2> is a second pre-allocated B<BN_CTX> or
-B<NULL> (lacking this parameter, BN_is_prime() always has to allocated
-an additional B<CN_CTX>).
-
+freeing the structure in a loop), or B<NULL>.
 
 =head1 RETURN VALUES
 
@@ -99,7 +90,7 @@ The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
 
 =head1 SEE ALSO
 
-L<bn(3)|bn(3)>, L<err(3)|err(3)>, L<rand(3)|rand(3)>
+L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<rand(3)|rand(3)>
 
 =head1 HISTORY