1 /** 2 * \file error.h 3 * 4 * \brief Error to string translation 5 * 6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 7 * SPDX-License-Identifier: Apache-2.0 8 * 9 * Licensed under the Apache License, Version 2.0 (the "License"); you may 10 * not use this file except in compliance with the License. 11 * You may obtain a copy of the License at 12 * 13 * http://www.apache.org/licenses/LICENSE-2.0 14 * 15 * Unless required by applicable law or agreed to in writing, software 16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 18 * See the License for the specific language governing permissions and 19 * limitations under the License. 20 * 21 * This file is part of mbed TLS (https://tls.mbed.org) 22 */ 23 #ifndef MBEDTLS_ERROR_H 24 #define MBEDTLS_ERROR_H 25 26 #include <stddef.h> 27 28 /** 29 * Error code layout. 30 * 31 * Currently we try to keep all error codes within the negative space of 16 32 * bits signed integers to support all platforms (-0x0001 - -0x7FFF). In 33 * addition we'd like to give two layers of information on the error if 34 * possible. 35 * 36 * For that purpose the error codes are segmented in the following manner: 37 * 38 * 16 bit error code bit-segmentation 39 * 40 * 1 bit - Unused (sign bit) 41 * 3 bits - High level module ID 42 * 5 bits - Module-dependent error code 43 * 7 bits - Low level module errors 44 * 45 * For historical reasons, low-level error codes are divided in even and odd, 46 * even codes were assigned first, and -1 is reserved for other errors. 47 * 48 * Low-level module errors (0x0002-0x007E, 0x0003-0x007F) 49 * 50 * Module Nr Codes assigned 51 * MPI 7 0x0002-0x0010 52 * GCM 2 0x0012-0x0014 53 * BLOWFISH 2 0x0016-0x0018 54 * THREADING 3 0x001A-0x001E 55 * AES 2 0x0020-0x0022 56 * CAMELLIA 2 0x0024-0x0026 57 * XTEA 1 0x0028-0x0028 58 * BASE64 2 0x002A-0x002C 59 * OID 1 0x002E-0x002E 0x000B-0x000B 60 * PADLOCK 1 0x0030-0x0030 61 * DES 1 0x0032-0x0032 62 * CTR_DBRG 4 0x0034-0x003A 63 * ENTROPY 3 0x003C-0x0040 0x003D-0x003F 64 * NET 11 0x0042-0x0052 0x0043-0x0045 65 * ASN1 7 0x0060-0x006C 66 * PBKDF2 1 0x007C-0x007C 67 * HMAC_DRBG 4 0x0003-0x0009 68 * CCM 2 0x000D-0x000F 69 * 70 * High-level module nr (3 bits - 0x0...-0x7...) 71 * Name ID Nr of Errors 72 * PEM 1 9 73 * PKCS#12 1 4 (Started from top) 74 * X509 2 19 75 * PKCS5 2 4 (Started from top) 76 * DHM 3 9 77 * PK 3 14 (Started from top) 78 * RSA 4 9 79 * ECP 4 8 (Started from top) 80 * MD 5 4 81 * CIPHER 6 6 82 * SSL 6 17 (Started from top) 83 * SSL 7 31 84 * 85 * Module dependent error code (5 bits 0x.00.-0x.F8.) 86 */ 87 88 #ifdef __cplusplus 89 extern "C" { 90 #endif 91 92 /** 93 * \brief Translate a mbed TLS error code into a string representation, 94 * Result is truncated if necessary and always includes a terminating 95 * null byte. 96 * 97 * \param errnum error code 98 * \param buffer buffer to place representation in 99 * \param buflen length of the buffer 100 */ 101 void mbedtls_strerror( int errnum, char *buffer, size_t buflen ); 102 103 #ifdef __cplusplus 104 } 105 #endif 106 107 #endif /* error.h */ 108
