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