SSL_STREAM_RESET(3SSL)

📦
version 4.0.3 · 6 versions
, in ubuntu stonking

🌸 NAME 🌸

SSL_stream_reset — okay so literally this is the girl that resets a QUIC stream 💅

🦋 SYNOPSIS 🦋

#include <openssl/ssl.h>

typedef struct ssl_stream_reset_args_st {
    uint64_t quic_error_code;
} SSL_STREAM_RESET_ARGS;

int SSL_stream_reset(SSL *ssl,
                     const SSL_STREAM_RESET_ARGS *args,
                     size_t args_len);

✨ DESCRIPTION ✨

So SSL_stream_reset() resets the send part of a QUIC stream, and you can call it when you're working with either:

  • a QUIC stream SSL object, or
  • a QUIC connection SSL object that has a default stream attached 🫶

If args is non-NULL, then args_len must be set to sizeof(*args). No exceptions, bestie, that's the vibe check.

quic_error_code is an application-specified error code, and it must live in the range [0, 2**62-1]. If args is NULL? Then a value of 0 gets used. Simple as that. 🌈

Resetting a stream is basically telling an application that the sending part of the stream is terminating abnormally 😭. And here's the part you need to actually internalize: when a stream is reset, the implementation does not guarantee that any data you already passed to SSL_write(3) will be received by the peer. Also, data already passed to SSL_write(3) but not yet transmitted may or may not be discarded. Like, it's genuinely ambiguous, no cap. So the rule is: only reset a stream when the info you transmitted on that stream no longer matters — for example because of an error condition.

⚠️ This function cannot be called on a unidirectional stream initiated by the peer, because only the sending side of a stream can initiate a stream reset. Periodt.

It's also possible to trigger a stream reset by calling SSL_free(3) — go read the SSL_free(3) docs for the deets, iykyk.

Oh and the receiving part of the stream (for bidirectional streams) keeps functioning normally 💖. She's fine, she's thriving, she's just not the one getting reset.

📝 NOTES 📝

This function corresponds to the QUIC RESET_STREAM frame. That's it, that's the note. 👑

⭐ RETURN VALUES ⭐

  • Returns 1 on success and 0 on failure. Classic binary slay.

This function fails if you call it on:

  • a QUIC connection SSL object without a default stream attached, or
  • a non-QUIC SSL object. 💀

And here's a fun one: after the first call to this function succeeds for a given stream, any subsequent calls succeed but are ignored. The application error code that ends up being used is the one passed to the first successful call to this function. So like, the first girl to speak wins, periodt. 🙈

👑 SEE ALSO 👑

🎀 HISTORY 🎀

SSL_stream_reset() was added in OpenSSL 3.2. A relatively recent icon, honestly. ✨

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

okay bestie that's the whole page, you're officially fluent in SSL_stream_reset 🧚

this was version 4.0.3, dated 2026-09-29, from the SSL_STREAM_RESET(3SSL) manual — love you, go reset something responsibly 💖🦋✨

📦 where this page comes from