1 /**
2 * \file error.h
3 *
4 * \brief Error to string translation
5 */
6 /*
7 * Copyright The Mbed TLS Contributors
8 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 */
22 #ifndef MBEDTLS_ERROR_H
23 #define MBEDTLS_ERROR_H
24
25 #include "mbedtls/build_info.h"
26
27 #include <stddef.h>
28
29 /**
30 * Error code layout.
31 *
32 * Currently we try to keep all error codes within the negative space of 16
33 * bits signed integers to support all platforms (-0x0001 - -0x7FFF). In
34 * addition we'd like to give two layers of information on the error if
35 * possible.
36 *
37 * For that purpose the error codes are segmented in the following manner:
38 *
39 * 16 bit error code bit-segmentation
40 *
41 * 1 bit - Unused (sign bit)
42 * 3 bits - High level module ID
43 * 5 bits - Module-dependent error code
44 * 7 bits - Low level module errors
45 *
46 * For historical reasons, low-level error codes are divided in even and odd,
47 * even codes were assigned first, and -1 is reserved for other errors.
48 *
49 * Low-level module errors (0x0002-0x007E, 0x0001-0x007F)
50 *
51 * Module Nr Codes assigned
52 * ERROR 2 0x006E 0x0001
53 * MPI 7 0x0002-0x0010
54 * GCM 3 0x0012-0x0016 0x0013-0x0013
55 * THREADING 3 0x001A-0x001E
56 * AES 5 0x0020-0x0022 0x0021-0x0025
57 * CAMELLIA 3 0x0024-0x0026 0x0027-0x0027
58 * BASE64 2 0x002A-0x002C
59 * OID 1 0x002E-0x002E 0x000B-0x000B
60 * PADLOCK 1 0x0030-0x0030
61 * DES 2 0x0032-0x0032 0x0033-0x0033
62 * CTR_DBRG 4 0x0034-0x003A
63 * ENTROPY 3 0x003C-0x0040 0x003D-0x003F
64 * NET 13 0x0042-0x0052 0x0043-0x0049
65 * ARIA 4 0x0058-0x005E
66 * ASN1 7 0x0060-0x006C
67 * CMAC 1 0x007A-0x007A
68 * PBKDF2 1 0x007C-0x007C
69 * HMAC_DRBG 4 0x0003-0x0009
70 * CCM 3 0x000D-0x0011
71 * MD5 1 0x002F-0x002F
72 * RIPEMD160 1 0x0031-0x0031
73 * SHA1 1 0x0035-0x0035 0x0073-0x0073
74 * SHA256 1 0x0037-0x0037 0x0074-0x0074
75 * SHA512 1 0x0039-0x0039 0x0075-0x0075
76 * CHACHA20 3 0x0051-0x0055
77 * POLY1305 3 0x0057-0x005B
78 * CHACHAPOLY 2 0x0054-0x0056
79 * PLATFORM 2 0x0070-0x0072
80 * LMS 5 0x0011-0x0019
81 *
82 * High-level module nr (3 bits - 0x0...-0x7...)
83 * Name ID Nr of Errors
84 * PEM 1 9
85 * PKCS#12 1 4 (Started from top)
86 * X509 2 20
87 * PKCS5 2 4 (Started from top)
88 * DHM 3 11
89 * PK 3 15 (Started from top)
90 * RSA 4 11
91 * ECP 4 10 (Started from top)
92 * MD 5 5
93 * HKDF 5 1 (Started from top)
94 * PKCS7 5 12 (Started from 0x5300)
95 * SSL 5 2 (Started from 0x5F00)
96 * CIPHER 6 8 (Started from 0x6080)
97 * SSL 6 22 (Started from top, plus 0x6000)
98 * SSL 7 20 (Started from 0x7000, gaps at
99 * 0x7380, 0x7900-0x7980, 0x7A80-0x7E80)
100 *
101 * Module dependent error code (5 bits 0x.00.-0x.F8.)
102 */
103
104 #ifdef __cplusplus
105 extern "C" {
106 #endif
107
108 /** Generic error */
109 #define MBEDTLS_ERR_ERROR_GENERIC_ERROR -0x0001
110 /** This is a bug in the library */
111 #define MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED -0x006E
112
113 /** Hardware accelerator failed */
114 #define MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED -0x0070
115 /** The requested feature is not supported by the platform */
116 #define MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED -0x0072
117
118 /**
119 * \brief Combines a high-level and low-level error code together.
120 *
121 * Wrapper macro for mbedtls_error_add(). See that function for
122 * more details.
123 */
124 #define MBEDTLS_ERROR_ADD( high, low ) \
125 mbedtls_error_add( high, low, __FILE__, __LINE__ )
126
127 #if defined(MBEDTLS_TEST_HOOKS)
128 /**
129 * \brief Testing hook called before adding/combining two error codes together.
130 * Only used when invasive testing is enabled via MBEDTLS_TEST_HOOKS.
131 */
132 extern void (*mbedtls_test_hook_error_add)( int, int, const char *, int );
133 #endif
134
135 /**
136 * \brief Combines a high-level and low-level error code together.
137 *
138 * This function can be called directly however it is usually
139 * called via the #MBEDTLS_ERROR_ADD macro.
140 *
141 * While a value of zero is not a negative error code, it is still an
142 * error code (that denotes success) and can be combined with both a
143 * negative error code or another value of zero.
144 *
145 * \note When invasive testing is enabled via #MBEDTLS_TEST_HOOKS, also try to
146 * call \link mbedtls_test_hook_error_add \endlink.
147 *
148 * \param high high-level error code. See error.h for more details.
149 * \param low low-level error code. See error.h for more details.
150 * \param file file where this error code addition occurred.
151 * \param line line where this error code addition occurred.
152 */
mbedtls_error_add(int high,int low,const char * file,int line)153 static inline int mbedtls_error_add( int high, int low,
154 const char *file, int line )
155 {
156 #if defined(MBEDTLS_TEST_HOOKS)
157 if( *mbedtls_test_hook_error_add != NULL )
158 ( *mbedtls_test_hook_error_add )( high, low, file, line );
159 #endif
160 (void)file;
161 (void)line;
162
163 return( high + low );
164 }
165
166 /**
167 * \brief Translate a mbed TLS error code into a string representation,
168 * Result is truncated if necessary and always includes a terminating
169 * null byte.
170 *
171 * \param errnum error code
172 * \param buffer buffer to place representation in
173 * \param buflen length of the buffer
174 */
175 void mbedtls_strerror( int errnum, char *buffer, size_t buflen );
176
177 /**
178 * \brief Translate the high-level part of an Mbed TLS error code into a string
179 * representation.
180 *
181 * This function returns a const pointer to an un-modifiable string. The caller
182 * must not try to modify the string. It is intended to be used mostly for
183 * logging purposes.
184 *
185 * \param error_code error code
186 *
187 * \return The string representation of the error code, or \c NULL if the error
188 * code is unknown.
189 */
190 const char * mbedtls_high_level_strerr( int error_code );
191
192 /**
193 * \brief Translate the low-level part of an Mbed TLS error code into a string
194 * representation.
195 *
196 * This function returns a const pointer to an un-modifiable string. The caller
197 * must not try to modify the string. It is intended to be used mostly for
198 * logging purposes.
199 *
200 * \param error_code error code
201 *
202 * \return The string representation of the error code, or \c NULL if the error
203 * code is unknown.
204 */
205 const char * mbedtls_low_level_strerr( int error_code );
206
207 #ifdef __cplusplus
208 }
209 #endif
210
211 #endif /* error.h */
212
