mbed TLS Build
include/mbedtls/error.h@0:cdf462088d13, 2017-01-05 (annotated)
- Committer:
- markrad
- Date:
- Thu Jan 05 00:18:44 2017 +0000
- Revision:
- 0:cdf462088d13
Initial commit
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
markrad | 0:cdf462088d13 | 1 | /** |
markrad | 0:cdf462088d13 | 2 | * \file error.h |
markrad | 0:cdf462088d13 | 3 | * |
markrad | 0:cdf462088d13 | 4 | * \brief Error to string translation |
markrad | 0:cdf462088d13 | 5 | * |
markrad | 0:cdf462088d13 | 6 | * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved |
markrad | 0:cdf462088d13 | 7 | * SPDX-License-Identifier: Apache-2.0 |
markrad | 0:cdf462088d13 | 8 | * |
markrad | 0:cdf462088d13 | 9 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
markrad | 0:cdf462088d13 | 10 | * not use this file except in compliance with the License. |
markrad | 0:cdf462088d13 | 11 | * You may obtain a copy of the License at |
markrad | 0:cdf462088d13 | 12 | * |
markrad | 0:cdf462088d13 | 13 | * http://www.apache.org/licenses/LICENSE-2.0 |
markrad | 0:cdf462088d13 | 14 | * |
markrad | 0:cdf462088d13 | 15 | * Unless required by applicable law or agreed to in writing, software |
markrad | 0:cdf462088d13 | 16 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
markrad | 0:cdf462088d13 | 17 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
markrad | 0:cdf462088d13 | 18 | * See the License for the specific language governing permissions and |
markrad | 0:cdf462088d13 | 19 | * limitations under the License. |
markrad | 0:cdf462088d13 | 20 | * |
markrad | 0:cdf462088d13 | 21 | * This file is part of mbed TLS (https://tls.mbed.org) |
markrad | 0:cdf462088d13 | 22 | */ |
markrad | 0:cdf462088d13 | 23 | #ifndef MBEDTLS_ERROR_H |
markrad | 0:cdf462088d13 | 24 | #define MBEDTLS_ERROR_H |
markrad | 0:cdf462088d13 | 25 | |
markrad | 0:cdf462088d13 | 26 | #include <stddef.h> |
markrad | 0:cdf462088d13 | 27 | |
markrad | 0:cdf462088d13 | 28 | /** |
markrad | 0:cdf462088d13 | 29 | * Error code layout. |
markrad | 0:cdf462088d13 | 30 | * |
markrad | 0:cdf462088d13 | 31 | * Currently we try to keep all error codes within the negative space of 16 |
markrad | 0:cdf462088d13 | 32 | * bits signed integers to support all platforms (-0x0001 - -0x7FFF). In |
markrad | 0:cdf462088d13 | 33 | * addition we'd like to give two layers of information on the error if |
markrad | 0:cdf462088d13 | 34 | * possible. |
markrad | 0:cdf462088d13 | 35 | * |
markrad | 0:cdf462088d13 | 36 | * For that purpose the error codes are segmented in the following manner: |
markrad | 0:cdf462088d13 | 37 | * |
markrad | 0:cdf462088d13 | 38 | * 16 bit error code bit-segmentation |
markrad | 0:cdf462088d13 | 39 | * |
markrad | 0:cdf462088d13 | 40 | * 1 bit - Unused (sign bit) |
markrad | 0:cdf462088d13 | 41 | * 3 bits - High level module ID |
markrad | 0:cdf462088d13 | 42 | * 5 bits - Module-dependent error code |
markrad | 0:cdf462088d13 | 43 | * 7 bits - Low level module errors |
markrad | 0:cdf462088d13 | 44 | * |
markrad | 0:cdf462088d13 | 45 | * For historical reasons, low-level error codes are divided in even and odd, |
markrad | 0:cdf462088d13 | 46 | * even codes were assigned first, and -1 is reserved for other errors. |
markrad | 0:cdf462088d13 | 47 | * |
markrad | 0:cdf462088d13 | 48 | * Low-level module errors (0x0002-0x007E, 0x0003-0x007F) |
markrad | 0:cdf462088d13 | 49 | * |
markrad | 0:cdf462088d13 | 50 | * Module Nr Codes assigned |
markrad | 0:cdf462088d13 | 51 | * MPI 7 0x0002-0x0010 |
markrad | 0:cdf462088d13 | 52 | * GCM 2 0x0012-0x0014 |
markrad | 0:cdf462088d13 | 53 | * BLOWFISH 2 0x0016-0x0018 |
markrad | 0:cdf462088d13 | 54 | * THREADING 3 0x001A-0x001E |
markrad | 0:cdf462088d13 | 55 | * AES 2 0x0020-0x0022 |
markrad | 0:cdf462088d13 | 56 | * CAMELLIA 2 0x0024-0x0026 |
markrad | 0:cdf462088d13 | 57 | * XTEA 1 0x0028-0x0028 |
markrad | 0:cdf462088d13 | 58 | * BASE64 2 0x002A-0x002C |
markrad | 0:cdf462088d13 | 59 | * OID 1 0x002E-0x002E 0x000B-0x000B |
markrad | 0:cdf462088d13 | 60 | * PADLOCK 1 0x0030-0x0030 |
markrad | 0:cdf462088d13 | 61 | * DES 1 0x0032-0x0032 |
markrad | 0:cdf462088d13 | 62 | * CTR_DBRG 4 0x0034-0x003A |
markrad | 0:cdf462088d13 | 63 | * ENTROPY 3 0x003C-0x0040 0x003D-0x003F |
markrad | 0:cdf462088d13 | 64 | * NET 11 0x0042-0x0052 0x0043-0x0045 |
markrad | 0:cdf462088d13 | 65 | * ASN1 7 0x0060-0x006C |
markrad | 0:cdf462088d13 | 66 | * PBKDF2 1 0x007C-0x007C |
markrad | 0:cdf462088d13 | 67 | * HMAC_DRBG 4 0x0003-0x0009 |
markrad | 0:cdf462088d13 | 68 | * CCM 2 0x000D-0x000F |
markrad | 0:cdf462088d13 | 69 | * |
markrad | 0:cdf462088d13 | 70 | * High-level module nr (3 bits - 0x0...-0x7...) |
markrad | 0:cdf462088d13 | 71 | * Name ID Nr of Errors |
markrad | 0:cdf462088d13 | 72 | * PEM 1 9 |
markrad | 0:cdf462088d13 | 73 | * PKCS#12 1 4 (Started from top) |
markrad | 0:cdf462088d13 | 74 | * X509 2 19 |
markrad | 0:cdf462088d13 | 75 | * PKCS5 2 4 (Started from top) |
markrad | 0:cdf462088d13 | 76 | * DHM 3 9 |
markrad | 0:cdf462088d13 | 77 | * PK 3 14 (Started from top) |
markrad | 0:cdf462088d13 | 78 | * RSA 4 9 |
markrad | 0:cdf462088d13 | 79 | * ECP 4 8 (Started from top) |
markrad | 0:cdf462088d13 | 80 | * MD 5 4 |
markrad | 0:cdf462088d13 | 81 | * CIPHER 6 6 |
markrad | 0:cdf462088d13 | 82 | * SSL 6 17 (Started from top) |
markrad | 0:cdf462088d13 | 83 | * SSL 7 31 |
markrad | 0:cdf462088d13 | 84 | * |
markrad | 0:cdf462088d13 | 85 | * Module dependent error code (5 bits 0x.00.-0x.F8.) |
markrad | 0:cdf462088d13 | 86 | */ |
markrad | 0:cdf462088d13 | 87 | |
markrad | 0:cdf462088d13 | 88 | #ifdef __cplusplus |
markrad | 0:cdf462088d13 | 89 | extern "C" { |
markrad | 0:cdf462088d13 | 90 | #endif |
markrad | 0:cdf462088d13 | 91 | |
markrad | 0:cdf462088d13 | 92 | /** |
markrad | 0:cdf462088d13 | 93 | * \brief Translate a mbed TLS error code into a string representation, |
markrad | 0:cdf462088d13 | 94 | * Result is truncated if necessary and always includes a terminating |
markrad | 0:cdf462088d13 | 95 | * null byte. |
markrad | 0:cdf462088d13 | 96 | * |
markrad | 0:cdf462088d13 | 97 | * \param errnum error code |
markrad | 0:cdf462088d13 | 98 | * \param buffer buffer to place representation in |
markrad | 0:cdf462088d13 | 99 | * \param buflen length of the buffer |
markrad | 0:cdf462088d13 | 100 | */ |
markrad | 0:cdf462088d13 | 101 | void mbedtls_strerror( int errnum, char *buffer, size_t buflen ); |
markrad | 0:cdf462088d13 | 102 | |
markrad | 0:cdf462088d13 | 103 | #ifdef __cplusplus |
markrad | 0:cdf462088d13 | 104 | } |
markrad | 0:cdf462088d13 | 105 | #endif |
markrad | 0:cdf462088d13 | 106 | |
markrad | 0:cdf462088d13 | 107 | #endif /* error.h */ |