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 11 * 12 * Licensed under the Apache License, Version 2.0 (the "License"); you may 13 * not use this file except in compliance with the License. 14 * You may obtain a copy of the License at 15 * 16 * http://www.apache.org/licenses/LICENSE-2.0 17 * 18 * Unless required by applicable law or agreed to in writing, software 19 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 20 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 21 * See the License for the specific language governing permissions and 22 * limitations under the License. 23 */ 24 #ifndef MBEDTLS_PKCS5_H 25 #define MBEDTLS_PKCS5_H 26 27 #include "mbedtls/build_info.h" 28 29 #include "mbedtls/asn1.h" 30 #include "mbedtls/md.h" 31 32 #include <stddef.h> 33 #include <stdint.h> 34 35 /** Bad input parameters to function. */ 36 #define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA -0x2f80 37 /** Unexpected ASN.1 data. */ 38 #define MBEDTLS_ERR_PKCS5_INVALID_FORMAT -0x2f00 39 /** Requested encryption or digest alg not available. */ 40 #define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE -0x2e80 41 /** Given private key password does not allow for correct decryption. */ 42 #define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH -0x2e00 43 44 #define MBEDTLS_PKCS5_DECRYPT 0 45 #define MBEDTLS_PKCS5_ENCRYPT 1 46 47 #ifdef __cplusplus 48 extern "C" { 49 #endif 50 51 #if defined(MBEDTLS_ASN1_PARSE_C) 52 53 /** 54 * \brief PKCS#5 PBES2 function 55 * 56 * \param pbe_params the ASN.1 algorithm parameters 57 * \param mode either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT 58 * \param pwd password to use when generating key 59 * \param pwdlen length of password 60 * \param data data to process 61 * \param datalen length of data 62 * \param output output buffer 63 * 64 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails. 65 */ 66 int mbedtls_pkcs5_pbes2( const mbedtls_asn1_buf *pbe_params, int mode, 67 const unsigned char *pwd, size_t pwdlen, 68 const unsigned char *data, size_t datalen, 69 unsigned char *output ); 70 71 #endif /* MBEDTLS_ASN1_PARSE_C */ 72 73 /** 74 * \brief PKCS#5 PBKDF2 using HMAC without using the HMAC context 75 * 76 * \param md_type Hash algorithm used 77 * \param password Password to use when generating key 78 * \param plen Length of password 79 * \param salt Salt to use when generating key 80 * \param slen Length of salt 81 * \param iteration_count Iteration count 82 * \param key_length Length of generated key in bytes 83 * \param output Generated key. Must be at least as big as key_length 84 * 85 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails. 86 */ 87 int mbedtls_pkcs5_pbkdf2_hmac_ext( mbedtls_md_type_t md_type, 88 const unsigned char *password, 89 size_t plen, const unsigned char *salt, size_t slen, 90 unsigned int iteration_count, 91 uint32_t key_length, unsigned char *output ); 92 93 #if defined(MBEDTLS_MD_C) 94 #if !defined(MBEDTLS_DEPRECATED_REMOVED) 95 /** 96 * \brief PKCS#5 PBKDF2 using HMAC 97 * 98 * \deprecated Superseded by mbedtls_pkcs5_pbkdf2_hmac_ext(). 99 * 100 * \param ctx Generic HMAC context 101 * \param password Password to use when generating key 102 * \param plen Length of password 103 * \param salt Salt to use when generating key 104 * \param slen Length of salt 105 * \param iteration_count Iteration count 106 * \param key_length Length of generated key in bytes 107 * \param output Generated key. Must be at least as big as key_length 108 * 109 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails. 110 */ 111 int MBEDTLS_DEPRECATED mbedtls_pkcs5_pbkdf2_hmac( mbedtls_md_context_t *ctx, 112 const unsigned char *password, 113 size_t plen, const unsigned char *salt, size_t slen, 114 unsigned int iteration_count, 115 uint32_t key_length, unsigned char *output ); 116 #endif /* !MBEDTLS_DEPRECATED_REMOVED */ 117 #endif /* MBEDTLS_MD_C */ 118 #if defined(MBEDTLS_SELF_TEST) 119 120 /** 121 * \brief Checkup routine 122 * 123 * \return 0 if successful, or 1 if the test failed 124 */ 125 int mbedtls_pkcs5_self_test( int verbose ); 126 127 #endif /* MBEDTLS_SELF_TEST */ 128 129 #ifdef __cplusplus 130 } 131 #endif 132 133 #endif /* pkcs5.h */ 134
