mbed TLS v3.1.0
Macros | Functions
pkcs12.h File Reference

PKCS#12 Personal Information Exchange Syntax. More...

#include "mbedtls/build_info.h"
#include "mbedtls/md.h"
#include "mbedtls/cipher.h"
#include "mbedtls/asn1.h"
#include <stddef.h>
Include dependency graph for pkcs12.h:

Go to the source code of this file.

Macros

#define MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA   -0x1F80
 
#define MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE   -0x1F00
 
#define MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT   -0x1E80
 
#define MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH   -0x1E00
 
#define MBEDTLS_PKCS12_DERIVE_KEY   1
 
#define MBEDTLS_PKCS12_DERIVE_IV   2
 
#define MBEDTLS_PKCS12_DERIVE_MAC_KEY   3
 
#define MBEDTLS_PKCS12_PBE_DECRYPT   0
 
#define MBEDTLS_PKCS12_PBE_ENCRYPT   1
 

Functions

int mbedtls_pkcs12_pbe (mbedtls_asn1_buf *pbe_params, int mode, mbedtls_cipher_type_t cipher_type, mbedtls_md_type_t md_type, const unsigned char *pwd, size_t pwdlen, const unsigned char *input, size_t len, unsigned char *output)
 PKCS12 Password Based function (encryption / decryption) for cipher-based and mbedtls_md-based PBE's. More...
 
int mbedtls_pkcs12_derivation (unsigned char *data, size_t datalen, const unsigned char *pwd, size_t pwdlen, const unsigned char *salt, size_t saltlen, mbedtls_md_type_t mbedtls_md, int id, int iterations)
 The PKCS#12 derivation function uses a password and a salt to produce pseudo-random bits for a particular "purpose". More...
 

Detailed Description

PKCS#12 Personal Information Exchange Syntax.

Definition in file pkcs12.h.

Macro Definition Documentation

#define MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA   -0x1F80

Bad input parameters to function.

Definition at line 34 of file pkcs12.h.

#define MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE   -0x1F00

Feature not available, e.g. unsupported encryption scheme.

Definition at line 36 of file pkcs12.h.

#define MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH   -0x1E00

Given private key password does not allow for correct decryption.

Definition at line 40 of file pkcs12.h.

#define MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT   -0x1E80

PBE ASN.1 data not as expected.

Definition at line 38 of file pkcs12.h.

#define MBEDTLS_PKCS12_DERIVE_IV   2

initialization vector

Definition at line 43 of file pkcs12.h.

#define MBEDTLS_PKCS12_DERIVE_KEY   1

encryption/decryption key

Definition at line 42 of file pkcs12.h.

#define MBEDTLS_PKCS12_DERIVE_MAC_KEY   3

integrity / MAC key

Definition at line 44 of file pkcs12.h.

#define MBEDTLS_PKCS12_PBE_DECRYPT   0

Definition at line 46 of file pkcs12.h.

#define MBEDTLS_PKCS12_PBE_ENCRYPT   1

Definition at line 47 of file pkcs12.h.

Function Documentation

int mbedtls_pkcs12_derivation ( unsigned char *  data,
size_t  datalen,
const unsigned char *  pwd,
size_t  pwdlen,
const unsigned char *  salt,
size_t  saltlen,
mbedtls_md_type_t  mbedtls_md,
int  id,
int  iterations 
)

The PKCS#12 derivation function uses a password and a salt to produce pseudo-random bits for a particular "purpose".

Depending on the given id, this function can produce an encryption/decryption key, an initialization vector or an integrity key.

Parameters
databuffer to store the derived data in
datalenlength of buffer to fill
pwdThe password to use. For compliance with PKCS#12 §B.1, this should be a BMPString, i.e. a Unicode string where each character is encoded as 2 bytes in big-endian order, with no byte order mark and with a null terminator (i.e. the last two bytes should be 0x00 0x00).
pwdlenlength of the password (may be 0).
saltSalt buffer to use This may only be NULL when saltlen is 0.
saltlenlength of the salt (may be zero)
mbedtls_mdmbedtls_md type to use during the derivation
idid that describes the purpose (can be MBEDTLS_PKCS12_DERIVE_KEY, MBEDTLS_PKCS12_DERIVE_IV or MBEDTLS_PKCS12_DERIVE_MAC_KEY)
iterationsnumber of iterations
Returns
0 if successful, or a MD, BIGNUM type error.
int mbedtls_pkcs12_pbe ( mbedtls_asn1_buf pbe_params,
int  mode,
mbedtls_cipher_type_t  cipher_type,
mbedtls_md_type_t  md_type,
const unsigned char *  pwd,
size_t  pwdlen,
const unsigned char *  input,
size_t  len,
unsigned char *  output 
)

PKCS12 Password Based function (encryption / decryption) for cipher-based and mbedtls_md-based PBE's.

Parameters
pbe_paramsan ASN1 buffer containing the pkcs-12 PbeParams structure
modeeither MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT
cipher_typethe cipher used
md_typethe mbedtls_md used
pwdLatin1-encoded password used. This may only be NULL when pwdlen is 0. No null terminator should be used.
pwdlenlength of the password (may be 0)
inputthe input data
lendata length
outputthe output buffer
Returns
0 if successful, or a MBEDTLS_ERR_XXX code