1 /** 2 * \file error.h 3 * 4 * \brief Error to string translation 5 */ 6 /* 7 * Copyright (C) 2006-2018, ARM Limited, All Rights Reserved 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 * This file is part of mbed TLS (https://tls.mbed.org) 23 */ 24 #ifndef MBEDTLS_ERROR_H 25 #define MBEDTLS_ERROR_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, 0x0003-0x007F) 50 * 51 * Module Nr Codes assigned 52 * MPI 7 0x0002-0x0010 53 * GCM 3 0x0012-0x0014 0x0013-0x0013 54 * BLOWFISH 3 0x0016-0x0018 0x0017-0x0017 55 * THREADING 3 0x001A-0x001E 56 * AES 5 0x0020-0x0022 0x0021-0x0025 57 * CAMELLIA 3 0x0024-0x0026 0x0027-0x0027 58 * XTEA 2 0x0028-0x0028 0x0029-0x0029 59 * BASE64 2 0x002A-0x002C 60 * OID 1 0x002E-0x002E 0x000B-0x000B 61 * PADLOCK 1 0x0030-0x0030 62 * DES 2 0x0032-0x0032 0x0033-0x0033 63 * CTR_DBRG 4 0x0034-0x003A 64 * ENTROPY 3 0x003C-0x0040 0x003D-0x003F 65 * NET 13 0x0042-0x0052 0x0043-0x0049 66 * ARIA 4 0x0058-0x005E 67 * ASN1 7 0x0060-0x006C 68 * CMAC 1 0x007A-0x007A 69 * PBKDF2 1 0x007C-0x007C 70 * HMAC_DRBG 4 0x0003-0x0009 71 * CCM 3 0x000D-0x0011 72 * ARC4 1 0x0019-0x0019 73 * MD2 1 0x002B-0x002B 74 * MD4 1 0x002D-0x002D 75 * MD5 1 0x002F-0x002F 76 * RIPEMD160 1 0x0031-0x0031 77 * SHA1 1 0x0035-0x0035 0x0073-0x0073 78 * SHA256 1 0x0037-0x0037 0x0074-0x0074 79 * SHA512 1 0x0039-0x0039 0x0075-0x0075 80 * CHACHA20 3 0x0051-0x0055 81 * POLY1305 3 0x0057-0x005B 82 * CHACHAPOLY 2 0x0054-0x0056 83 * PLATFORM 1 0x0070-0x0072 84 * 85 * High-level module nr (3 bits - 0x0...-0x7...) 86 * Name ID Nr of Errors 87 * PEM 1 9 88 * PKCS#12 1 4 (Started from top) 89 * X509 2 20 90 * PKCS5 2 4 (Started from top) 91 * DHM 3 11 92 * PK 3 15 (Started from top) 93 * RSA 4 11 94 * ECP 4 10 (Started from top) 95 * MD 5 5 96 * HKDF 5 1 (Started from top) 97 * CIPHER 6 8 98 * SSL 6 23 (Started from top) 99 * SSL 7 32 100 * 101 * Module dependent error code (5 bits 0x.00.-0x.F8.) 102 */ 103 104 #ifdef __cplusplus 105 extern "C" { 106 #endif 107 108 /** 109 * \brief Translate a mbed TLS error code into a string representation, 110 * Result is truncated if necessary and always includes a terminating 111 * null byte. 112 * 113 * \param errnum error code 114 * \param buffer buffer to place representation in 115 * \param buflen length of the buffer 116 */ 117 void mbedtls_strerror( int errnum, char *buffer, size_t buflen ); 118 119 #ifdef __cplusplus 120 } 121 #endif 122 123 #endif /* error.h */ 124