doc/man3/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 Deprecated since OpenSSL 3.0:
  12
  13  RSA *RSA_new(void);
  14
  15  void RSA_free(RSA *rsa);
  16
  17 =head1 DESCRIPTION
  18
  19 RSA_new() allocates and initializes an B<RSA> structure. It is equivalent to
  20 calling RSA_new_method(NULL).
  21
  22 RSA_free() frees the B<RSA> structure and its components. The key is
  23 erased before the memory is returned to the system.
  24 If B<rsa> is NULL nothing is done.
  25
  26 =head1 RETURN VALUES
  27
  28 If the allocation fails, RSA_new() returns B<NULL> and sets an error
  29 code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns
  30 a pointer to the newly allocated structure.
  31
  32 RSA_free() returns no value.
  33
  34 =head1 SEE ALSO
  35
  36 L<ERR_get_error(3)>,
  37 L<RSA_generate_key(3)>,
  38 L<RSA_new_method(3)>
  39
  40 =head1 HISTORY
  41
  42 All functions described here were deprecated in OpenSSL 3.0.
  43 For replacement see EVP_PKEY-RSA(7).
  44
  45 =head1 COPYRIGHT
  46
  47 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
  48
  49 Licensed under the Apache License 2.0 (the "License").  You may not use
  50 this file except in compliance with the License.  You can obtain a copy
  51 in the file LICENSE in the source distribution or at
  52 L<https://www.openssl.org/source/license.html>.
  53
  54 =cut