diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_set1_initial_peer_addr.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/SSL_set1_initial_peer_addr.3 | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_set1_initial_peer_addr.3 b/secure/lib/libcrypto/man/man3/SSL_set1_initial_peer_addr.3 new file mode 100644 index 000000000000..d75d7f303d4f --- /dev/null +++ b/secure/lib/libcrypto/man/man3/SSL_set1_initial_peer_addr.3 @@ -0,0 +1,114 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" +.\" 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 +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. 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 +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "SSL_SET1_INITIAL_PEER_ADDR 3ossl" +.TH SSL_SET1_INITIAL_PEER_ADDR 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 +SSL_set1_initial_peer_addr \- set the initial peer address for a QUIC connection +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/ssl.h> +\& +\& int SSL_set1_initial_peer_addr(SSL *s, const BIO_ADDR *addr); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBSSL_set1_initial_peer_addr()\fR sets the initial destination peer address to be used +for the purposes of establishing a QUIC connection in client mode. This function +can be used only on a QUIC connection SSL object, and can be used only before a +connection attempt is first made. \fIaddr\fR must point to a \fBBIO_ADDR\fR +representing a UDP destination address of the server to connect to. +.PP +Where a QUIC connection object is provided with a write BIO which supports the +\&\fBBIO_CTRL_DGRAM_GET_PEER\fR control (for example, \fBBIO_s_dgram\fR), the initial +destination peer address can be detected automatically; if +\&\fBBIO_CTRL_DGRAM_GET_PEER\fR returns a valid (non\-\fBAF_UNSPEC\fR) peer address and +no valid peer address has yet been set, this will be set automatically as the +initial peer address. This behaviour can be overridden by calling +\&\fBSSL_set1_initial_peer_addr()\fR with a valid peer address explicitly. +.PP +The destination address used by QUIC may change over time in response to +connection events, such as connection migration (where supported). +\&\fBSSL_set1_initial_peer_addr()\fR configures the destination address used for initial +connection establishment, and does not confer any guarantee about the +destination address being used for communication at any later time in the +connection lifecycle. +.PP +This function makes a copy of the address passed by the caller; the \fBBIO_ADDR\fR +structure pointed to by \fIaddr\fR may be freed by the caller after this function +returns. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +Returns 1 on success and 0 on failure. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBBIO_ADDR\fR\|(3), \fBssl\fR\|(7) +.SH HISTORY +.IX Header "HISTORY" +The \fBSSL_set1_initial_peer_addr()\fR function was added in OpenSSL 3.2. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2022\-2023 The OpenSSL Project Authors. All Rights Reserved. +.PP +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 LICENSE in the source distribution or at +<https://www.openssl.org/source/license.html>. |