1 /** 2 * \file pkcs5.h 3 * 4 * \brief PKCS#5 functions 5 * 6 * \author Mathias Olsson <mathias@kompetensum.com> 7 */ 8 /* 9 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 10 * SPDX-License-Identifier: GPL-2.0 11 * 12 * This program is free software; you can redistribute it and/or modify 13 * it under the terms of the GNU General Public License as published by 14 * the Free Software Foundation; either version 2 of the License, or 15 * (at your option) any later version. 16 * 17 * This program is distributed in the hope that it will be useful, 18 * but WITHOUT ANY WARRANTY; without even the implied warranty of 19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 * GNU General Public License for more details. 21 * 22 * You should have received a copy of the GNU General Public License along 23 * with this program; if not, write to the Free Software Foundation, Inc., 24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 25 * 26 * This file is part of mbed TLS (https://tls.mbed.org) 27 */ 28 #ifndef MBEDTLS_PKCS5_H 29 #define MBEDTLS_PKCS5_H 30 31 #include "asn1.h" 32 #include "md.h" 33 34 #include <stddef.h> 35 #include <stdint.h> 36 37 #define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA -0x2f80 /**< Bad input parameters to function. */ 38 #define MBEDTLS_ERR_PKCS5_INVALID_FORMAT -0x2f00 /**< Unexpected ASN.1 data. */ 39 #define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE -0x2e80 /**< Requested encryption or digest alg not available. */ 40 #define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH -0x2e00 /**< Given private key password does not allow for correct decryption. */ 41 42 #define MBEDTLS_PKCS5_DECRYPT 0 43 #define MBEDTLS_PKCS5_ENCRYPT 1 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 #if defined(MBEDTLS_ASN1_PARSE_C) 50 51 /** 52 * \brief PKCS#5 PBES2 function 53 * 54 * \param pbe_params the ASN.1 algorithm parameters 55 * \param mode either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT 56 * \param pwd password to use when generating key 57 * \param pwdlen length of password 58 * \param data data to process 59 * \param datalen length of data 60 * \param output output buffer 61 * 62 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails. 63 */ 64 int mbedtls_pkcs5_pbes2( const mbedtls_asn1_buf *pbe_params, int mode, 65 const unsigned char *pwd, size_t pwdlen, 66 const unsigned char *data, size_t datalen, 67 unsigned char *output ); 68 69 #endif /* MBEDTLS_ASN1_PARSE_C */ 70 71 /** 72 * \brief PKCS#5 PBKDF2 using HMAC 73 * 74 * \param ctx Generic HMAC context 75 * \param password Password to use when generating key 76 * \param plen Length of password 77 * \param salt Salt to use when generating key 78 * \param slen Length of salt 79 * \param iteration_count Iteration count 80 * \param key_length Length of generated key in bytes 81 * \param output Generated key. Must be at least as big as key_length 82 * 83 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails. 84 */ 85 int mbedtls_pkcs5_pbkdf2_hmac( mbedtls_md_context_t *ctx, const unsigned char *password, 86 size_t plen, const unsigned char *salt, size_t slen, 87 unsigned int iteration_count, 88 uint32_t key_length, unsigned char *output ); 89 90 /** 91 * \brief Checkup routine 92 * 93 * \return 0 if successful, or 1 if the test failed 94 */ 95 int mbedtls_pkcs5_self_test( int verbose ); 96 97 #ifdef __cplusplus 98 } 99 #endif 100 101 #endif /* pkcs5.h */ 102