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
  20  int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
  21  int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx, unsigned char *d,
  22                                  long len);
  23  int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);
  24  int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
  25  int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, unsigned char *d, long len);
  26  int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);
  27  int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
  28  int SSL_use_PrivateKey_ASN1(int pk,SSL *ssl, unsigned char *d, long len);
  29  int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
  30  int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
  31  int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, unsigned char *d, long len);
  32  int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
  33
  34  int SSL_CTX_check_private_key(SSL_CTX *ctx);
  35  int SSL_check_private_key(SSL *ssl);
  36
  37 =head1 DESCRIPTION
  38
  39 These functions load the certificates and private keys into the SSL_CTX
  40 or SSL object, respectively.
  41
  42 The SSL_CTX_* class of functions loads the certificates and keys into the
  43 SSL_CTX object B<ctx>. The information is passed to SSL objects B<ssl>
  44 created from B<ctx> with L<SSL_new(3)|SSL_new(3)> by copying, so that
  45 changes applied to B<ctx> do not propagate to already existing SSL objects.
  46
  47 The SSL_* class of functions only loads certificates and keys into a
  48 specific SSL object. The specific information is kept, when
  49 L<SSL_clear(3)|SSL_clear(3)> is called for this SSL object.
  50
  51 SSL_CTX_use_certificate() loads the certificate B<x> into B<ctx>,
  52 SSL_use_certificate() loads B<x> into B<ssl>.
  53
  54 SSL_CTX_use_certificate_ASN1() loads the ASN1 encoded certificate from
  55 the memory location B<d> (with length B<len>) into B<ctx>,
  56 SSL_use_certificate_ASN1() loads the ASN1 encoded certificate into B<ssl>.
  57
  58 SSL_CTX_use_certificate_file() loads the first certificate stored in B<file>
  59 into B<ctx>. The formatting B<type> of the certificate must be specified
  60 from the known types SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.
  61 SSL_use_certificate_file() loads the certificate from B<file> into B<ssl>.
  62
  63 SSL_CTX_use_certificate_chain_file() loads a certificate chain from
  64 B<file> into B<ctx>. The certificates must be in PEM format and must
  65 be sorted starting with the certificate to the highest level (root CA).
  66 There is no corresponding function working on a single SSL object.
  67
  68 SSL_CTX_use_PrivateKey() adds B<pkey> as private key to B<ctx>.
  69 SSL_CTX_use_RSAPrivateKey() adds the private key B<rsa> of type RSA
  70 to B<ctx>. SSL_use_PrivateKey() adds B<pkey> as private key to B<ssl>;
  71 SSL_use_RSAPrivateKey() adds B<rsa> as private key of type RSA to B<ssl>.
  72
  73 SSL_CTX_use_PrivateKey_ASN1() adds the private key of type B<pk>
  74 stored at memory location B<d> (length B<len>) to B<ctx>.
  75 SSL_CTX_use_RSAPrivateKey_ASN1() adds the private key of type RSA
  76 stored at memory location B<d> (length B<len>) to B<ctx>.
  77 SSL_use_PrivateKey_ASN1() and SSL_use_RSAPrivateKey_ASN1() add the private
  78 key to B<ssl>.
  79
  80 SSL_CTX_use_PrivateKey_file() adds the first private key found in
  81 B<file> to B<ctx>. The formatting B<type> of the certificate must be specified
  82 from the known types SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.
  83 SSL_CTX_use_RSAPrivateKey_file() adds the first private RSA key found in
  84 B<file> to B<ctx>. SSL_use_PrivateKey_file() adds the first private key found
  85 in B<file> to B<ssl>; SSL_use_RSAPrivateKey_file() adds the first private
  86 RSA key found to B<ssl>.
  87
  88 SSL_CTX_check_private_key() checks the consistency of a private key with
  89 the corresponding certificate loaded into B<ctx>. If more than one
  90 key/certificate pair (RSA/DSA) is installed, the last item installed will
  91 be checked. If e.g. the last item was a RSA certificate or key, the RSA
  92 key/certificate pair will be checked. SSL_check_private_key() performs
  93 the same check for B<ssl>. If no key/certificate was explicitly added for
  94 this B<ssl>, the last item added into B<ctx> will be checked.
  95
  96 =head1 NOTES
  97
  98 The internal certificate store of OpenSSL can hold two private key/certificate
  99 pairs at a time: one key/certificate of type RSA and one key/certificate
 100 of type DSA. The certificate used depends on the cipher select, see
 101 also L<SSL_CTX_set_cipher_list(3)|SSL_CTX_set_cipher_list(3)>.
 102
 103 When reading certificates and private keys from file, files of type
 104 SSL_FILETYPE_ASN1 (also known as B<DER>, binary encoding) can only contain
 105 one certificate or private key, consequently
 106 SSL_CTX_use_certificate_chain_file() is only applicable to PEM formatting.
 107 Files of type SSL_FILETYPE_PEM can contain more than one item.
 108
 109 SSL_CTX_use_certificate_chain_file() adds the first certificate found
 110 in the file to the certificate store. The other certificates are added
 111 to the store of chain certificates using
 112 L<SSL_CTX_add_extra_chain_cert(3)|SSL_CTX_add_extra_chain_cert(3)>.
 113 There exists only one extra chain store, so that the same chain is appended
 114 to both types of certificates, RSA and DSA!
 115
 116 If additional certificates are needed to complete the chain during the
 117 TLS negotiation, CA certificates are additionally looked up in the
 118 locations of trusted CA certificates, see
 119 L<SSL_CTX_load_verify_locations(3)|SSL_CTX_load_verify_locations(3)>.
 120
 121 The private keys loaded from file can be encrypted. In order to successfully
 122 load encrypted keys, a function returning the passphrase must have been
 123 supplied, see
 124 L<SSL_CTX_set_default_passwd_cb(3)|SSL_CTX_set_default_passwd_cb(3)>.
 125 (Certificate files might be encrypted as well from the technical point
 126 of view, it however does not make sense as the data in the certificate
 127 is considered public anyway.)
 128
 129 =head1 RETURN VALUES
 130
 131 On success, the functions return 1.
 132 Otherwise check out the error stack to find out the reason.
 133
 134 =head1 SEE ALSO
 135
 136 L<ssl(3)|ssl(3)>, L<SSL_new(3)|SSL_new(3)>, L<SSL_clear(3)|SSL_clear(3)>,
 137 L<SSL_CTX_load_verify_locations(3)|SSL_CTX_load_verify_locations(3)>,
 138 L<SSL_CTX_set_default_passwd_cb(3)|SSL_CTX_set_default_passwd_cb(3)>,
 139 L<SSL_CTX_set_cipher_list(3)|SSL_CTX_set_cipher_list(3)>,
 140 L<SSL_CTX_add_extra_chain_cert(3)|SSL_CTX_add_extra_chain_cert(3)>
 141
 142 =cut