← Back to branch summary

~bibledit/bibledit/client

« back to all changes in this revision

Viewing changes to mbedtls_2.x/error.h

  • Committer: Teus Benschop
  • Date: 2024-08-17 17:08:44 UTC
  • Revision ID: teusjannette@gmail.com-20240817170844-0qf789ywtms3hyz7
new upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
mbedtls_2.x/error.h
1
 
#pragma GCC system_header
2
 
/**
3
 
 * \file error.h
4
 
 *
5
 
 * \brief Error to string translation
6
 
 */
7
 
/*
8
 
 *  Copyright The Mbed TLS Contributors
9
 
 *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
10
 
 *
11
 
 *  This file is provided under the Apache License 2.0, or the
12
 
 *  GNU General Public License v2.0 or later.
13
 
 *
14
 
 *  **********
15
 
 *  Apache License 2.0:
16
 
 *
17
 
 *  Licensed under the Apache License, Version 2.0 (the "License"); you may
18
 
 *  not use this file except in compliance with the License.
19
 
 *  You may obtain a copy of the License at
20
 
 *
21
 
 *  http://www.apache.org/licenses/LICENSE-2.0
22
 
 *
23
 
 *  Unless required by applicable law or agreed to in writing, software
24
 
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
25
 
 *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
26
 
 *  See the License for the specific language governing permissions and
27
 
 *  limitations under the License.
28
 
 *
29
 
 *  **********
30
 
 *
31
 
 *  **********
32
 
 *  GNU General Public License v2.0 or later:
33
 
 *
34
 
 *  This program is free software; you can redistribute it and/or modify
35
 
 *  it under the terms of the GNU General Public License as published by
36
 
 *  the Free Software Foundation; either version 2 of the License, or
37
 
 *  (at your option) any later version.
38
 
 *
39
 
 *  This program is distributed in the hope that it will be useful,
40
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
41
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
42
 
 *  GNU General Public License for more details.
43
 
 *
44
 
 *  You should have received a copy of the GNU General Public License along
45
 
 *  with this program; if not, write to the Free Software Foundation, Inc.,
46
 
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
47
 
 *
48
 
 *  **********
49
 
 */
50
 
#ifndef MBEDTLS_ERROR_H
51
 
#define MBEDTLS_ERROR_H
52
 
 
53
 
#if !defined(MBEDTLS_CONFIG_FILE)
54
 
#include "config.h"
55
 
#else
56
 
#include MBEDTLS_CONFIG_FILE
57
 
#endif
58
 
 
59
 
#include <stddef.h>
60
 
 
61
 
/**
62
 
 * Error code layout.
63
 
 *
64
 
 * Currently we try to keep all error codes within the negative space of 16
65
 
 * bits signed integers to support all platforms (-0x0001 - -0x7FFF). In
66
 
 * addition we'd like to give two layers of information on the error if
67
 
 * possible.
68
 
 *
69
 
 * For that purpose the error codes are segmented in the following manner:
70
 
 *
71
 
 * 16 bit error code bit-segmentation
72
 
 *
73
 
 * 1 bit  - Unused (sign bit)
74
 
 * 3 bits - High level module ID
75
 
 * 5 bits - Module-dependent error code
76
 
 * 7 bits - Low level module errors
77
 
 *
78
 
 * For historical reasons, low-level error codes are divided in even and odd,
79
 
 * even codes were assigned first, and -1 is reserved for other errors.
80
 
 *
81
 
 * Low-level module errors (0x0002-0x007E, 0x0003-0x007F)
82
 
 *
83
 
 * Module   Nr  Codes assigned
84
 
 * MPI       7  0x0002-0x0010
85
 
 * GCM       3  0x0012-0x0014   0x0013-0x0013
86
 
 * BLOWFISH  3  0x0016-0x0018   0x0017-0x0017
87
 
 * THREADING 3  0x001A-0x001E
88
 
 * AES       5  0x0020-0x0022   0x0021-0x0025
89
 
 * CAMELLIA  3  0x0024-0x0026   0x0027-0x0027
90
 
 * XTEA      2  0x0028-0x0028   0x0029-0x0029
91
 
 * BASE64    2  0x002A-0x002C
92
 
 * OID       1  0x002E-0x002E   0x000B-0x000B
93
 
 * PADLOCK   1  0x0030-0x0030
94
 
 * DES       2  0x0032-0x0032   0x0033-0x0033
95
 
 * CTR_DBRG  4  0x0034-0x003A
96
 
 * ENTROPY   3  0x003C-0x0040   0x003D-0x003F
97
 
 * NET      13  0x0042-0x0052   0x0043-0x0049
98
 
 * ARIA      4  0x0058-0x005E
99
 
 * ASN1      7  0x0060-0x006C
100
 
 * CMAC      1  0x007A-0x007A
101
 
 * PBKDF2    1  0x007C-0x007C
102
 
 * HMAC_DRBG 4                  0x0003-0x0009
103
 
 * CCM       3                  0x000D-0x0011
104
 
 * ARC4      1                  0x0019-0x0019
105
 
 * MD2       1                  0x002B-0x002B
106
 
 * MD4       1                  0x002D-0x002D
107
 
 * MD5       1                  0x002F-0x002F
108
 
 * RIPEMD160 1                  0x0031-0x0031
109
 
 * SHA1      1                  0x0035-0x0035 0x0073-0x0073
110
 
 * SHA256    1                  0x0037-0x0037 0x0074-0x0074
111
 
 * SHA512    1                  0x0039-0x0039 0x0075-0x0075
112
 
 * CHACHA20  3                  0x0051-0x0055
113
 
 * POLY1305  3                  0x0057-0x005B
114
 
 * CHACHAPOLY 2 0x0054-0x0056
115
 
 * PLATFORM  1  0x0070-0x0072
116
 
 *
117
 
 * High-level module nr (3 bits - 0x0...-0x7...)
118
 
 * Name      ID  Nr of Errors
119
 
 * PEM       1   9
120
 
 * PKCS#12   1   4 (Started from top)
121
 
 * X509      2   20
122
 
 * PKCS5     2   4 (Started from top)
123
 
 * DHM       3   11
124
 
 * PK        3   15 (Started from top)
125
 
 * RSA       4   11
126
 
 * ECP       4   10 (Started from top)
127
 
 * MD        5   5
128
 
 * HKDF      5   1 (Started from top)
129
 
 * SSL       5   1 (Started from 0x5E80)
130
 
 * CIPHER    6   8
131
 
 * SSL       6   23 (Started from top)
132
 
 * SSL       7   32
133
 
 *
134
 
 * Module dependent error code (5 bits 0x.00.-0x.F8.)
135
 
 */
136
 
 
137
 
#ifdef __cplusplus
138
 
extern "C" {
139
 
#endif
140
 
 
141
 
/**
142
 
 * \brief Translate a mbed TLS error code into a string representation,
143
 
 *        Result is truncated if necessary and always includes a terminating
144
 
 *        null byte.
145
 
 *
146
 
 * \param errnum    error code
147
 
 * \param buffer    buffer to place representation in
148
 
 * \param buflen    length of the buffer
149
 
 */
150
 
void mbedtls_strerror( int errnum, char *buffer, size_t buflen );
151
 
 
152
 
#ifdef __cplusplus
153
 
}
154
 
#endif
155
 
 
156
 
#endif /* error.h */