e9b7724687
I tried hard to keep the lines at 80 characters or less, but in a few cases I had to punt and just indented the subsequent lines by 4 spaces. A few well-placed typedefs for callback functions would really help, but these would be part of the API, so that's probably for later. I also took the liberty of inserting empty lines in overlong blocks to provide some visual space. Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1956)
47 lines
1.1 KiB
Text
47 lines
1.1 KiB
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.
|
|
If B<rsa> is NULL nothing is done.
|
|
|
|
=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)>. Otherwise it returns
|
|
a pointer to the newly allocated structure.
|
|
|
|
RSA_free() returns no value.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<ERR_get_error(3)>,
|
|
L<RSA_generate_key(3)>,
|
|
L<RSA_new_method(3)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the OpenSSL license (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|