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 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "mbedtls/config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32 
33 #include "mbedtls/asn1.h"
34 #include "mbedtls/md.h"
35 
36 #include <stddef.h>
37 #include <stdint.h>
38 
39 #define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA                  -0x2f80  /**< Bad input parameters to function. */
40 #define MBEDTLS_ERR_PKCS5_INVALID_FORMAT                  -0x2f00  /**< Unexpected ASN.1 data. */
41 #define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE             -0x2e80  /**< Requested encryption or digest alg not available. */
42 #define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH               -0x2e00  /**< Given private key password does not allow for correct decryption. */
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
75  *
76  * \param ctx      Generic HMAC context
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( mbedtls_md_context_t *ctx, const unsigned char *password,
88                        size_t plen, const unsigned char *salt, size_t slen,
89                        unsigned int iteration_count,
90                        uint32_t key_length, unsigned char *output );
91 
92 #if defined(MBEDTLS_SELF_TEST)
93 
94 /**
95  * \brief          Checkup routine
96  *
97  * \return         0 if successful, or 1 if the test failed
98  */
99 int mbedtls_pkcs5_self_test( int verbose );
100 
101 #endif /* MBEDTLS_SELF_TEST */
102 
103 #ifdef __cplusplus
104 }
105 #endif
106 
107 #endif /* pkcs5.h */
108