Standard preamble:
========================================================================
..
.... Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================
Title "SSL_CTX_USE_CERTIFICATE 3ossl"
way too many mistakes in technical documents.
The SSL_CTX_* class of functions loads the certificates and keys into the \s-1SSL_CTX\s0 object ctx. The information is passed to \s-1SSL\s0 objects ssl created from ctx with SSL_new\|(3) by copying, so that changes applied to ctx do not propagate to already existing \s-1SSL\s0 objects.
The SSL_* class of functions only loads certificates and keys into a specific \s-1SSL\s0 object. The specific information is kept, when \fBSSL_clear\|(3) is called for this \s-1SSL\s0 object.
\fBSSL_CTX_use_certificate() loads the certificate x into ctx, \fBSSL_use_certificate() loads x into ssl. The rest of the certificates needed to form the complete certificate chain can be specified using the \fBSSL_CTX_add_extra_chain_cert\|(3) function.
\fBSSL_CTX_use_certificate_ASN1() loads the \s-1ASN1\s0 encoded certificate from the memory location d (with length len) into ctx, \fBSSL_use_certificate_ASN1() loads the \s-1ASN1\s0 encoded certificate into ssl.
\fBSSL_CTX_use_certificate_file() loads the first certificate stored in file into ctx. The formatting type of the certificate must be specified from the known types \s-1SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.\s0 \fBSSL_use_certificate_file() loads the certificate from file into ssl. See the \s-1NOTES\s0 section on why SSL_CTX_use_certificate_chain_file() should be preferred.
\fBSSL_CTX_use_certificate_chain_file() loads a certificate chain from \fBfile into ctx. The certificates must be in \s-1PEM\s0 format and must be sorted starting with the subject's certificate (actual client or server certificate), followed by intermediate \s-1CA\s0 certificates if applicable, and ending at the highest level (root) \s-1CA.\s0 SSL_use_certificate_chain_file() is similar except it loads the certificate chain into ssl.
\fBSSL_CTX_use_PrivateKey() adds pkey as private key to ctx. \fBSSL_CTX_use_RSAPrivateKey() adds the private key rsa of type \s-1RSA\s0 to ctx. SSL_use_PrivateKey() adds pkey as private key to ssl; \fBSSL_use_RSAPrivateKey() adds rsa as private key of type \s-1RSA\s0 to ssl. If a certificate has already been set and the private key does not belong to the certificate an error is returned. To change a [certificate/private-key] pair, the new certificate needs to be set first with SSL_use_certificate() or \fBSSL_CTX_use_certificate() before setting the private key with \fBSSL_CTX_use_PrivateKey() or SSL_use_PrivateKey().
\fBSSL_CTX_use_cert_and_key() and SSL_use_cert_and_key() assign the X.509 certificate x, private key key, and certificate chain onto the corresponding ssl or ctx. The pkey argument must be the private key of the X.509 certificate x. If the override argument is 0, then \fBx, pkey and chain are set only if all were not previously set. If override is non-0, then the certificate, private key and chain certs are always set. If pkey is \s-1NULL,\s0 then the public key of x is used as the private key. This is intended to be used with hardware (via the \s-1ENGINE\s0 interface) that stores the private key securely, such that it cannot be accessed by OpenSSL. The reference count of the public key is incremented (twice if there is no private key); it is not copied nor duplicated. This allows all private key validations checks to succeed without an actual private key being assigned via SSL_CTX_use_PrivateKey(), etc.
\fBSSL_CTX_use_PrivateKey_ASN1() adds the private key of type pk stored at memory location d (length len) to ctx. \fBSSL_CTX_use_RSAPrivateKey_ASN1() adds the private key of type \s-1RSA\s0 stored at memory location d (length len) to ctx. \fBSSL_use_PrivateKey_ASN1() and SSL_use_RSAPrivateKey_ASN1() add the private key to ssl.
\fBSSL_CTX_use_PrivateKey_file() adds the first private key found in \fBfile to ctx. The formatting type of the private key must be specified from the known types \s-1SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.\s0 \fBSSL_CTX_use_RSAPrivateKey_file() adds the first private \s-1RSA\s0 key found in \fBfile to ctx. SSL_use_PrivateKey_file() adds the first private key found in file to ssl; SSL_use_RSAPrivateKey_file() adds the first private \s-1RSA\s0 key found to ssl.
\fBSSL_CTX_check_private_key() checks the consistency of a private key with the corresponding certificate loaded into ctx. If more than one key/certificate pair (\s-1RSA/DSA\s0) is installed, the last item installed will be checked. If e.g. the last item was an \s-1RSA\s0 certificate or key, the \s-1RSA\s0 key/certificate pair will be checked. SSL_check_private_key() performs the same check for ssl. If no key/certificate was explicitly added for this ssl, the last item added into ctx will be checked.
When reading certificates and private keys from file, files of type \s-1SSL_FILETYPE_ASN1\s0 (also known as \s-1DER\s0, binary encoding) can only contain one certificate or private key, consequently \fBSSL_CTX_use_certificate_chain_file() is only applicable to \s-1PEM\s0 formatting. Files of type \s-1SSL_FILETYPE_PEM\s0 can contain more than one item.
\fBSSL_CTX_use_certificate_chain_file() adds the first certificate found in the file to the certificate store. The other certificates are added to the store of chain certificates using SSL_CTX_add1_chain_cert\|(3). Note: versions of OpenSSL before 1.0.2 only had a single certificate chain store for all certificate types, OpenSSL 1.0.2 and later have a separate chain store for each type. SSL_CTX_use_certificate_chain_file() should be used instead of the SSL_CTX_use_certificate_file() function in order to allow the use of complete certificate chains even when no trusted \s-1CA\s0 storage is used or when the \s-1CA\s0 issuing the certificate shall not be added to the trusted \s-1CA\s0 storage.
If additional certificates are needed to complete the chain during the \s-1TLS\s0 negotiation, \s-1CA\s0 certificates are additionally looked up in the locations of trusted \s-1CA\s0 certificates, see \fBSSL_CTX_load_verify_locations\|(3).
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 \fBSSL_CTX_set_default_passwd_cb\|(3). (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.)
All of the functions to set a new certificate will replace any existing certificate of the same type that has already been set. Similarly all of the functions to set a new private key will replace any private key that has already been set. Applications should call SSL_CTX_check_private_key\|(3) or \fBSSL_check_private_key\|(3) as appropriate after loading a new certificate and private key to confirm that the certificate and key match.
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.