doc/man3/RSA_generate_key.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_generate_key_ex, RSA_generate_key - generate RSA key pair
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rsa.h>
  10
  11  int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
  12
  13 Deprecated:
  14
  15  #if OPENSSL_API_COMPAT < 0x00908000L
  16  RSA *RSA_generate_key(int num, unsigned long e,
  17                        void (*callback)(int, int, void *), void *cb_arg);
  18  #endif
  19
  20 =head1 DESCRIPTION
  21
  22 RSA_generate_key_ex() generates a key pair and stores it in the B<RSA>
  23 structure provided in B<rsa>. The pseudo-random number generator must
  24 be seeded prior to calling RSA_generate_key_ex().
  25
  26 The modulus size will be of length B<bits>, and the public exponent will be
  27 B<e>. Key sizes with B<num> E<lt> 1024 should be considered insecure.
  28 The exponent is an odd number, typically 3, 17 or 65537.
  29
  30 A callback function may be used to provide feedback about the
  31 progress of the key generation. If B<cb> is not B<NULL>, it
  32 will be called as follows using the BN_GENCB_call() function
  33 described on the L<BN_generate_prime(3)> page.
  34
  35 =over 2
  36
  37 =item *
  38
  39 While a random prime number is generated, it is called as
  40 described in L<BN_generate_prime(3)>.
  41
  42 =item *
  43
  44 When the n-th randomly generated prime is rejected as not
  45 suitable for the key, B<BN_GENCB_call(cb, 2, n)> is called.
  46
  47 =item *
  48
  49 When a random p has been found with p-1 relatively prime to B<e>,
  50 it is called as B<BN_GENCB_call(cb, 3, 0)>.
  51
  52 =back
  53
  54 The process is then repeated for prime q with B<BN_GENCB_call(cb, 3, 1)>.
  55
  56 RSA_generate_key() is deprecated (new applications should use
  57 RSA_generate_key_ex() instead). RSA_generate_key() works in the same way as
  58 RSA_generate_key_ex() except it uses "old style" call backs. See
  59 L<BN_generate_prime(3)> for further details.
  60
  61 =head1 RETURN VALUE
  62
  63 RSA_generate_key_ex() returns 1 on success or 0 on error.
  64 RSA_generate_key() returns the key on success or B<NULL> on error.
  65
  66 The error codes can be obtained by L<ERR_get_error(3)>.
  67
  68 =head1 BUGS
  69
  70 B<BN_GENCB_call(cb, 2, x)> is used with two different meanings.
  71
  72 RSA_generate_key() goes into an infinite loop for illegal input values.
  73
  74 =head1 SEE ALSO
  75
  76 L<ERR_get_error(3)>, L<RAND_bytes(3)>,
  77 L<RSA_generate_key(3)>, L<BN_generate_prime(3)>
  78
  79 =head1 COPYRIGHT
  80
  81 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  82
  83 Licensed under the OpenSSL license (the "License").  You may not use
  84 this file except in compliance with the License.  You can obtain a copy
  85 in the file LICENSE in the source distribution or at
  86 L<https://www.openssl.org/source/license.html>.
  87
  88 =cut