xref: /netbsd-src/crypto/external/bsd/openssl.old/dist/doc/man3/RSA_new.pod (revision 4724848cf0da353df257f730694b7882798e5daf)
1*4724848cSchristos=pod
2*4724848cSchristos
3*4724848cSchristos=head1 NAME
4*4724848cSchristos
5*4724848cSchristosRSA_new, RSA_free - allocate and free RSA objects
6*4724848cSchristos
7*4724848cSchristos=head1 SYNOPSIS
8*4724848cSchristos
9*4724848cSchristos #include <openssl/rsa.h>
10*4724848cSchristos
11*4724848cSchristos RSA *RSA_new(void);
12*4724848cSchristos
13*4724848cSchristos void RSA_free(RSA *rsa);
14*4724848cSchristos
15*4724848cSchristos=head1 DESCRIPTION
16*4724848cSchristos
17*4724848cSchristosRSA_new() allocates and initializes an B<RSA> structure. It is equivalent to
18*4724848cSchristoscalling RSA_new_method(NULL).
19*4724848cSchristos
20*4724848cSchristosRSA_free() frees the B<RSA> structure and its components. The key is
21*4724848cSchristoserased before the memory is returned to the system.
22*4724848cSchristosIf B<rsa> is NULL nothing is done.
23*4724848cSchristos
24*4724848cSchristos=head1 RETURN VALUES
25*4724848cSchristos
26*4724848cSchristosIf the allocation fails, RSA_new() returns B<NULL> and sets an error
27*4724848cSchristoscode that can be obtained by L<ERR_get_error(3)>. Otherwise it returns
28*4724848cSchristosa pointer to the newly allocated structure.
29*4724848cSchristos
30*4724848cSchristosRSA_free() returns no value.
31*4724848cSchristos
32*4724848cSchristos=head1 SEE ALSO
33*4724848cSchristos
34*4724848cSchristosL<ERR_get_error(3)>,
35*4724848cSchristosL<RSA_generate_key(3)>,
36*4724848cSchristosL<RSA_new_method(3)>
37*4724848cSchristos
38*4724848cSchristos=head1 COPYRIGHT
39*4724848cSchristos
40*4724848cSchristosCopyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
41*4724848cSchristos
42*4724848cSchristosLicensed under the OpenSSL license (the "License").  You may not use
43*4724848cSchristosthis file except in compliance with the License.  You can obtain a copy
44*4724848cSchristosin the file LICENSE in the source distribution or at
45*4724848cSchristosL<https://www.openssl.org/source/license.html>.
46*4724848cSchristos
47*4724848cSchristos=cut
48