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