xref: /freebsd/secure/lib/libcrypto/man/man3/X509_check_private_key.3 (revision 88b8b7f0c4e9948667a2279e78e975a784049cba)
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "X509_CHECK_PRIVATE_KEY 3ossl"
X509_CHECK_PRIVATE_KEY 3ossl 2025-07-01 3.5.1 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
X509_check_private_key, X509_REQ_check_private_key - check the consistency of a private key with the public key in an X509 certificate or certificate request
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/x509.h> \& int X509_check_private_key(const X509 *cert, EVP_PKEY *pkey); \& int X509_REQ_check_private_key(X509_REQ *req, EVP_PKEY *pkey); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBX509_check_private_key() function checks the consistency of private key pkey with the public key in cert.

\fBX509_REQ_check_private_key() is equivalent to X509_check_private_key() except that req represents a certificate request of structure X509_REQ.

"RETURN VALUES"
Header "RETURN VALUES" \fBX509_check_private_key() and X509_REQ_check_private_key() return 1 if the keys match each other, and 0 if not.

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

BUGS
Header "BUGS" The X509_check_private_key() and X509_REQ_check_private_key() functions do not check if pkey itself is indeed a private key or not. They merely compare the public materials (e.g., exponent and modulus of an RSA key) and/or key parameters (e.g. EC params of an EC key) of a key pair. So they also return success if pkey is a matching public key.
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.