284 lines
12 KiB
Groff
284 lines
12 KiB
Groff
.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.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. \*(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 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" ''
|
|
. ds C`
|
|
. ds C'
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" 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'.
|
|
.de IX
|
|
..
|
|
.if !\nF .nr F 0
|
|
.if \nF>0 \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{\
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" 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_new 3"
|
|
.TH SSL_CTX_new 3 "2017-01-26" "1.0.2k" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
SSL_CTX_new,
|
|
SSLv23_method, SSLv23_server_method, SSLv23_client_method,
|
|
TLSv1_2_method, TLSv1_2_server_method, TLSv1_2_client_method,
|
|
TLSv1_1_method, TLSv1_1_server_method, TLSv1_1_client_method,
|
|
TLSv1_method, TLSv1_server_method, TLSv1_client_method,
|
|
SSLv3_method, SSLv3_server_method, SSLv3_client_method,
|
|
SSLv2_method, SSLv2_server_method, SSLv2_client_method,
|
|
DTLS_method, DTLS_server_method, DTLS_client_method,
|
|
DTLSv1_2_method, DTLSv1_2_server_method, DTLSv1_2_client_method,
|
|
DTLSv1_method, DTLSv1_server_method, DTLSv1_client_method \-
|
|
create a new SSL_CTX object as framework for TLS/SSL enabled functions
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/ssl.h>
|
|
\&
|
|
\& SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
|
|
\& const SSL_METHOD *SSLv23_method(void);
|
|
\& const SSL_METHOD *SSLv23_server_method(void);
|
|
\& const SSL_METHOD *SSLv23_client_method(void);
|
|
\& const SSL_METHOD *TLSv1_2_method(void);
|
|
\& const SSL_METHOD *TLSv1_2_server_method(void);
|
|
\& const SSL_METHOD *TLSv1_2_client_method(void);
|
|
\& const SSL_METHOD *TLSv1_1_method(void);
|
|
\& const SSL_METHOD *TLSv1_1_server_method(void);
|
|
\& const SSL_METHOD *TLSv1_1_client_method(void);
|
|
\& const SSL_METHOD *TLSv1_method(void);
|
|
\& const SSL_METHOD *TLSv1_server_method(void);
|
|
\& const SSL_METHOD *TLSv1_client_method(void);
|
|
\& #ifndef OPENSSL_NO_SSL3_METHOD
|
|
\& const SSL_METHOD *SSLv3_method(void);
|
|
\& const SSL_METHOD *SSLv3_server_method(void);
|
|
\& const SSL_METHOD *SSLv3_client_method(void);
|
|
\& #endif
|
|
\& #ifndef OPENSSL_NO_SSL2
|
|
\& const SSL_METHOD *SSLv2_method(void);
|
|
\& const SSL_METHOD *SSLv2_server_method(void);
|
|
\& const SSL_METHOD *SSLv2_client_method(void);
|
|
\& #endif
|
|
\&
|
|
\& const SSL_METHOD *DTLS_method(void);
|
|
\& const SSL_METHOD *DTLS_server_method(void);
|
|
\& const SSL_METHOD *DTLS_client_method(void);
|
|
\& const SSL_METHOD *DTLSv1_2_method(void);
|
|
\& const SSL_METHOD *DTLSv1_2_server_method(void);
|
|
\& const SSL_METHOD *DTLSv1_2_client_method(void);
|
|
\& const SSL_METHOD *DTLSv1_method(void);
|
|
\& const SSL_METHOD *DTLSv1_server_method(void);
|
|
\& const SSL_METHOD *DTLSv1_client_method(void);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fISSL_CTX_new()\fR creates a new \fB\s-1SSL_CTX\s0\fR object as framework to establish
|
|
\&\s-1TLS/SSL\s0 enabled connections.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
The \s-1SSL_CTX\s0 object uses \fBmethod\fR as connection method. The methods exist
|
|
in a generic type (for client and server use), a server only type, and a
|
|
client only type. \fBmethod\fR can be of the following types:
|
|
.IP "\fISSLv23_method()\fR, \fISSLv23_server_method()\fR, \fISSLv23_client_method()\fR" 4
|
|
.IX Item "SSLv23_method(), SSLv23_server_method(), SSLv23_client_method()"
|
|
These are the general-purpose \fIversion-flexible\fR \s-1SSL/TLS\s0 methods.
|
|
The actual protocol version used will be negotiated to the highest version
|
|
mutually supported by the client and the server.
|
|
The supported protocols are SSLv2, SSLv3, TLSv1, TLSv1.1 and TLSv1.2.
|
|
Most applications should use these method, and avoid the version specific
|
|
methods described below.
|
|
.Sp
|
|
The list of protocols available can be further limited using the
|
|
\&\fBSSL_OP_NO_SSLv2\fR, \fBSSL_OP_NO_SSLv3\fR, \fBSSL_OP_NO_TLSv1\fR,
|
|
\&\fBSSL_OP_NO_TLSv1_1\fR and \fBSSL_OP_NO_TLSv1_2\fR options of the
|
|
\&\fISSL_CTX_set_options\fR\|(3) or \fISSL_set_options\fR\|(3) functions.
|
|
Clients should avoid creating \*(L"holes\*(R" in the set of protocols they support,
|
|
when disabling a protocol, make sure that you also disable either all previous
|
|
or all subsequent protocol versions.
|
|
In clients, when a protocol version is disabled without disabling \fIall\fR
|
|
previous protocol versions, the effect is to also disable all subsequent
|
|
protocol versions.
|
|
.Sp
|
|
The SSLv2 and SSLv3 protocols are deprecated and should generally not be used.
|
|
Applications should typically use \fISSL_CTX_set_options\fR\|(3) in combination with
|
|
the \fBSSL_OP_NO_SSLv3\fR flag to disable negotiation of SSLv3 via the above
|
|
\&\fIversion-flexible\fR \s-1SSL/TLS\s0 methods.
|
|
The \fBSSL_OP_NO_SSLv2\fR option is set by default, and would need to be cleared
|
|
via \fISSL_CTX_clear_options\fR\|(3) in order to enable negotiation of SSLv2.
|
|
.IP "\fITLSv1_2_method()\fR, \fITLSv1_2_server_method()\fR, \fITLSv1_2_client_method()\fR" 4
|
|
.IX Item "TLSv1_2_method(), TLSv1_2_server_method(), TLSv1_2_client_method()"
|
|
A \s-1TLS/SSL\s0 connection established with these methods will only understand the
|
|
TLSv1.2 protocol. A client will send out TLSv1.2 client hello messages and
|
|
will also indicate that it only understand TLSv1.2. A server will only
|
|
understand TLSv1.2 client hello messages.
|
|
.IP "\fITLSv1_1_method()\fR, \fITLSv1_1_server_method()\fR, \fITLSv1_1_client_method()\fR" 4
|
|
.IX Item "TLSv1_1_method(), TLSv1_1_server_method(), TLSv1_1_client_method()"
|
|
A \s-1TLS/SSL\s0 connection established with these methods will only understand the
|
|
TLSv1.1 protocol. A client will send out TLSv1.1 client hello messages and
|
|
will also indicate that it only understand TLSv1.1. A server will only
|
|
understand TLSv1.1 client hello messages.
|
|
.IP "\fITLSv1_method()\fR, \fITLSv1_server_method()\fR, \fITLSv1_client_method()\fR" 4
|
|
.IX Item "TLSv1_method(), TLSv1_server_method(), TLSv1_client_method()"
|
|
A \s-1TLS/SSL\s0 connection established with these methods will only understand the
|
|
TLSv1 protocol. A client will send out TLSv1 client hello messages and will
|
|
indicate that it only understands TLSv1. A server will only understand TLSv1
|
|
client hello messages.
|
|
.IP "\fISSLv3_method()\fR, \fISSLv3_server_method()\fR, \fISSLv3_client_method()\fR" 4
|
|
.IX Item "SSLv3_method(), SSLv3_server_method(), SSLv3_client_method()"
|
|
A \s-1TLS/SSL\s0 connection established with these methods will only understand the
|
|
SSLv3 protocol. A client will send out SSLv3 client hello messages and will
|
|
indicate that it only understands SSLv3. A server will only understand SSLv3
|
|
client hello messages. The SSLv3 protocol is deprecated and should not be
|
|
used.
|
|
.IP "\fISSLv2_method()\fR, \fISSLv2_server_method()\fR, \fISSLv2_client_method()\fR" 4
|
|
.IX Item "SSLv2_method(), SSLv2_server_method(), SSLv2_client_method()"
|
|
A \s-1TLS/SSL\s0 connection established with these methods will only understand the
|
|
SSLv2 protocol. A client will send out SSLv2 client hello messages and will
|
|
also indicate that it only understand SSLv2. A server will only understand
|
|
SSLv2 client hello messages. The SSLv2 protocol offers little to no security
|
|
and should not be used.
|
|
As of OpenSSL 1.0.2g, \s-1EXPORT\s0 ciphers and 56\-bit \s-1DES\s0 are no longer available
|
|
with SSLv2.
|
|
.IP "\fIDTLS_method()\fR, \fIDTLS_server_method()\fR, \fIDTLS_client_method()\fR" 4
|
|
.IX Item "DTLS_method(), DTLS_server_method(), DTLS_client_method()"
|
|
These are the version-flexible \s-1DTLS\s0 methods.
|
|
.IP "\fIDTLSv1_2_method()\fR, \fIDTLSv1_2_server_method()\fR, \fIDTLSv1_2_client_method()\fR" 4
|
|
.IX Item "DTLSv1_2_method(), DTLSv1_2_server_method(), DTLSv1_2_client_method()"
|
|
These are the version-specific methods for DTLSv1.2.
|
|
.IP "\fIDTLSv1_method()\fR, \fIDTLSv1_server_method()\fR, \fIDTLSv1_client_method()\fR" 4
|
|
.IX Item "DTLSv1_method(), DTLSv1_server_method(), DTLSv1_client_method()"
|
|
These are the version-specific methods for DTLSv1.
|
|
.PP
|
|
\&\fISSL_CTX_new()\fR initializes the list of ciphers, the session cache setting, the
|
|
callbacks, the keys and certificates and the options to its default values.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
The following return values can occur:
|
|
.IP "\s-1NULL\s0" 4
|
|
.IX Item "NULL"
|
|
The creation of a new \s-1SSL_CTX\s0 object failed. Check the error stack to find out
|
|
the reason.
|
|
.IP "Pointer to an \s-1SSL_CTX\s0 object" 4
|
|
.IX Item "Pointer to an SSL_CTX object"
|
|
The return value points to an allocated \s-1SSL_CTX\s0 object.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fISSL_CTX_set_options\fR\|(3), \fISSL_CTX_clear_options\fR\|(3), \fISSL_set_options\fR\|(3),
|
|
\&\fISSL_CTX_free\fR\|(3), \fISSL_accept\fR\|(3),
|
|
\&\fIssl\fR\|(3), \fISSL_set_connect_state\fR\|(3)
|