pem.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. /**
  2. * \file pem.h
  3. *
  4. * \brief Privacy Enhanced Mail (PEM) decoding
  5. */
  6. /*
  7. * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
  8. * SPDX-License-Identifier: Apache-2.0
  9. *
  10. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  11. * not use this file except in compliance with the License.
  12. * You may obtain a copy of the License at
  13. *
  14. * http://www.apache.org/licenses/LICENSE-2.0
  15. *
  16. * Unless required by applicable law or agreed to in writing, software
  17. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  18. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19. * See the License for the specific language governing permissions and
  20. * limitations under the License.
  21. *
  22. * This file is part of mbed TLS (https://tls.mbed.org)
  23. */
  24. #ifndef MBEDTLS_PEM_H
  25. #define MBEDTLS_PEM_H
  26. #if !defined(MBEDTLS_CONFIG_FILE)
  27. #include "config.h"
  28. #else
  29. #include MBEDTLS_CONFIG_FILE
  30. #endif
  31. #include <stddef.h>
  32. /**
  33. * \name PEM Error codes
  34. * These error codes are returned in case of errors reading the
  35. * PEM data.
  36. * \{
  37. */
  38. #define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT -0x1080 /**< No PEM header or footer found. */
  39. #define MBEDTLS_ERR_PEM_INVALID_DATA -0x1100 /**< PEM string is not as expected. */
  40. #define MBEDTLS_ERR_PEM_ALLOC_FAILED -0x1180 /**< Failed to allocate memory. */
  41. #define MBEDTLS_ERR_PEM_INVALID_ENC_IV -0x1200 /**< RSA IV is not in hex-format. */
  42. #define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG -0x1280 /**< Unsupported key encryption algorithm. */
  43. #define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED -0x1300 /**< Private key password can't be empty. */
  44. #define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH -0x1380 /**< Given private key password does not allow for correct decryption. */
  45. #define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE -0x1400 /**< Unavailable feature, e.g. hashing/encryption combination. */
  46. #define MBEDTLS_ERR_PEM_BAD_INPUT_DATA -0x1480 /**< Bad input parameters to function. */
  47. /* \} name */
  48. #ifdef __cplusplus
  49. extern "C" {
  50. #endif
  51. #if defined(MBEDTLS_PEM_PARSE_C)
  52. /**
  53. * \brief PEM context structure
  54. */
  55. typedef struct mbedtls_pem_context
  56. {
  57. unsigned char *buf; /*!< buffer for decoded data */
  58. size_t buflen; /*!< length of the buffer */
  59. unsigned char *info; /*!< buffer for extra header information */
  60. }
  61. mbedtls_pem_context;
  62. /**
  63. * \brief PEM context setup
  64. *
  65. * \param ctx context to be initialized
  66. */
  67. void mbedtls_pem_init( mbedtls_pem_context *ctx );
  68. /**
  69. * \brief Read a buffer for PEM information and store the resulting
  70. * data into the specified context buffers.
  71. *
  72. * \param ctx context to use
  73. * \param header header string to seek and expect
  74. * \param footer footer string to seek and expect
  75. * \param data source data to look in (must be nul-terminated)
  76. * \param pwd password for decryption (can be NULL)
  77. * \param pwdlen length of password
  78. * \param use_len destination for total length used (set after header is
  79. * correctly read, so unless you get
  80. * MBEDTLS_ERR_PEM_BAD_INPUT_DATA or
  81. * MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT, use_len is
  82. * the length to skip)
  83. *
  84. * \note Attempts to check password correctness by verifying if
  85. * the decrypted text starts with an ASN.1 sequence of
  86. * appropriate length
  87. *
  88. * \return 0 on success, or a specific PEM error code
  89. */
  90. int mbedtls_pem_read_buffer( mbedtls_pem_context *ctx, const char *header, const char *footer,
  91. const unsigned char *data,
  92. const unsigned char *pwd,
  93. size_t pwdlen, size_t *use_len );
  94. /**
  95. * \brief PEM context memory freeing
  96. *
  97. * \param ctx context to be freed
  98. */
  99. void mbedtls_pem_free( mbedtls_pem_context *ctx );
  100. #endif /* MBEDTLS_PEM_PARSE_C */
  101. #if defined(MBEDTLS_PEM_WRITE_C)
  102. /**
  103. * \brief Write a buffer of PEM information from a DER encoded
  104. * buffer.
  105. *
  106. * \param header header string to write
  107. * \param footer footer string to write
  108. * \param der_data DER data to write
  109. * \param der_len length of the DER data
  110. * \param buf buffer to write to
  111. * \param buf_len length of output buffer
  112. * \param olen total length written / required (if buf_len is not enough)
  113. *
  114. * \return 0 on success, or a specific PEM or BASE64 error code. On
  115. * MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL olen is the required
  116. * size.
  117. */
  118. int mbedtls_pem_write_buffer( const char *header, const char *footer,
  119. const unsigned char *der_data, size_t der_len,
  120. unsigned char *buf, size_t buf_len, size_t *olen );
  121. #endif /* MBEDTLS_PEM_WRITE_C */
  122. #ifdef __cplusplus
  123. }
  124. #endif
  125. #endif /* pem.h */