2011-05-09 16:17:09 +00:00
|
|
|
/**
|
|
|
|
|
* \file error.h
|
|
|
|
|
*
|
|
|
|
|
* \brief Error to string translation
|
|
|
|
|
*
|
2013-01-16 16:00:43 +00:00
|
|
|
* Copyright (C) 2006-2013, Brainspark B.V.
|
2011-05-09 16:17:09 +00:00
|
|
|
*
|
|
|
|
|
* This file is part of PolarSSL (http://www.polarssl.org)
|
|
|
|
|
* Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
|
|
|
|
|
*
|
|
|
|
|
* All rights reserved.
|
|
|
|
|
*
|
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
|
* (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
|
*/
|
|
|
|
|
#ifndef POLARSSL_ERROR_H
|
|
|
|
|
#define POLARSSL_ERROR_H
|
|
|
|
|
|
2013-06-24 17:03:14 +00:00
|
|
|
#include <string.h>
|
|
|
|
|
|
2011-05-09 16:17:09 +00:00
|
|
|
/**
|
|
|
|
|
* Error code layout.
|
|
|
|
|
*
|
|
|
|
|
* Currently we try to keep all error codes within the negative space of 16
|
|
|
|
|
* bytes signed integers to support all platforms (-0x0000 - -0x8000). In
|
|
|
|
|
* addition we'd like to give two layers of information on the error if
|
|
|
|
|
* possible.
|
|
|
|
|
*
|
|
|
|
|
* For that purpose the error codes are segmented in the following manner:
|
|
|
|
|
*
|
|
|
|
|
* 16 bit error code bit-segmentation
|
|
|
|
|
*
|
2014-02-01 09:22:21 +00:00
|
|
|
* 1 bit - Sign bit
|
2011-05-09 16:17:09 +00:00
|
|
|
* 3 bits - High level module ID
|
|
|
|
|
* 5 bits - Module-dependent error code
|
2014-02-01 09:22:21 +00:00
|
|
|
* 7 bits - Low level module errors
|
2011-05-09 16:17:09 +00:00
|
|
|
*
|
2014-02-01 09:22:21 +00:00
|
|
|
* For historical reasons, low-level error codes are divided in even and odd,
|
2014-03-11 08:34:02 +00:00
|
|
|
* even codes were assigned first, and -1 is reserved for other errors.
|
2011-05-09 16:17:09 +00:00
|
|
|
*
|
2014-03-11 08:34:02 +00:00
|
|
|
* Low-level module errors (0x0002-0x007E, 0x0003-0x007F)
|
2014-02-01 09:22:21 +00:00
|
|
|
*
|
|
|
|
|
* Module Nr Codes assigned
|
2011-12-10 21:55:01 +00:00
|
|
|
* MPI 7 0x0002-0x0010
|
2012-04-18 14:17:32 +00:00
|
|
|
* GCM 2 0x0012-0x0014
|
2012-07-04 11:02:11 +00:00
|
|
|
* BLOWFISH 2 0x0016-0x0018
|
2013-09-28 12:40:38 +00:00
|
|
|
* THREADING 3 0x001A-0x001E
|
2011-05-09 16:17:09 +00:00
|
|
|
* AES 2 0x0020-0x0022
|
|
|
|
|
* CAMELLIA 2 0x0024-0x0026
|
|
|
|
|
* XTEA 1 0x0028-0x0028
|
2011-12-10 21:55:01 +00:00
|
|
|
* BASE64 2 0x002A-0x002C
|
2014-03-28 15:06:35 +00:00
|
|
|
* OID 1 0x002E-0x002E 0x000B-0x000B
|
2011-05-09 16:17:09 +00:00
|
|
|
* PADLOCK 1 0x0030-0x0030
|
|
|
|
|
* DES 1 0x0032-0x0032
|
2014-02-01 09:22:21 +00:00
|
|
|
* CTR_DBRG 4 0x0034-0x003A
|
2011-12-15 20:11:16 +00:00
|
|
|
* ENTROPY 3 0x003C-0x0040
|
2012-02-13 23:11:30 +00:00
|
|
|
* NET 11 0x0042-0x0056
|
2014-03-26 10:54:05 +00:00
|
|
|
* ENTROPY 1 0x0058-0x0058
|
2012-02-13 23:11:30 +00:00
|
|
|
* ASN1 7 0x0060-0x006C
|
2011-12-10 21:55:01 +00:00
|
|
|
* MD2 1 0x0070-0x0070
|
|
|
|
|
* MD4 1 0x0072-0x0072
|
|
|
|
|
* MD5 1 0x0074-0x0074
|
|
|
|
|
* SHA1 1 0x0076-0x0076
|
2013-06-30 12:34:05 +00:00
|
|
|
* SHA256 1 0x0078-0x0078
|
|
|
|
|
* SHA512 1 0x007A-0x007A
|
2012-08-23 13:03:18 +00:00
|
|
|
* PBKDF2 1 0x007C-0x007C
|
2014-02-01 09:22:21 +00:00
|
|
|
* RIPEMD160 1 0x007E-0x007E
|
2014-03-11 08:34:02 +00:00
|
|
|
* HMAC_DRBG 4 0x0003-0x0009
|
2011-05-09 16:17:09 +00:00
|
|
|
*
|
2014-03-11 08:34:02 +00:00
|
|
|
* High-level module nr (3 bits - 0x0...-0x7...)
|
2013-08-25 09:21:30 +00:00
|
|
|
* Name ID Nr of Errors
|
|
|
|
|
* PEM 1 9
|
|
|
|
|
* PKCS#12 1 4 (Started from top)
|
2013-09-15 11:01:22 +00:00
|
|
|
* X509 2 18
|
2014-04-08 10:40:15 +00:00
|
|
|
* PK 2 14 (Started from top, plus 0x2000)
|
2013-09-15 15:43:54 +00:00
|
|
|
* DHM 3 9
|
2013-08-25 09:21:30 +00:00
|
|
|
* PKCS5 3 4 (Started from top)
|
|
|
|
|
* RSA 4 9
|
2014-04-08 10:17:41 +00:00
|
|
|
* ECP 4 8 (Started from top)
|
2013-08-25 09:21:30 +00:00
|
|
|
* MD 5 4
|
2013-09-19 16:09:14 +00:00
|
|
|
* CIPHER 6 6
|
2014-03-10 20:20:29 +00:00
|
|
|
* SSL 6 9 (Started from top)
|
2013-08-25 09:21:30 +00:00
|
|
|
* SSL 7 31
|
2011-05-09 16:17:09 +00:00
|
|
|
*
|
2014-02-01 09:22:21 +00:00
|
|
|
* Module dependent error code (5 bits 0x.00.-0x.F8.)
|
2011-05-09 16:17:09 +00:00
|
|
|
*/
|
|
|
|
|
|
2011-05-20 12:30:59 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
|
extern "C" {
|
|
|
|
|
#endif
|
|
|
|
|
|
2011-05-09 16:17:09 +00:00
|
|
|
/**
|
|
|
|
|
* \brief Translate a PolarSSL error code into a string representation,
|
|
|
|
|
* Result is truncated if necessary and always includes a terminating
|
|
|
|
|
* null byte.
|
|
|
|
|
*
|
|
|
|
|
* \param errnum error code
|
|
|
|
|
* \param buffer buffer to place representation in
|
|
|
|
|
* \param buflen length of the buffer
|
|
|
|
|
*/
|
2013-06-29 16:24:32 +00:00
|
|
|
void polarssl_strerror( int errnum, char *buffer, size_t buflen );
|
|
|
|
|
|
|
|
|
|
#if defined(POLARSSL_ERROR_STRERROR_BC)
|
2011-05-09 16:17:09 +00:00
|
|
|
void error_strerror( int errnum, char *buffer, size_t buflen );
|
2013-06-29 16:24:32 +00:00
|
|
|
#endif
|
2011-05-09 16:17:09 +00:00
|
|
|
|
2011-05-20 12:30:59 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
2011-05-09 16:17:09 +00:00
|
|
|
#endif /* error.h */
|
