extlibs/mbedtls/mbedtls/include/mbedtls/pem.h

   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
  26 #include <stddef.h>
  27
  28 /**
  29  * \name PEM Error codes
  30  * These error codes are returned in case of errors reading the
  31  * PEM data.
  32  * \{
  33  */
  34 #define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT          -0x1080  /**< No PEM header or footer found. */
  35 #define MBEDTLS_ERR_PEM_INVALID_DATA                      -0x1100  /**< PEM string is not as expected. */
  36 #define MBEDTLS_ERR_PEM_ALLOC_FAILED                      -0x1180  /**< Failed to allocate memory. */
  37 #define MBEDTLS_ERR_PEM_INVALID_ENC_IV                    -0x1200  /**< RSA IV is not in hex-format. */
  38 #define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG                   -0x1280  /**< Unsupported key encryption algorithm. */
  39 #define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED                 -0x1300  /**< Private key password can't be empty. */
  40 #define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH                 -0x1380  /**< Given private key password does not allow for correct decryption. */
  41 #define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE               -0x1400  /**< Unavailable feature, e.g. hashing/encryption combination. */
  42 #define MBEDTLS_ERR_PEM_BAD_INPUT_DATA                    -0x1480  /**< Bad input parameters to function. */
  43 /* \} name */
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 #if defined(MBEDTLS_PEM_PARSE_C)
  50 /**
  51  * \brief       PEM context structure
  52  */
  53 typedef struct
  54 {
  55     unsigned char *buf;     /*!< buffer for decoded data             */
  56     size_t buflen;          /*!< length of the buffer                */
  57     unsigned char *info;    /*!< buffer for extra header information */
  58 }
  59 mbedtls_pem_context;
  60
  61 /**
  62  * \brief       PEM context setup
  63  *
  64  * \param ctx   context to be initialized
  65  */
  66 void mbedtls_pem_init( mbedtls_pem_context *ctx );
  67
  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 /**
  96  * \brief       PEM context memory freeing
  97  *
  98  * \param ctx   context to be freed
  99  */
 100 void mbedtls_pem_free( mbedtls_pem_context *ctx );
 101 #endif /* MBEDTLS_PEM_PARSE_C */
 102
 103 #if defined(MBEDTLS_PEM_WRITE_C)
 104 /**
 105  * \brief           Write a buffer of PEM information from a DER encoded
 106  *                  buffer.
 107  *
 108  * \param header    header string to write
 109  * \param footer    footer string to write
 110  * \param der_data  DER data to write
 111  * \param der_len   length of the DER data
 112  * \param buf       buffer to write to
 113  * \param buf_len   length of output buffer
 114  * \param olen      total length written / required (if buf_len is not enough)
 115  *
 116  * \return          0 on success, or a specific PEM or BASE64 error code. On
 117  *                  MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL olen is the required
 118  *                  size.
 119  */
 120 int mbedtls_pem_write_buffer( const char *header, const char *footer,
 121                       const unsigned char *der_data, size_t der_len,
 122                       unsigned char *buf, size_t buf_len, size_t *olen );
 123 #endif /* MBEDTLS_PEM_WRITE_C */
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif
 128
 129 #endif /* pem.h */