BN_CTX_new.pod 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. =pod
  2. =head1 NAME
  3. BN_CTX_new, BN_CTX_init, BN_CTX_free - allocate and free BN_CTX structures
  4. =head1 SYNOPSIS
  5. #include <openssl/bn.h>
  6. BN_CTX *BN_CTX_new(void);
  7. void BN_CTX_free(BN_CTX *c);
  8. Deprecated:
  9. void BN_CTX_init(BN_CTX *c);
  10. =head1 DESCRIPTION
  11. A B<BN_CTX> is a structure that holds B<BIGNUM> temporary variables used by
  12. library functions. Since dynamic memory allocation to create B<BIGNUM>s
  13. is rather expensive when used in conjunction with repeated subroutine
  14. calls, the B<BN_CTX> structure is used.
  15. BN_CTX_new() allocates and initializes a B<BN_CTX>
  16. structure.
  17. BN_CTX_free() frees the components of the B<BN_CTX>, and if it was
  18. created by BN_CTX_new(), also the structure itself.
  19. If L<BN_CTX_start(3)|BN_CTX_start(3)> has been used on the B<BN_CTX>,
  20. L<BN_CTX_end(3)|BN_CTX_end(3)> must be called before the B<BN_CTX>
  21. may be freed by BN_CTX_free().
  22. BN_CTX_init() (deprecated) initializes an existing uninitialized B<BN_CTX>.
  23. This should not be used for new programs. Use BN_CTX_new() instead.
  24. =head1 RETURN VALUES
  25. BN_CTX_new() returns a pointer to the B<BN_CTX>. If the allocation fails,
  26. it returns B<NULL> and sets an error code that can be obtained by
  27. L<ERR_get_error(3)|ERR_get_error(3)>.
  28. BN_CTX_init() and BN_CTX_free() have no return values.
  29. =head1 SEE ALSO
  30. L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<BN_add(3)|BN_add(3)>,
  31. L<BN_CTX_start(3)|BN_CTX_start(3)>
  32. =head1 HISTORY
  33. BN_CTX_new() and BN_CTX_free() are available in all versions on SSLeay
  34. and OpenSSL. BN_CTX_init() was added in SSLeay 0.9.1b.
  35. =cut