2
0

BN_new.pod 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. =pod
  2. =head1 NAME
  3. BN_new, BN_secure_new, BN_clear, BN_free, BN_clear_free - allocate and free BIGNUMs
  4. =head1 SYNOPSIS
  5. #include <openssl/bn.h>
  6. BIGNUM *BN_new(void);
  7. BIGNUM *BN_secure_new(void);
  8. void BN_clear(BIGNUM *a);
  9. void BN_free(BIGNUM *a);
  10. void BN_clear_free(BIGNUM *a);
  11. =head1 DESCRIPTION
  12. BN_new() allocates and initializes a B<BIGNUM> structure.
  13. BN_secure_new() does the same except that the secure heap
  14. OPENSSL_secure_malloc(3) is used to store the value.
  15. BN_clear() is used to destroy sensitive data such as keys when they
  16. are no longer needed. It erases the memory used by B<a> and sets it
  17. to the value 0.
  18. BN_free() frees the components of the B<BIGNUM>, and if it was created
  19. by BN_new(), also the structure itself. BN_clear_free() additionally
  20. overwrites the data before the memory is returned to the system.
  21. If B<a> is NULL, nothing is done.
  22. =head1 RETURN VALUES
  23. BN_new() and BN_secure_new()
  24. return a pointer to the B<BIGNUM> initialised to the value 0.
  25. If the allocation fails,
  26. they return B<NULL> and set an error code that can be obtained
  27. by L<ERR_get_error(3)>.
  28. BN_clear(), BN_free() and BN_clear_free() have no return values.
  29. =head1 SEE ALSO
  30. L<ERR_get_error(3)>
  31. =head1 HISTORY
  32. BN_init() was removed in OpenSSL 1.1.0; use BN_new() instead.
  33. =head1 COPYRIGHT
  34. Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
  35. Licensed under the OpenSSL license (the "License"). You may not use
  36. this file except in compliance with the License. You can obtain a copy
  37. in the file LICENSE in the source distribution or at
  38. L<https://www.openssl.org/source/license.html>.
  39. =cut