doc/crypto/RSA_check_key.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_check_key - validate private RSA keys
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rsa.h>
  10
  11  int RSA_check_key(RSA *rsa);
  12
  13 =head1 DESCRIPTION
  14
  15 This function validates RSA keys. It checks that B<p> and B<q> are
  16 in fact prime, and that B<n = p*q>.
  17
  18 It also checks that B<d*e = 1 mod (p-1*q-1)>,
  19 and that B<dmp1>, B<dmq1> and B<iqmp> are set correctly or are B<NULL>.
  20
  21 The key's public components may not be B<NULL>.
  22
  23 =head1 RETURN VALUE
  24
  25 RSA_check_key() returns 1 if B<rsa> is a valid RSA key, and 0 otherwise.
  26 -1 is returned if an error occurs while checking the key.
  27
  28 If the key is invalid or an error occurred, the reason code can be
  29 obtained using L<ERR_get_error(3)|ERR_get_error(3)>.
  30
  31 =head1 NOTES
  32
  33 RSA_check_key() can only check soft keys.  If given hard keys, i.e. keys
  34 that were retreived from an ENGINE (with ENGINE_load_private_key()),
  35 RSA_check_key() will always return 0, as if the key was invalid.  The
  36 reason is that the private components B<p>, B<q> and B<d> are normally
  37 not available to OpenSSL for hard keys, and the checks can therefore not
  38 be done.
  39
  40 =head1 SEE ALSO
  41
  42 L<rsa(3)|rsa(3)>, L<err(3)|err(3)>
  43
  44 =head1 HISTORY
  45
  46 RSA_check_key() appeared in OpenSSL 0.9.4.
  47
  48 =cut