From 48333ce530b31d1ab71bc1ad740314f576ccdf9d Mon Sep 17 00:00:00 2001 From: Abtin Keshavarzian Date: Tue, 5 May 2020 13:05:26 -0700 Subject: [PATCH] [crypto] adding HMAC Key Derivation Function (HKDF) using SHA-256 (#4440) This commit adds a new class `Crypto::HkdfSha256` which implements HMAC-based Extract-and-Expand Key Derivation Function from RFC-5869 using SHA-256. It also adds a unit test for the new module. --- Android.mk | 1 + src/core/BUILD.gn | 2 + src/core/CMakeLists.txt | 1 + src/core/Makefile.am | 2 + src/core/crypto/hkdf_sha256.cpp | 96 +++++++++++++++++++ src/core/crypto/hkdf_sha256.hpp | 103 ++++++++++++++++++++ tests/unit/CMakeLists.txt | 28 ++++++ tests/unit/Makefile.am | 4 + tests/unit/test_hkdf_sha256.cpp | 162 ++++++++++++++++++++++++++++++++ tests/unit/test_util.cpp | 2 +- tests/unit/test_util.hpp | 2 +- 11 files changed, 401 insertions(+), 2 deletions(-) create mode 100644 src/core/crypto/hkdf_sha256.cpp create mode 100644 src/core/crypto/hkdf_sha256.hpp create mode 100644 tests/unit/test_hkdf_sha256.cpp diff --git a/Android.mk b/Android.mk index 6404c0363..2732f18d8 100644 --- a/Android.mk +++ b/Android.mk @@ -203,6 +203,7 @@ LOCAL_SRC_FILES := \ src/core/common/trickle_timer.cpp \ src/core/crypto/aes_ccm.cpp \ src/core/crypto/aes_ecb.cpp \ + src/core/crypto/hkdf_sha256.cpp \ src/core/crypto/hmac_sha256.cpp \ src/core/crypto/mbedtls.cpp \ src/core/crypto/pbkdf2_cmac.cpp \ diff --git a/src/core/BUILD.gn b/src/core/BUILD.gn index 1e2b85b34..7b3901ad6 100644 --- a/src/core/BUILD.gn +++ b/src/core/BUILD.gn @@ -397,6 +397,8 @@ openthread_core_files = [ "crypto/aes_ecb.hpp", "crypto/ecdsa.cpp", "crypto/ecdsa.hpp", + "crypto/hkdf_sha256.cpp", + "crypto/hkdf_sha256.hpp", "crypto/hmac_sha256.cpp", "crypto/hmac_sha256.hpp", "crypto/mbedtls.cpp", diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt index 249413008..1c948d0ab 100644 --- a/src/core/CMakeLists.txt +++ b/src/core/CMakeLists.txt @@ -94,6 +94,7 @@ set(COMMON_SOURCES crypto/aes_ccm.cpp crypto/aes_ecb.cpp crypto/ecdsa.cpp + crypto/hkdf_sha256.cpp crypto/hmac_sha256.cpp crypto/mbedtls.cpp crypto/pbkdf2_cmac.cpp diff --git a/src/core/Makefile.am b/src/core/Makefile.am index 0fcaf2e66..57de1cbee 100644 --- a/src/core/Makefile.am +++ b/src/core/Makefile.am @@ -171,6 +171,7 @@ SOURCES_COMMON = \ crypto/aes_ccm.cpp \ crypto/aes_ecb.cpp \ crypto/ecdsa.cpp \ + crypto/hkdf_sha256.cpp \ crypto/hmac_sha256.cpp \ crypto/mbedtls.cpp \ crypto/pbkdf2_cmac.cpp \ @@ -403,6 +404,7 @@ HEADERS_COMMON = \ crypto/aes_ccm.hpp \ crypto/aes_ecb.hpp \ crypto/ecdsa.hpp \ + crypto/hkdf_sha256.hpp \ crypto/hmac_sha256.hpp \ crypto/mbedtls.hpp \ crypto/pbkdf2_cmac.h \ diff --git a/src/core/crypto/hkdf_sha256.cpp b/src/core/crypto/hkdf_sha256.cpp new file mode 100644 index 000000000..3201fb1de --- /dev/null +++ b/src/core/crypto/hkdf_sha256.cpp @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2020, The OpenThread Authors. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the copyright holder nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/** + * @file + * This file implements HMAC-based Extract-and-Expand Key Derivation Function (HKDF) using SHA-256. + */ + +#include "hkdf_sha256.hpp" + +#include + +namespace ot { +namespace Crypto { + +void HkdfSha256::Extract(const uint8_t *aSalt, uint16_t aSaltLength, const uint8_t *aInputKey, uint16_t aInputKeyLength) +{ + HmacSha256 hmac; + + // PRK is calculated as HMAC-Hash(aSalt, aInputKey) + + hmac.Start(aSalt, aSaltLength); + hmac.Update(aInputKey, aInputKeyLength); + hmac.Finish(mPrk); +} + +void HkdfSha256::Expand(const uint8_t *aInfo, uint16_t aInfoLength, uint8_t *aOutputKey, uint16_t aOutputKeyLength) +{ + HmacSha256 hmac; + uint8_t hash[kHashSize]; + uint8_t iter = 0; + uint16_t copyLength; + + // The aOutputKey is calculated as follows [RFC5889]: + // + // N = ceil( aOutputKeyLength / HashSize) + // T = T(1) | T(2) | T(3) | ... | T(N) + // aOutputKey is first aOutputKeyLength of T + // + // Where: + // T(0) = empty string (zero length) + // T(1) = HMAC-Hash(PRK, T(0) | info | 0x01) + // T(2) = HMAC-Hash(PRK, T(1) | info | 0x02) + // T(3) = HMAC-Hash(PRK, T(2) | info | 0x03) + // ... + + while (aOutputKeyLength > 0) + { + hmac.Start(mPrk, sizeof(mPrk)); + + if (iter != 0) + { + hmac.Update(hash, sizeof(hash)); + } + + hmac.Update(aInfo, aInfoLength); + + iter++; + hmac.Update(&iter, sizeof(iter)); + hmac.Finish(hash); + + copyLength = (aOutputKeyLength > sizeof(hash)) ? sizeof(hash) : aOutputKeyLength; + + memcpy(aOutputKey, hash, copyLength); + aOutputKey += copyLength; + aOutputKeyLength -= copyLength; + } +} + +} // namespace Crypto +} // namespace ot diff --git a/src/core/crypto/hkdf_sha256.hpp b/src/core/crypto/hkdf_sha256.hpp new file mode 100644 index 000000000..379ef45e0 --- /dev/null +++ b/src/core/crypto/hkdf_sha256.hpp @@ -0,0 +1,103 @@ +/* + * Copyright (c) 2020, The OpenThread Authors. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the copyright holder nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/** + * @file + * This file includes definitions for performing HMAC-based Extract-and-Expand Key Derivation Function (HKDF) using + * SHA-256. + */ + +#ifndef HKDF_SHA256_HPP_ +#define HKDF_SHA256_HPP_ + +#include "openthread-core-config.h" + +#include "hmac_sha256.hpp" + +namespace ot { +namespace Crypto { + +/** + * @addtogroup core-security + * + * @{ + * + */ + +/** + * This class implements HMAC-based Extract-and-Expand Key Derivation Function (HKDF) [RFC5869] using SHA-256. + * + */ +class HkdfSha256 +{ +public: + /** + * This method performs the HKDF Extract step. + * + * In the Extract step getting an input key extracts from it a pseudo-random key. + * + * @param[in] aSalt A pointer to buffer containing salt. + * @param[in] aSaltLength The salt length (in bytes). + * @param[in] aInputKey A pointer to buffer containing the input key. + * @param[in] aInputKeyLength The input key length (in bytes). + * + */ + void Extract(const uint8_t *aSalt, uint16_t aSaltLength, const uint8_t *aInputKey, uint16_t aInputKeyLength); + + /** + * This method performs the HKDF Expand step. + * + * The method should be used after a previous `Extract` call, otherwise its behavior is undefined. In the Expand + * stage an output key of a given length is derived from the pseudo-random key of Extract stage. + * + * @param[in] aInfo A pointer to buffer containing info sequence. + * @param[in] aInfoLength The info length (in bytes). + * @param[out] aOutputKey Buffer to place the output key (must contain at least @p aOutputKeyLength bytes). + * @param[in] aOutputKeyLength The output key length. + * + */ + void Expand(const uint8_t *aInfo, uint16_t aInfoLength, uint8_t *aOutputKey, uint16_t aOutputKeyLength); + +private: + enum + { + kHashSize = HmacSha256::kHashSize, + }; + + uint8_t mPrk[kHashSize]; // Pseudo-Random Key (derived from Extract step). +}; + +/** + * @} + * + */ + +} // namespace Crypto +} // namespace ot + +#endif // HKDF_SHA256_HPP_ diff --git a/tests/unit/CMakeLists.txt b/tests/unit/CMakeLists.txt index 64f6ec08d..307f98e47 100644 --- a/tests/unit/CMakeLists.txt +++ b/tests/unit/CMakeLists.txt @@ -236,6 +236,33 @@ target_link_libraries(test-heap add_test(NAME test-heap COMMAND test-heap) +add_executable(test-hkdf-sha256 + ${COMMON_SOURCES} + test_hkdf_sha256.cpp +) + +target_include_directories(test-hkdf-sha256 + PRIVATE + ${COMMON_INCLUDES} +) + +target_compile_definitions(test-hkdf-sha256 + PRIVATE + ${OT_PRIVATE_DEFINES} +) + +target_compile_options(test-hkdf-sha256 + PRIVATE + ${COMMON_COMPILE_OPTIONS} +) + +target_link_libraries(test-hkdf-sha256 + PRIVATE + ${COMMON_LIBS} +) + +add_test(NAME test-hkdf-sha256 COMMAND test-hkdf-sha256) + add_executable(test-hmac-sha256 test_hmac_sha256.cpp ) @@ -668,6 +695,7 @@ set_target_properties( test-dns test-flash test-heap + test-hkdf-sha256 test-hmac-sha256 test-ip6-address test-link-quality diff --git a/tests/unit/Makefile.am b/tests/unit/Makefile.am index c3718697d..aff58bf78 100644 --- a/tests/unit/Makefile.am +++ b/tests/unit/Makefile.am @@ -114,6 +114,7 @@ check_PROGRAMS += \ test-dns \ test-flash \ test-heap \ + test-hkdf-sha256 \ test-hmac-sha256 \ test-ip6-address \ test-link-quality \ @@ -201,6 +202,9 @@ test_hdlc_SOURCES = $(COMMON_SOURCES) test_hdlc.cpp test_heap_LDADD = $(COMMON_LDADD) test_heap_SOURCES = $(COMMON_SOURCES) test_heap.cpp +test_hkdf_sha256_LDADD = $(COMMON_LDADD) +test_hkdf_sha256_SOURCES = $(COMMON_SOURCES) test_hkdf_sha256.cpp + test_hmac_sha256_LDADD = $(COMMON_LDADD) test_hmac_sha256_SOURCES = $(COMMON_SOURCES) test_hmac_sha256.cpp diff --git a/tests/unit/test_hkdf_sha256.cpp b/tests/unit/test_hkdf_sha256.cpp new file mode 100644 index 000000000..6ce50d340 --- /dev/null +++ b/tests/unit/test_hkdf_sha256.cpp @@ -0,0 +1,162 @@ +/* + * Copyright (c) 2020, The OpenThread Authors. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the copyright holder nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#include + +#include "common/debug.hpp" +#include "crypto/hkdf_sha256.hpp" + +#include "test_platform.h" +#include "test_util.h" +#include "test_util.hpp" + +struct TestVector +{ + const uint8_t *mInKey; + uint16_t mInKeyLength; + const uint8_t *mSalt; + uint16_t mSaltLength; + const uint8_t *mInfo; + uint16_t mInfoLength; + const uint8_t *mOutKey; + uint16_t mOutKeyLength; +}; + +void TestHkdfSha256(void) +{ + enum + { + kMaxOuttKey = 128, + kFillByte = 0x77, + }; + + // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + // Test Case #1: RFC-5869 Appendix A.1 + const uint8_t kInKey1[] = {0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, + 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b}; + const uint8_t kSalt1[] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c}; + const uint8_t kInfo1[] = {0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9}; + const uint8_t kOutKey1[] = {0x3c, 0xb2, 0x5f, 0x25, 0xfa, 0xac, 0xd5, 0x7a, 0x90, 0x43, 0x4f, 0x64, 0xd0, 0x36, + 0x2f, 0x2a, 0x2d, 0x2d, 0x0a, 0x90, 0xcf, 0x1a, 0x5a, 0x4c, 0x5d, 0xb0, 0x2d, 0x56, + 0xec, 0xc4, 0xc5, 0xbf, 0x34, 0x00, 0x72, 0x08, 0xd5, 0xb8, 0x87, 0x18, 0x58, 0x65}; + + // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + // Test Case #2: RFC-5869 Appendix A.2 + + const uint8_t kInKey2[] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, + 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, + 0x1c, 0x1d, 0x1e, 0x1f, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, + 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, + 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f, 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, + 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f}; + + const uint8_t kSalt2[] = {0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, + 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x7b, + 0x7c, 0x7d, 0x7e, 0x7f, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, + 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, + 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f, 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, + 0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf}; + + const uint8_t kInfo2[] = {0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7, 0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, + 0xbe, 0xbf, 0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xca, 0xcb, + 0xcc, 0xcd, 0xce, 0xcf, 0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8, 0xd9, + 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf, 0xe0, 0xe1, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7, + 0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef, 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, + 0xf6, 0xf7, 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff}; + + const uint8_t kOutKey2[] = {0xb1, 0x1e, 0x39, 0x8d, 0xc8, 0x03, 0x27, 0xa1, 0xc8, 0xe7, 0xf7, 0x8c, 0x59, 0x6a, + 0x49, 0x34, 0x4f, 0x01, 0x2e, 0xda, 0x2d, 0x4e, 0xfa, 0xd8, 0xa0, 0x50, 0xcc, 0x4c, + 0x19, 0xaf, 0xa9, 0x7c, 0x59, 0x04, 0x5a, 0x99, 0xca, 0xc7, 0x82, 0x72, 0x71, 0xcb, + 0x41, 0xc6, 0x5e, 0x59, 0x0e, 0x09, 0xda, 0x32, 0x75, 0x60, 0x0c, 0x2f, 0x09, 0xb8, + 0x36, 0x77, 0x93, 0xa9, 0xac, 0xa3, 0xdb, 0x71, 0xcc, 0x30, 0xc5, 0x81, 0x79, 0xec, + 0x3e, 0x87, 0xc1, 0x4c, 0x01, 0xd5, 0xc1, 0xf3, 0x43, 0x4f, 0x1d, 0x87}; + + // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + // Test Case #3: RFC-5869 Appendix A.3 + + const uint8_t kInKey3[] = {0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, + 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b}; + + const uint8_t kOutKey3[] = {0x8d, 0xa4, 0xe7, 0x75, 0xa5, 0x63, 0xc1, 0x8f, 0x71, 0x5f, 0x80, 0x2a, 0x06, 0x3c, + 0x5a, 0x31, 0xb8, 0xa1, 0x1f, 0x5c, 0x5e, 0xe1, 0x87, 0x9e, 0xc3, 0x45, 0x4e, 0x5f, + 0x3c, 0x73, 0x8d, 0x2d, 0x9d, 0x20, 0x13, 0x95, 0xfa, 0xa4, 0xb6, 0x1a, 0x96, 0xc8}; + + // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + // Test Case #4: + + const uint8_t kInKey4[] = {'h', 'e', 'l', 'l', 'o'}; + const uint8_t kSalt4[] = {0x8e, 0x94, 0xef, 0x80, 0x5b, 0x93, 0xe6, 0x83, 0xff, 0x18}; + const uint8_t kOutKey4[] = {0x13, 0x48, 0x50, 0x67, 0xe2, 0x1a, 0xf1, 0x7c, + 0x09, 0x00, 0xf7, 0x0d, 0x88, 0x5f, 0x02, 0x59}; + + const TestVector kTestVectors[] = { + {kInKey1, sizeof(kInKey1), kSalt1, sizeof(kSalt1), kInfo1, sizeof(kInfo1), kOutKey1, sizeof(kOutKey1)}, + {kInKey2, sizeof(kInKey2), kSalt2, sizeof(kSalt2), kInfo2, sizeof(kInfo2), kOutKey2, sizeof(kOutKey2)}, + {kInKey3, sizeof(kInKey3), nullptr, 0, nullptr, 0, kOutKey3, sizeof(kOutKey3)}, + {kInKey4, sizeof(kInKey4), kSalt4, sizeof(kSalt4), nullptr, 0, kOutKey4, sizeof(kOutKey4)}, + }; + + otInstance *instance = testInitInstance(); + + VerifyOrQuit(instance != nullptr, "Null OpenThread instance"); + + for (const TestVector *test = &kTestVectors[0]; test < OT_ARRAY_END(kTestVectors); test++) + { + ot::Crypto::HkdfSha256 hkdf; + uint8_t outKey[kMaxOuttKey]; + + printf("\n- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -"); + DumpBuffer("\nInput Key", test->mInKey, test->mInKeyLength); + DumpBuffer("\nSalt", test->mSalt, test->mSaltLength); + DumpBuffer("\nInfo", test->mInfo, test->mInfoLength); + DumpBuffer("\nExpected Output Key", test->mOutKey, test->mOutKeyLength); + + memset(outKey, kFillByte, sizeof(outKey)); + + hkdf.Extract(test->mSalt, test->mSaltLength, test->mInKey, test->mInKeyLength); + hkdf.Expand(test->mInfo, test->mInfoLength, outKey, test->mOutKeyLength); + + DumpBuffer("\nCalculated Output Key", outKey, test->mOutKeyLength); + + VerifyOrQuit(memcmp(outKey, test->mOutKey, test->mOutKeyLength) == 0, "HKDF-SHA-256 failed"); + + for (uint16_t i = test->mOutKeyLength + 1; i < sizeof(outKey); i++) + { + VerifyOrQuit(outKey[i] == kFillByte, "HKDF-SHA-256 wrote beyond output key length"); + } + } + + testFreeInstance(instance); +} + +int main(void) +{ + TestHkdfSha256(); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/unit/test_util.cpp b/tests/unit/test_util.cpp index 0e0ee45dd..cfa64002e 100644 --- a/tests/unit/test_util.cpp +++ b/tests/unit/test_util.cpp @@ -30,7 +30,7 @@ #include -void DumpBuffer(const char *aTextMessage, uint8_t *aBuffer, uint16_t aBufferLength) +void DumpBuffer(const char *aTextMessage, const uint8_t *aBuffer, uint16_t aBufferLength) { enum { diff --git a/tests/unit/test_util.hpp b/tests/unit/test_util.hpp index 122c1ea4c..e561fc2d1 100644 --- a/tests/unit/test_util.hpp +++ b/tests/unit/test_util.hpp @@ -41,6 +41,6 @@ * @param[in] aBufferLength Number of bytes in the buffer. * */ -void DumpBuffer(const char *aTextMessage, uint8_t *aBuffer, uint16_t aBufferLength); +void DumpBuffer(const char *aTextMessage, const uint8_t *aBuffer, uint16_t aBufferLength); #endif