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