diff options
Diffstat (limited to 'deps/openssl/openssl/doc/crypto/BN_new.pod')
| -rw-r--r-- | deps/openssl/openssl/doc/crypto/BN_new.pod | 34 |
1 files changed, 21 insertions, 13 deletions
diff --git a/deps/openssl/openssl/doc/crypto/BN_new.pod b/deps/openssl/openssl/doc/crypto/BN_new.pod index d446603191..08aae5e919 100644 --- a/deps/openssl/openssl/doc/crypto/BN_new.pod +++ b/deps/openssl/openssl/doc/crypto/BN_new.pod @@ -2,7 +2,7 @@ =head1 NAME -BN_new, BN_init, BN_clear, BN_free, BN_clear_free - allocate and free BIGNUMs +BN_new, BN_secure_new, BN_clear, BN_free, BN_clear_free - allocate and free BIGNUMs =head1 SYNOPSIS @@ -10,7 +10,7 @@ BN_new, BN_init, BN_clear, BN_free, BN_clear_free - allocate and free BIGNUMs BIGNUM *BN_new(void); - void BN_init(BIGNUM *); + BIGNUM *BN_secure_new(void); void BN_clear(BIGNUM *a); @@ -20,8 +20,9 @@ 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_secure_new() does the same except that the secure heap +OPENSSL_secure_malloc(3) is used to store the value. 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 @@ -34,22 +35,29 @@ If B<a> is NULL, nothing is done. =head1 RETURN VALUES -BN_new() returns a pointer to the B<BIGNUM> initialised to the value 0. +BN_new() and BN_secure_new() +return a pointer to the B<BIGNUM> initialised to the value 0. 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)>. +they return B<NULL> and set an error code that can be obtained +by L<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 SEE ALSO -L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)> +L<ERR_get_error(3)> =head1 HISTORY -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. +BN_init() was removed in OpenSSL 1.1.0; use BN_new() instead. + +=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 |