openssl/doc/crypto/RSA_new.pod
Geoff Thorpe ac120e20e3 Various parts of the RSA documentation were inaccurate and out of date and
this fixes those that I'm currently aware of. In particular, the ENGINE
interference in the RSA API has hopefully been clarified. This still needs
to be done for other areas of the API ...
2002-08-04 21:08:36 +00:00

40 lines
905 B
Text

=pod
=head1 NAME
RSA_new, RSA_free - allocate and free RSA objects
=head1 SYNOPSIS
#include <openssl/rsa.h>
RSA * RSA_new(void);
void RSA_free(RSA *rsa);
=head1 DESCRIPTION
RSA_new() allocates and initializes an B<RSA> structure. It is equivalent to
calling RSA_new_method(NULL).
RSA_free() frees the B<RSA> structure and its components. The key is
erased before the memory is returned to the system.
=head1 RETURN VALUES
If the allocation fails, RSA_new() returns B<NULL> and sets an error
code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns
a pointer to the newly allocated structure.
RSA_free() returns no value.
=head1 SEE ALSO
L<err(3)|err(3)>, L<rsa(3)|rsa(3)>, L<RSA_generate_key(3)|RSA_generate_key(3)>,
L<RSA_new_method(3)|RSA_new_method(3)>
=head1 HISTORY
RSA_new() and RSA_free() are available in all versions of SSLeay and OpenSSL.
=cut