doc/crypto/BN_new.pod

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