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 /** Bad input parameters to function. */ 38 #define MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA -0x1F80 39 /** Feature not available, e.g. unsupported encryption scheme. */ 40 #define MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE -0x1F00 41 /** PBE ASN.1 data not as expected. */ 42 #define MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT -0x1E80 43 /** Given private key password does not allow for correct decryption. */ 44 #define MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH -0x1E00 45 46 #define MBEDTLS_PKCS12_DERIVE_KEY 1 /**< encryption/decryption key */ 47 #define MBEDTLS_PKCS12_DERIVE_IV 2 /**< initialization vector */ 48 #define MBEDTLS_PKCS12_DERIVE_MAC_KEY 3 /**< integrity / MAC key */ 49 50 #define MBEDTLS_PKCS12_PBE_DECRYPT 0 51 #define MBEDTLS_PKCS12_PBE_ENCRYPT 1 52 53 #ifdef __cplusplus 54 extern "C" { 55 #endif 56 57 #if defined(MBEDTLS_ASN1_PARSE_C) 58 59 /** 60 * \brief PKCS12 Password Based function (encryption / decryption) 61 * for pbeWithSHAAnd128BitRC4 62 * 63 * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure 64 * \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT 65 * \param pwd the password used (may be NULL if no password is used) 66 * \param pwdlen length of the password (may be 0) 67 * \param input the input data 68 * \param len data length 69 * \param output the output buffer 70 * 71 * \return 0 if successful, or a MBEDTLS_ERR_XXX code 72 */ 73 int mbedtls_pkcs12_pbe_sha1_rc4_128( mbedtls_asn1_buf *pbe_params, int mode, 74 const unsigned char *pwd, size_t pwdlen, 75 const unsigned char *input, size_t len, 76 unsigned char *output ); 77 78 /** 79 * \brief PKCS12 Password Based function (encryption / decryption) 80 * for cipher-based and mbedtls_md-based PBE's 81 * 82 * \param pbe_params an ASN1 buffer containing the pkcs-12 PbeParams structure 83 * \param mode either #MBEDTLS_PKCS12_PBE_ENCRYPT or 84 * #MBEDTLS_PKCS12_PBE_DECRYPT 85 * \param cipher_type the cipher used 86 * \param md_type the mbedtls_md used 87 * \param pwd Latin1-encoded password used. This may only be \c NULL when 88 * \p pwdlen is 0. No null terminator should be used. 89 * \param pwdlen length of the password (may be 0) 90 * \param input the input data 91 * \param len data length 92 * \param output the output buffer 93 * 94 * \return 0 if successful, or a MBEDTLS_ERR_XXX code 95 */ 96 int mbedtls_pkcs12_pbe( mbedtls_asn1_buf *pbe_params, int mode, 97 mbedtls_cipher_type_t cipher_type, mbedtls_md_type_t md_type, 98 const unsigned char *pwd, size_t pwdlen, 99 const unsigned char *input, size_t len, 100 unsigned char *output ); 101 102 #endif /* MBEDTLS_ASN1_PARSE_C */ 103 104 /** 105 * \brief The PKCS#12 derivation function uses a password and a salt 106 * to produce pseudo-random bits for a particular "purpose". 107 * 108 * Depending on the given id, this function can produce an 109 * encryption/decryption key, an initialization vector or an 110 * integrity key. 111 * 112 * \param data buffer to store the derived data in 113 * \param datalen length of buffer to fill 114 * \param pwd The password to use. For compliance with PKCS#12 §B.1, this 115 * should be a BMPString, i.e. a Unicode string where each 116 * character is encoded as 2 bytes in big-endian order, with 117 * no byte order mark and with a null terminator (i.e. the 118 * last two bytes should be 0x00 0x00). 119 * \param pwdlen length of the password (may be 0). 120 * \param salt Salt buffer to use This may only be \c NULL when 121 * \p saltlen is 0. 122 * \param saltlen length of the salt (may be zero) 123 * \param mbedtls_md mbedtls_md type to use during the derivation 124 * \param id id that describes the purpose (can be 125 * #MBEDTLS_PKCS12_DERIVE_KEY, #MBEDTLS_PKCS12_DERIVE_IV or 126 * #MBEDTLS_PKCS12_DERIVE_MAC_KEY) 127 * \param iterations number of iterations 128 * 129 * \return 0 if successful, or a MD, BIGNUM type error. 130 */ 131 int mbedtls_pkcs12_derivation( unsigned char *data, size_t datalen, 132 const unsigned char *pwd, size_t pwdlen, 133 const unsigned char *salt, size_t saltlen, 134 mbedtls_md_type_t mbedtls_md, int id, int iterations ); 135 136 #ifdef __cplusplus 137 } 138 #endif 139 140 #endif /* pkcs12.h */ 141