1=pod
2
3=head1 NAME
4
5SSL_CTX_use_certificate, SSL_CTX_use_certificate_ASN1,
6SSL_CTX_use_certificate_file, SSL_use_certificate, SSL_use_certificate_ASN1,
7SSL_use_certificate_file, SSL_CTX_use_certificate_chain_file,
8SSL_use_certificate_chain_file,
9SSL_CTX_use_PrivateKey, SSL_CTX_use_PrivateKey_ASN1,
10SSL_CTX_use_PrivateKey_file, SSL_CTX_use_RSAPrivateKey,
11SSL_CTX_use_RSAPrivateKey_ASN1, SSL_CTX_use_RSAPrivateKey_file,
12SSL_use_PrivateKey_file, SSL_use_PrivateKey_ASN1, SSL_use_PrivateKey,
13SSL_use_RSAPrivateKey, SSL_use_RSAPrivateKey_ASN1,
14SSL_use_RSAPrivateKey_file, SSL_CTX_check_private_key, SSL_check_private_key,
15SSL_CTX_use_cert_and_key, SSL_use_cert_and_key
16- load certificate and key data
17
18=head1 SYNOPSIS
19
20 #include <openssl/ssl.h>
21
22 int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
23 int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len, const unsigned char *d);
24 int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type);
25 int SSL_use_certificate(SSL *ssl, X509 *x);
26 int SSL_use_certificate_ASN1(SSL *ssl, const unsigned char *d, int len);
27 int SSL_use_certificate_file(SSL *ssl, const char *file, int type);
28
29 int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
30 int SSL_use_certificate_chain_file(SSL *ssl, const char *file);
31
32 int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
33 int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx, const unsigned char *d,
34                                 long len);
35 int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);
36 int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
37 int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, const unsigned char *d, long len);
38 int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);
39 int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
40 int SSL_use_PrivateKey_ASN1(int pk, SSL *ssl, const unsigned char *d, long len);
41 int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
42 int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
43 int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const unsigned char *d, long len);
44 int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
45
46 int SSL_CTX_check_private_key(const SSL_CTX *ctx);
47 int SSL_check_private_key(const SSL *ssl);
48
49 int SSL_CTX_use_cert_and_key(SSL_CTX *ctx, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);
50 int SSL_use_cert_and_key(SSL *ssl, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);
51
52=head1 DESCRIPTION
53
54These functions load the certificates and private keys into the SSL_CTX
55or SSL object, respectively.
56
57The SSL_CTX_* class of functions loads the certificates and keys into the
58SSL_CTX object B<ctx>. The information is passed to SSL objects B<ssl>
59created from B<ctx> with L<SSL_new(3)> by copying, so that
60changes applied to B<ctx> do not propagate to already existing SSL objects.
61
62The SSL_* class of functions only loads certificates and keys into a
63specific SSL object. The specific information is kept, when
64L<SSL_clear(3)> is called for this SSL object.
65
66SSL_CTX_use_certificate() loads the certificate B<x> into B<ctx>,
67SSL_use_certificate() loads B<x> into B<ssl>. The rest of the
68certificates needed to form the complete certificate chain can be
69specified using the
70L<SSL_CTX_add_extra_chain_cert(3)>
71function. On success the reference counter of the B<x> is incremented.
72
73SSL_CTX_use_certificate_ASN1() loads the ASN1 encoded certificate from
74the memory location B<d> (with length B<len>) into B<ctx>,
75SSL_use_certificate_ASN1() loads the ASN1 encoded certificate into B<ssl>.
76
77SSL_CTX_use_certificate_file() loads the first certificate stored in B<file>
78into B<ctx>. The formatting B<type> of the certificate must be specified
79from the known types SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.
80SSL_use_certificate_file() loads the certificate from B<file> into B<ssl>.
81See the NOTES section on why SSL_CTX_use_certificate_chain_file()
82should be preferred.
83
84SSL_CTX_use_certificate_chain_file() loads a certificate chain from
85B<file> into B<ctx>. The certificates must be in PEM format and must
86be sorted starting with the subject's certificate (actual client or server
87certificate), followed by intermediate CA certificates if applicable, and
88ending at the highest level (root) CA. SSL_use_certificate_chain_file() is
89similar except it loads the certificate chain into B<ssl>.
90
91SSL_CTX_use_PrivateKey() adds B<pkey> as private key to B<ctx>. B<ctx> B<MUST NOT> be NULL.
92SSL_CTX_use_RSAPrivateKey() adds the private key B<rsa> of type RSA
93to B<ctx>. SSL_use_PrivateKey() adds B<pkey> as private key to B<ssl>;
94SSL_use_RSAPrivateKey() adds B<rsa> as private key of type RSA to B<ssl>.
95If a certificate has already been set and the private key does not belong
96to the certificate an error is returned. To change a [certificate/private-key]
97pair, the new certificate needs to be set first with SSL_use_certificate() or
98SSL_CTX_use_certificate() before setting the private key with
99SSL_CTX_use_PrivateKey() or SSL_use_PrivateKey().
100On success the reference counter of the B<pkey>/B<rsa> is incremented.
101
102SSL_CTX_use_cert_and_key() and SSL_use_cert_and_key() assign the X.509
103certificate B<x>, private key B<key>, and certificate B<chain> onto the
104corresponding B<ssl> or B<ctx>. The B<pkey> argument must be the private
105key of the X.509 certificate B<x>. If the B<override> argument is 0, then
106B<x>, B<pkey> and B<chain> are set only if all were not previously set.
107If B<override> is non-0, then the certificate, private key and chain certs
108are always set. If B<pkey> is NULL, then the public key of B<x> is used as
109the private key. This is intended to be used with hardware (via the ENGINE
110interface) that stores the private key securely, such that it cannot be
111accessed by OpenSSL. The reference count of the public key is incremented
112(twice if there is no private key); it is not copied nor duplicated. This
113allows all private key validations checks to succeed without an actual
114private key being assigned via SSL_CTX_use_PrivateKey(), etc.
115
116SSL_CTX_use_PrivateKey_ASN1() adds the private key of type B<pk>
117stored at memory location B<d> (length B<len>) to B<ctx>.
118SSL_CTX_use_RSAPrivateKey_ASN1() adds the private key of type RSA
119stored at memory location B<d> (length B<len>) to B<ctx>.
120SSL_use_PrivateKey_ASN1() and SSL_use_RSAPrivateKey_ASN1() add the private
121key to B<ssl>.
122
123SSL_CTX_use_PrivateKey_file() adds the first private key found in
124B<file> to B<ctx>. The formatting B<type> of the private key must be specified
125from the known types SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.
126SSL_CTX_use_RSAPrivateKey_file() adds the first private RSA key found in
127B<file> to B<ctx>. SSL_use_PrivateKey_file() adds the first private key found
128in B<file> to B<ssl>; SSL_use_RSAPrivateKey_file() adds the first private
129RSA key found to B<ssl>. B<ctx> B<MUST NOT> be NULL.
130
131SSL_CTX_check_private_key() checks the consistency of a private key with
132the corresponding certificate loaded into B<ctx>. If more than one
133key/certificate pair (RSA/DSA) is installed, the last item installed will
134be checked. If e.g. the last item was an RSA certificate or key, the RSA
135key/certificate pair will be checked. SSL_check_private_key() performs
136the same check for B<ssl>. If no key/certificate was explicitly added for
137this B<ssl>, the last item added into B<ctx> will be checked.
138
139=head1 NOTES
140
141The internal certificate store of OpenSSL can hold several private
142key/certificate pairs at a time. The certificate used depends on the
143cipher selected, see also L<SSL_CTX_set_cipher_list(3)>.
144
145When reading certificates and private keys from file, files of type
146SSL_FILETYPE_ASN1 (also known as B<DER>, binary encoding) can only contain
147one certificate or private key, consequently
148SSL_CTX_use_certificate_chain_file() is only applicable to PEM formatting.
149Files of type SSL_FILETYPE_PEM can contain more than one item.
150
151SSL_CTX_use_certificate_chain_file() adds the first certificate found
152in the file to the certificate store. The other certificates are added
153to the store of chain certificates using L<SSL_CTX_add1_chain_cert(3)>.
154Note: versions of OpenSSL before 1.0.2 only had a single
155certificate chain store for all certificate types, OpenSSL 1.0.2 and later
156have a separate chain store for each type. SSL_CTX_use_certificate_chain_file()
157should be used instead of the SSL_CTX_use_certificate_file() function in order
158to allow the use of complete certificate chains even when no trusted CA
159storage is used or when the CA issuing the certificate shall not be added to
160the trusted CA storage.
161
162If additional certificates are needed to complete the chain during the
163TLS negotiation, CA certificates are additionally looked up in the
164locations of trusted CA certificates, see
165L<SSL_CTX_load_verify_locations(3)>.
166
167The private keys loaded from file can be encrypted. In order to successfully
168load encrypted keys, a function returning the passphrase must have been
169supplied, see
170L<SSL_CTX_set_default_passwd_cb(3)>.
171(Certificate files might be encrypted as well from the technical point
172of view, it however does not make sense as the data in the certificate
173is considered public anyway.)
174
175All of the functions to set a new certificate will replace any existing
176certificate of the same type that has already been set. Similarly all of the
177functions to set a new private key will replace any private key that has already
178been set. Applications should call L<SSL_CTX_check_private_key(3)> or
179L<SSL_check_private_key(3)> as appropriate after loading a new certificate and
180private key to confirm that the certificate and key match.
181
182=head1 RETURN VALUES
183
184On success, the functions return 1.
185Otherwise check out the error stack to find out the reason.
186
187=head1 SEE ALSO
188
189L<ssl(7)>, L<SSL_new(3)>, L<SSL_clear(3)>,
190L<SSL_CTX_load_verify_locations(3)>,
191L<SSL_CTX_set_default_passwd_cb(3)>,
192L<SSL_CTX_set_cipher_list(3)>,
193L<SSL_CTX_set_client_CA_list(3)>,
194L<SSL_CTX_set_client_cert_cb(3)>,
195L<SSL_CTX_add_extra_chain_cert(3)>
196
197=head1 COPYRIGHT
198
199Copyright 2000-2024 The OpenSSL Project Authors. All Rights Reserved.
200
201Licensed under the Apache License 2.0 (the "License").  You may not use
202this file except in compliance with the License.  You can obtain a copy
203in the file LICENSE in the source distribution or at
204L<https://www.openssl.org/source/license.html>.
205
206=cut
207