diff options
Diffstat (limited to 'deps/openssl/openssl/doc/crypto/BN_generate_prime.pod')
| -rw-r--r-- | deps/openssl/openssl/doc/crypto/BN_generate_prime.pod | 80 |
1 files changed, 62 insertions, 18 deletions
diff --git a/deps/openssl/openssl/doc/crypto/BN_generate_prime.pod b/deps/openssl/openssl/doc/crypto/BN_generate_prime.pod index bf1b5308ad..c97536b5c4 100644 --- a/deps/openssl/openssl/doc/crypto/BN_generate_prime.pod +++ b/deps/openssl/openssl/doc/crypto/BN_generate_prime.pod @@ -3,49 +3,59 @@ =head1 NAME BN_generate_prime_ex, BN_is_prime_ex, BN_is_prime_fasttest_ex, BN_GENCB_call, -BN_GENCB_set_old, BN_GENCB_set, BN_generate_prime, BN_is_prime, -BN_is_prime_fasttest - generate primes and test for primality +BN_GENCB_new, BN_GENCB_free, BN_GENCB_set_old, BN_GENCB_set, BN_GENCB_get_arg, +BN_generate_prime, BN_is_prime, BN_is_prime_fasttest - generate primes and test +for primality =head1 SYNOPSIS #include <openssl/bn.h> - int BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add, + int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add, const BIGNUM *rem, BN_GENCB *cb); - int BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb); + int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb); - int BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, + int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, int do_trial_division, BN_GENCB *cb); int BN_GENCB_call(BN_GENCB *cb, int a, int b); - #define BN_GENCB_set_old(gencb, callback, cb_arg) ... + BN_GENCB *BN_GENCB_new(void); - #define BN_GENCB_set(gencb, callback, cb_arg) ... + void BN_GENCB_free(BN_GENCB *cb); + void BN_GENCB_set_old(BN_GENCB *gencb, + void (*callback)(int, int, void *), void *cb_arg); + + void BN_GENCB_set(BN_GENCB *gencb, + int (*callback)(int, int, BN_GENCB *), void *cb_arg); + + void *BN_GENCB_get_arg(BN_GENCB *cb); Deprecated: + #if OPENSSL_API_COMPAT < 0x00908000L 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(const 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(const BIGNUM *a, int checks, void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg, int do_trial_division); + #endif =head1 DESCRIPTION BN_generate_prime_ex() generates a pseudo-random prime number of -bit length B<bits>. +at least bit length B<bits>. If B<ret> is not B<NULL>, it will be used to store the number. If B<cb> is not B<NULL>, it is used as follows: -=over 4 +=over 2 =item * @@ -103,17 +113,23 @@ B<BN_GENCB> structure that are supported: "new" style and "old" style. New programs should prefer the "new" style, whilst the "old" style is provided for backwards compatibility purposes. +A BN_GENCB structure should be created through a call to BN_GENCB_new(), +and freed through a call to BN_GENCB_free(). + For "new" style callbacks a BN_GENCB structure should be initialised with a -call to BN_GENCB_set, where B<gencb> is a B<BN_GENCB *>, B<callback> is of +call to BN_GENCB_set(), where B<gencb> is a B<BN_GENCB *>, B<callback> is of type B<int (*callback)(int, int, BN_GENCB *)> and B<cb_arg> is a B<void *>. "Old" style callbacks are the same except they are initialised with a call -to BN_GENCB_set_old and B<callback> is of type +to BN_GENCB_set_old() and B<callback> is of type B<void (*callback)(int, int, void *)>. A callback is invoked through a call to B<BN_GENCB_call>. This will check the type of the callback and will invoke B<callback(a, b, gencb)> for new style callbacks or B<callback(a, b, cb_arg)> for old style. +It is possible to obtained the argument associated with a BN_GENCB structure +(set via a call to BN_GENCB_set or BN_GENCB_set_old) using BN_GENCB_get_arg. + BN_generate_prime (deprecated) works in the same way as BN_generate_prime_ex but expects an old style callback function directly in the B<callback> parameter, and an argument to pass to it in @@ -132,19 +148,47 @@ prime with an error probability of less than 0.25^B<nchecks>, and BN_generate_prime() returns the prime number on success, B<NULL> otherwise. +BN_GENCB_new returns a pointer to a BN_GENCB structure on success, or B<NULL> +otherwise. + +BN_GENCB_get_arg returns the argument previously associated with a BN_GENCB +structure. + Callback functions should return 1 on success or 0 on error. -The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. +The error codes can be obtained by L<ERR_get_error(3)>. + +=head1 REMOVED FUNCTIONALITY + +As of OpenSSL 1.1.0 it is no longer possible to create a BN_GENCB structure +directly, as in: + + BN_GENCB callback; + +Instead applications should create a BN_GENCB structure using BN_GENCB_new: + + BN_GENCB *callback; + callback = BN_GENCB_new(); + if(!callback) /* handle error */ + ... + BN_GENCB_free(callback); =head1 SEE ALSO -L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<rand(3)|rand(3)> +L<ERR_get_error(3)>, L<RAND_bytes(3)> =head1 HISTORY -The B<cb_arg> arguments to BN_generate_prime() and to BN_is_prime() -were added in SSLeay 0.9.0. The B<ret> argument to BN_generate_prime() -was added in SSLeay 0.9.1. -BN_is_prime_fasttest() was added in OpenSSL 0.9.5. +BN_GENCB_new(), BN_GENCB_free(), +and BN_GENCB_get_arg() were added in OpenSSL 1.1.0 + +=head1 COPYRIGHT + +Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. =cut |