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