secure/lib/libcrypto/man/SSL_CTX_use_certificate.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_CTX_USE_CERTIFICATE 3"
 132 .TH SSL_CTX_USE_CERTIFICATE 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
 145 \& int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len, unsigned char *d);
 146 \& int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type);
 147 \& int SSL_use_certificate(SSL *ssl, X509 *x);
 148 \& int SSL_use_certificate_ASN1(SSL *ssl, unsigned char *d, int len);
 149 \& int SSL_use_certificate_file(SSL *ssl, const char *file, int type);
 150 \&
 151 \& int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
 152 \& int SSL_use_certificate_chain_file(SSL *ssl, const char *file);
 153 \&
 154 \& int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
 155 \& int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx, unsigned char *d,
 156 \&                                 long len);
 157 \& int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);
 158 \& int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
 159 \& int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, unsigned char *d, long len);
 160 \& int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);
 161 \& int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
 162 \& int SSL_use_PrivateKey_ASN1(int pk, SSL *ssl, unsigned char *d, long len);
 163 \& int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
 164 \& int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
 165 \& int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, unsigned char *d, long len);
 166 \& int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
 167 \&
 168 \& int SSL_CTX_check_private_key(const SSL_CTX *ctx);
 169 \& int SSL_check_private_key(const SSL *ssl);
 170 \&
 171 \& int SSL_CTX_use_cert_and_key(SSL_CTX *ctx, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);
 172 \& int SSL_use_cert_and_key(SSL *ssl, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);
 173 .Ve
 174 .SH "DESCRIPTION"
 175 .IX Header "DESCRIPTION"
 176 These functions load the certificates and private keys into the \s-1SSL_CTX\s0
 177 or \s-1SSL\s0 object, respectively.
 178 .PP
 179 The SSL_CTX_* class of functions loads the certificates and keys into the
 180 \&\s-1SSL_CTX\s0 object \fBctx\fR. The information is passed to \s-1SSL\s0 objects \fBssl\fR
 181 created from \fBctx\fR with \fISSL_new\fR\|(3) by copying, so that
 182 changes applied to \fBctx\fR do not propagate to already existing \s-1SSL\s0 objects.
 183 .PP
 184 The SSL_* class of functions only loads certificates and keys into a
 185 specific \s-1SSL\s0 object. The specific information is kept, when
 186 \&\fISSL_clear\fR\|(3) is called for this \s-1SSL\s0 object.
 187 .PP
 188 \&\fISSL_CTX_use_certificate()\fR loads the certificate \fBx\fR into \fBctx\fR,
 189 \&\fISSL_use_certificate()\fR loads \fBx\fR into \fBssl\fR. The rest of the
 190 certificates needed to form the complete certificate chain can be
 191 specified using the
 192 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3)
 193 function.
 194 .PP
 195 \&\fISSL_CTX_use_certificate_ASN1()\fR loads the \s-1ASN1\s0 encoded certificate from
 196 the memory location \fBd\fR (with length \fBlen\fR) into \fBctx\fR,
 197 \&\fISSL_use_certificate_ASN1()\fR loads the \s-1ASN1\s0 encoded certificate into \fBssl\fR.
 198 .PP
 199 \&\fISSL_CTX_use_certificate_file()\fR loads the first certificate stored in \fBfile\fR
 200 into \fBctx\fR. The formatting \fBtype\fR of the certificate must be specified
 201 from the known types \s-1SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.\s0
 202 \&\fISSL_use_certificate_file()\fR loads the certificate from \fBfile\fR into \fBssl\fR.
 203 See the \s-1NOTES\s0 section on why \fISSL_CTX_use_certificate_chain_file()\fR
 204 should be preferred.
 205 .PP
 206 \&\fISSL_CTX_use_certificate_chain_file()\fR loads a certificate chain from
 207 \&\fBfile\fR into \fBctx\fR. The certificates must be in \s-1PEM\s0 format and must
 208 be sorted starting with the subject's certificate (actual client or server
 209 certificate), followed by intermediate \s-1CA\s0 certificates if applicable, and
 210 ending at the highest level (root) \s-1CA.\s0 \fISSL_use_certificate_chain_file()\fR is
 211 similar except it loads the certificate chain into \fBssl\fR.
 212 .PP
 213 \&\fISSL_CTX_use_PrivateKey()\fR adds \fBpkey\fR as private key to \fBctx\fR.
 214 \&\fISSL_CTX_use_RSAPrivateKey()\fR adds the private key \fBrsa\fR of type \s-1RSA\s0
 215 to \fBctx\fR. \fISSL_use_PrivateKey()\fR adds \fBpkey\fR as private key to \fBssl\fR;
 216 \&\fISSL_use_RSAPrivateKey()\fR adds \fBrsa\fR as private key of type \s-1RSA\s0 to \fBssl\fR.
 217 If a certificate has already been set and the private does not belong
 218 to the certificate an error is returned. To change a certificate, private
 219 key pair the new certificate needs to be set with \fISSL_use_certificate()\fR
 220 or \fISSL_CTX_use_certificate()\fR before setting the private key with
 221 \&\fISSL_CTX_use_PrivateKey()\fR or \fISSL_use_PrivateKey()\fR.
 222 .PP
 223 \&\fISSL_CTX_use_cert_and_key()\fR and \fISSL_use_cert_and_key()\fR assign the X.509
 224 certificate \fBx\fR, private key \fBkey\fR, and certificate \fBchain\fR onto the
 225 corresponding \fBssl\fR or \fBctx\fR. The \fBpkey\fR argument must be the private
 226 key of the X.509 certificate \fBx\fR. If the \fBoverride\fR argument is 0, then
 227 \&\fBx\fR, \fBpkey\fR and \fBchain\fR are set only if all were not previously set.
 228 If \fBoverride\fR is non\-0, then the certificate, private key and chain certs
 229 are always set. If \fBpkey\fR is \s-1NULL,\s0 then the public key of \fBx\fR is used as
 230 the private key. This is intended to be used with hardware (via the \s-1ENGINE\s0
 231 interface) that stores the private key securely, such that it cannot be
 232 accessed by OpenSSL. The reference count of the public key is incremented
 233 (twice if there is no private key); it is not copied nor duplicated. This
 234 allows all private key validations checks to succeed without an actual
 235 private key being assigned via \fISSL_CTX_use_PrivateKey()\fR, etc.
 236 .PP
 237 \&\fISSL_CTX_use_PrivateKey_ASN1()\fR adds the private key of type \fBpk\fR
 238 stored at memory location \fBd\fR (length \fBlen\fR) to \fBctx\fR.
 239 \&\fISSL_CTX_use_RSAPrivateKey_ASN1()\fR adds the private key of type \s-1RSA\s0
 240 stored at memory location \fBd\fR (length \fBlen\fR) to \fBctx\fR.
 241 \&\fISSL_use_PrivateKey_ASN1()\fR and \fISSL_use_RSAPrivateKey_ASN1()\fR add the private
 242 key to \fBssl\fR.
 243 .PP
 244 \&\fISSL_CTX_use_PrivateKey_file()\fR adds the first private key found in
 245 \&\fBfile\fR to \fBctx\fR. The formatting \fBtype\fR of the private key must be specified
 246 from the known types \s-1SSL_FILETYPE_PEM, SSL_FILETYPE_ASN1.\s0
 247 \&\fISSL_CTX_use_RSAPrivateKey_file()\fR adds the first private \s-1RSA\s0 key found in
 248 \&\fBfile\fR to \fBctx\fR. \fISSL_use_PrivateKey_file()\fR adds the first private key found
 249 in \fBfile\fR to \fBssl\fR; \fISSL_use_RSAPrivateKey_file()\fR adds the first private
 250 \&\s-1RSA\s0 key found to \fBssl\fR.
 251 .PP
 252 \&\fISSL_CTX_check_private_key()\fR checks the consistency of a private key with
 253 the corresponding certificate loaded into \fBctx\fR. If more than one
 254 key/certificate pair (\s-1RSA/DSA\s0) is installed, the last item installed will
 255 be checked. If e.g. the last item was a \s-1RSA\s0 certificate or key, the \s-1RSA\s0
 256 key/certificate pair will be checked. \fISSL_check_private_key()\fR performs
 257 the same check for \fBssl\fR. If no key/certificate was explicitly added for
 258 this \fBssl\fR, the last item added into \fBctx\fR will be checked.
 259 .SH "NOTES"
 260 .IX Header "NOTES"
 261 The internal certificate store of OpenSSL can hold several private
 262 key/certificate pairs at a time. The certificate used depends on the
 263 cipher selected, see also \fISSL_CTX_set_cipher_list\fR\|(3).
 264 .PP
 265 When reading certificates and private keys from file, files of type
 266 \&\s-1SSL_FILETYPE_ASN1\s0 (also known as \fB\s-1DER\s0\fR, binary encoding) can only contain
 267 one certificate or private key, consequently
 268 \&\fISSL_CTX_use_certificate_chain_file()\fR is only applicable to \s-1PEM\s0 formatting.
 269 Files of type \s-1SSL_FILETYPE_PEM\s0 can contain more than one item.
 270 .PP
 271 \&\fISSL_CTX_use_certificate_chain_file()\fR adds the first certificate found
 272 in the file to the certificate store. The other certificates are added
 273 to the store of chain certificates using \fISSL_CTX_add1_chain_cert\fR\|(3). Note: versions of OpenSSL before 1.0.2 only had a single
 274 certificate chain store for all certificate types, OpenSSL 1.0.2 and later
 275 have a separate chain store for each type. \fISSL_CTX_use_certificate_chain_file()\fR
 276 should be used instead of the \fISSL_CTX_use_certificate_file()\fR function in order
 277 to allow the use of complete certificate chains even when no trusted \s-1CA\s0
 278 storage is used or when the \s-1CA\s0 issuing the certificate shall not be added to
 279 the trusted \s-1CA\s0 storage.
 280 .PP
 281 If additional certificates are needed to complete the chain during the
 282 \&\s-1TLS\s0 negotiation, \s-1CA\s0 certificates are additionally looked up in the
 283 locations of trusted \s-1CA\s0 certificates, see
 284 \&\fISSL_CTX_load_verify_locations\fR\|(3).
 285 .PP
 286 The private keys loaded from file can be encrypted. In order to successfully
 287 load encrypted keys, a function returning the passphrase must have been
 288 supplied, see
 289 \&\fISSL_CTX_set_default_passwd_cb\fR\|(3).
 290 (Certificate files might be encrypted as well from the technical point
 291 of view, it however does not make sense as the data in the certificate
 292 is considered public anyway.)
 293 .PP
 294 All of the functions to set a new certificate will replace any existing
 295 certificate of the same type that has already been set. Similarly all of the
 296 functions to set a new private key will replace any private key that has already
 297 been set. Applications should call \fISSL_CTX_check_private_key\fR\|(3) or
 298 \&\fISSL_check_private_key\fR\|(3) as appropriate after loading a new certificate and
 299 private key to confirm that the certificate and key match.
 300 .SH "RETURN VALUES"
 301 .IX Header "RETURN VALUES"
 302 On success, the functions return 1.
 303 Otherwise check out the error stack to find out the reason.
 304 .SH "SEE ALSO"
 305 .IX Header "SEE ALSO"
 306 \&\fIssl\fR\|(7), \fISSL_new\fR\|(3), \fISSL_clear\fR\|(3),
 307 \&\fISSL_CTX_load_verify_locations\fR\|(3),
 308 \&\fISSL_CTX_set_default_passwd_cb\fR\|(3),
 309 \&\fISSL_CTX_set_cipher_list\fR\|(3),
 310 \&\fISSL_CTX_set_client_CA_list\fR\|(3),
 311 \&\fISSL_CTX_set_client_cert_cb\fR\|(3),
 312 \&\fISSL_CTX_add_extra_chain_cert\fR\|(3)
 313 .SH "COPYRIGHT"
 314 .IX Header "COPYRIGHT"
 315 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 316 .PP
 317 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 318 this file except in compliance with the License.  You can obtain a copy
 319 in the file \s-1LICENSE\s0 in the source distribution or at
 320 <https://www.openssl.org/source/license.html>.