SSL_CTX_use_certificate.pod 9.9 KB

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