Documentation

Documentation

Includes

config.h

#include "config.h"
#include "config.h"

MBEDTLS_CONFIG_FILE

#include MBEDTLS_CONFIG_FILE
#include MBEDTLS_CONFIG_FILE

stddef.h

#include <stddef.h>
#include 

Macros

Marco MBEDTLS_PEM_H

#define MBEDTLS_PEM_H


      
      
#define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT         -4224 /**< No PEM header or footer found. */
/**
 * \name PEM Error codes
 * These error codes are returned in case of errors reading the
 * PEM data.
 * \{
 */

Marco MBEDTLS_ERR_PEM_INVALID_DATA

#define MBEDTLS_ERR_PEM_INVALID_DATA                     -4352 /**< PEM string is not as expected. */


      

Marco MBEDTLS_ERR_PEM_ALLOC_FAILED

#define MBEDTLS_ERR_PEM_ALLOC_FAILED                     -4480 /**< Failed to allocate memory. */


      

Marco MBEDTLS_ERR_PEM_INVALID_ENC_IV

#define MBEDTLS_ERR_PEM_INVALID_ENC_IV                   -4608 /**< RSA IV is not in hex-format. */


      

Marco MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG

#define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG                  -4736 /**< Unsupported key encryption algorithm. */


      

Marco MBEDTLS_ERR_PEM_PASSWORD_REQUIRED

#define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED                -4864 /**< Private key password can't be empty. */


      

Marco MBEDTLS_ERR_PEM_PASSWORD_MISMATCH

#define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH                -4992 /**< Given private key password does not allow for correct decryption. */


      

Marco MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE

#define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE              -5120 /**< Unavailable feature, e.g. hashing/encryption combination. */


      

Marco MBEDTLS_ERR_PEM_BAD_INPUT_DATA

#define MBEDTLS_ERR_PEM_BAD_INPUT_DATA                   -5248 /**< Bad input parameters to function. */

      

Functions

Func mbedtls_pem_init

void mbedtls_pem_init( mbedtls_pem_context *ctx );
/**
 * \brief       PEM context setup
 *
 * \param ctx   context to be initialized
 */

Func mbedtls_pem_read_buffer

int mbedtls_pem_read_buffer( mbedtls_pem_context *ctx, const char *header, const char *footer,
                    const unsigned char *data,
                    const unsigned char *pwd,
                    size_t pwdlen, size_t *use_len );
/**
 * \brief       Read a buffer for PEM information and store the resulting
 *              data into the specified context buffers.
 *
 * \param ctx       context to use
 * \param header    header string to seek and expect
 * \param footer    footer string to seek and expect
 * \param data      source data to look in (must be nul-terminated)
 * \param pwd       password for decryption (can be NULL)
 * \param pwdlen    length of password
 * \param use_len   destination for total length used (set after header is
 *                  correctly read, so unless you get
 *                  MBEDTLS_ERR_PEM_BAD_INPUT_DATA or
 *                  MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT, use_len is
 *                  the length to skip)
 *
 * \note            Attempts to check password correctness by verifying if
 *                  the decrypted text starts with an ASN.1 sequence of
 *                  appropriate length
 *
 * \return          0 on success, or a specific PEM error code
 */

Func mbedtls_pem_free

void mbedtls_pem_free( mbedtls_pem_context *ctx );
/**
 * \brief       PEM context memory freeing
 *
 * \param ctx   context to be freed
 */

Func mbedtls_pem_write_buffer

int mbedtls_pem_write_buffer( const char *header, const char *footer,
                     const unsigned char *der_data, size_t der_len,
                     unsigned char *buf, size_t buf_len, size_t *olen );
/**
 * \brief           Write a buffer of PEM information from a DER encoded
 *                  buffer.
 *
 * \param header    header string to write
 * \param footer    footer string to write
 * \param der_data  DER data to write
 * \param der_len   length of the DER data
 * \param buf       buffer to write to
 * \param buf_len   length of output buffer
 * \param olen      total length written / required (if buf_len is not enough)
 *
 * \return          0 on success, or a specific PEM or BASE64 error code. On
 *                  MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL olen is the required
 *                  size.
 */

Vars

Consts

Types

Typedefs

Typedef mbedtls_pem_context;

typedef struct mbedtls_pem_context
{
   unsigned char *buf;    /*!< buffer for decoded data             */
   size_t buflen;         /*!< length of the buffer                */
   unsigned char *info;   /*!< buffer for extra header information */
}
mbedtls_pem_context;
/**
 * \brief       PEM context structure
 */