RSA_check_key_ex (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/RSA_check_key_ex.3ssl".)

NAME

RSA_check_key_ex, RSA_check_key - validate private RSA keys

SYNOPSIS

 #include <openssl/rsa.h>

 int RSA_check_key_ex(RSA *rsa, BN_GENCB *cb);

 int RSA_check_key(RSA *rsa);

DESCRIPTION

RSA_check_key_ex() function validates keys. It checks that p and q are in fact prime, and that n = p*q.

It does not work on

public keys that have only the modulus and public exponent elements populated. It also checks that d*e = 1 mod (p-1*q-1), and that dmp1, dmq1 and iqmp are set correctly or are . It performs integrity checks on all the key material, so the key structure must contain all the private key data too. Therefore, it cannot be used with any arbitrary key object, even if it is otherwise fit for regular operation.

The cb parameter is a callback that will be invoked in the same manner as BN_is_prime_ex(3).

RSA_check_key() is equivalent to RSA_check_key_ex() with a

cb.

RETURN VALUE

RSA_check_key_ex() and RSA_check_key() return 1 if rsa is a valid key, and 0 otherwise. They return -1 if an error occurs while checking the key.

If the key is invalid or an error occurred, the reason code can be obtained using ERR_get_error(3).

NOTES

Unlike most other functions, this function does not work transparently with any underlying implementation because it uses the key data in the structure directly. An implementation can override the way key data is stored and handled, and can even provide support for keys - in which case the structure may contain no key data at all! If the in question is only being used for acceleration or analysis purposes, then in all likelihood the key data is complete and untouched, but this can't be assumed in the general case.

BUGS

A method of verifying the key using opaque functions might need to be considered. Right now RSA_check_key() simply uses the structure elements directly, bypassing the table altogether (and completely violating encapsulation and object-orientation in the process). The best fix will probably be to introduce a ``check_key()'' handler to the function table so that alternative implementations can also provide their own verifiers.

SEE ALSO

BN_is_prime_ex(3), ERR_get_error(3)

HISTORY

RSA_check_key_ex() appeared after OpenSSL 1.0.2.

COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the ``License''). You may not use this file except in compliance with the License. You can obtain a copy in the file

in the source distribution or at <www.openssl.org/source/license.html>.