diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_CTX_new.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/SSL_CTX_new.3 | 166 |
1 files changed, 46 insertions, 120 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_CTX_new.3 b/secure/lib/libcrypto/man/man3/SSL_CTX_new.3 index a293178b5785..0cef46fe5431 100644 --- a/secure/lib/libcrypto/man/man3/SSL_CTX_new.3 +++ b/secure/lib/libcrypto/man/man3/SSL_CTX_new.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .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' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .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\} @@ -68,75 +52,15 @@ . \} .\} .rr rF -.\" 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 3ossl" -.TH SSL_CTX_NEW 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH SSL_CTX_NEW 3ossl 2025-07-01 3.5.1 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" +.SH NAME TLSv1_2_method, TLSv1_2_server_method, TLSv1_2_client_method, SSL_CTX_new, SSL_CTX_new_ex, SSL_CTX_up_ref, SSLv3_method, SSLv3_server_method, SSLv3_client_method, TLSv1_method, TLSv1_server_method, @@ -148,7 +72,7 @@ DTLSv1_client_method, DTLSv1_2_method, DTLSv1_2_server_method, DTLSv1_2_client_method \&\- create a new SSL_CTX object as framework for TLS/SSL or DTLS enabled functions -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/ssl.h> @@ -206,44 +130,46 @@ functions \& const SSL_METHOD *DTLSv1_2_client_method(void); \& #endif .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -\&\fBSSL_CTX_new_ex()\fR creates a new \fB\s-1SSL_CTX\s0\fR object, which holds various -configuration and data relevant to \s-1SSL/TLS\s0 or \s-1DTLS\s0 session establishment. -These are later inherited by the \fB\s-1SSL\s0\fR object representing an active session. +\&\fBSSL_CTX_new_ex()\fR creates a new \fBSSL_CTX\fR object, which holds various +configuration and data relevant to SSL/TLS or DTLS session establishment. +These are later inherited by the \fBSSL\fR object representing an active session. The \fImethod\fR parameter specifies whether the context will be used for the -client or server side or both \- for details see the \*(L"\s-1NOTES\*(R"\s0 below. -The library context \fIlibctx\fR (see \s-1\fBOSSL_LIB_CTX\s0\fR\|(3)) is used to provide the +client or server side or both \- for details see the "NOTES" below. +The library context \fIlibctx\fR (see \fBOSSL_LIB_CTX\fR\|(3)) is used to provide the cryptographic algorithms needed for the session. Any cryptographic algorithms -that are used by any \fB\s-1SSL\s0\fR objects created from this \fB\s-1SSL_CTX\s0\fR will be fetched +that are used by any \fBSSL\fR objects created from this \fBSSL_CTX\fR will be fetched from the \fIlibctx\fR using the property query string \fIpropq\fR (see -\&\*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fBcrypto\fR\|(7). Either or both the \fIlibctx\fR or \fIpropq\fR -parameters may be \s-1NULL.\s0 +"ALGORITHM FETCHING" in \fBcrypto\fR\|(7). Either or both the \fIlibctx\fR or \fIpropq\fR +parameters may be NULL. .PP \&\fBSSL_CTX_new()\fR does the same as \fBSSL_CTX_new_ex()\fR except that the default library context is used and no property query string is specified. .PP -An \fB\s-1SSL_CTX\s0\fR object is reference counted. Creating an \fB\s-1SSL_CTX\s0\fR object for the -first time increments the reference count. Freeing the \fB\s-1SSL_CTX\s0\fR (using +An \fBSSL_CTX\fR object is reference counted. Creating an \fBSSL_CTX\fR object for the +first time increments the reference count. Freeing the \fBSSL_CTX\fR (using SSL_CTX_free) decrements it. When the reference count drops to zero, any memory -or resources allocated to the \fB\s-1SSL_CTX\s0\fR object are freed. \fBSSL_CTX_up_ref()\fR -increments the reference count for an existing \fB\s-1SSL_CTX\s0\fR structure. +or resources allocated to the \fBSSL_CTX\fR object are freed. \fBSSL_CTX_up_ref()\fR +increments the reference count for an existing \fBSSL_CTX\fR structure. .PP -An \fB\s-1SSL_CTX\s0\fR object should not be changed after it is used to create any \fB\s-1SSL\s0\fR +An \fBSSL_CTX\fR object should not be changed after it is used to create any \fBSSL\fR objects or from multiple threads concurrently, since the implementation does not provide serialization of access for these cases. -.SH "NOTES" +.SH NOTES .IX Header "NOTES" On session establishment, by default, no peer credentials verification is done. This must be explicitly requested, typically using \fBSSL_CTX_set_verify\fR\|(3). For verifying peer certificates many options can be set using various functions such as \fBSSL_CTX_load_verify_locations\fR\|(3) and \fBSSL_CTX_set1_param\fR\|(3). -The \fBX509_VERIFY_PARAM_set_purpose\fR\|(3) function can be used, also in conjunction -with \fBSSL_CTX_get0_param\fR\|(3), to set the intended purpose of the session. -The default is \fBX509_PURPOSE_SSL_SERVER\fR on the client side +.PP +The SSL/(D)TLS implementation uses the \fBX509_STORE_CTX_set_default\fR\|(3) +function to prepare checks for \fBX509_PURPOSE_SSL_SERVER\fR on the client side and \fBX509_PURPOSE_SSL_CLIENT\fR on the server side. +The \fBX509_VERIFY_PARAM_set_purpose\fR\|(3) function can be used, also in conjunction +with \fBSSL_CTX_get0_param\fR\|(3), to override the default purpose of the session. .PP -The \s-1SSL_CTX\s0 object uses \fImethod\fR as the connection method. +The SSL_CTX object uses \fImethod\fR as the connection method. Three method variants are available: a generic method (for either client or server use), a server-only method, and a client-only method. .PP @@ -251,7 +177,7 @@ The \fImethod\fR parameter of \fBSSL_CTX_new_ex()\fR and \fBSSL_CTX_new()\fR can be one of the following: .IP "\fBTLS_method()\fR, \fBTLS_server_method()\fR, \fBTLS_client_method()\fR" 4 .IX Item "TLS_method(), TLS_server_method(), TLS_client_method()" -These are the general-purpose \fIversion-flexible\fR \s-1SSL/TLS\s0 methods. +These are the general-purpose \fIversion-flexible\fR SSL/TLS 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 SSLv3, TLSv1, TLSv1.1, TLSv1.2 and TLSv1.3. @@ -267,25 +193,25 @@ old function names still compiles. However, using the old function names is deprecated and new code should call the new functions instead. .IP "\fBTLSv1_2_method()\fR, \fBTLSv1_2_server_method()\fR, \fBTLSv1_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 +A TLS/SSL connection established with these methods will only understand the TLSv1.2 protocol. These methods are deprecated. .IP "\fBTLSv1_1_method()\fR, \fBTLSv1_1_server_method()\fR, \fBTLSv1_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 +A TLS/SSL connection established with these methods will only understand the TLSv1.1 protocol. These methods are deprecated. .IP "\fBTLSv1_method()\fR, \fBTLSv1_server_method()\fR, \fBTLSv1_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 +A TLS/SSL connection established with these methods will only understand the TLSv1 protocol. These methods are deprecated. .IP "\fBSSLv3_method()\fR, \fBSSLv3_server_method()\fR, \fBSSLv3_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 +A TLS/SSL connection established with these methods will only understand the SSLv3 protocol. The SSLv3 protocol is deprecated and should not be used. .IP "\fBDTLS_method()\fR, \fBDTLS_server_method()\fR, \fBDTLS_client_method()\fR" 4 .IX Item "DTLS_method(), DTLS_server_method(), DTLS_client_method()" -These are the version-flexible \s-1DTLS\s0 methods. -Currently supported protocols are \s-1DTLS 1.0\s0 and \s-1DTLS 1.2.\s0 +These are the version-flexible DTLS methods. +Currently supported protocols are DTLS 1.0 and DTLS 1.2. .IP "\fBDTLSv1_2_method()\fR, \fBDTLSv1_2_server_method()\fR, \fBDTLSv1_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. @@ -310,14 +236,14 @@ methods you can use \fBSSL_CTX_set_min_proto_version\fR\|(3), \&\fBSSL_set_max_proto_version\fR\|(3) functions. Using these functions it is possible to choose e.g. \fBTLS_server_method()\fR and be able to negotiate with all possible clients, but to only -allow newer protocols like \s-1TLS 1.0, TLS 1.1, TLS 1.2\s0 or \s-1TLS 1.3.\s0 +allow newer protocols like TLS 1.0, TLS 1.1, TLS 1.2 or TLS 1.3. .PP The list of protocols available can also be limited using the \&\fBSSL_OP_NO_SSLv3\fR, \fBSSL_OP_NO_TLSv1\fR, \fBSSL_OP_NO_TLSv1_1\fR, \&\fBSSL_OP_NO_TLSv1_3\fR, \fBSSL_OP_NO_TLSv1_2\fR and \fBSSL_OP_NO_TLSv1_3\fR options of the \&\fBSSL_CTX_set_options\fR\|(3) or \fBSSL_set_options\fR\|(3) functions, but this approach -is not recommended. Clients should avoid creating \*(L"holes\*(R" in the set of +is not recommended. Clients should avoid creating "holes" 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 @@ -326,26 +252,26 @@ protocol versions. .PP The SSLv3 protocol is deprecated and should generally not be used. Applications should typically use \fBSSL_CTX_set_min_proto_version\fR\|(3) to set -the minimum protocol to at least \fB\s-1TLS1_VERSION\s0\fR. +the minimum protocol to at least \fBTLS1_VERSION\fR. .SH "RETURN VALUES" .IX Header "RETURN VALUES" The following return values can occur: -.IP "\s-1NULL\s0" 4 +.IP NULL 4 .IX Item "NULL" -The creation of a new \s-1SSL_CTX\s0 object failed. Check the error stack to find out +The creation of a new SSL_CTX object failed. Check the error stack to find out the reason. -.IP "Pointer to an \s-1SSL_CTX\s0 object" 4 +.IP "Pointer to an SSL_CTX object" 4 .IX Item "Pointer to an SSL_CTX object" -The return value points to an allocated \s-1SSL_CTX\s0 object. +The return value points to an allocated SSL_CTX object. .Sp \&\fBSSL_CTX_up_ref()\fR returns 1 for success and 0 for failure. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fBSSL_CTX_set_options\fR\|(3), \fBSSL_CTX_free\fR\|(3), +\&\fBSSL_CTX_set_options\fR\|(3), \fBSSL_CTX_free\fR\|(3), \fBX509_STORE_CTX_set_default\fR\|(3), \&\fBSSL_CTX_set_verify\fR\|(3), \fBSSL_CTX_set1_param\fR\|(3), \fBSSL_CTX_get0_param\fR\|(3), \&\fBSSL_connect\fR\|(3), \fBSSL_accept\fR\|(3), \&\fBSSL_CTX_set_min_proto_version\fR\|(3), \fBssl\fR\|(7), \fBSSL_set_connect_state\fR\|(3) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" Support for SSLv2 and the corresponding \fBSSLv2_method()\fR, \&\fBSSLv2_server_method()\fR and \fBSSLv2_client_method()\fR functions where @@ -358,11 +284,11 @@ and \fBTLS_client_method()\fR functions were added in OpenSSL 1.1.0. All version-specific methods were deprecated in OpenSSL 1.1.0. .PP \&\fBSSL_CTX_new_ex()\fR was added in OpenSSL 3.0. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |