f16490ea6a166f2ed108645adbe969fe45e3360c
[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.
18
19 RSA_free() frees the B<RSA> structure and its components. The key is
20 erased before the memory is returned to the system.
21
22 =head1 RETURN VALUES
23
24 If the allocation fails, RSA_new() returns B<NULL> and sets an error
25 code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns
26 a pointer to the newly allocated structure.
27
28 RSA_free() returns no value.
29
30 =head1 SEE ALSO
31
32 L<err(3)|err(3)>, L<rsa(3)|rsa(3)>, L<RSA_generate_key(3)|RSA_generate_key(3)>
33
34 =head1 HISTORY
35
36 RSA_new() and RSA_free() are available in all versions of SSLeay and OpenSSL.
37
38 =cut