apps-cleanup: the doc fixes
[openssl.git] / doc / crypto / BN_new.pod
1 =pod
2
3 =head1 NAME
4
5 BN_new, BN_init, 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
31 =head1 RETURN VALUES
32
33 BN_new() returns a pointer to the B<BIGNUM>. If the allocation fails,
34 it returns B<NULL> and sets an error code that can be obtained
35 by L<ERR_get_error(3)|ERR_get_error(3)>.
36
37 BN_clear(), BN_free() and BN_clear_free() have no return values.
38
39 =head1 REMOVED FUNCTIONALITY
40
41  void BN_init(BIGNUM *);
42
43 BN_init() is no longer available as of OpenSSL 1.1.0. It was used to initialize
44 an existing uninitialized B<BIGNUM>. Typically this would be done as follows:
45
46  BIGNUM a;
47  BN_init(&a);
48
49 Applications should replace use of BN_init with BN_new instead:
50
51  BIGNUM *a;
52  a = BN_new();
53  if(!a) /* Handle error */
54  ...
55  BN_free(a);
56
57 =head1 SEE ALSO
58
59 L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>
60
61 =head1 HISTORY
62
63 BN_new(), BN_clear(), BN_free() and BN_clear_free() are available in
64 all versions on SSLeay and OpenSSL.  BN_init() was added in SSLeay
65 0.9.1b and removed in OpenSSL 1.1.0.
66
67 =cut