doc/man3/RSA_check_key.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_check_key_ex, RSA_check_key - validate private RSA keys
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rsa.h>
  10
  11 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  12 B<OPENSSL_API_COMPAT> with a suitable version value, see
  13 L<openssl_user_macros(7)>:
  14
  15  int RSA_check_key_ex(RSA *rsa, BN_GENCB *cb);
  16
  17  int RSA_check_key(RSA *rsa);
  18
  19 =head1 DESCRIPTION
  20
  21 Both of the functions described on this page are deprecated.
  22 Applications should instead use L<EVP_PKEY_public_check(3)>,
  23 L<EVP_PKEY_private_check(3)> and L<EVP_PKEY_pairwise_check(3)>.
  24
  25 RSA_check_key_ex() function validates RSA keys.
  26 It checks that B<p> and B<q> are
  27 in fact prime, and that B<n = p*q>.
  28
  29 It does not work on RSA public keys that have only the modulus
  30 and public exponent elements populated.
  31 It also checks that B<d*e = 1 mod (p-1*q-1)>,
  32 and that B<dmp1>, B<dmq1> and B<iqmp> are set correctly or are B<NULL>.
  33 It performs integrity checks on all
  34 the RSA key material, so the RSA key structure must contain all the private
  35 key data too.
  36 Therefore, it cannot be used with any arbitrary RSA key object,
  37 even if it is otherwise fit for regular RSA operation.
  38
  39 The B<cb> parameter is a callback that will be invoked in the same
  40 manner as L<BN_is_prime_ex(3)>.
  41
  42 RSA_check_key() is equivalent to RSA_check_key_ex() with a NULL B<cb>.
  43
  44 =head1 RETURN VALUES
  45
  46 RSA_check_key_ex() and RSA_check_key()
  47 return 1 if B<rsa> is a valid RSA key, and 0 otherwise.
  48 They return -1 if an error occurs while checking the key.
  49
  50 If the key is invalid or an error occurred, the reason code can be
  51 obtained using L<ERR_get_error(3)>.
  52
  53 =head1 NOTES
  54
  55 Unlike most other RSA functions, this function does B<not> work
  56 transparently with any underlying ENGINE implementation because it uses the
  57 key data in the RSA structure directly. An ENGINE implementation can
  58 override the way key data is stored and handled, and can even provide
  59 support for HSM keys - in which case the RSA structure may contain B<no>
  60 key data at all! If the ENGINE in question is only being used for
  61 acceleration or analysis purposes, then in all likelihood the RSA key data
  62 is complete and untouched, but this can't be assumed in the general case.
  63
  64 =head1 BUGS
  65
  66 A method of verifying the RSA key using opaque RSA API functions might need
  67 to be considered. Right now RSA_check_key() simply uses the RSA structure
  68 elements directly, bypassing the RSA_METHOD table altogether (and
  69 completely violating encapsulation and object-orientation in the process).
  70 The best fix will probably be to introduce a "check_key()" handler to the
  71 RSA_METHOD function table so that alternative implementations can also
  72 provide their own verifiers.
  73
  74 =head1 SEE ALSO
  75
  76 L<BN_is_prime_ex(3)>,
  77 L<ERR_get_error(3)>
  78
  79 =head1 HISTORY
  80
  81 All of these functions were deprecated in OpenSSL 3.0.
  82
  83 RSA_check_key_ex() appeared after OpenSSL 1.0.2.
  84
  85 =head1 COPYRIGHT
  86
  87 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
  88
  89 Licensed under the Apache License 2.0 (the "License").  You may not use
  90 this file except in compliance with the License.  You can obtain a copy
  91 in the file LICENSE in the source distribution or at
  92 L<https://www.openssl.org/source/license.html>.
  93
  94 =cut