BN_new.pod 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. =pod
  2. =head1 NAME
  3. BN_new, BN_init, 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. void BN_init(BIGNUM *);
  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. BN_init()
  13. initializes an existing uninitialized B<BIGNUM>.
  14. BN_clear() is used to destroy sensitive data such as keys when they
  15. are no longer needed. It erases the memory used by B<a> and sets it
  16. to the value 0.
  17. BN_free() frees the components of the B<BIGNUM>, and if it was created
  18. by BN_new(), also the structure itself. BN_clear_free() additionally
  19. overwrites the data before the memory is returned to the system.
  20. =head1 RETURN VALUES
  21. BN_new() returns a pointer to the B<BIGNUM>. If the allocation fails,
  22. it returns B<NULL> and sets an error code that can be obtained
  23. by L<ERR_get_error(3)|ERR_get_error(3)>.
  24. BN_init(), BN_clear(), BN_free() and BN_clear_free() have no return
  25. values.
  26. =head1 SEE ALSO
  27. L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>
  28. =head1 HISTORY
  29. BN_new(), BN_clear(), BN_free() and BN_clear_free() are available in
  30. all versions on SSLeay and OpenSSL. BN_init() was added in SSLeay
  31. 0.9.1b.
  32. =cut