doc/man3/X509_check_private_key.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_check_private_key, X509_REQ_check_private_key - check the consistency
   6 of a private key with the public key in an X509 certificate or certificate
   7 request
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/x509.h>
  12
  13  int X509_check_private_key(const X509 *cert, EVP_PKEY *pkey);
  14
  15  int X509_REQ_check_private_key(X509_REQ *req, EVP_PKEY *pkey);
  16
  17 =head1 DESCRIPTION
  18
  19 X509_check_private_key() function checks the consistency of private
  20 key I<pkey> with the public key in I<cert>.
  21
  22 X509_REQ_check_private_key() is equivalent to X509_check_private_key()
  23 except that I<req> represents a certificate request of structure B<X509_REQ>.
  24
  25 =head1 RETURN VALUES
  26
  27 X509_check_private_key() and X509_REQ_check_private_key() return 1 if
  28 the keys match each other, and 0 if not.
  29
  30 If the key is invalid or an error occurred, the reason code can be
  31 obtained using L<ERR_get_error(3)>.
  32
  33 =head1 BUGS
  34
  35 The X509_check_private_key() and X509_REQ_check_private_key() functions
  36 do not check if I<pkey> itself is indeed a private key or not.
  37 They merely compare the public materials (e.g., exponent and modulus of an RSA
  38 key) and/or key parameters (e.g. EC params of an EC key) of a key pair.
  39 So they also return success if I<pkey> is a matching public key.
  40
  41 =head1 SEE ALSO
  42
  43 L<ERR_get_error(3)>
  44
  45 =head1 COPYRIGHT
  46
  47 Copyright 2017-2018 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