1 /*
2  *  Copyright (c) 2016, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * @brief
32  *  This file includes definitions for performing Password-Based Key Derivation Function 2 (PBKDF2) using CMAC.
33  */
34 
35 #ifndef PBKDF2_CMAC_HPP_
36 #define PBKDF2_CMAC_HPP_
37 
38 #include "openthread-core-config.h"
39 
40 #include <stdint.h>
41 
42 namespace ot {
43 namespace Crypto {
44 namespace Pbkdf2 {
45 
46 /**
47  * @addtogroup core-security
48  *
49  * @{
50  *
51  */
52 
53 constexpr uint16_t kMaxSaltLength = 30; ///< Max SALT length: salt prefix (6) + extended panid (8) + network name (16)
54 
55 /**
56  * This function performs PKCS#5 PBKDF2 using CMAC (AES-CMAC-PRF-128).
57  *
58  * @param[in]     aPassword          Password to use when generating key.
59  * @param[in]     aPasswordLen       Length of password.
60  * @param[in]     aSalt              Salt to use when generating key.
61  * @param[in]     aSaltLen           Length of salt.
62  * @param[in]     aIterationCounter  Iteration count.
63  * @param[in]     aKeyLen            Length of generated key in bytes.
64  * @param[out]    aKey               A pointer to the generated key.
65  *
66  */
67 void GenerateKey(const uint8_t *aPassword,
68                  uint16_t       aPasswordLen,
69                  const uint8_t *aSalt,
70                  uint16_t       aSaltLen,
71                  uint32_t       aIterationCounter,
72                  uint16_t       aKeyLen,
73                  uint8_t *      aKey);
74 
75 /**
76  * @}
77  *
78  */
79 
80 } // namespace Pbkdf2
81 } // namespace Crypto
82 } // namespace ot
83 
84 #endif // PBKDF2_CMAC_HPP_
85