src/libpolarssl/error.h

   1 /**
   2  * \file error.h
   3  *
   4  * \brief Error to string translation
   5  *
   6  *  Copyright (C) 2006-2010, Brainspark B.V.
   7  *
   8  *  This file is part of PolarSSL (http://www.polarssl.org)
   9  *  Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
  10  *
  11  *  All rights reserved.
  12  *
  13  *  This program is free software; you can redistribute it and/or modify
  14  *  it under the terms of the GNU General Public License as published by
  15  *  the Free Software Foundation; either version 2 of the License, or
  16  *  (at your option) any later version.
  17  *
  18  *  This program is distributed in the hope that it will be useful,
  19  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  *  GNU General Public License for more details.
  22  *
  23  *  You should have received a copy of the GNU General Public License along
  24  *  with this program; if not, write to the Free Software Foundation, Inc.,
  25  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  26  */
  27 #ifndef POLARSSL_ERROR_H
  28 #define POLARSSL_ERROR_H
  29
  30 #include <string.h>
  31
  32 /**
  33  * Error code layout.
  34  *
  35  * Currently we try to keep all error codes within the negative space of 16
  36  * bytes signed integers to support all platforms (-0x0000 - -0x8000). In
  37  * addition we'd like to give two layers of information on the error if
  38  * possible.
  39  *
  40  * For that purpose the error codes are segmented in the following manner:
  41  *
  42  * 16 bit error code bit-segmentation
  43  *
  44  * 1 bit  - Intentionally not used
  45  * 3 bits - High level module ID
  46  * 5 bits - Module-dependent error code
  47  * 6 bits - Low level module errors
  48  * 1 bit  - Intentionally not used
  49  *
  50  * Low-level module errors (0x007E-0x0002)
  51  *
  52  * Module   Nr  Codes assigned
  53  * MPI       7  0x0002-0x0010
  54  * GCM       2  0x0012-0x0014
  55  * BLOWFISH  2  0x0016-0x0018
  56  * AES       2  0x0020-0x0022
  57  * CAMELLIA  2  0x0024-0x0026
  58  * XTEA      1  0x0028-0x0028
  59  * BASE64    2  0x002A-0x002C
  60  * PADLOCK   1  0x0030-0x0030
  61  * DES       1  0x0032-0x0032
  62  * CTR_DBRG  3  0x0034-0x003A
  63  * ENTROPY   3  0x003C-0x0040
  64  * NET      11  0x0042-0x0056
  65  * ASN1      7  0x0060-0x006C
  66  * MD2       1  0x0070-0x0070
  67  * MD4       1  0x0072-0x0072
  68  * MD5       1  0x0074-0x0074
  69  * SHA1      1  0x0076-0x0076
  70  * SHA2      1  0x0078-0x0078
  71  * SHA4      1  0x007A-0x007A
  72  *
  73  * High-level module nr (3 bits - 0x1...-0x8...)
  74  * Name     ID  Nr of Errors
  75  * PEM      1   9
  76  * PKCS#12  1   4 (Started from top)
  77  * X509     2   23
  78  * DHM      3   6
  79  * PKCS5    3   4 (Started from top)
  80  * RSA      4   9
  81  * MD       5   4
  82  * CIPHER   6   5
  83  * SSL      6   2 (Started from top)
  84  * SSL      7   31
  85  *
  86  * Module dependent error code (5 bits 0x.08.-0x.F8.)
  87  */
  88
  89 #ifdef __cplusplus
  90 extern "C" {
  91 #endif
  92
  93 /**
  94  * \brief Translate a PolarSSL error code into a string representation,
  95  *        Result is truncated if necessary and always includes a terminating
  96  *        null byte.
  97  *
  98  * \param errnum    error code
  99  * \param buffer    buffer to place representation in
 100  * \param buflen    length of the buffer
 101  */
 102 void error_strerror( int errnum, char *buffer, size_t buflen );
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif /* error.h */