Debian Codegraph @

upstream/debian-unstable/man3/SSL_inject_net_dgram.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_INJECT_NET_DGRAM 3SSL"
58 .TH SSL_INJECT_NET_DGRAM 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_inject_net_dgram \- inject a datagram as though received from the network
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_inject_net_dgram(SSL *s, const unsigned char *buf,
71 \& size_t buf_len,
72 \& const BIO_ADDR *peer,
73 \& const BIO_ADDR *local);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 This function can be used to inject a datagram payload to a QUIC connection SSL
78 object. The payload is processed as though it was received from the network.
79 This function can be used for debugging purposes or to allow datagrams to be fed
80 to QUIC from alternative sources.
81 .PP
82 \&\fIbuf\fR is required and must point to a datagram payload to inject. \fIbuf_len\fR is
83 the length of the buffer in bytes. The buffer is copied and need not remain
84 valid after this function returns.
85 .PP
86 \&\fIpeer\fR and \fIlocal\fR are optional values pointing to \fBBIO_ADDR\fR structures
87 describing the remote and local UDP endpoint addresses for the packet. Though
88 the injected packet was not actually received from the network directly by
89 OpenSSL, the packet will be processed as though the received datagram had the
90 given addresses.
91 .SH "RETURN VALUES"
92 .IX Header "RETURN VALUES"
93 Returns 1 on success or 0 on failure. This function always fails if called
94 on an SSL object which is not a QUIC connection SSL object.
95 .SH "SEE ALSO"
96 .IX Header "SEE ALSO"
97 \&\fBOSSL_QUIC_client_method\fR\|(3), \fBSSL_handle_events\fR\|(3), \fBSSL_set_blocking_mode\fR\|(3)
98 .SH HISTORY
99 .IX Header "HISTORY"
100 The function \fBSSL_inject_net_dgram()\fR was added in OpenSSL 3.2.
101 .SH COPYRIGHT
102 .IX Header "COPYRIGHT"
103 Copyright 2023 The OpenSSL Project Authors. All Rights Reserved.
104 .PP
105 Licensed under the Apache License 2.0 (the "License"). You may not use
106 this file except in compliance with the License. You can obtain a copy
107 in the file LICENSE in the source distribution or at
108 <https://www.openssl.org/source/license.html>.