third_party/mbedtls/repo/include/mbedtls/error.h

   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 #if !defined(MBEDTLS_CONFIG_FILE)
  28 #include "config.h"
  29 #else
  30 #include MBEDTLS_CONFIG_FILE
  31 #endif
  32
  33 #include <stddef.h>
  34
  35 /**
  36  * Error code layout.
  37  *
  38  * Currently we try to keep all error codes within the negative space of 16
  39  * bits signed integers to support all platforms (-0x0001 - -0x7FFF). In
  40  * addition we'd like to give two layers of information on the error if
  41  * possible.
  42  *
  43  * For that purpose the error codes are segmented in the following manner:
  44  *
  45  * 16 bit error code bit-segmentation
  46  *
  47  * 1 bit  - Unused (sign bit)
  48  * 3 bits - High level module ID
  49  * 5 bits - Module-dependent error code
  50  * 7 bits - Low level module errors
  51  *
  52  * For historical reasons, low-level error codes are divided in even and odd,
  53  * even codes were assigned first, and -1 is reserved for other errors.
  54  *
  55  * Low-level module errors (0x0002-0x007E, 0x0003-0x007F)
  56  *
  57  * Module   Nr  Codes assigned
  58  * MPI       7  0x0002-0x0010
  59  * GCM       3  0x0012-0x0014   0x0013-0x0013
  60  * BLOWFISH  3  0x0016-0x0018   0x0017-0x0017
  61  * THREADING 3  0x001A-0x001E
  62  * AES       5  0x0020-0x0022   0x0021-0x0025
  63  * CAMELLIA  3  0x0024-0x0026   0x0027-0x0027
  64  * XTEA      2  0x0028-0x0028   0x0029-0x0029
  65  * BASE64    2  0x002A-0x002C
  66  * OID       1  0x002E-0x002E   0x000B-0x000B
  67  * PADLOCK   1  0x0030-0x0030
  68  * DES       2  0x0032-0x0032   0x0033-0x0033
  69  * CTR_DBRG  4  0x0034-0x003A
  70  * ENTROPY   3  0x003C-0x0040   0x003D-0x003F
  71  * NET      13  0x0042-0x0052   0x0043-0x0049
  72  * ARIA      4  0x0058-0x005E
  73  * ASN1      7  0x0060-0x006C
  74  * CMAC      1  0x007A-0x007A
  75  * PBKDF2    1  0x007C-0x007C
  76  * HMAC_DRBG 4                  0x0003-0x0009
  77  * CCM       3                  0x000D-0x0011
  78  * ARC4      1                  0x0019-0x0019
  79  * MD2       1                  0x002B-0x002B
  80  * MD4       1                  0x002D-0x002D
  81  * MD5       1                  0x002F-0x002F
  82  * RIPEMD160 1                  0x0031-0x0031
  83  * SHA1      1                  0x0035-0x0035 0x0073-0x0073
  84  * SHA256    1                  0x0037-0x0037 0x0074-0x0074
  85  * SHA512    1                  0x0039-0x0039 0x0075-0x0075
  86  * CHACHA20  3                  0x0051-0x0055
  87  * POLY1305  3                  0x0057-0x005B
  88  * CHACHAPOLY 2 0x0054-0x0056
  89  * PLATFORM  1  0x0070-0x0072
  90  *
  91  * High-level module nr (3 bits - 0x0...-0x7...)
  92  * Name      ID  Nr of Errors
  93  * PEM       1   9
  94  * PKCS#12   1   4 (Started from top)
  95  * X509      2   20
  96  * PKCS5     2   4 (Started from top)
  97  * DHM       3   11
  98  * PK        3   15 (Started from top)
  99  * RSA       4   11
 100  * ECP       4   10 (Started from top)
 101  * MD        5   5
 102  * HKDF      5   1 (Started from top)
 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 /**
 115  * \brief Translate a mbed TLS error code into a string representation,
 116  *        Result is truncated if necessary and always includes a terminating
 117  *        null byte.
 118  *
 119  * \param errnum    error code
 120  * \param buffer    buffer to place representation in
 121  * \param buflen    length of the buffer
 122  */
 123 void mbedtls_strerror( int errnum, char *buffer, size_t buflen );
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif
 128
 129 #endif /* error.h */