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 /** 34 * Error code layout. 35 * 36 * Currently we try to keep all error codes within the negative space of 16 37 * bits signed integers to support all platforms (-0x0001 - -0x7FFF). In 38 * addition we'd like to give two layers of information on the error if 39 * possible. 40 * 41 * For that purpose the error codes are segmented in the following manner: 42 * 43 * 16 bit error code bit-segmentation 44 * 45 * 1 bit - Unused (sign bit) 46 * 3 bits - High level module ID 47 * 5 bits - Module-dependent error code 48 * 7 bits - Low level module errors 49 * 50 * For historical reasons, low-level error codes are divided in even and odd, 51 * even codes were assigned first, and -1 is reserved for other errors. 52 * 53 * Low-level module errors (0x0002-0x007E, 0x0001-0x007F) 54 * 55 * Module Nr Codes assigned 56 * ERROR 2 0x006E 0x0001 57 * MPI 7 0x0002-0x0010 58 * GCM 3 0x0012-0x0014 0x0013-0x0013 59 * BLOWFISH 3 0x0016-0x0018 0x0017-0x0017 60 * THREADING 3 0x001A-0x001E 61 * AES 5 0x0020-0x0022 0x0021-0x0025 62 * CAMELLIA 3 0x0024-0x0026 0x0027-0x0027 63 * XTEA 2 0x0028-0x0028 0x0029-0x0029 64 * BASE64 2 0x002A-0x002C 65 * OID 1 0x002E-0x002E 0x000B-0x000B 66 * PADLOCK 1 0x0030-0x0030 67 * DES 2 0x0032-0x0032 0x0033-0x0033 68 * CTR_DBRG 4 0x0034-0x003A 69 * ENTROPY 3 0x003C-0x0040 0x003D-0x003F 70 * NET 13 0x0042-0x0052 0x0043-0x0049 71 * ARIA 4 0x0058-0x005E 72 * ASN1 7 0x0060-0x006C 73 * CMAC 1 0x007A-0x007A 74 * PBKDF2 1 0x007C-0x007C 75 * HMAC_DRBG 4 0x0003-0x0009 76 * CCM 3 0x000D-0x0011 77 * ARC4 1 0x0019-0x0019 78 * MD2 1 0x002B-0x002B 79 * MD4 1 0x002D-0x002D 80 * MD5 1 0x002F-0x002F 81 * RIPEMD160 1 0x0031-0x0031 82 * SHA1 1 0x0035-0x0035 0x0073-0x0073 83 * SHA256 1 0x0037-0x0037 0x0074-0x0074 84 * SHA512 1 0x0039-0x0039 0x0075-0x0075 85 * CHACHA20 3 0x0051-0x0055 86 * POLY1305 3 0x0057-0x005B 87 * CHACHAPOLY 2 0x0054-0x0056 88 * PLATFORM 2 0x0070-0x0072 89 * 90 * High-level module nr (3 bits - 0x0...-0x7...) 91 * Name ID Nr of Errors 92 * PEM 1 9 93 * PKCS#12 1 4 (Started from top) 94 * X509 2 20 95 * PKCS5 2 4 (Started from top) 96 * DHM 3 11 97 * PK 3 15 (Started from top) 98 * RSA 4 11 99 * ECP 4 10 (Started from top) 100 * MD 5 5 101 * HKDF 5 1 (Started from top) 102 * SSL 5 2 (Started from 0x5F00) 103 * CIPHER 6 8 (Started from 0x6080) 104 * SSL 6 24 (Started from top, plus 0x6000) 105 * SSL 7 32 106 * 107 * Module dependent error code (5 bits 0x.00.-0x.F8.) 108 */ 109 110 #ifdef __cplusplus 111 extern "C" { 112 #endif 113 114 #define MBEDTLS_ERR_ERROR_GENERIC_ERROR -0x0001 /**< Generic error */ 115 #define MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED -0x006E /**< This is a bug in the library */ 116 117 /** 118 * \brief Translate a mbed TLS error code into a string representation, 119 * Result is truncated if necessary and always includes a terminating 120 * null byte. 121 * 122 * \param errnum error code 123 * \param buffer buffer to place representation in 124 * \param buflen length of the buffer 125 */ 126 void mbedtls_strerror( int errnum, char *buffer, size_t buflen ); 127 128 /** 129 * \brief Translate the high-level part of an Mbed TLS error code into a string 130 * representation. 131 * 132 * This function returns a const pointer to an un-modifiable string. The caller 133 * must not try to modify the string. It is intended to be used mostly for 134 * logging purposes. 135 * 136 * \param error_code error code 137 * 138 * \return The string representation of the error code, or \c NULL if the error 139 * code is unknown. 140 */ 141 const char * mbedtls_high_level_strerr( int error_code ); 142 143 /** 144 * \brief Translate the low-level part of an Mbed TLS error code into a string 145 * representation. 146 * 147 * This function returns a const pointer to an un-modifiable string. The caller 148 * must not try to modify the string. It is intended to be used mostly for 149 * logging purposes. 150 * 151 * \param error_code error code 152 * 153 * \return The string representation of the error code, or \c NULL if the error 154 * code is unknown. 155 */ 156 const char * mbedtls_low_level_strerr( int error_code ); 157 158 #ifdef __cplusplus 159 } 160 #endif 161 162 #endif /* error.h */ 163
