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