error.h 3.1 KB

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