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