Android_verify/lib/openssl/share/man/man3/SSL_inject_net_dgram.3ossl

.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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_INJECT_NET_DGRAM 3ossl"
.TH SSL_INJECT_NET_DGRAM 3ossl 2025-01-17 3.4.0 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_inject_net_dgram \- inject a datagram as though received from the network
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
\&
\& int SSL_inject_net_dgram(SSL *s, const unsigned char *buf,
\&                          size_t buf_len,
\&                          const BIO_ADDR *peer,
\&                          const BIO_ADDR *local);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This function can be used to inject a datagram payload to a QUIC connection SSL
object. The payload is processed as though it was received from the network.
This function can be used for debugging purposes or to allow datagrams to be fed
to QUIC from alternative sources.
.PP
\&\fIbuf\fR is required and must point to a datagram payload to inject. \fIbuf_len\fR is
the length of the buffer in bytes. The buffer is copied and need not remain
valid after this function returns.
.PP
\&\fIpeer\fR and \fIlocal\fR are optional values pointing to \fBBIO_ADDR\fR structures
describing the remote and local UDP endpoint addresses for the packet. Though
the injected packet was not actually received from the network directly by
OpenSSL, the packet will be processed as though the received datagram had the
given addresses.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
Returns 1 on success or 0 on failure. This function always fails if called
on a SSL object which is not a QUIC connection SSL object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBOSSL_QUIC_client_method\fR\|(3), \fBSSL_handle_events\fR\|(3), \fBSSL_set_blocking_mode\fR\|(3)
.SH HISTORY
.IX Header "HISTORY"
The function \fBSSL_inject_net_dgram()\fR was added in OpenSSL 3.2.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 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>.