QUIC CHANNEL: Improve error reporting
[openssl.git] / include / internal / quic_error.h
1 /*
2  * Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef OSSL_QUIC_ERROR_H
11 # define OSSL_QUIC_ERROR_H
12
13 # include <openssl/ssl.h>
14
15 # ifndef OPENSSL_NO_QUIC
16
17 /* RFC 9000 Section 20.1 */
18 #  define QUIC_ERR_NO_ERROR                  0x00
19 #  define QUIC_ERR_INTERNAL_ERROR            0x01
20 #  define QUIC_ERR_CONNECTION_REFUSED        0x02
21 #  define QUIC_ERR_FLOW_CONTROL_ERROR        0x03
22 #  define QUIC_ERR_STREAM_LIMIT_ERROR        0x04
23 #  define QUIC_ERR_STREAM_STATE_ERROR        0x05
24 #  define QUIC_ERR_FINAL_SIZE_ERROR          0x06
25 #  define QUIC_ERR_FRAME_ENCODING_ERROR      0x07
26 #  define QUIC_ERR_TRANSPORT_PARAMETER_ERROR 0x08
27 #  define QUIC_ERR_CONNECTION_ID_LIMIT_ERROR 0x09
28 #  define QUIC_ERR_PROTOCOL_VIOLATION        0x0A
29 #  define QUIC_ERR_INVALID_TOKEN             0x0B
30 #  define QUIC_ERR_APPLICATION_ERROR         0x0C
31 #  define QUIC_ERR_CRYPTO_BUFFER_EXCEEDED    0x0D
32 #  define QUIC_ERR_KEY_UPDATE_ERROR          0x0E
33 #  define QUIC_ERR_AEAD_LIMIT_REACHED        0x0F
34 #  define QUIC_ERR_NO_VIABLE_PATH            0x10
35
36 /* Inclusive range for handshake-specific errors. */
37 #  define QUIC_ERR_CRYPTO_ERR_BEGIN          0x0100
38 #  define QUIC_ERR_CRYPTO_ERR_END            0x01FF
39
40 #  define QUIC_ERR_CRYPTO_ERR(X) \
41     (QUIC_ERR_CRYPTO_ERR_BEGIN + (X))
42
43 #  define QUIC_ERR_CRYPTO_MISSING_EXT \
44     QUIC_ERR_CRYPTO_ERR(TLS13_AD_MISSING_EXTENSION)
45
46 #  define QUIC_ERR_CRYPTO_NO_APP_PROTO \
47     QUIC_ERR_CRYPTO_ERR(TLS1_AD_NO_APPLICATION_PROTOCOL)
48
49 static ossl_inline ossl_unused const char *
50 ossl_quic_err_to_string(uint64_t error_code)
51 {
52     switch (error_code) {
53 #define X(name) case QUIC_ERR_##name: return #name;
54     X(NO_ERROR)
55     X(INTERNAL_ERROR)
56     X(CONNECTION_REFUSED)
57     X(FLOW_CONTROL_ERROR)
58     X(STREAM_LIMIT_ERROR)
59     X(STREAM_STATE_ERROR)
60     X(FINAL_SIZE_ERROR)
61     X(FRAME_ENCODING_ERROR)
62     X(TRANSPORT_PARAMETER_ERROR)
63     X(CONNECTION_ID_LIMIT_ERROR)
64     X(PROTOCOL_VIOLATION)
65     X(INVALID_TOKEN)
66     X(APPLICATION_ERROR)
67     X(CRYPTO_BUFFER_EXCEEDED)
68     X(KEY_UPDATE_ERROR)
69     X(AEAD_LIMIT_REACHED)
70     X(NO_VIABLE_PATH)
71 #undef X
72     default:
73         return NULL;
74     }
75 }
76
77 # endif
78
79 #endif