1 /** 2 * \file pkcs12.h 3 * 4 * \brief PKCS#12 Personal Information Exchange Syntax 5 */ 6 /* 7 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 8 * SPDX-License-Identifier: Apache-2.0 9 * 10 * Licensed under the Apache License, Version 2.0 (the "License"); you may 11 * not use this file except in compliance with the License. 12 * You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, software 17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 19 * See the License for the specific language governing permissions and 20 * limitations under the License. 21 * 22 * This file is part of mbed TLS (https://tls.mbed.org) 23 */ 24 #ifndef MBEDTLS_PKCS12_H 25 #define MBEDTLS_PKCS12_H 26 27 #include "md.h" 28 #include "cipher.h" 29 #include "asn1.h" 30 31 #include <stddef.h> 32 33 #define MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA -0x1F80 /**< Bad input parameters to function. */ 34 #define MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE -0x1F00 /**< Feature not available, e.g. unsupported encryption scheme. */ 35 #define MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT -0x1E80 /**< PBE ASN.1 data not as expected. */ 36 #define MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH -0x1E00 /**< Given private key password does not allow for correct decryption. */ 37 38 #define MBEDTLS_PKCS12_DERIVE_KEY 1 /**< encryption/decryption key */ 39 #define MBEDTLS_PKCS12_DERIVE_IV 2 /**< initialization vector */ 40 #define MBEDTLS_PKCS12_DERIVE_MAC_KEY 3 /**< integrity / MAC key */ 41 42 #define MBEDTLS_PKCS12_PBE_DECRYPT 0 43 #define MBEDTLS_PKCS12_PBE_ENCRYPT 1 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 #if defined(MBEDTLS_ASN1_PARSE_C) 50 51 /** 52 * \brief PKCS12 Password Based function (encryption / decryption) 53 * for pbeWithSHAAnd128BitRC4 54 * 55 * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure 56 * \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT 57 * \param pwd the password used (may be NULL if no password is used) 58 * \param pwdlen length of the password (may be 0) 59 * \param input the input data 60 * \param len data length 61 * \param output the output buffer 62 * 63 * \return 0 if successful, or a MBEDTLS_ERR_XXX code 64 */ 65 int mbedtls_pkcs12_pbe_sha1_rc4_128( mbedtls_asn1_buf *pbe_params, int mode, 66 const unsigned char *pwd, size_t pwdlen, 67 const unsigned char *input, size_t len, 68 unsigned char *output ); 69 70 /** 71 * \brief PKCS12 Password Based function (encryption / decryption) 72 * for cipher-based and mbedtls_md-based PBE's 73 * 74 * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure 75 * \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT 76 * \param cipher_type the cipher used 77 * \param md_type the mbedtls_md used 78 * \param pwd the password used (may be NULL if no password is used) 79 * \param pwdlen length of the password (may be 0) 80 * \param input the input data 81 * \param len data length 82 * \param output the output buffer 83 * 84 * \return 0 if successful, or a MBEDTLS_ERR_XXX code 85 */ 86 int mbedtls_pkcs12_pbe( mbedtls_asn1_buf *pbe_params, int mode, 87 mbedtls_cipher_type_t cipher_type, mbedtls_md_type_t md_type, 88 const unsigned char *pwd, size_t pwdlen, 89 const unsigned char *input, size_t len, 90 unsigned char *output ); 91 92 #endif /* MBEDTLS_ASN1_PARSE_C */ 93 94 /** 95 * \brief The PKCS#12 derivation function uses a password and a salt 96 * to produce pseudo-random bits for a particular "purpose". 97 * 98 * Depending on the given id, this function can produce an 99 * encryption/decryption key, an nitialization vector or an 100 * integrity key. 101 * 102 * \param data buffer to store the derived data in 103 * \param datalen length to fill 104 * \param pwd password to use (may be NULL if no password is used) 105 * \param pwdlen length of the password (may be 0) 106 * \param salt salt buffer to use 107 * \param saltlen length of the salt 108 * \param mbedtls_md mbedtls_md type to use during the derivation 109 * \param id id that describes the purpose (can be MBEDTLS_PKCS12_DERIVE_KEY, 110 * MBEDTLS_PKCS12_DERIVE_IV or MBEDTLS_PKCS12_DERIVE_MAC_KEY) 111 * \param iterations number of iterations 112 * 113 * \return 0 if successful, or a MD, BIGNUM type error. 114 */ 115 int mbedtls_pkcs12_derivation( unsigned char *data, size_t datalen, 116 const unsigned char *pwd, size_t pwdlen, 117 const unsigned char *salt, size_t saltlen, 118 mbedtls_md_type_t mbedtls_md, int id, int iterations ); 119 120 #ifdef __cplusplus 121 } 122 #endif 123 124 #endif /* pkcs12.h */ 125