mbed TLS  Version 2.17.0
SSL/TLS Library for the Embedded Space
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pem.h File Reference

Data Structures

struct  mbedtls_pem_context
 PEM context structure. More...
 

Macros

PEM Error codes

These error codes are returned in case of errors reading the PEM data.

#define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT   -0x1080
 No PEM header or footer found. More...
 
#define MBEDTLS_ERR_PEM_INVALID_DATA   -0x1100
 PEM string is not as expected. More...
 
#define MBEDTLS_ERR_PEM_ALLOC_FAILED   -0x1180
 Failed to allocate memory. More...
 
#define MBEDTLS_ERR_PEM_INVALID_ENC_IV   -0x1200
 RSA IV is not in hex-format. More...
 
#define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG   -0x1280
 Unsupported key encryption algorithm. More...
 
#define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED   -0x1300
 Private key password can't be empty. More...
 
#define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH   -0x1380
 Given private key password does not allow for correct decryption. More...
 
#define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE   -0x1400
 Unavailable feature, e.g. More...
 
#define MBEDTLS_ERR_PEM_BAD_INPUT_DATA   -0x1480
 Bad input parameters to function. More...
 

Functions

void mbedtls_pem_init (mbedtls_pem_context *ctx)
 PEM context setup. More...
 
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)
 Read a buffer for PEM information and store the resulting data into the specified context buffers. More...
 
void mbedtls_pem_free (mbedtls_pem_context *ctx)
 PEM context memory freeing. More...
 
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)
 Write a buffer of PEM information from a DER encoded buffer. More...
 

Description

Privacy Enhanced Mail (PEM) decoding.


Data Structure Documentation

struct mbedtls_pem_context

PEM context structure.

Data Fields
unsigned char * buf

buffer for decoded data

size_t buflen

length of the buffer

unsigned char * info

buffer for extra header information

Macro Definition Documentation

#define MBEDTLS_ERR_PEM_ALLOC_FAILED   -0x1180

Failed to allocate memory.

#define MBEDTLS_ERR_PEM_BAD_INPUT_DATA   -0x1480

Bad input parameters to function.

#define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE   -0x1400

Unavailable feature, e.g.

hashing/encryption combination.

#define MBEDTLS_ERR_PEM_INVALID_DATA   -0x1100

PEM string is not as expected.

#define MBEDTLS_ERR_PEM_INVALID_ENC_IV   -0x1200

RSA IV is not in hex-format.

#define MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT   -0x1080

No PEM header or footer found.

#define MBEDTLS_ERR_PEM_PASSWORD_MISMATCH   -0x1380

Given private key password does not allow for correct decryption.

#define MBEDTLS_ERR_PEM_PASSWORD_REQUIRED   -0x1300

Private key password can't be empty.

#define MBEDTLS_ERR_PEM_UNKNOWN_ENC_ALG   -0x1280

Unsupported key encryption algorithm.

Function Documentation

void mbedtls_pem_free ( mbedtls_pem_context ctx)

PEM context memory freeing.

Parameters
ctxcontext to be freed
void mbedtls_pem_init ( mbedtls_pem_context ctx)

PEM context setup.

Parameters
ctxcontext to be initialized
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 
)

Read a buffer for PEM information and store the resulting data into the specified context buffers.

Parameters
ctxcontext to use
headerheader string to seek and expect
footerfooter string to seek and expect
datasource data to look in (must be nul-terminated)
pwdpassword for decryption (can be NULL)
pwdlenlength of password
use_lendestination 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
Returns
0 on success, or a specific PEM error code
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 
)

Write a buffer of PEM information from a DER encoded buffer.

Parameters
headerheader string to write
footerfooter string to write
der_dataDER data to write
der_lenlength of the DER data
bufbuffer to write to
buf_lenlength of output buffer
olentotal length written / required (if buf_len is not enough)
Returns
0 on success, or a specific PEM or BASE64 error code. On MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL olen is the required size.