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