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