
#use wml::openssl-macros area=docs page=SSL_CTX_use_certificate

<title>Documents, SSL_CTX_use_certificate(3)</title>

<h1>SSL_CTX_use_certificate(3)</h1>

#use wml::imp::generic

{:
## What's this? [[s|(<STRONG>[^<].+?)</A>(</STRONG><DD>)|$1$2|sg]]
[[s|<P>\s+<P>|<P>|sg]]
[[s|<P>\s+</|</|sg]]
[[s|<DD>\s*<DT>|<DD>&nbsp;<DT>|sg]]
[[s|<DD>\s*</DL>|<DD>&nbsp;</DL>|sg]]
[[s|\[|&#91;|sg]]
[[s|\]|&#93;|sg]]

<!-- INDEX BEGIN -->

<UL>

	<LI><A HREF="#NAME">NAME</A>
	<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
	<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
	<LI><A HREF="#NOTES">NOTES</A>
	<LI><A HREF="#RETURN_VALUES">RETURN VALUES</A>
	<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
	<LI><A HREF="#HISTORY">HISTORY</A>
</UL>
<!-- INDEX END -->

<HR>
<P>
<HR>
<H1><A NAME="NAME">NAME</A></H1>
<P>
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

</P>
<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
<PRE> #include &lt;openssl/ssl.h&gt;
</PRE>
<PRE> int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
 int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len, unsigned char *d);
 int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type);
 int SSL_use_certificate(SSL *ssl, X509 *x);
 int SSL_use_certificate_ASN1(SSL *ssl, unsigned char *d, int len);
 int SSL_use_certificate_file(SSL *ssl, const char *file, int type);
</PRE>
<PRE> int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
</PRE>
<PRE> int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
 int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx, unsigned char *d,
                                 long len);
 int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);
 int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
 int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, unsigned char *d, long len);
 int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);
 int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
 int SSL_use_PrivateKey_ASN1(int pk,SSL *ssl, unsigned char *d, long len);
 int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
 int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
 int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, unsigned char *d, long len);
 int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
</PRE>
<PRE> int SSL_CTX_check_private_key(const SSL_CTX *ctx);
 int SSL_check_private_key(const SSL *ssl);
</PRE>
<P>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
<P>
These functions load the certificates and private keys into the SSL_CTX or
SSL object, respectively.

</P>
<P>
The SSL_CTX_* class of functions loads the certificates and keys into the
SSL_CTX object <STRONG>ctx</STRONG>. The information is passed to SSL objects <STRONG>ssl</STRONG>
created from <STRONG>ctx</STRONG> with <A HREF="../ssl/SSL_new.html#">SSL_new(3)</A> by copying, so that changes applied to <STRONG>ctx</STRONG> do not propagate to already existing SSL objects.

</P>
<P>
The SSL_* class of functions only loads certificates and keys into a
specific SSL object. The specific information is kept, when
<A HREF="../ssl/SSL_clear.html#">SSL_clear(3)</A> is called for this SSL object.

</P>
<P>
<CODE>SSL_CTX_use_certificate()</CODE> loads the certificate <STRONG>x</STRONG> into <STRONG>ctx</STRONG>, <CODE>SSL_use_certificate()</CODE> loads <STRONG>x</STRONG> into <STRONG>ssl</STRONG>. The rest of the certificates needed to form the complete certificate
chain can be specified using the
<A HREF="../ssl/SSL_CTX_add_extra_chain_cert.html#">SSL_CTX_add_extra_chain_cert(3)</A>
function.

</P>
<P>
<CODE>SSL_CTX_use_certificate_ASN1()</CODE> loads the ASN1 encoded
certificate from the memory location <STRONG>d</STRONG> (with length <STRONG>len</STRONG>) into <STRONG>ctx</STRONG>, <CODE>SSL_use_certificate_ASN1()</CODE> loads the ASN1 encoded
certificate into <STRONG>ssl</STRONG>.

</P>
<P>
<CODE>SSL_CTX_use_certificate_file()</CODE> loads the first certificate
stored in <STRONG>file</STRONG>
into <STRONG>ctx</STRONG>. The formatting <STRONG>type</STRONG> of the certificate must be specified from the known types SSL_FILETYPE_PEM,
SSL_FILETYPE_ASN1. <CODE>SSL_use_certificate_file()</CODE> loads the
certificate from <STRONG>file</STRONG> into <STRONG>ssl</STRONG>. See the NOTES section on why
<CODE>SSL_CTX_use_certificate_chain_file()</CODE> should be preferred.

</P>
<P>
<CODE>SSL_CTX_use_certificate_chain_file()</CODE> loads a certificate chain
from 
<STRONG>file</STRONG> into <STRONG>ctx</STRONG>. The certificates must be in PEM format and must be sorted starting with
the subject's certificate (actual client or server certificate), followed
by intermediate CA certificates if applicable, and ending at the highest
level (root) CA. There is no corresponding function working on a single SSL
object.

</P>
<P>
<CODE>SSL_CTX_use_PrivateKey()</CODE> adds <STRONG>pkey</STRONG> as private key to <STRONG>ctx</STRONG>. <CODE>SSL_CTX_use_RSAPrivateKey()</CODE> adds the private key <STRONG>rsa</STRONG> of type RSA to <STRONG>ctx</STRONG>. <CODE>SSL_use_PrivateKey()</CODE> adds <STRONG>pkey</STRONG> as private key to <STRONG>ssl</STRONG>; <CODE>SSL_use_RSAPrivateKey()</CODE> adds <STRONG>rsa</STRONG> as private key of type RSA to <STRONG>ssl</STRONG>. If a certificate has already been set and the private does not belong to
the certificate an error is returned. To change a certificate, private key
pair the new certificate needs to be set with
<CODE>SSL_use_certificate()</CODE> or
<CODE>SSL_CTX_use_certificate()</CODE> before setting the private key with
<CODE>SSL_CTX_use_PrivateKey()</CODE> or <CODE>SSL_use_PrivateKey().</CODE> 

</P>
<P>
<CODE>SSL_CTX_use_PrivateKey_ASN1()</CODE> adds the private key of type <STRONG>pk</STRONG>
stored at memory location <STRONG>d</STRONG> (length <STRONG>len</STRONG>) to <STRONG>ctx</STRONG>. <CODE>SSL_CTX_use_RSAPrivateKey_ASN1()</CODE> adds the private key of
type RSA stored at memory location <STRONG>d</STRONG> (length <STRONG>len</STRONG>) to <STRONG>ctx</STRONG>. <CODE>SSL_use_PrivateKey_ASN1()</CODE> and
<CODE>SSL_use_RSAPrivateKey_ASN1()</CODE> add the private key to <STRONG>ssl</STRONG>.

</P>
<P>
<CODE>SSL_CTX_use_PrivateKey_file()</CODE> adds the first private key found
in
<STRONG>file</STRONG> to <STRONG>ctx</STRONG>. The formatting <STRONG>type</STRONG> of the certificate must be specified from the known types SSL_FILETYPE_PEM,
SSL_FILETYPE_ASN1. <CODE>SSL_CTX_use_RSAPrivateKey_file()</CODE> adds the
first private RSA key found in
<STRONG>file</STRONG> to <STRONG>ctx</STRONG>. <CODE>SSL_use_PrivateKey_file()</CODE> adds the first private key found
in <STRONG>file</STRONG> to <STRONG>ssl</STRONG>; <CODE>SSL_use_RSAPrivateKey_file()</CODE> adds the first private RSA key
found to <STRONG>ssl</STRONG>.

</P>
<P>
<CODE>SSL_CTX_check_private_key()</CODE> checks the consistency of a
private key with the corresponding certificate loaded into <STRONG>ctx</STRONG>. If more than one key/certificate pair (RSA/DSA) is installed, the last
item installed will be checked. If e.g. the last item was a RSA certificate
or key, the RSA key/certificate pair will be checked.
<CODE>SSL_check_private_key()</CODE> performs the same check for <STRONG>ssl</STRONG>. If no key/certificate was explicitly added for this <STRONG>ssl</STRONG>, the last item added into <STRONG>ctx</STRONG> will be checked.

</P>
<P>
<HR>
<H1><A NAME="NOTES_The_internal_certificate_s">NOTES
  
The internal certificate store of OpenSSL can hold two private key/certificate
pairs at a time: one key/certificate of type RSA and one key/certificate
of type DSA. The certificate used depends on the cipher select, see
also &lt;A HREF=&quot;../ssl/SSL_CTX_set_cipher_list.html#&quot;&gt;SSL_CTX_set_cipher_list(3)&lt;/A&gt;.</A></H1>
<P>
When reading certificates and private keys from file, files of type
SSL_FILETYPE_ASN1 (also known as <STRONG>DER</STRONG>, binary encoding) can only contain one certificate or private key,
consequently <CODE>SSL_CTX_use_certificate_chain_file()</CODE> is only
applicable to PEM formatting. Files of type SSL_FILETYPE_PEM can contain
more than one item.

</P>
<P>
<CODE>SSL_CTX_use_certificate_chain_file()</CODE> adds the first
certificate found in the file to the certificate store. The other
certificates are added to the store of chain certificates using
<A HREF="../ssl/SSL_CTX_add_extra_chain_cert.html#">SSL_CTX_add_extra_chain_cert(3)</A>. There exists only one extra chain store, so that the same chain is
appended to both types of certificates, RSA and DSA! If it is not intended
to use both type of certificate at the same time, it is recommended to use
the <CODE>SSL_CTX_use_certificate_chain_file()</CODE> instead of the
<CODE>SSL_CTX_use_certificate_file()</CODE> function in order to allow the
use of complete certificate chains even when no trusted CA storage is used
or when the CA issuing the certificate shall not be added to the trusted CA
storage.

</P>
<P>
If additional certificates are needed to complete the chain during the TLS
negotiation, CA certificates are additionally looked up in the locations of
trusted CA certificates, see
<A HREF="../ssl/SSL_CTX_load_verify_locations.html#">SSL_CTX_load_verify_locations(3)</A>.

</P>
<P>
The private keys loaded from file can be encrypted. In order to
successfully load encrypted keys, a function returning the passphrase must
have been supplied, see
<A HREF="../ssl/SSL_CTX_set_default_passwd_cb.html#">SSL_CTX_set_default_passwd_cb(3)</A>. (Certificate files might be encrypted as well from the technical point of
view, it however does not make sense as the data in the certificate is
considered public anyway.)

</P>
<P>
<HR>
<H1><A NAME="RETURN_VALUES">RETURN VALUES</A></H1>
<P>
On success, the functions return 1. Otherwise check out the error stack to
find out the reason.

</P>
<P>
<HR>
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
<A HREF="../ssl/ssl.html#">ssl(3)</A>, <A HREF="../ssl/SSL_new.html#">SSL_new(3)</A>, <A HREF="../ssl/SSL_clear.html#">SSL_clear(3)</A>,
<A HREF="../ssl/SSL_CTX_load_verify_locations.html#">SSL_CTX_load_verify_locations(3)</A>,
<A HREF="../ssl/SSL_CTX_set_default_passwd_cb.html#">SSL_CTX_set_default_passwd_cb(3)</A>,
<A HREF="../ssl/SSL_CTX_set_cipher_list.html#">SSL_CTX_set_cipher_list(3)</A>,
<A HREF="../ssl/SSL_CTX_set_client_cert_cb.html#">SSL_CTX_set_client_cert_cb(3)</A>,
<A HREF="../ssl/SSL_CTX_add_extra_chain_cert.html#">SSL_CTX_add_extra_chain_cert(3)</A>



</P>
<P>
<HR>
<H1><A NAME="HISTORY">HISTORY</A></H1>
<P>
Support for DER encoded private keys (SSL_FILETYPE_ASN1) in
<CODE>SSL_CTX_use_PrivateKey_file()</CODE> and
<CODE>SSL_use_PrivateKey_file()</CODE> was added in 0.9.8 .

</P>
:}

