secure/lib/libcrypto/man/man3/SSL_CTX_use_certificate.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_CTX_USE_CERTIFICATE 3"
 136 .TH SSL_CTX_USE_CERTIFICATE 3 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 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_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, SSL_CTX_use_cert_and_key, SSL_use_cert_and_key \&\- load certificate and key data
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
 149 \& int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len, unsigned char *d);
 150 \& int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type);
 151 \& int SSL_use_certificate(SSL *ssl, X509 *x);
 152 \& int SSL_use_certificate_ASN1(SSL *ssl, unsigned char *d, int len);
 153 \& int SSL_use_certificate_file(SSL *ssl, const char *file, int type);
 154 \&
 155 \& int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
 156 \& int SSL_use_certificate_chain_file(SSL *ssl, const char *file);
 157 \&
 158 \& int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
 159 \& int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx, unsigned char *d,
 160 \&                                 long len);
 161 \& int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);
 162 \& int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
 163 \& int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, unsigned char *d, long len);
 164 \& int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);
 165 \& int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
 166 \& int SSL_use_PrivateKey_ASN1(int pk, SSL *ssl, unsigned char *d, long len);
 167 \& int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
 168 \& int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
 169 \& int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, unsigned char *d, long len);
 170 \& int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
 171 \&
 172 \& int SSL_CTX_check_private_key(const SSL_CTX *ctx);
 173 \& int SSL_check_private_key(const SSL *ssl);
 174 \&
 175 \& int SSL_CTX_use_cert_and_key(SSL_CTX *ctx, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);
 176 \& int SSL_use_cert_and_key(SSL *ssl, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);
 177 .Ve
 178 .SH "DESCRIPTION"
 179 .IX Header "DESCRIPTION"
 180 These functions load the certificates and private keys into the \s-1SSL_CTX\s0
 181 or \s-1SSL\s0 object, respectively.
 182 .PP
 183 The SSL_CTX_* class of functions loads the certificates and keys into the
 184 \&\s-1SSL_CTX\s0 object \fBctx\fR. The information is passed to \s-1SSL\s0 objects \fBssl\fR
 185 created from \fBctx\fR with \fBSSL_new\fR\|(3) by copying, so that
 186 changes applied to \fBctx\fR do not propagate to already existing \s-1SSL\s0 objects.
 187 .PP
 188 The SSL_* class of functions only loads certificates and keys into a
 189 specific \s-1SSL\s0 object. The specific information is kept, when
 190 \&\fBSSL_clear\fR\|(3) is called for this \s-1SSL\s0 object.
 191 .PP
 192 \&\fBSSL_CTX_use_certificate()\fR loads the certificate \fBx\fR into \fBctx\fR,
 193 \&\fBSSL_use_certificate()\fR loads \fBx\fR into \fBssl\fR. The rest of the
 194 certificates needed to form the complete certificate chain can be
 195 specified using the
 196 \&\fBSSL_CTX_add_extra_chain_cert\fR\|(3)
 197 function.
 198 .PP
 199 \&\fBSSL_CTX_use_certificate_ASN1()\fR loads the \s-1ASN1\s0 encoded certificate from
 200 the memory location \fBd\fR (with length \fBlen\fR) into \fBctx\fR,
 201 \&\fBSSL_use_certificate_ASN1()\fR loads the \s-1ASN1\s0 encoded certificate into \fBssl\fR.
 202 .PP
 203 \&\fBSSL_CTX_use_certificate_file()\fR loads the first certificate stored in \fBfile\fR
 204 into \fBctx\fR. The formatting \fBtype\fR of the certificate must be specified
 205 from the known types \s-1SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.\s0
 206 \&\fBSSL_use_certificate_file()\fR loads the certificate from \fBfile\fR into \fBssl\fR.
 207 See the \s-1NOTES\s0 section on why \fBSSL_CTX_use_certificate_chain_file()\fR
 208 should be preferred.
 209 .PP
 210 \&\fBSSL_CTX_use_certificate_chain_file()\fR loads a certificate chain from
 211 \&\fBfile\fR into \fBctx\fR. The certificates must be in \s-1PEM\s0 format and must
 212 be sorted starting with the subject's certificate (actual client or server
 213 certificate), followed by intermediate \s-1CA\s0 certificates if applicable, and
 214 ending at the highest level (root) \s-1CA.\s0 \fBSSL_use_certificate_chain_file()\fR is
 215 similar except it loads the certificate chain into \fBssl\fR.
 216 .PP
 217 \&\fBSSL_CTX_use_PrivateKey()\fR adds \fBpkey\fR as private key to \fBctx\fR.
 218 \&\fBSSL_CTX_use_RSAPrivateKey()\fR adds the private key \fBrsa\fR of type \s-1RSA\s0
 219 to \fBctx\fR. \fBSSL_use_PrivateKey()\fR adds \fBpkey\fR as private key to \fBssl\fR;
 220 \&\fBSSL_use_RSAPrivateKey()\fR adds \fBrsa\fR as private key of type \s-1RSA\s0 to \fBssl\fR.
 221 If a certificate has already been set and the private does not belong
 222 to the certificate an error is returned. To change a certificate, private
 223 key pair the new certificate needs to be set with \fBSSL_use_certificate()\fR
 224 or \fBSSL_CTX_use_certificate()\fR before setting the private key with
 225 \&\fBSSL_CTX_use_PrivateKey()\fR or \fBSSL_use_PrivateKey()\fR.
 226 .PP
 227 \&\fBSSL_CTX_use_cert_and_key()\fR and \fBSSL_use_cert_and_key()\fR assign the X.509
 228 certificate \fBx\fR, private key \fBkey\fR, and certificate \fBchain\fR onto the
 229 corresponding \fBssl\fR or \fBctx\fR. The \fBpkey\fR argument must be the private
 230 key of the X.509 certificate \fBx\fR. If the \fBoverride\fR argument is 0, then
 231 \&\fBx\fR, \fBpkey\fR and \fBchain\fR are set only if all were not previously set.
 232 If \fBoverride\fR is non\-0, then the certificate, private key and chain certs
 233 are always set. If \fBpkey\fR is \s-1NULL,\s0 then the public key of \fBx\fR is used as
 234 the private key. This is intended to be used with hardware (via the \s-1ENGINE\s0
 235 interface) that stores the private key securely, such that it cannot be
 236 accessed by OpenSSL. The reference count of the public key is incremented
 237 (twice if there is no private key); it is not copied nor duplicated. This
 238 allows all private key validations checks to succeed without an actual
 239 private key being assigned via \fBSSL_CTX_use_PrivateKey()\fR, etc.
 240 .PP
 241 \&\fBSSL_CTX_use_PrivateKey_ASN1()\fR adds the private key of type \fBpk\fR
 242 stored at memory location \fBd\fR (length \fBlen\fR) to \fBctx\fR.
 243 \&\fBSSL_CTX_use_RSAPrivateKey_ASN1()\fR adds the private key of type \s-1RSA\s0
 244 stored at memory location \fBd\fR (length \fBlen\fR) to \fBctx\fR.
 245 \&\fBSSL_use_PrivateKey_ASN1()\fR and \fBSSL_use_RSAPrivateKey_ASN1()\fR add the private
 246 key to \fBssl\fR.
 247 .PP
 248 \&\fBSSL_CTX_use_PrivateKey_file()\fR adds the first private key found in
 249 \&\fBfile\fR to \fBctx\fR. The formatting \fBtype\fR of the private key must be specified
 250 from the known types \s-1SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.\s0
 251 \&\fBSSL_CTX_use_RSAPrivateKey_file()\fR adds the first private \s-1RSA\s0 key found in
 252 \&\fBfile\fR to \fBctx\fR. \fBSSL_use_PrivateKey_file()\fR adds the first private key found
 253 in \fBfile\fR to \fBssl\fR; \fBSSL_use_RSAPrivateKey_file()\fR adds the first private
 254 \&\s-1RSA\s0 key found to \fBssl\fR.
 255 .PP
 256 \&\fBSSL_CTX_check_private_key()\fR checks the consistency of a private key with
 257 the corresponding certificate loaded into \fBctx\fR. If more than one
 258 key/certificate pair (\s-1RSA/DSA\s0) is installed, the last item installed will
 259 be checked. If e.g. the last item was a \s-1RSA\s0 certificate or key, the \s-1RSA\s0
 260 key/certificate pair will be checked. \fBSSL_check_private_key()\fR performs
 261 the same check for \fBssl\fR. If no key/certificate was explicitly added for
 262 this \fBssl\fR, the last item added into \fBctx\fR will be checked.
 263 .SH "NOTES"
 264 .IX Header "NOTES"
 265 The internal certificate store of OpenSSL can hold several private
 266 key/certificate pairs at a time. The certificate used depends on the
 267 cipher selected, see also \fBSSL_CTX_set_cipher_list\fR\|(3).
 268 .PP
 269 When reading certificates and private keys from file, files of type
 270 \&\s-1SSL_FILETYPE_ASN1\s0 (also known as \fB\s-1DER\s0\fR, binary encoding) can only contain
 271 one certificate or private key, consequently
 272 \&\fBSSL_CTX_use_certificate_chain_file()\fR is only applicable to \s-1PEM\s0 formatting.
 273 Files of type \s-1SSL_FILETYPE_PEM\s0 can contain more than one item.
 274 .PP
 275 \&\fBSSL_CTX_use_certificate_chain_file()\fR adds the first certificate found
 276 in the file to the certificate store. The other certificates are added
 277 to the store of chain certificates using \fBSSL_CTX_add1_chain_cert\fR\|(3). Note: versions of OpenSSL before 1.0.2 only had a single
 278 certificate chain store for all certificate types, OpenSSL 1.0.2 and later
 279 have a separate chain store for each type. \fBSSL_CTX_use_certificate_chain_file()\fR
 280 should be used instead of the \fBSSL_CTX_use_certificate_file()\fR function in order
 281 to allow the use of complete certificate chains even when no trusted \s-1CA\s0
 282 storage is used or when the \s-1CA\s0 issuing the certificate shall not be added to
 283 the trusted \s-1CA\s0 storage.
 284 .PP
 285 If additional certificates are needed to complete the chain during the
 286 \&\s-1TLS\s0 negotiation, \s-1CA\s0 certificates are additionally looked up in the
 287 locations of trusted \s-1CA\s0 certificates, see
 288 \&\fBSSL_CTX_load_verify_locations\fR\|(3).
 289 .PP
 290 The private keys loaded from file can be encrypted. In order to successfully
 291 load encrypted keys, a function returning the passphrase must have been
 292 supplied, see
 293 \&\fBSSL_CTX_set_default_passwd_cb\fR\|(3).
 294 (Certificate files might be encrypted as well from the technical point
 295 of view, it however does not make sense as the data in the certificate
 296 is considered public anyway.)
 297 .PP
 298 All of the functions to set a new certificate will replace any existing
 299 certificate of the same type that has already been set. Similarly all of the
 300 functions to set a new private key will replace any private key that has already
 301 been set. Applications should call \fBSSL_CTX_check_private_key\fR\|(3) or
 302 \&\fBSSL_check_private_key\fR\|(3) as appropriate after loading a new certificate and
 303 private key to confirm that the certificate and key match.
 304 .SH "RETURN VALUES"
 305 .IX Header "RETURN VALUES"
 306 On success, the functions return 1.
 307 Otherwise check out the error stack to find out the reason.
 308 .SH "SEE ALSO"
 309 .IX Header "SEE ALSO"
 310 \&\fBssl\fR\|(7), \fBSSL_new\fR\|(3), \fBSSL_clear\fR\|(3),
 311 \&\fBSSL_CTX_load_verify_locations\fR\|(3),
 312 \&\fBSSL_CTX_set_default_passwd_cb\fR\|(3),
 313 \&\fBSSL_CTX_set_cipher_list\fR\|(3),
 314 \&\fBSSL_CTX_set_client_CA_list\fR\|(3),
 315 \&\fBSSL_CTX_set_client_cert_cb\fR\|(3),
 316 \&\fBSSL_CTX_add_extra_chain_cert\fR\|(3)
 317 .SH "COPYRIGHT"
 318 .IX Header "COPYRIGHT"
 319 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 320 .PP
 321 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 322 this file except in compliance with the License.  You can obtain a copy
 323 in the file \s-1LICENSE\s0 in the source distribution or at
 324 <https://www.openssl.org/source/license.html>.