pem.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. /**
  2. * \file pem.h
  3. *
  4. * \brief Privacy Enhanced Mail (PEM) decoding
  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_PEM_H
  24. #define MBEDTLS_PEM_H
  25. #include <stddef.h>
  26. /**
  27. * \name PEM Error codes
  28. * These error codes are returned in case of errors reading the
  29. * PEM data.
  30. * \{
  31. */
  32. #define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT -0x1080 /**< No PEM header or footer found. */
  33. #define MBEDTLS_ERR_PEM_INVALID_DATA -0x1100 /**< PEM string is not as expected. */
  34. #define MBEDTLS_ERR_PEM_ALLOC_FAILED -0x1180 /**< Failed to allocate memory. */
  35. #define MBEDTLS_ERR_PEM_INVALID_ENC_IV -0x1200 /**< RSA IV is not in hex-format. */
  36. #define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG -0x1280 /**< Unsupported key encryption algorithm. */
  37. #define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED -0x1300 /**< Private key password can't be empty. */
  38. #define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH -0x1380 /**< Given private key password does not allow for correct decryption. */
  39. #define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE -0x1400 /**< Unavailable feature, e.g. hashing/encryption combination. */
  40. #define MBEDTLS_ERR_PEM_BAD_INPUT_DATA -0x1480 /**< Bad input parameters to function. */
  41. /* \} name */
  42. #ifdef __cplusplus
  43. extern "C" {
  44. #endif
  45. #if defined(MBEDTLS_PEM_PARSE_C)
  46. /**
  47. * \brief PEM context structure
  48. */
  49. typedef struct
  50. {
  51. unsigned char *buf; /*!< buffer for decoded data */
  52. size_t buflen; /*!< length of the buffer */
  53. unsigned char *info; /*!< buffer for extra header information */
  54. }
  55. mbedtls_pem_context;
  56. /**
  57. * \brief PEM context setup
  58. *
  59. * \param ctx context to be initialized
  60. */
  61. void mbedtls_pem_init( mbedtls_pem_context *ctx );
  62. /**
  63. * \brief Read a buffer for PEM information and store the resulting
  64. * data into the specified context buffers.
  65. *
  66. * \param ctx context to use
  67. * \param header header string to seek and expect
  68. * \param footer footer string to seek and expect
  69. * \param data source data to look in (must be nul-terminated)
  70. * \param pwd password for decryption (can be NULL)
  71. * \param pwdlen length of password
  72. * \param use_len destination for total length used (set after header is
  73. * correctly read, so unless you get
  74. * MBEDTLS_ERR_PEM_BAD_INPUT_DATA or
  75. * MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT, use_len is
  76. * the length to skip)
  77. *
  78. * \note Attempts to check password correctness by verifying if
  79. * the decrypted text starts with an ASN.1 sequence of
  80. * appropriate length
  81. *
  82. * \return 0 on success, or a specific PEM error code
  83. */
  84. int mbedtls_pem_read_buffer( mbedtls_pem_context *ctx, const char *header, const char *footer,
  85. const unsigned char *data,
  86. const unsigned char *pwd,
  87. size_t pwdlen, size_t *use_len );
  88. /**
  89. * \brief PEM context memory freeing
  90. *
  91. * \param ctx context to be freed
  92. */
  93. void mbedtls_pem_free( mbedtls_pem_context *ctx );
  94. #endif /* MBEDTLS_PEM_PARSE_C */
  95. #if defined(MBEDTLS_PEM_WRITE_C)
  96. /**
  97. * \brief Write a buffer of PEM information from a DER encoded
  98. * buffer.
  99. *
  100. * \param header header string to write
  101. * \param footer footer string to write
  102. * \param der_data DER data to write
  103. * \param der_len length of the DER data
  104. * \param buf buffer to write to
  105. * \param buf_len length of output buffer
  106. * \param olen total length written / required (if buf_len is not enough)
  107. *
  108. * \return 0 on success, or a specific PEM or BASE64 error code. On
  109. * MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL olen is the required
  110. * size.
  111. */
  112. int mbedtls_pem_write_buffer( const char *header, const char *footer,
  113. const unsigned char *der_data, size_t der_len,
  114. unsigned char *buf, size_t buf_len, size_t *olen );
  115. #endif /* MBEDTLS_PEM_WRITE_C */
  116. #ifdef __cplusplus
  117. }
  118. #endif
  119. #endif /* pem.h */