0ce325d5b8b5f220d2f9207fedc886c410f3b910
[openssl.git] / doc / crypto / RSA_new.pod
1 =pod
2
3 =head1 NAME
4
5 RSA_new, RSA_free - allocate and free RSA objects
6
7 =head1 SYNOPSIS
8
9  #include <openssl/rsa.h>
10
11  RSA * RSA_new(void);
12
13  void RSA_free(RSA *rsa);
14
15 =head1 DESCRIPTION
16
17 RSA_new() allocates and initializes an B<RSA> structure. It is equivalent to
18 calling RSA_new_method(NULL).
19
20 RSA_free() frees the B<RSA> structure and its components. The key is
21 erased before the memory is returned to the system.
22 If B<rsa> is NULL nothing is done.
23
24 =head1 RETURN VALUES
25
26 If the allocation fails, RSA_new() returns B<NULL> and sets an error
27 code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns
28 a pointer to the newly allocated structure.
29
30 RSA_free() returns no value.
31
32 =head1 SEE ALSO
33
34 L<ERR_get_error(3)>, L<rsa(3)>,
35 L<RSA_generate_key(3)>,
36 L<RSA_new_method(3)>
37
38 =head1 HISTORY
39
40 RSA_new() and RSA_free() are available in all versions of SSLeay and OpenSSL.
41
42 =cut