Debian Codegraph @

upstream/debian-unstable/man3/SSL_set1_initial_peer_addr.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_SET1_INITIAL_PEER_ADDR 3SSL"
58 .TH SSL_SET1_INITIAL_PEER_ADDR 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_set1_initial_peer_addr \- set the initial peer address for a QUIC connection
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_set1_initial_peer_addr(SSL *s, const BIO_ADDR *addr);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBSSL_set1_initial_peer_addr()\fR sets the initial destination peer address to be used
75 for the purposes of establishing a QUIC connection in client mode. This function
76 can be used only on a QUIC connection SSL object, and can be used only before a
77 connection attempt is first made. \fIaddr\fR must point to a \fBBIO_ADDR\fR
78 representing a UDP destination address of the server to connect to.
79 .PP
80 Where a QUIC connection object is provided with a write BIO which supports the
81 \&\fBBIO_CTRL_DGRAM_GET_PEER\fR control (for example, \fBBIO_s_dgram\fR), the initial
82 destination peer address can be detected automatically; if
83 \&\fBBIO_CTRL_DGRAM_GET_PEER\fR returns a valid (non\-\fBAF_UNSPEC\fR) peer address and
84 no valid peer address has yet been set, this will be set automatically as the
85 initial peer address. This behaviour can be overridden by calling
86 \&\fBSSL_set1_initial_peer_addr()\fR with a valid peer address explicitly.
87 .PP
88 The destination address used by QUIC may change over time in response to
89 connection events, such as connection migration (where supported).
90 \&\fBSSL_set1_initial_peer_addr()\fR configures the destination address used for initial
91 connection establishment, and does not confer any guarantee about the
92 destination address being used for communication at any later time in the
93 connection lifecycle.
94 .PP
95 This function makes a copy of the address passed by the caller; the \fBBIO_ADDR\fR
96 structure pointed to by \fIaddr\fR may be freed by the caller after this function
97 returns.
98 .SH "RETURN VALUES"
99 .IX Header "RETURN VALUES"
100 Returns 1 on success and 0 on failure.
101 .SH "SEE ALSO"
102 .IX Header "SEE ALSO"
103 \&\fBBIO_ADDR\fR\|(3), \fBssl\fR\|(7)
104 .SH HISTORY
105 .IX Header "HISTORY"
106 The \fBSSL_set1_initial_peer_addr()\fR function was added in OpenSSL 3.2.
107 .SH COPYRIGHT
108 .IX Header "COPYRIGHT"
109 Copyright 2022\-2023 The OpenSSL Project Authors. All Rights Reserved.
110 .PP
111 Licensed under the Apache License 2.0 (the "License"). You may not use
112 this file except in compliance with the License. You can obtain a copy
113 in the file LICENSE in the source distribution or at
114 <https://www.openssl.org/source/license.html>.