1 /** 2 * \file pkcs12.h 3 * 4 * \brief PKCS#12 Personal Information Exchange Syntax 5 */ 6 /* 7 * Copyright The Mbed TLS Contributors 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 #ifndef MBEDTLS_PKCS12_H 23 #define MBEDTLS_PKCS12_H 24 25 #if !defined(MBEDTLS_CONFIG_FILE) 26 #include "mbedtls/config.h" 27 #else 28 #include MBEDTLS_CONFIG_FILE 29 #endif 30 31 #include "mbedtls/md.h" 32 #include "mbedtls/cipher.h" 33 #include "mbedtls/asn1.h" 34 35 #include <stddef.h> 36 37 #define MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA -0x1F80 /**< Bad input parameters to function. */ 38 #define MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE -0x1F00 /**< Feature not available, e.g. unsupported encryption scheme. */ 39 #define MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT -0x1E80 /**< PBE ASN.1 data not as expected. */ 40 #define MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH -0x1E00 /**< Given private key password does not allow for correct decryption. */ 41 42 #define MBEDTLS_PKCS12_DERIVE_KEY 1 /**< encryption/decryption key */ 43 #define MBEDTLS_PKCS12_DERIVE_IV 2 /**< initialization vector */ 44 #define MBEDTLS_PKCS12_DERIVE_MAC_KEY 3 /**< integrity / MAC key */ 45 46 #define MBEDTLS_PKCS12_PBE_DECRYPT 0 47 #define MBEDTLS_PKCS12_PBE_ENCRYPT 1 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 #if defined(MBEDTLS_ASN1_PARSE_C) 54 55 /** 56 * \brief PKCS12 Password Based function (encryption / decryption) 57 * for pbeWithSHAAnd128BitRC4 58 * 59 * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure 60 * \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT 61 * \param pwd the password used (may be NULL if no password is used) 62 * \param pwdlen length of the password (may be 0) 63 * \param input the input data 64 * \param len data length 65 * \param output the output buffer 66 * 67 * \return 0 if successful, or a MBEDTLS_ERR_XXX code 68 */ 69 int mbedtls_pkcs12_pbe_sha1_rc4_128( mbedtls_asn1_buf *pbe_params, int mode, 70 const unsigned char *pwd, size_t pwdlen, 71 const unsigned char *input, size_t len, 72 unsigned char *output ); 73 74 /** 75 * \brief PKCS12 Password Based function (encryption / decryption) 76 * for cipher-based and mbedtls_md-based PBE's 77 * 78 * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure 79 * \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT 80 * \param cipher_type the cipher used 81 * \param md_type the mbedtls_md used 82 * \param pwd the password used (may be NULL if no password is used) 83 * \param pwdlen length of the password (may be 0) 84 * \param input the input data 85 * \param len data length 86 * \param output the output buffer 87 * 88 * \return 0 if successful, or a MBEDTLS_ERR_XXX code 89 */ 90 int mbedtls_pkcs12_pbe( mbedtls_asn1_buf *pbe_params, int mode, 91 mbedtls_cipher_type_t cipher_type, mbedtls_md_type_t md_type, 92 const unsigned char *pwd, size_t pwdlen, 93 const unsigned char *input, size_t len, 94 unsigned char *output ); 95 96 #endif /* MBEDTLS_ASN1_PARSE_C */ 97 98 /** 99 * \brief The PKCS#12 derivation function uses a password and a salt 100 * to produce pseudo-random bits for a particular "purpose". 101 * 102 * Depending on the given id, this function can produce an 103 * encryption/decryption key, an nitialization vector or an 104 * integrity key. 105 * 106 * \param data buffer to store the derived data in 107 * \param datalen length to fill 108 * \param pwd password to use (may be NULL if no password is used) 109 * \param pwdlen length of the password (may be 0) 110 * \param salt salt buffer to use 111 * \param saltlen length of the salt 112 * \param mbedtls_md mbedtls_md type to use during the derivation 113 * \param id id that describes the purpose (can be MBEDTLS_PKCS12_DERIVE_KEY, 114 * MBEDTLS_PKCS12_DERIVE_IV or MBEDTLS_PKCS12_DERIVE_MAC_KEY) 115 * \param iterations number of iterations 116 * 117 * \return 0 if successful, or a MD, BIGNUM type error. 118 */ 119 int mbedtls_pkcs12_derivation( unsigned char *data, size_t datalen, 120 const unsigned char *pwd, size_t pwdlen, 121 const unsigned char *salt, size_t saltlen, 122 mbedtls_md_type_t mbedtls_md, int id, int iterations ); 123 124 #ifdef __cplusplus 125 } 126 #endif 127 128 #endif /* pkcs12.h */ 129