297 lines
12 KiB
Groff
297 lines
12 KiB
Groff
.\" $NetBSD: SSL_CTX_use_certificate.3,v 1.1 2001/04/12 10:45:41 itojun Exp $
|
|
.\"
|
|
.\" Automatically generated by Pod::Man version 1.02
|
|
.\" Thu Apr 12 19:27:24 2001
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ======================================================================
|
|
.de Sh \" Subsection heading
|
|
.br
|
|
.if t .Sp
|
|
.ne 5
|
|
.PP
|
|
\fB\\$1\fR
|
|
.PP
|
|
..
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Ip \" List item
|
|
.br
|
|
.ie \\n(.$>=3 .ne \\$3
|
|
.el .ne 3
|
|
.IP "\\$1" \\$2
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
|
|
.fi
|
|
..
|
|
.\" 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. | will give a
|
|
.\" real vertical bar. \*(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-|\(bv\*(Tr
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. 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\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr
|
|
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
|
|
.\" index entries marked with X<> in POD. Of course, you'll have to process
|
|
.\" the output yourself in some meaningful fashion.
|
|
.if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
. .
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.\"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it
|
|
.\" makes way too many mistakes in technical documents.
|
|
.hy 0
|
|
.if n .na
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
.bd B 3
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. 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
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. 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
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ======================================================================
|
|
.\"
|
|
.IX Title "SSL_CTX_use_certificate 3"
|
|
.TH SSL_CTX_use_certificate 3 "0.9.6a" "2001-04-12" "OpenSSL"
|
|
.UC
|
|
.SH "NAME"
|
|
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
|
|
.SH "LIBRARY"
|
|
libcrypto, -lcrypto
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/ssl.h>
|
|
.Ve
|
|
.Vb 6
|
|
\& 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);
|
|
.Ve
|
|
.Vb 1
|
|
\& int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
|
|
.Ve
|
|
.Vb 13
|
|
\& 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);
|
|
.Ve
|
|
.Vb 2
|
|
\& int SSL_CTX_check_private_key(SSL_CTX *ctx);
|
|
\& int SSL_check_private_key(SSL *ssl);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
These functions load the certificates and private keys into the \s-1SSL_CTX\s0
|
|
or \s-1SSL\s0 object, respectively.
|
|
.PP
|
|
The SSL_CTX_* class of functions loads the certificates and keys into the
|
|
\&\s-1SSL_CTX\s0 object \fBctx\fR. The information is passed to \s-1SSL\s0 objects \fBssl\fR
|
|
created from \fBctx\fR with SSL_new(3) by copying, so that
|
|
changes applied to \fBctx\fR do not propagate to already existing \s-1SSL\s0 objects.
|
|
.PP
|
|
The SSL_* class of functions only loads certificates and keys into a
|
|
specific \s-1SSL\s0 object. The specific information is kept, when
|
|
SSL_clear(3) is called for this \s-1SSL\s0 object.
|
|
.PP
|
|
\&\fISSL_CTX_use_certificate()\fR loads the certificate \fBx\fR into \fBctx\fR,
|
|
\&\fISSL_use_certificate()\fR loads \fBx\fR into \fBssl\fR. The rest of the
|
|
certificates needed to form the complete certificate chain can be
|
|
specified using the
|
|
SSL_CTX_add_extra_chain_cert(3)
|
|
function.
|
|
.PP
|
|
\&\fISSL_CTX_use_certificate_ASN1()\fR loads the \s-1ASN1\s0 encoded certificate from
|
|
the memory location \fBd\fR (with length \fBlen\fR) into \fBctx\fR,
|
|
\&\fISSL_use_certificate_ASN1()\fR loads the \s-1ASN1\s0 encoded certificate into \fBssl\fR.
|
|
.PP
|
|
\&\fISSL_CTX_use_certificate_file()\fR loads the first certificate stored in \fBfile\fR
|
|
into \fBctx\fR. The formatting \fBtype\fR of the certificate must be specified
|
|
from the known types \s-1SSL_FILETYPE_PEM\s0, \s-1SSL_FILETYPE_ASN1\s0.
|
|
\&\fISSL_use_certificate_file()\fR loads the certificate from \fBfile\fR into \fBssl\fR.
|
|
See the \s-1NOTES\s0 section on why \fISSL_CTX_use_certificate_chain_file()\fR
|
|
should be preferred.
|
|
.PP
|
|
\&\fISSL_CTX_use_certificate_chain_file()\fR loads a certificate chain from
|
|
\&\fBfile\fR into \fBctx\fR. The certificates must be in \s-1PEM\s0 format and must
|
|
be sorted starting with the certificate to the highest level (root \s-1CA\s0).
|
|
There is no corresponding function working on a single \s-1SSL\s0 object.
|
|
.PP
|
|
\&\fISSL_CTX_use_PrivateKey()\fR adds \fBpkey\fR as private key to \fBctx\fR.
|
|
\&\fISSL_CTX_use_RSAPrivateKey()\fR adds the private key \fBrsa\fR of type \s-1RSA\s0
|
|
to \fBctx\fR. \fISSL_use_PrivateKey()\fR adds \fBpkey\fR as private key to \fBssl\fR;
|
|
\&\fISSL_use_RSAPrivateKey()\fR adds \fBrsa\fR as private key of type \s-1RSA\s0 to \fBssl\fR.
|
|
.PP
|
|
\&\fISSL_CTX_use_PrivateKey_ASN1()\fR adds the private key of type \fBpk\fR
|
|
stored at memory location \fBd\fR (length \fBlen\fR) to \fBctx\fR.
|
|
\&\fISSL_CTX_use_RSAPrivateKey_ASN1()\fR adds the private key of type \s-1RSA\s0
|
|
stored at memory location \fBd\fR (length \fBlen\fR) to \fBctx\fR.
|
|
\&\fISSL_use_PrivateKey_ASN1()\fR and \fISSL_use_RSAPrivateKey_ASN1()\fR add the private
|
|
key to \fBssl\fR.
|
|
.PP
|
|
\&\fISSL_CTX_use_PrivateKey_file()\fR adds the first private key found in
|
|
\&\fBfile\fR to \fBctx\fR. The formatting \fBtype\fR of the certificate must be specified
|
|
from the known types \s-1SSL_FILETYPE_PEM\s0, \s-1SSL_FILETYPE_ASN1\s0.
|
|
\&\fISSL_CTX_use_RSAPrivateKey_file()\fR adds the first private \s-1RSA\s0 key found in
|
|
\&\fBfile\fR to \fBctx\fR. \fISSL_use_PrivateKey_file()\fR adds the first private key found
|
|
in \fBfile\fR to \fBssl\fR; \fISSL_use_RSAPrivateKey_file()\fR adds the first private
|
|
\&\s-1RSA\s0 key found to \fBssl\fR.
|
|
.PP
|
|
\&\fISSL_CTX_check_private_key()\fR checks the consistency of a private key with
|
|
the corresponding certificate loaded into \fBctx\fR. 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 a \s-1RSA\s0 certificate or key, the \s-1RSA\s0
|
|
key/certificate pair will be checked. \fISSL_check_private_key()\fR performs
|
|
the same check for \fBssl\fR. If no key/certificate was explicitly added for
|
|
this \fBssl\fR, the last item added into \fBctx\fR will be checked.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
The internal certificate store of OpenSSL can hold two private key/certificate
|
|
pairs at a time: one key/certificate of type \s-1RSA\s0 and one key/certificate
|
|
of type \s-1DSA\s0. The certificate used depends on the cipher select, see
|
|
also SSL_CTX_set_cipher_list(3).
|
|
.PP
|
|
When reading certificates and private keys from file, files of type
|
|
\&\s-1SSL_FILETYPE_ASN1\s0 (also known as \fB\s-1DER\s0\fR, binary encoding) can only contain
|
|
one certificate or private key, consequently
|
|
\&\fISSL_CTX_use_certificate_chain_file()\fR is only applicable to \s-1PEM\s0 formatting.
|
|
Files of type \s-1SSL_FILETYPE_PEM\s0 can contain more than one item.
|
|
.PP
|
|
\&\fISSL_CTX_use_certificate_chain_file()\fR 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_add_extra_chain_cert(3).
|
|
There exists only one extra chain store, so that the same chain is appended
|
|
to both types of certificates, \s-1RSA\s0 and \s-1DSA\s0! If it is not intended to use
|
|
both type of certificate at the same time, it is recommended to use the
|
|
\&\fISSL_CTX_use_certificate_chain_file()\fR instead of the
|
|
\&\fISSL_CTX_use_certificate_file()\fR 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.
|
|
.PP
|
|
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
|
|
SSL_CTX_load_verify_locations(3).
|
|
.PP
|
|
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
|
|
SSL_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.)
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
On success, the functions return 1.
|
|
Otherwise check out the error stack to find out the reason.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
ssl(3), SSL_new(3), SSL_clear(3),
|
|
SSL_CTX_load_verify_locations(3),
|
|
SSL_CTX_set_default_passwd_cb(3),
|
|
SSL_CTX_set_cipher_list(3),
|
|
SSL_CTX_add_extra_chain_cert(3)
|