1 /** 2 * \file pkcs5.h 3 * 4 * \brief PKCS#5 functions 5 * 6 * \author Mathias Olsson <mathias@kompetensum.com> 7 */ 8 /* 9 * Copyright The Mbed TLS Contributors 10 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 11 * 12 * This file is provided under the Apache License 2.0, or the 13 * GNU General Public License v2.0 or later. 14 * 15 * ********** 16 * Apache License 2.0: 17 * 18 * Licensed under the Apache License, Version 2.0 (the "License"); you may 19 * not use this file except in compliance with the License. 20 * You may obtain a copy of the License at 21 * 22 * http://www.apache.org/licenses/LICENSE-2.0 23 * 24 * Unless required by applicable law or agreed to in writing, software 25 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 26 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 27 * See the License for the specific language governing permissions and 28 * limitations under the License. 29 * 30 * ********** 31 * 32 * ********** 33 * GNU General Public License v2.0 or later: 34 * 35 * This program is free software; you can redistribute it and/or modify 36 * it under the terms of the GNU General Public License as published by 37 * the Free Software Foundation; either version 2 of the License, or 38 * (at your option) any later version. 39 * 40 * This program is distributed in the hope that it will be useful, 41 * but WITHOUT ANY WARRANTY; without even the implied warranty of 42 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 43 * GNU General Public License for more details. 44 * 45 * You should have received a copy of the GNU General Public License along 46 * with this program; if not, write to the Free Software Foundation, Inc., 47 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 48 * 49 * ********** 50 */ 51 #ifndef MBEDTLS_PKCS5_H 52 #define MBEDTLS_PKCS5_H 53 54 #if !defined(MBEDTLS_CONFIG_FILE) 55 #include "config.h" 56 #else 57 #include MBEDTLS_CONFIG_FILE 58 #endif 59 60 #include "asn1.h" 61 #include "md.h" 62 63 #include <stddef.h> 64 #include <stdint.h> 65 66 #define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA -0x2f80 /**< Bad input parameters to function. */ 67 #define MBEDTLS_ERR_PKCS5_INVALID_FORMAT -0x2f00 /**< Unexpected ASN.1 data. */ 68 #define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE -0x2e80 /**< Requested encryption or digest alg not available. */ 69 #define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH -0x2e00 /**< Given private key password does not allow for correct decryption. */ 70 71 #define MBEDTLS_PKCS5_DECRYPT 0 72 #define MBEDTLS_PKCS5_ENCRYPT 1 73 74 #ifdef __cplusplus 75 extern "C" { 76 #endif 77 78 #if defined(MBEDTLS_ASN1_PARSE_C) 79 80 /** 81 * \brief PKCS#5 PBES2 function 82 * 83 * \param pbe_params the ASN.1 algorithm parameters 84 * \param mode either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT 85 * \param pwd password to use when generating key 86 * \param pwdlen length of password 87 * \param data data to process 88 * \param datalen length of data 89 * \param output output buffer 90 * 91 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails. 92 */ 93 int mbedtls_pkcs5_pbes2( const mbedtls_asn1_buf *pbe_params, int mode, 94 const unsigned char *pwd, size_t pwdlen, 95 const unsigned char *data, size_t datalen, 96 unsigned char *output ); 97 98 #endif /* MBEDTLS_ASN1_PARSE_C */ 99 100 /** 101 * \brief PKCS#5 PBKDF2 using HMAC 102 * 103 * \param ctx Generic HMAC context 104 * \param password Password to use when generating key 105 * \param plen Length of password 106 * \param salt Salt to use when generating key 107 * \param slen Length of salt 108 * \param iteration_count Iteration count 109 * \param key_length Length of generated key in bytes 110 * \param output Generated key. Must be at least as big as key_length 111 * 112 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails. 113 */ 114 int mbedtls_pkcs5_pbkdf2_hmac( mbedtls_md_context_t *ctx, const unsigned char *password, 115 size_t plen, const unsigned char *salt, size_t slen, 116 unsigned int iteration_count, 117 uint32_t key_length, unsigned char *output ); 118 119 #if defined(MBEDTLS_SELF_TEST) 120 121 /** 122 * \brief Checkup routine 123 * 124 * \return 0 if successful, or 1 if the test failed 125 */ 126 int mbedtls_pkcs5_self_test( int verbose ); 127 128 #endif /* MBEDTLS_SELF_TEST */ 129 130 #ifdef __cplusplus 131 } 132 #endif 133 134 #endif /* pkcs5.h */ 135