Google Git
Sign in
pigweed / third_party / github / ARMmbed / mbedtls / 686bfae2440714a6ac1bed19bf4a98fd04e688b0 / . / include / polarssl / error.h
blob: 45a66401a3fc456b19ecc006f48c3d0a6acba7f4 [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 *
Paul Bakkercf4365f2013-01-16 17:00:43 +0100[diff] [blame]6 * Copyright (C) 2006-2013, Brainspark B.V.
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]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
Paul Bakker3c2122f2013-06-24 19:03:14 +0200[diff] [blame]30#include <string.h>
31
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]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
Paul Bakker69e095c2011-12-10 21:55:01 +0000[diff] [blame]53 * MPI 7 0x0002-0x0010
Paul Bakkerd8ef1672012-04-18 14:17:32 +0000[diff] [blame]54 * GCM 2 0x0012-0x0014
Paul Bakkera9379c02012-07-04 11:02:11 +0000[diff] [blame]55 * BLOWFISH 2 0x0016-0x0018
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]56 * AES 2 0x0020-0x0022
57 * CAMELLIA 2 0x0024-0x0026
58 * XTEA 1 0x0028-0x0028
Paul Bakker69e095c2011-12-10 21:55:01 +0000[diff] [blame]59 * BASE64 2 0x002A-0x002C
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]60 * OID 1 0x002E-0x002E
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]61 * PADLOCK 1 0x0030-0x0030
62 * DES 1 0x0032-0x0032
Paul Bakker69e095c2011-12-10 21:55:01 +0000[diff] [blame]63 * CTR_DBRG 3 0x0034-0x003A
Paul Bakker43655f42011-12-15 20:11:16 +0000[diff] [blame]64 * ENTROPY 3 0x003C-0x0040
Paul Bakkerbdb912d2012-02-13 23:11:30 +0000[diff] [blame]65 * NET 11 0x0042-0x0056
66 * ASN1 7 0x0060-0x006C
Paul Bakker69e095c2011-12-10 21:55:01 +0000[diff] [blame]67 * MD2 1 0x0070-0x0070
68 * MD4 1 0x0072-0x0072
69 * MD5 1 0x0074-0x0074
70 * SHA1 1 0x0076-0x0076
Paul Bakker9e36f042013-06-30 14:34:05 +0200[diff] [blame]71 * SHA256 1 0x0078-0x0078
72 * SHA512 1 0x007A-0x007A
Paul Bakkerf518b162012-08-23 13:03:18 +0000[diff] [blame]73 * PBKDF2 1 0x007C-0x007C
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]74 *
75 * High-level module nr (3 bits - 0x1...-0x8...)
76 * Name ID Nr of Errors
Paul Bakker00b28602013-06-24 13:02:41 +0200[diff] [blame]77 * PEM 1 9
Paul Bakker38b50d72013-06-24 19:33:27 +0200[diff] [blame]78 * PKCS#12 1 4 (Started from top)
Manuel Pégourié-Gonnard7a6c9462013-07-09 10:04:07 +0200[diff] [blame]79 * X509 2 25
80 * PK 2 1 (Started from top)
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]81 * DHM 3 6
Paul Bakker28144de2013-06-24 19:28:55 +0200[diff] [blame]82 * PKCS5 3 4 (Started from top)
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]83 * RSA 4 9
Paul Bakkerfd3eac52013-06-29 23:31:33 +0200[diff] [blame]84 * ECP 4 4 (Started from top)
Paul Bakker8913f822012-01-14 18:07:41 +0000[diff] [blame]85 * MD 5 4
86 * CIPHER 6 5
Paul Bakker606b4ba2013-08-14 16:52:14 +0200[diff] [blame]87 * SSL 6 5 (Started from top)
Paul Bakker05ef8352012-05-08 09:17:57 +0000[diff] [blame]88 * SSL 7 31
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]89 *
90 * Module dependent error code (5 bits 0x.08.-0x.F8.)
91 */
92
Paul Bakkerbcd5db42011-05-20 12:30:59 +0000[diff] [blame]93#ifdef __cplusplus
94extern "C" {
95#endif
96
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]97/**
98 * \brief Translate a PolarSSL error code into a string representation,
99 * Result is truncated if necessary and always includes a terminating
100 * null byte.
101 *
102 * \param errnum error code
103 * \param buffer buffer to place representation in
104 * \param buflen length of the buffer
105 */
Paul Bakkere2ab84f2013-06-29 18:24:32 +0200[diff] [blame]106void polarssl_strerror( int errnum, char *buffer, size_t buflen );
107
108#if defined(POLARSSL_ERROR_STRERROR_BC)
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]109void error_strerror( int errnum, char *buffer, size_t buflen );
Paul Bakkere2ab84f2013-06-29 18:24:32 +0200[diff] [blame]110#endif
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]111
Paul Bakkerbcd5db42011-05-20 12:30:59 +0000[diff] [blame]112#ifdef __cplusplus
113}
114#endif
115
Paul Bakker9d781402011-05-09 16:17:09 +0000[diff] [blame]116#endif /* error.h */