xref: /freebsd/secure/lib/libcrypto/man/man3/SSL_set1_initial_peer_addr.3 (revision 4757b351ea9d59d71d4a38b82506d2d16fcd560d)
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

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'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "SSL_SET1_INITIAL_PEER_ADDR 3ossl"
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.
NAME
SSL_set1_initial_peer_addr - set the initial peer address for a QUIC connection
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& int SSL_set1_initial_peer_addr(SSL *s, const BIO_ADDR *addr); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBSSL_set1_initial_peer_addr() 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. addr must point to a BIO_ADDR representing a UDP destination address of the server to connect to.

Where a QUIC connection object is provided with a write BIO which supports the \fBBIO_CTRL_DGRAM_GET_PEER control (for example, BIO_s_dgram), the initial destination peer address can be detected automatically; if \fBBIO_CTRL_DGRAM_GET_PEER returns a valid (non-AF_UNSPEC) 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() with a valid peer address explicitly.

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() 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.

This function makes a copy of the address passed by the caller; the BIO_ADDR structure pointed to by addr may be freed by the caller after this function returns.

"RETURN VALUES"
Header "RETURN VALUES" Returns 1 on success and 0 on failure.
"SEE ALSO"
Header "SEE ALSO" \fBBIO_ADDR\|(3), ssl\|(7)
HISTORY
Header "HISTORY" The SSL_set1_initial_peer_addr() function was added in OpenSSL 3.2.
COPYRIGHT
Header "COPYRIGHT" Copyright 2022-2023 The OpenSSL Project Authors. All Rights Reserved.

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>.