Debian Codegraph @

upstream/debian-unstable/man3/X509_check_private_key.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "X509_CHECK_PRIVATE_KEY 3SSL"
58 .TH X509_CHECK_PRIVATE_KEY 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 X509_check_private_key, X509_REQ_check_private_key \- check the consistency
65 of a private key with the public key in an X509 certificate or certificate
66 request
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/x509.h>
71 \&
72 \& int X509_check_private_key(const X509 *cert, EVP_PKEY *pkey);
73 \&
74 \& int X509_REQ_check_private_key(X509_REQ *req, EVP_PKEY *pkey);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 \&\fBX509_check_private_key()\fR function checks the consistency of private
79 key \fIpkey\fR with the public key in \fIcert\fR.
80 .PP
81 \&\fBX509_REQ_check_private_key()\fR is equivalent to \fBX509_check_private_key()\fR
82 except that \fIreq\fR represents a certificate request of structure \fBX509_REQ\fR.
83 .SH "RETURN VALUES"
84 .IX Header "RETURN VALUES"
85 \&\fBX509_check_private_key()\fR and \fBX509_REQ_check_private_key()\fR return 1 if
86 the keys match each other, and 0 if not.
87 .PP
88 If the key is invalid or an error occurred, the reason code can be
89 obtained using \fBERR_get_error\fR\|(3).
90 .SH BUGS
91 .IX Header "BUGS"
92 The \fBX509_check_private_key()\fR and \fBX509_REQ_check_private_key()\fR functions
93 do not check if \fIpkey\fR itself is indeed a private key or not.
94 They merely compare the public materials (e.g., exponent and modulus of an RSA
95 key) and/or key parameters (e.g. EC params of an EC key) of a key pair.
96 So they also return success if \fIpkey\fR is a matching public key.
97 .SH "SEE ALSO"
98 .IX Header "SEE ALSO"
99 \&\fBERR_get_error\fR\|(3)
100 .SH COPYRIGHT
101 .IX Header "COPYRIGHT"
102 Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved.
103 .PP
104 Licensed under the Apache License 2.0 (the "License"). You may not use
105 this file except in compliance with the License. You can obtain a copy
106 in the file LICENSE in the source distribution or at
107 <https://www.openssl.org/source/license.html>.