secure/lib/libssl/man/SSL_CTX_use_certificate.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:47:43 2003
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "SSL_CTX_use_certificate 3"
 141 .TH SSL_CTX_use_certificate 3 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 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
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 .Vb 1
 148 \& #include <openssl/ssl.h>
 149 .Ve
 150 .Vb 6
 151 \& int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
 152 \& int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len, unsigned char *d);
 153 \& int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type);
 154 \& int SSL_use_certificate(SSL *ssl, X509 *x);
 155 \& int SSL_use_certificate_ASN1(SSL *ssl, unsigned char *d, int len);
 156 \& int SSL_use_certificate_file(SSL *ssl, const char *file, int type);
 157 .Ve
 158 .Vb 1
 159 \& int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
 160 .Ve
 161 .Vb 13
 162 \& int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
 163 \& int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx, unsigned char *d,
 164 \&                                 long len);
 165 \& int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);
 166 \& int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
 167 \& int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, unsigned char *d, long len);
 168 \& int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);
 169 \& int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
 170 \& int SSL_use_PrivateKey_ASN1(int pk,SSL *ssl, unsigned char *d, long len);
 171 \& int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
 172 \& int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
 173 \& int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, unsigned char *d, long len);
 174 \& int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
 175 .Ve
 176 .Vb 2
 177 \& int SSL_CTX_check_private_key(SSL_CTX *ctx);
 178 \& int SSL_check_private_key(SSL *ssl);
 179 .Ve
 180 .SH "DESCRIPTION"
 181 .IX Header "DESCRIPTION"
 182 These functions load the certificates and private keys into the \s-1SSL_CTX\s0
 183 or \s-1SSL\s0 object, respectively.
 184 .PP
 185 The SSL_CTX_* class of functions loads the certificates and keys into the
 186 \&\s-1SSL_CTX\s0 object \fBctx\fR. The information is passed to \s-1SSL\s0 objects \fBssl\fR
 187 created from \fBctx\fR with SSL_new(3) by copying, so that
 188 changes applied to \fBctx\fR do not propagate to already existing \s-1SSL\s0 objects.
 189 .PP
 190 The SSL_* class of functions only loads certificates and keys into a
 191 specific \s-1SSL\s0 object. The specific information is kept, when
 192 SSL_clear(3) is called for this \s-1SSL\s0 object.
 193 .PP
 194 \&\fISSL_CTX_use_certificate()\fR loads the certificate \fBx\fR into \fBctx\fR,
 195 \&\fISSL_use_certificate()\fR loads \fBx\fR into \fBssl\fR. The rest of the
 196 certificates needed to form the complete certificate chain can be
 197 specified using the
 198 SSL_CTX_add_extra_chain_cert(3)
 199 function.
 200 .PP
 201 \&\fISSL_CTX_use_certificate_ASN1()\fR loads the \s-1ASN1\s0 encoded certificate from
 202 the memory location \fBd\fR (with length \fBlen\fR) into \fBctx\fR,
 203 \&\fISSL_use_certificate_ASN1()\fR loads the \s-1ASN1\s0 encoded certificate into \fBssl\fR.
 204 .PP
 205 \&\fISSL_CTX_use_certificate_file()\fR loads the first certificate stored in \fBfile\fR
 206 into \fBctx\fR. The formatting \fBtype\fR of the certificate must be specified
 207 from the known types \s-1SSL_FILETYPE_PEM\s0, \s-1SSL_FILETYPE_ASN1\s0.
 208 \&\fISSL_use_certificate_file()\fR loads the certificate from \fBfile\fR into \fBssl\fR.
 209 See the \s-1NOTES\s0 section on why \fISSL_CTX_use_certificate_chain_file()\fR
 210 should be preferred.
 211 .PP
 212 \&\fISSL_CTX_use_certificate_chain_file()\fR loads a certificate chain from
 213 \&\fBfile\fR into \fBctx\fR. The certificates must be in \s-1PEM\s0 format and must
 214 be sorted starting with the certificate to the highest level (root \s-1CA\s0).
 215 There is no corresponding function working on a single \s-1SSL\s0 object.
 216 .PP
 217 \&\fISSL_CTX_use_PrivateKey()\fR adds \fBpkey\fR as private key to \fBctx\fR.
 218 \&\fISSL_CTX_use_RSAPrivateKey()\fR adds the private key \fBrsa\fR of type \s-1RSA\s0
 219 to \fBctx\fR. \fISSL_use_PrivateKey()\fR adds \fBpkey\fR as private key to \fBssl\fR;
 220 \&\fISSL_use_RSAPrivateKey()\fR adds \fBrsa\fR as private key of type \s-1RSA\s0 to \fBssl\fR.
 221 .PP
 222 \&\fISSL_CTX_use_PrivateKey_ASN1()\fR adds the private key of type \fBpk\fR
 223 stored at memory location \fBd\fR (length \fBlen\fR) to \fBctx\fR.
 224 \&\fISSL_CTX_use_RSAPrivateKey_ASN1()\fR adds the private key of type \s-1RSA\s0
 225 stored at memory location \fBd\fR (length \fBlen\fR) to \fBctx\fR.
 226 \&\fISSL_use_PrivateKey_ASN1()\fR and \fISSL_use_RSAPrivateKey_ASN1()\fR add the private
 227 key to \fBssl\fR.
 228 .PP
 229 \&\fISSL_CTX_use_PrivateKey_file()\fR adds the first private key found in
 230 \&\fBfile\fR to \fBctx\fR. The formatting \fBtype\fR of the certificate must be specified
 231 from the known types \s-1SSL_FILETYPE_PEM\s0, \s-1SSL_FILETYPE_ASN1\s0.
 232 \&\fISSL_CTX_use_RSAPrivateKey_file()\fR adds the first private \s-1RSA\s0 key found in
 233 \&\fBfile\fR to \fBctx\fR. \fISSL_use_PrivateKey_file()\fR adds the first private key found
 234 in \fBfile\fR to \fBssl\fR; \fISSL_use_RSAPrivateKey_file()\fR adds the first private
 235 \&\s-1RSA\s0 key found to \fBssl\fR.
 236 .PP
 237 \&\fISSL_CTX_check_private_key()\fR checks the consistency of a private key with
 238 the corresponding certificate loaded into \fBctx\fR. If more than one
 239 key/certificate pair (\s-1RSA/DSA\s0) is installed, the last item installed will
 240 be checked. If e.g. the last item was a \s-1RSA\s0 certificate or key, the \s-1RSA\s0
 241 key/certificate pair will be checked. \fISSL_check_private_key()\fR performs
 242 the same check for \fBssl\fR. If no key/certificate was explicitly added for
 243 this \fBssl\fR, the last item added into \fBctx\fR will be checked.
 244 .SH "NOTES"
 245 .IX Header "NOTES"
 246 The internal certificate store of OpenSSL can hold two private key/certificate
 247 pairs at a time: one key/certificate of type \s-1RSA\s0 and one key/certificate
 248 of type \s-1DSA\s0. The certificate used depends on the cipher select, see
 249 also SSL_CTX_set_cipher_list(3).
 250 .PP
 251 When reading certificates and private keys from file, files of type
 252 \&\s-1SSL_FILETYPE_ASN1\s0 (also known as \fB\s-1DER\s0\fR, binary encoding) can only contain
 253 one certificate or private key, consequently
 254 \&\fISSL_CTX_use_certificate_chain_file()\fR is only applicable to \s-1PEM\s0 formatting.
 255 Files of type \s-1SSL_FILETYPE_PEM\s0 can contain more than one item.
 256 .PP
 257 \&\fISSL_CTX_use_certificate_chain_file()\fR adds the first certificate found
 258 in the file to the certificate store. The other certificates are added
 259 to the store of chain certificates using
 260 SSL_CTX_add_extra_chain_cert(3).
 261 There exists only one extra chain store, so that the same chain is appended
 262 to both types of certificates, \s-1RSA\s0 and \s-1DSA\s0! If it is not intended to use
 263 both type of certificate at the same time, it is recommended to use the
 264 \&\fISSL_CTX_use_certificate_chain_file()\fR instead of the
 265 \&\fISSL_CTX_use_certificate_file()\fR function in order to allow the use of
 266 complete certificate chains even when no trusted \s-1CA\s0 storage is used or
 267 when the \s-1CA\s0 issuing the certificate shall not be added to the trusted
 268 \&\s-1CA\s0 storage.
 269 .PP
 270 If additional certificates are needed to complete the chain during the
 271 \&\s-1TLS\s0 negotiation, \s-1CA\s0 certificates are additionally looked up in the
 272 locations of trusted \s-1CA\s0 certificates, see
 273 SSL_CTX_load_verify_locations(3).
 274 .PP
 275 The private keys loaded from file can be encrypted. In order to successfully
 276 load encrypted keys, a function returning the passphrase must have been
 277 supplied, see
 278 SSL_CTX_set_default_passwd_cb(3).
 279 (Certificate files might be encrypted as well from the technical point
 280 of view, it however does not make sense as the data in the certificate
 281 is considered public anyway.)
 282 .SH "RETURN VALUES"
 283 .IX Header "RETURN VALUES"
 284 On success, the functions return 1.
 285 Otherwise check out the error stack to find out the reason.
 286 .SH "SEE ALSO"
 287 .IX Header "SEE ALSO"
 288 ssl(3), SSL_new(3), SSL_clear(3),
 289 SSL_CTX_load_verify_locations(3),
 290 SSL_CTX_set_default_passwd_cb(3),
 291 SSL_CTX_set_cipher_list(3),
 292 SSL_CTX_set_client_cert_cb(3),
 293 SSL_CTX_add_extra_chain_cert(3)