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 OR GPL-2.0-or-later 9 * 10 * This file is provided under the Apache License 2.0, or the 11 * GNU General Public License v2.0 or later. 12 * 13 * ********** 14 * Apache License 2.0: 15 * 16 * Licensed under the Apache License, Version 2.0 (the "License"); you may 17 * not use this file except in compliance with the License. 18 * You may obtain a copy of the License at 19 * 20 * http://www.apache.org/licenses/LICENSE-2.0 21 * 22 * Unless required by applicable law or agreed to in writing, software 23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 25 * See the License for the specific language governing permissions and 26 * limitations under the License. 27 * 28 * ********** 29 * 30 * ********** 31 * GNU General Public License v2.0 or later: 32 * 33 * This program is free software; you can redistribute it and/or modify 34 * it under the terms of the GNU General Public License as published by 35 * the Free Software Foundation; either version 2 of the License, or 36 * (at your option) any later version. 37 * 38 * This program is distributed in the hope that it will be useful, 39 * but WITHOUT ANY WARRANTY; without even the implied warranty of 40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 41 * GNU General Public License for more details. 42 * 43 * You should have received a copy of the GNU General Public License along 44 * with this program; if not, write to the Free Software Foundation, Inc., 45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 46 * 47 * ********** 48 */ 49 #ifndef MBEDTLS_PKCS12_H 50 #define MBEDTLS_PKCS12_H 51 52 #if !defined(MBEDTLS_CONFIG_FILE) 53 #include "config.h" 54 #else 55 #include MBEDTLS_CONFIG_FILE 56 #endif 57 58 #include "md.h" 59 #include "cipher.h" 60 #include "asn1.h" 61 62 #include <stddef.h> 63 64 #define MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA -0x1F80 /**< Bad input parameters to function. */ 65 #define MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE -0x1F00 /**< Feature not available, e.g. unsupported encryption scheme. */ 66 #define MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT -0x1E80 /**< PBE ASN.1 data not as expected. */ 67 #define MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH -0x1E00 /**< Given private key password does not allow for correct decryption. */ 68 69 #define MBEDTLS_PKCS12_DERIVE_KEY 1 /**< encryption/decryption key */ 70 #define MBEDTLS_PKCS12_DERIVE_IV 2 /**< initialization vector */ 71 #define MBEDTLS_PKCS12_DERIVE_MAC_KEY 3 /**< integrity / MAC key */ 72 73 #define MBEDTLS_PKCS12_PBE_DECRYPT 0 74 #define MBEDTLS_PKCS12_PBE_ENCRYPT 1 75 76 #ifdef __cplusplus 77 extern "C" { 78 #endif 79 80 #if defined(MBEDTLS_ASN1_PARSE_C) 81 82 /** 83 * \brief PKCS12 Password Based function (encryption / decryption) 84 * for pbeWithSHAAnd128BitRC4 85 * 86 * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure 87 * \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT 88 * \param pwd the password used (may be NULL if no password is 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_sha1_rc4_128( mbedtls_asn1_buf *pbe_params, int mode, 97 const unsigned char *pwd, size_t pwdlen, 98 const unsigned char *input, size_t len, 99 unsigned char *output ); 100 101 /** 102 * \brief PKCS12 Password Based function (encryption / decryption) 103 * for cipher-based and mbedtls_md-based PBE's 104 * 105 * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure 106 * \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT 107 * \param cipher_type the cipher used 108 * \param md_type the mbedtls_md used 109 * \param pwd the password used (may be NULL if no password is used) 110 * \param pwdlen length of the password (may be 0) 111 * \param input the input data 112 * \param len data length 113 * \param output the output buffer 114 * 115 * \return 0 if successful, or a MBEDTLS_ERR_XXX code 116 */ 117 int mbedtls_pkcs12_pbe( mbedtls_asn1_buf *pbe_params, int mode, 118 mbedtls_cipher_type_t cipher_type, mbedtls_md_type_t md_type, 119 const unsigned char *pwd, size_t pwdlen, 120 const unsigned char *input, size_t len, 121 unsigned char *output ); 122 123 #endif /* MBEDTLS_ASN1_PARSE_C */ 124 125 /** 126 * \brief The PKCS#12 derivation function uses a password and a salt 127 * to produce pseudo-random bits for a particular "purpose". 128 * 129 * Depending on the given id, this function can produce an 130 * encryption/decryption key, an nitialization vector or an 131 * integrity key. 132 * 133 * \param data buffer to store the derived data in 134 * \param datalen length to fill 135 * \param pwd password to use (may be NULL if no password is used) 136 * \param pwdlen length of the password (may be 0) 137 * \param salt salt buffer to use 138 * \param saltlen length of the salt 139 * \param mbedtls_md mbedtls_md type to use during the derivation 140 * \param id id that describes the purpose (can be MBEDTLS_PKCS12_DERIVE_KEY, 141 * MBEDTLS_PKCS12_DERIVE_IV or MBEDTLS_PKCS12_DERIVE_MAC_KEY) 142 * \param iterations number of iterations 143 * 144 * \return 0 if successful, or a MD, BIGNUM type error. 145 */ 146 int mbedtls_pkcs12_derivation( unsigned char *data, size_t datalen, 147 const unsigned char *pwd, size_t pwdlen, 148 const unsigned char *salt, size_t saltlen, 149 mbedtls_md_type_t mbedtls_md, int id, int iterations ); 150 151 #ifdef __cplusplus 152 } 153 #endif 154 155 #endif /* pkcs12.h */ 156