1 /** 2 * \file pkcs5.h 3 * 4 * \brief PKCS#5 functions 5 * 6 * \author Mathias Olsson <mathias@kompetensum.com> 7 * 8 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 9 * SPDX-License-Identifier: Apache-2.0 10 * 11 * Licensed under the Apache License, Version 2.0 (the "License"); you may 12 * not use this file except in compliance with the License. 13 * You may obtain a copy of the License at 14 * 15 * http://www.apache.org/licenses/LICENSE-2.0 16 * 17 * Unless required by applicable law or agreed to in writing, software 18 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 19 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20 * See the License for the specific language governing permissions and 21 * limitations under the License. 22 * 23 * This file is part of mbed TLS (https://tls.mbed.org) 24 */ 25 #ifndef MBEDTLS_PKCS5_H 26 #define MBEDTLS_PKCS5_H 27 28 #include "asn1.h" 29 #include "md.h" 30 31 #include <stddef.h> 32 #include <stdint.h> 33 34 #define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA -0x2f80 /**< Bad input parameters to function. */ 35 #define MBEDTLS_ERR_PKCS5_INVALID_FORMAT -0x2f00 /**< Unexpected ASN.1 data. */ 36 #define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE -0x2e80 /**< Requested encryption or digest alg not available. */ 37 #define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH -0x2e00 /**< Given private key password does not allow for correct decryption. */ 38 39 #define MBEDTLS_PKCS5_DECRYPT 0 40 #define MBEDTLS_PKCS5_ENCRYPT 1 41 42 #ifdef __cplusplus 43 extern "C" { 44 #endif 45 46 /** 47 * \brief PKCS#5 PBES2 function 48 * 49 * \param pbe_params the ASN.1 algorithm parameters 50 * \param mode either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT 51 * \param pwd password to use when generating key 52 * \param pwdlen length of password 53 * \param data data to process 54 * \param datalen length of data 55 * \param output output buffer 56 * 57 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails. 58 */ 59 int mbedtls_pkcs5_pbes2( const mbedtls_asn1_buf *pbe_params, int mode, 60 const unsigned char *pwd, size_t pwdlen, 61 const unsigned char *data, size_t datalen, 62 unsigned char *output ); 63 64 /** 65 * \brief PKCS#5 PBKDF2 using HMAC 66 * 67 * \param ctx Generic HMAC context 68 * \param password Password to use when generating key 69 * \param plen Length of password 70 * \param salt Salt to use when generating key 71 * \param slen Length of salt 72 * \param iteration_count Iteration count 73 * \param key_length Length of generated key in bytes 74 * \param output Generated key. Must be at least as big as key_length 75 * 76 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails. 77 */ 78 int mbedtls_pkcs5_pbkdf2_hmac( mbedtls_md_context_t *ctx, const unsigned char *password, 79 size_t plen, const unsigned char *salt, size_t slen, 80 unsigned int iteration_count, 81 uint32_t key_length, unsigned char *output ); 82 83 /** 84 * \brief Checkup routine 85 * 86 * \return 0 if successful, or 1 if the test failed 87 */ 88 int mbedtls_pkcs5_self_test( int verbose ); 89 90 #ifdef __cplusplus 91 } 92 #endif 93 94 #endif /* pkcs5.h */ 95
