diff options
Diffstat (limited to 'doc/crypto/BN_new.pod')
| -rw-r--r-- | doc/crypto/BN_new.pod | 28 |
1 files changed, 21 insertions, 7 deletions
diff --git a/doc/crypto/BN_new.pod b/doc/crypto/BN_new.pod index ab7a105e3a..61743e37fe 100644 --- a/doc/crypto/BN_new.pod +++ b/doc/crypto/BN_new.pod @@ -10,8 +10,6 @@ BN_new, BN_init, BN_clear, BN_free, BN_clear_free - allocate and free BIGNUMs BIGNUM *BN_new(void); - void BN_init(BIGNUM *); - void BN_clear(BIGNUM *a); void BN_free(BIGNUM *a); @@ -20,8 +18,7 @@ BN_new, BN_init, BN_clear, BN_free, BN_clear_free - allocate and free BIGNUMs =head1 DESCRIPTION -BN_new() allocates and initializes a B<BIGNUM> structure. BN_init() -initializes an existing uninitialized B<BIGNUM>. +BN_new() allocates and initializes a B<BIGNUM> structure. BN_clear() is used to destroy sensitive data such as keys when they are no longer needed. It erases the memory used by B<a> and sets it @@ -37,8 +34,25 @@ BN_new() returns a pointer to the B<BIGNUM>. If the allocation fails, it returns B<NULL> and sets an error code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. -BN_init(), BN_clear(), BN_free() and BN_clear_free() have no return -values. +BN_clear(), BN_free() and BN_clear_free() have no return values. + +=head1 REMOVED FUNCTIONALITY + + void BN_init(BIGNUM *); + +BN_init() is no longer available as of OpenSSL 1.1.0. It was used to initialize +an existing uninitialized B<BIGNUM>. Typically this would be done as follows: + + BIGNUM a; + BN_init(&a); + +Applications should replace use of BN_init with BN_new instead: + + BIGNUM *a; + a = BN_new(); + if(!a) /* Handle error */ + ... + BN_free(a); =head1 SEE ALSO @@ -48,6 +62,6 @@ L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)> BN_new(), BN_clear(), BN_free() and BN_clear_free() are available in all versions on SSLeay and OpenSSL. BN_init() was added in SSLeay -0.9.1b. +0.9.1b and removed in OpenSSL 1.1.0. =cut |