| Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 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 | /** |
| 31 | * Error code layout. |
| 32 | * |
| 33 | * Currently we try to keep all error codes within the negative space of 16 |
| 34 | * bytes signed integers to support all platforms (-0x0000 - -0x8000). In |
| 35 | * addition we'd like to give two layers of information on the error if |
| 36 | * possible. |
| 37 | * |
| 38 | * For that purpose the error codes are segmented in the following manner: |
| 39 | * |
| 40 | * 16 bit error code bit-segmentation |
| 41 | * |
| 42 | * 1 bit - Intentionally not used |
| 43 | * 3 bits - High level module ID |
| 44 | * 5 bits - Module-dependent error code |
| 45 | * 6 bits - Low level module errors |
| 46 | * 1 bit - Intentionally not used |
| 47 | * |
| 48 | * Low-level module errors (0x007E-0x0002) |
| 49 | * |
| 50 | * Module Nr Codes assigned |
| 51 | * MPI 7 0x0002-0x000E |
| 52 | * BASE64 2 0x0010-0x0012 |
| 53 | * ASN1 5 0x0014-0x001C |
| 54 | * AES 2 0x0020-0x0022 |
| 55 | * CAMELLIA 2 0x0024-0x0026 |
| 56 | * XTEA 1 0x0028-0x0028 |
| 57 | * PADLOCK 1 0x0030-0x0030 |
| 58 | * DES 1 0x0032-0x0032 |
| Paul Bakker | 831a755 | 2011-05-18 13:32:51 +0000 | [diff] [blame] | 59 | * NET 11 0x0040-0x0054 |
| Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 60 | * |
| 61 | * High-level module nr (3 bits - 0x1...-0x8...) |
| 62 | * Name ID Nr of Errors |
| 63 | * PEM 1 8 |
| 64 | * X509 2 20 |
| 65 | * DHM 3 6 |
| 66 | * RSA 4 9 |
| 67 | * MD 5 1 |
| 68 | * CIPER 6 1 |
| 69 | * SSL 7 27 |
| 70 | * |
| 71 | * Module dependent error code (5 bits 0x.08.-0x.F8.) |
| 72 | */ |
| 73 | |
| Paul Bakker | bcd5db4 | 2011-05-20 12:30:59 +0000 | [diff] [blame^] | 74 | #ifdef __cplusplus |
| 75 | extern "C" { |
| 76 | #endif |
| 77 | |
| Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 78 | /** |
| 79 | * \brief Translate a PolarSSL error code into a string representation, |
| 80 | * Result is truncated if necessary and always includes a terminating |
| 81 | * null byte. |
| 82 | * |
| 83 | * \param errnum error code |
| 84 | * \param buffer buffer to place representation in |
| 85 | * \param buflen length of the buffer |
| 86 | */ |
| 87 | void error_strerror( int errnum, char *buffer, size_t buflen ); |
| 88 | |
| Paul Bakker | bcd5db4 | 2011-05-20 12:30:59 +0000 | [diff] [blame^] | 89 | #ifdef __cplusplus |
| 90 | } |
| 91 | #endif |
| 92 | |
| Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 93 | #endif /* error.h */ |