xref: /freebsd/secure/lib/libcrypto/man/man3/SSL_inject_net_dgram.3 (revision b5daf675efc746611c7cfcd1fa474b8905064c4b)
-*- 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_INJECT_NET_DGRAM 3ossl"
SSL_INJECT_NET_DGRAM 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_inject_net_dgram - inject a datagram as though received from the network
SYNOPSIS
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
DESCRIPTION
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.

\fIbuf is required and must point to a datagram payload to inject. buf_len is the length of the buffer in bytes. The buffer is copied and need not remain valid after this function returns.

\fIpeer and local are optional values pointing to BIO_ADDR 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.

"RETURN VALUES"
Header "RETURN VALUES" Returns 1 on success or 0 on failure. This function always fails if called on an SSL object which is not a QUIC connection SSL object.
"SEE ALSO"
Header "SEE ALSO" \fBOSSL_QUIC_client_method\|(3), SSL_handle_events\|(3), SSL_set_blocking_mode\|(3)
HISTORY
Header "HISTORY" The function SSL_inject_net_dgram() was added in OpenSSL 3.2.
COPYRIGHT
Header "COPYRIGHT" Copyright 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>.