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 OR GPL-2.0-or-later 9 * 10 * This file is provided under the Apache License 2.0, or the 11 * GNU General Public License v2.0 or later. 12 * 13 * ********** 14 * Apache License 2.0: 15 * 16 * Licensed under the Apache License, Version 2.0 (the "License"); you may 17 * not use this file except in compliance with the License. 18 * You may obtain a copy of the License at 19 * 20 * http://www.apache.org/licenses/LICENSE-2.0 21 * 22 * Unless required by applicable law or agreed to in writing, software 23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 25 * See the License for the specific language governing permissions and 26 * limitations under the License. 27 * 28 * ********** 29 * 30 * ********** 31 * GNU General Public License v2.0 or later: 32 * 33 * This program is free software; you can redistribute it and/or modify 34 * it under the terms of the GNU General Public License as published by 35 * the Free Software Foundation; either version 2 of the License, or 36 * (at your option) any later version. 37 * 38 * This program is distributed in the hope that it will be useful, 39 * but WITHOUT ANY WARRANTY; without even the implied warranty of 40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 41 * GNU General Public License for more details. 42 * 43 * You should have received a copy of the GNU General Public License along 44 * with this program; if not, write to the Free Software Foundation, Inc., 45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 46 * 47 * ********** 48 */ 49 #ifndef MBEDTLS_ERROR_H 50 #define MBEDTLS_ERROR_H 51 52 #if !defined(MBEDTLS_CONFIG_FILE) 53 #include "config.h" 54 #else 55 #include MBEDTLS_CONFIG_FILE 56 #endif 57 58 #include <stddef.h> 59 60 /** 61 * Error code layout. 62 * 63 * Currently we try to keep all error codes within the negative space of 16 64 * bits signed integers to support all platforms (-0x0001 - -0x7FFF). In 65 * addition we'd like to give two layers of information on the error if 66 * possible. 67 * 68 * For that purpose the error codes are segmented in the following manner: 69 * 70 * 16 bit error code bit-segmentation 71 * 72 * 1 bit - Unused (sign bit) 73 * 3 bits - High level module ID 74 * 5 bits - Module-dependent error code 75 * 7 bits - Low level module errors 76 * 77 * For historical reasons, low-level error codes are divided in even and odd, 78 * even codes were assigned first, and -1 is reserved for other errors. 79 * 80 * Low-level module errors (0x0002-0x007E, 0x0003-0x007F) 81 * 82 * Module Nr Codes assigned 83 * MPI 7 0x0002-0x0010 84 * GCM 3 0x0012-0x0014 0x0013-0x0013 85 * BLOWFISH 3 0x0016-0x0018 0x0017-0x0017 86 * THREADING 3 0x001A-0x001E 87 * AES 5 0x0020-0x0022 0x0021-0x0025 88 * CAMELLIA 3 0x0024-0x0026 0x0027-0x0027 89 * XTEA 2 0x0028-0x0028 0x0029-0x0029 90 * BASE64 2 0x002A-0x002C 91 * OID 1 0x002E-0x002E 0x000B-0x000B 92 * PADLOCK 1 0x0030-0x0030 93 * DES 2 0x0032-0x0032 0x0033-0x0033 94 * CTR_DBRG 4 0x0034-0x003A 95 * ENTROPY 3 0x003C-0x0040 0x003D-0x003F 96 * NET 13 0x0042-0x0052 0x0043-0x0049 97 * ARIA 4 0x0058-0x005E 98 * ASN1 7 0x0060-0x006C 99 * CMAC 1 0x007A-0x007A 100 * PBKDF2 1 0x007C-0x007C 101 * HMAC_DRBG 4 0x0003-0x0009 102 * CCM 3 0x000D-0x0011 103 * ARC4 1 0x0019-0x0019 104 * MD2 1 0x002B-0x002B 105 * MD4 1 0x002D-0x002D 106 * MD5 1 0x002F-0x002F 107 * RIPEMD160 1 0x0031-0x0031 108 * SHA1 1 0x0035-0x0035 0x0073-0x0073 109 * SHA256 1 0x0037-0x0037 0x0074-0x0074 110 * SHA512 1 0x0039-0x0039 0x0075-0x0075 111 * CHACHA20 3 0x0051-0x0055 112 * POLY1305 3 0x0057-0x005B 113 * CHACHAPOLY 2 0x0054-0x0056 114 * PLATFORM 1 0x0070-0x0072 115 * 116 * High-level module nr (3 bits - 0x0...-0x7...) 117 * Name ID Nr of Errors 118 * PEM 1 9 119 * PKCS#12 1 4 (Started from top) 120 * X509 2 20 121 * PKCS5 2 4 (Started from top) 122 * DHM 3 11 123 * PK 3 15 (Started from top) 124 * RSA 4 11 125 * ECP 4 10 (Started from top) 126 * MD 5 5 127 * HKDF 5 1 (Started from top) 128 * SSL 5 1 (Started from 0x5E80) 129 * CIPHER 6 8 130 * SSL 6 23 (Started from top) 131 * SSL 7 32 132 * 133 * Module dependent error code (5 bits 0x.00.-0x.F8.) 134 */ 135 136 #ifdef __cplusplus 137 extern "C" { 138 #endif 139 140 /** 141 * \brief Translate a mbed TLS error code into a string representation, 142 * Result is truncated if necessary and always includes a terminating 143 * null byte. 144 * 145 * \param errnum error code 146 * \param buffer buffer to place representation in 147 * \param buflen length of the buffer 148 */ 149 void mbedtls_strerror( int errnum, char *buffer, size_t buflen ); 150 151 #ifdef __cplusplus 152 } 153 #endif 154 155 #endif /* error.h */ 156