diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_new.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/SSL_new.3 | 137 |
1 files changed, 32 insertions, 105 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_new.3 b/secure/lib/libcrypto/man/man3/SSL_new.3 index e0650851a373..68a59be603a5 100644 --- a/secure/lib/libcrypto/man/man3/SSL_new.3 +++ b/secure/lib/libcrypto/man/man3/SSL_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,77 +52,17 @@ . \} .\} .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_NEW 3ossl" -.TH SSL_NEW 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH SSL_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 SSL_dup, SSL_new, SSL_up_ref \- create an SSL structure for a connection -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/ssl.h> @@ -147,29 +71,29 @@ SSL_dup, SSL_new, SSL_up_ref \- create an SSL structure for a connection \& SSL *SSL_new(SSL_CTX *ctx); \& int SSL_up_ref(SSL *s); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -\&\fBSSL_new()\fR creates a new \fB\s-1SSL\s0\fR structure which is needed to hold the -data for a \s-1TLS/SSL\s0 connection. The new structure inherits the settings +\&\fBSSL_new()\fR creates a new \fBSSL\fR structure which is needed to hold the +data for a TLS/SSL connection. The new structure inherits the settings of the underlying context \fBctx\fR: connection method, -options, verification settings, timeout settings. An \fB\s-1SSL\s0\fR structure is -reference counted. Creating an \fB\s-1SSL\s0\fR structure for the first time increments +options, verification settings, timeout settings. An \fBSSL\fR structure is +reference counted. Creating an \fBSSL\fR structure for the first time increments the reference count. Freeing it (using SSL_free) decrements it. When the -reference count drops to zero, any memory or resources allocated to the \fB\s-1SSL\s0\fR +reference count drops to zero, any memory or resources allocated to the \fBSSL\fR structure are freed. .PP \&\fBSSL_up_ref()\fR increments the reference count for an -existing \fB\s-1SSL\s0\fR structure. +existing \fBSSL\fR structure. .PP -The function \fBSSL_dup()\fR creates and returns a new \fB\s-1SSL\s0\fR structure from the same -\&\fB\s-1SSL_CTX\s0\fR that was used to create \fIs\fR. It additionally duplicates a subset of -the settings in \fIs\fR into the new \fB\s-1SSL\s0\fR object. +The function \fBSSL_dup()\fR creates and returns a new \fBSSL\fR structure from the same +\&\fBSSL_CTX\fR that was used to create \fIs\fR. It additionally duplicates a subset of +the settings in \fIs\fR into the new \fBSSL\fR object. .PP -For \fBSSL_dup()\fR to work, the connection \s-1MUST\s0 be in its initial state and -\&\s-1MUST NOT\s0 have yet started the \s-1SSL\s0 handshake. For connections that are not in +For \fBSSL_dup()\fR to work, the connection MUST be in its initial state and +MUST NOT have yet started the SSL handshake. For connections that are not in their initial state \fBSSL_dup()\fR just increments an internal reference count and returns the \fIsame\fR handle. It may be possible to -use \fBSSL_clear\fR\|(3) to recycle an \s-1SSL\s0 handle that is not in its initial +use \fBSSL_clear\fR\|(3) to recycle an SSL handle that is not in its initial state for reuse, but this is best avoided. Instead, save and restore the session, if desired, and construct a fresh handle for each connection. .PP @@ -183,7 +107,7 @@ The subset of settings in \fIs\fR that are duplicated are: .IX Item "any configured certificates, private keys or certificate chains" .IP "any configured signature algorithms, or client signature algorithms" 4 .IX Item "any configured signature algorithms, or client signature algorithms" -.IP "any \s-1DANE\s0 settings" 4 +.IP "any DANE settings" 4 .IX Item "any DANE settings" .IP "any Options set via \fBSSL_set_options\fR\|(3)" 4 .IX Item "any Options set via SSL_set_options" @@ -209,29 +133,32 @@ The subset of settings in \fIs\fR that are duplicated are: .IX Item "the read_ahead value set via SSL_set_read_ahead" .IP "application specific data set via \fBSSL_set_ex_data\fR\|(3)" 4 .IX Item "application specific data set via SSL_set_ex_data" -.IP "any \s-1CA\s0 list or client \s-1CA\s0 list set via \fBSSL_set0_CA_list\fR\|(3), \fBSSL_set0_client_CA_list()\fR or similar functions" 4 +.IP "any CA list or client CA list set via \fBSSL_set0_CA_list\fR\|(3), \fBSSL_set0_client_CA_list()\fR or similar functions" 4 .IX Item "any CA list or client CA list set via SSL_set0_CA_list, SSL_set0_client_CA_list() or similar functions" .IP "any security level settings or callbacks" 4 .IX Item "any security level settings or callbacks" .IP "any configured serverinfo data" 4 .IX Item "any configured serverinfo data" -.IP "any configured \s-1PSK\s0 identity hint" 4 +.IP "any configured PSK identity hint" 4 .IX Item "any configured PSK identity hint" .IP "any configured custom extensions" 4 .IX Item "any configured custom extensions" .IP "any client certificate types configured via SSL_set1_client_certificate_types" 4 .IX Item "any client certificate types configured via SSL_set1_client_certificate_types" .PD +.PP +\&\fBSSL_dup()\fR is not supported on QUIC SSL objects and returns NULL if called on +such an object. .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\s0 structure failed. Check the error stack to +The creation of a new SSL structure failed. Check the error stack to find out the reason. -.IP "Pointer to an \s-1SSL\s0 structure" 4 +.IP "Pointer to an SSL structure" 4 .IX Item "Pointer to an SSL structure" -The return value points to an allocated \s-1SSL\s0 structure. +The return value points to an allocated SSL structure. .Sp \&\fBSSL_up_ref()\fR returns 1 for success and 0 for failure. .SH "SEE ALSO" @@ -240,11 +167,11 @@ The return value points to an allocated \s-1SSL\s0 structure. \&\fBSSL_CTX_set_options\fR\|(3), \&\fBSSL_get_SSL_CTX\fR\|(3), \&\fBssl\fR\|(7) -.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>. |