summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorHugo Landau <hlandau@openssl.org>2024-02-15 09:03:26 +0000
committerHugo Landau <hlandau@openssl.org>2024-03-07 23:48:49 +0000
commitc38558357de693ac9807d42c5f700ee59de7f20d (patch)
treefe42a4783e1067513a785e1c2bc37aafe481a927 /doc
parent4b4b9c9eb3e677de6276c94758cb554c8f560697 (diff)
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)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/SSL_get_conn_close_info.pod48
1 files changed, 46 insertions, 2 deletions
diff --git a/doc/man3/SSL_get_conn_close_info.pod b/doc/man3/SSL_get_conn_close_info.pod
index fb8e0d25d3..bb5bc72b7a 100644
--- a/doc/man3/SSL_get_conn_close_info.pod
+++ b/doc/man3/SSL_get_conn_close_info.pod
@@ -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