mbed TLS v1.3.17
Macros | Functions
pkcs12.h File Reference

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

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

Go to the source code of this file.

Macros

#define POLARSSL_ERR_PKCS12_BAD_INPUT_DATA   -0x1F80
 Bad input parameters to function. More...
 
#define POLARSSL_ERR_PKCS12_FEATURE_UNAVAILABLE   -0x1F00
 Feature not available, e.g. More...
 
#define POLARSSL_ERR_PKCS12_PBE_INVALID_FORMAT   -0x1E80
 PBE ASN.1 data not as expected. More...
 
#define POLARSSL_ERR_PKCS12_PASSWORD_MISMATCH   -0x1E00
 Given private key password does not allow for correct decryption. More...
 
#define PKCS12_DERIVE_KEY   1
 encryption/decryption key More...
 
#define PKCS12_DERIVE_IV   2
 initialization vector More...
 
#define PKCS12_DERIVE_MAC_KEY   3
 integrity / MAC key More...
 
#define PKCS12_PBE_DECRYPT   0
 
#define PKCS12_PBE_ENCRYPT   1
 

Functions

int pkcs12_pbe_sha1_rc4_128 (asn1_buf *pbe_params, int mode, const unsigned char *pwd, size_t pwdlen, const unsigned char *input, size_t len, unsigned char *output)
 PKCS12 Password Based function (encryption / decryption) for pbeWithSHAAnd128BitRC4. More...
 
int pkcs12_pbe (asn1_buf *pbe_params, int mode, cipher_type_t cipher_type, 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 md-based PBE's. More...
 
int pkcs12_derivation (unsigned char *data, size_t datalen, const unsigned char *pwd, size_t pwdlen, const unsigned char *salt, size_t saltlen, md_type_t 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.

Copyright (C) 2006-2013, ARM Limited, All Rights Reserved

This file is part of mbed TLS (https://tls.mbed.org)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Definition in file pkcs12.h.

Macro Definition Documentation

#define PKCS12_DERIVE_IV   2

initialization vector

Definition at line 39 of file pkcs12.h.

#define PKCS12_DERIVE_KEY   1

encryption/decryption key

Definition at line 38 of file pkcs12.h.

#define PKCS12_DERIVE_MAC_KEY   3

integrity / MAC key

Definition at line 40 of file pkcs12.h.

#define PKCS12_PBE_DECRYPT   0

Definition at line 42 of file pkcs12.h.

#define PKCS12_PBE_ENCRYPT   1

Definition at line 43 of file pkcs12.h.

#define POLARSSL_ERR_PKCS12_BAD_INPUT_DATA   -0x1F80

Bad input parameters to function.

Definition at line 33 of file pkcs12.h.

#define POLARSSL_ERR_PKCS12_FEATURE_UNAVAILABLE   -0x1F00

Feature not available, e.g.

unsupported encryption scheme.

Definition at line 34 of file pkcs12.h.

#define POLARSSL_ERR_PKCS12_PASSWORD_MISMATCH   -0x1E00

Given private key password does not allow for correct decryption.

Definition at line 36 of file pkcs12.h.

#define POLARSSL_ERR_PKCS12_PBE_INVALID_FORMAT   -0x1E80

PBE ASN.1 data not as expected.

Definition at line 35 of file pkcs12.h.

Function Documentation

int pkcs12_derivation ( unsigned char *  data,
size_t  datalen,
const unsigned char *  pwd,
size_t  pwdlen,
const unsigned char *  salt,
size_t  saltlen,
md_type_t  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 nitialization vector or an integrity key.

Parameters
databuffer to store the derived data in
datalenlength to fill
pwdpassword to use (may be NULL if no password is used)
pwdlenlength of the password (may be 0)
saltsalt buffer to use
saltlenlength of the salt
mdmd type to use during the derivation
idid that describes the purpose (can be PKCS12_DERIVE_KEY, PKCS12_DERIVE_IV or PKCS12_DERIVE_MAC_KEY)
iterationsnumber of iterations
Returns
0 if successful, or a MD, BIGNUM type error.
int pkcs12_pbe ( asn1_buf pbe_params,
int  mode,
cipher_type_t  cipher_type,
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 md-based PBE's.

Parameters
pbe_paramsan ASN1 buffer containing the pkcs-12PbeParams structure
modeeither PKCS12_PBE_ENCRYPT or PKCS12_PBE_DECRYPT
cipher_typethe cipher used
md_typethe md used
pwdthe password used (may be NULL if no password is used)
pwdlenlength of the password (may be 0)
inputthe input data
lendata length
outputthe output buffer
Returns
0 if successful, or a POLARSSL_ERR_xxx code
int pkcs12_pbe_sha1_rc4_128 ( asn1_buf pbe_params,
int  mode,
const unsigned char *  pwd,
size_t  pwdlen,
const unsigned char *  input,
size_t  len,
unsigned char *  output 
)

PKCS12 Password Based function (encryption / decryption) for pbeWithSHAAnd128BitRC4.

Parameters
pbe_paramsan ASN1 buffer containing the pkcs-12PbeParams structure
modeeither PKCS12_PBE_ENCRYPT or PKCS12_PBE_DECRYPT
pwdthe password used (may be NULL if no password is used)
pwdlenlength of the password (may be 0)
inputthe input data
lendata length
outputthe output buffer
Returns
0 if successful, or a POLARSSL_ERR_xxx code