76c4883ad0259ae2b0c3f5f16160eaaba7bb467e
[openssl.git] / doc / ssl / SSL_CTX_use_certificate.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_use_certificate, SSL_CTX_use_certificate_ASN1, SSL_CTX_use_certificate_file, SSL_use_certificate, SSL_use_certificate_ASN1, SSL_use_certificate_file, SSL_CTX_use_certificate_chain_file, SSL_CTX_use_PrivateKey, SSL_CTX_use_PrivateKey_ASN1, SSL_CTX_use_PrivateKey_file, SSL_CTX_use_RSAPrivateKey, SSL_CTX_use_RSAPrivateKey_ASN1, SSL_CTX_use_RSAPrivateKey_file, SSL_use_PrivateKey_file, SSL_use_PrivateKey_ASN1, SSL_use_PrivateKey, SSL_use_RSAPrivateKey, SSL_use_RSAPrivateKey_ASN1, SSL_use_RSAPrivateKey_file, SSL_CTX_check_private_key, SSL_check_private_key - load certificate and key data
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
12  int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len, unsigned char *d);
13  int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type);
14  int SSL_use_certificate(SSL *ssl, X509 *x);
15  int SSL_use_certificate_ASN1(SSL *ssl, unsigned char *d, int len);
16  int SSL_use_certificate_file(SSL *ssl, const char *file, int type);
17
18  int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
19  int SSL_use_certificate_chain_file(SSL *ssl, const char *file);
20
21  int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
22  int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx, unsigned char *d,
23                                  long len);
24  int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);
25  int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
26  int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, unsigned char *d, long len);
27  int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);
28  int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
29  int SSL_use_PrivateKey_ASN1(int pk,SSL *ssl, unsigned char *d, long len);
30  int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
31  int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
32  int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, unsigned char *d, long len);
33  int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
34
35  int SSL_CTX_check_private_key(const SSL_CTX *ctx);
36  int SSL_check_private_key(const SSL *ssl);
37
38 =head1 DESCRIPTION
39
40 These functions load the certificates and private keys into the SSL_CTX
41 or SSL object, respectively.
42
43 The SSL_CTX_* class of functions loads the certificates and keys into the
44 SSL_CTX object B<ctx>. The information is passed to SSL objects B<ssl>
45 created from B<ctx> with L<SSL_new(3)> by copying, so that
46 changes applied to B<ctx> do not propagate to already existing SSL objects.
47
48 The SSL_* class of functions only loads certificates and keys into a
49 specific SSL object. The specific information is kept, when
50 L<SSL_clear(3)> is called for this SSL object.
51
52 SSL_CTX_use_certificate() loads the certificate B<x> into B<ctx>,
53 SSL_use_certificate() loads B<x> into B<ssl>. The rest of the
54 certificates needed to form the complete certificate chain can be
55 specified using the
56 L<SSL_CTX_add_extra_chain_cert(3)>
57 function.
58
59 SSL_CTX_use_certificate_ASN1() loads the ASN1 encoded certificate from
60 the memory location B<d> (with length B<len>) into B<ctx>,
61 SSL_use_certificate_ASN1() loads the ASN1 encoded certificate into B<ssl>.
62
63 SSL_CTX_use_certificate_file() loads the first certificate stored in B<file>
64 into B<ctx>. The formatting B<type> of the certificate must be specified
65 from the known types SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.
66 SSL_use_certificate_file() loads the certificate from B<file> into B<ssl>.
67 See the NOTES section on why SSL_CTX_use_certificate_chain_file()
68 should be preferred.
69
70 SSL_CTX_use_certificate_chain_file() loads a certificate chain from 
71 B<file> into B<ctx>. The certificates must be in PEM format and must
72 be sorted starting with the subject's certificate (actual client or server
73 certificate), followed by intermediate CA certificates if applicable, and
74 ending at the highest level (root) CA. SSL_use_certificate_chain_file() is
75 similar except it loads the cerificate chain into B<ssl>.
76
77 SSL_CTX_use_PrivateKey() adds B<pkey> as private key to B<ctx>.
78 SSL_CTX_use_RSAPrivateKey() adds the private key B<rsa> of type RSA
79 to B<ctx>. SSL_use_PrivateKey() adds B<pkey> as private key to B<ssl>;
80 SSL_use_RSAPrivateKey() adds B<rsa> as private key of type RSA to B<ssl>.
81 If a certificate has already been set and the private does not belong
82 to the certificate an error is returned. To change a certificate, private
83 key pair the new certificate needs to be set with SSL_use_certificate()
84 or SSL_CTX_use_certificate() before setting the private key with
85 SSL_CTX_use_PrivateKey() or SSL_use_PrivateKey(). 
86
87
88 SSL_CTX_use_PrivateKey_ASN1() adds the private key of type B<pk>
89 stored at memory location B<d> (length B<len>) to B<ctx>.
90 SSL_CTX_use_RSAPrivateKey_ASN1() adds the private key of type RSA
91 stored at memory location B<d> (length B<len>) to B<ctx>.
92 SSL_use_PrivateKey_ASN1() and SSL_use_RSAPrivateKey_ASN1() add the private
93 key to B<ssl>.
94
95 SSL_CTX_use_PrivateKey_file() adds the first private key found in
96 B<file> to B<ctx>. The formatting B<type> of the certificate must be specified
97 from the known types SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.
98 SSL_CTX_use_RSAPrivateKey_file() adds the first private RSA key found in
99 B<file> to B<ctx>. SSL_use_PrivateKey_file() adds the first private key found
100 in B<file> to B<ssl>; SSL_use_RSAPrivateKey_file() adds the first private
101 RSA key found to B<ssl>.
102
103 SSL_CTX_check_private_key() checks the consistency of a private key with
104 the corresponding certificate loaded into B<ctx>. If more than one
105 key/certificate pair (RSA/DSA) is installed, the last item installed will
106 be checked. If e.g. the last item was a RSA certificate or key, the RSA
107 key/certificate pair will be checked. SSL_check_private_key() performs
108 the same check for B<ssl>. If no key/certificate was explicitly added for
109 this B<ssl>, the last item added into B<ctx> will be checked.
110
111 =head1 NOTES
112   
113 The internal certificate store of OpenSSL can hold several private
114 key/certificate pairs at a time. The certificate used depends on the
115 cipher selected, see also L<SSL_CTX_set_cipher_list(3)>.
116
117 When reading certificates and private keys from file, files of type
118 SSL_FILETYPE_ASN1 (also known as B<DER>, binary encoding) can only contain
119 one certificate or private key, consequently 
120 SSL_CTX_use_certificate_chain_file() is only applicable to PEM formatting.
121 Files of type SSL_FILETYPE_PEM can contain more than one item.
122
123 SSL_CTX_use_certificate_chain_file() adds the first certificate found
124 in the file to the certificate store. The other certificates are added
125 to the store of chain certificates using L<SSL_CTX_add1_chain_cert(3)>. Note: versions of OpenSSL before 1.0.2 only had a single
126 certificate chain store for all certificate types, OpenSSL 1.0.2 and later
127 have a separate chain store for each type. SSL_CTX_use_certificate_chain_file() 
128 should be used instead of the SSL_CTX_use_certificate_file() function in order
129 to allow the use of complete certificate chains even when no trusted CA
130 storage is used or when the CA issuing the certificate shall not be added to
131 the trusted CA storage.
132
133 If additional certificates are needed to complete the chain during the
134 TLS negotiation, CA certificates are additionally looked up in the
135 locations of trusted CA certificates, see
136 L<SSL_CTX_load_verify_locations(3)>.
137
138 The private keys loaded from file can be encrypted. In order to successfully
139 load encrypted keys, a function returning the passphrase must have been
140 supplied, see
141 L<SSL_CTX_set_default_passwd_cb(3)>.
142 (Certificate files might be encrypted as well from the technical point
143 of view, it however does not make sense as the data in the certificate
144 is considered public anyway.)
145
146 =head1 RETURN VALUES
147
148 On success, the functions return 1.
149 Otherwise check out the error stack to find out the reason.
150
151 =head1 SEE ALSO
152
153 L<ssl(3)>, L<SSL_new(3)>, L<SSL_clear(3)>,
154 L<SSL_CTX_load_verify_locations(3)>,
155 L<SSL_CTX_set_default_passwd_cb(3)>,
156 L<SSL_CTX_set_cipher_list(3)>,
157 L<SSL_CTX_set_client_cert_cb(3)>,
158 L<SSL_CTX_add_extra_chain_cert(3)>
159
160 =head1 HISTORY
161
162 Support for DER encoded private keys (SSL_FILETYPE_ASN1) in
163 SSL_CTX_use_PrivateKey_file() and SSL_use_PrivateKey_file() was added
164 in 0.9.8 .
165
166 =cut