QUIC: Add documentation for QUIC error codes

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/23598)
This commit is contained in:
Hugo Landau 2024-02-15 09:03:26 +00:00
parent 4b4b9c9eb3
commit c38558357d
2 changed files with 66 additions and 2 deletions

View File

@ -3,8 +3,28 @@
=head1 NAME
SSL_get_conn_close_info, SSL_CONN_CLOSE_FLAG_LOCAL,
SSL_CONN_CLOSE_FLAG_TRANSPORT - get information about why a QUIC connection was
closed
SSL_CONN_CLOSE_FLAG_TRANSPORT,
OSSL_QUIC_ERR_NO_ERROR,
OSSL_QUIC_ERR_INTERNAL_ERROR,
OSSL_QUIC_ERR_CONNECTION_REFUSED,
OSSL_QUIC_ERR_FLOW_CONTROL_ERROR,
OSSL_QUIC_ERR_STREAM_LIMIT_ERROR,
OSSL_QUIC_ERR_STREAM_STATE_ERROR,
OSSL_QUIC_ERR_FINAL_SIZE_ERROR,
OSSL_QUIC_ERR_FRAME_ENCODING_ERROR,
OSSL_QUIC_ERR_TRANSPORT_PARAMETER_ERROR,
OSSL_QUIC_ERR_CONNECTION_ID_LIMIT_ERROR,
OSSL_QUIC_ERR_PROTOCOL_VIOLATION,
OSSL_QUIC_ERR_INVALID_TOKEN,
OSSL_QUIC_ERR_APPLICATION_ERROR,
OSSL_QUIC_ERR_CRYPTO_BUFFER_EXCEEDED,
OSSL_QUIC_ERR_KEY_UPDATE_ERROR,
OSSL_QUIC_ERR_AEAD_LIMIT_REACHED,
OSSL_QUIC_ERR_NO_VIABLE_PATH,
OSSL_QUIC_ERR_CRYPTO_ERR_BEGIN,
OSSL_QUIC_ERR_CRYPTO_ERR_END,
OSSL_QUIC_ERR_CRYPTO_ERR
- get information about why a QUIC connection was closed
=head1 SYNOPSIS
@ -23,6 +43,30 @@ closed
int SSL_get_conn_close_info(SSL *ssl, SSL_CONN_CLOSE_INFO *info,
size_t info_len);
#define OSSL_QUIC_ERR_NO_ERROR 0x00
#define OSSL_QUIC_ERR_INTERNAL_ERROR 0x01
#define OSSL_QUIC_ERR_CONNECTION_REFUSED 0x02
#define OSSL_QUIC_ERR_FLOW_CONTROL_ERROR 0x03
#define OSSL_QUIC_ERR_STREAM_LIMIT_ERROR 0x04
#define OSSL_QUIC_ERR_STREAM_STATE_ERROR 0x05
#define OSSL_QUIC_ERR_FINAL_SIZE_ERROR 0x06
#define OSSL_QUIC_ERR_FRAME_ENCODING_ERROR 0x07
#define OSSL_QUIC_ERR_TRANSPORT_PARAMETER_ERROR 0x08
#define OSSL_QUIC_ERR_CONNECTION_ID_LIMIT_ERROR 0x09
#define OSSL_QUIC_ERR_PROTOCOL_VIOLATION 0x0A
#define OSSL_QUIC_ERR_INVALID_TOKEN 0x0B
#define OSSL_QUIC_ERR_APPLICATION_ERROR 0x0C
#define OSSL_QUIC_ERR_CRYPTO_BUFFER_EXCEEDED 0x0D
#define OSSL_QUIC_ERR_KEY_UPDATE_ERROR 0x0E
#define OSSL_QUIC_ERR_AEAD_LIMIT_REACHED 0x0F
#define OSSL_QUIC_ERR_NO_VIABLE_PATH 0x10
/* Inclusive range for handshake-specific errors. */
#define OSSL_QUIC_ERR_CRYPTO_ERR_BEGIN 0x0100
#define OSSL_QUIC_ERR_CRYPTO_ERR_END 0x01FF
#define OSSL_QUIC_ERR_CRYPTO_ERR(X)
=head1 DESCRIPTION
The SSL_get_conn_close_info() function provides information about why and how a

View File

@ -490,6 +490,26 @@ OSSL_ENCODER_Parameters_TO_PEM_PQ define
OSSL_ENCODER_PUBKEY_TO_TEXT_PQ define
OSSL_ENCODER_PrivateKey_TO_TEXT_PQ define
OSSL_ENCODER_Parameters_TO_TEXT_PQ define
OSSL_QUIC_ERR_NO_ERROR define
OSSL_QUIC_ERR_INTERNAL_ERROR define
OSSL_QUIC_ERR_CONNECTION_REFUSED define
OSSL_QUIC_ERR_FLOW_CONTROL_ERROR define
OSSL_QUIC_ERR_STREAM_LIMIT_ERROR define
OSSL_QUIC_ERR_STREAM_STATE_ERROR define
OSSL_QUIC_ERR_FINAL_SIZE_ERROR define
OSSL_QUIC_ERR_FRAME_ENCODING_ERROR define
OSSL_QUIC_ERR_TRANSPORT_PARAMETER_ERROR define
OSSL_QUIC_ERR_CONNECTION_ID_LIMIT_ERROR define
OSSL_QUIC_ERR_PROTOCOL_VIOLATION define
OSSL_QUIC_ERR_INVALID_TOKEN define
OSSL_QUIC_ERR_APPLICATION_ERROR define
OSSL_QUIC_ERR_CRYPTO_BUFFER_EXCEEDED define
OSSL_QUIC_ERR_KEY_UPDATE_ERROR define
OSSL_QUIC_ERR_AEAD_LIMIT_REACHED define
OSSL_QUIC_ERR_NO_VIABLE_PATH define
OSSL_QUIC_ERR_CRYPTO_ERR_BEGIN define
OSSL_QUIC_ERR_CRYPTO_ERR_END define
OSSL_QUIC_ERR_CRYPTO_ERR define
PEM_FLAG_EAY_COMPATIBLE define
PEM_FLAG_ONLY_B64 define
PEM_FLAG_SECURE define