mirror of
https://github.com/espressif/openthread.git
synced 2026-08-04 18:07:47 +00:00
Adding C APIs for crypto opereation HMAC and AES-CCM (#868)
This commit is contained in:
Abtin Keshavarzian
committed by
Jonathan Hui
Jonathan Hui
parent
78d4b678e3
commit
d6fa21e368
@@ -58,6 +58,7 @@ PRETTY_SUBDIRS = \
|
||||
include_HEADERS = \
|
||||
openthread.h \
|
||||
openthread-diag.h \
|
||||
openthread-crypto.h \
|
||||
openthread-types.h \
|
||||
openthread-coap.h \
|
||||
$(NULL)
|
||||
|
||||
@@ -0,0 +1,95 @@
|
||||
/*
|
||||
* Copyright (c) 2016, 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
|
||||
* @brief
|
||||
* This file defines the OpenThread crypto C APIs.
|
||||
*/
|
||||
|
||||
#ifndef OPENTHREAD_CRYPTO_H_
|
||||
#define OPENTHREAD_CRYPTO_H_
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#define OT_CRYPTO_HMAC_SHA_HASH_SIZE 32 ///< Length of HMAC SHA (in bytes).
|
||||
|
||||
/**
|
||||
* This function performs HMAC computation.
|
||||
*
|
||||
* @param[in] aKey A pointer to the key.
|
||||
* @param[in] aKeyLength The key length in bytes.
|
||||
* @param[in] aBuf A pointer to the input buffer.
|
||||
* @param[in] aBufLength The length of @p aBuf in bytes.
|
||||
* @param[out] aHash A pointer to the output hash buffer.
|
||||
*
|
||||
*/
|
||||
void otCryptoHmacSha256(
|
||||
const uint8_t *aKey, uint16_t aKeyLength,
|
||||
const uint8_t *aBuf, uint16_t aBufLength,
|
||||
uint8_t *aHash);
|
||||
|
||||
/**
|
||||
* This method performs AES CCM computation.
|
||||
*
|
||||
* @param[in] aKey A pointer to the key.
|
||||
* @param[in] aKeyLength Length of the key in bytes.
|
||||
* @param[in] aTagLength Length of tag in bytes.
|
||||
* @param[in] aNonce A pointer to the nonce.
|
||||
* @param[in] aNonceLength Length of nonce in bytes.
|
||||
*
|
||||
* @param[in] aHeader A pointer to the header.
|
||||
* @param[in] aHeaderLength Length of header in bytes.
|
||||
*
|
||||
* @param[inout] aPlainText A pointer to the plaintext.
|
||||
* @param[inout] aCipherText A pointer to the ciphertext.
|
||||
* @param[in] aLength Plaintext length in bytes.
|
||||
* @param[in] aEncrypt `true` on encrypt and `false` on decrypt.
|
||||
*
|
||||
* @param[out] aTag A pointer to the tag.
|
||||
*
|
||||
*/
|
||||
void otCryptoAesCcm(
|
||||
const uint8_t *aKey, uint16_t aKeyLength,
|
||||
uint8_t aTagLength,
|
||||
const void *aNonce, uint8_t aNonceLength,
|
||||
const void *aHeader, uint32_t aHeaderLength,
|
||||
void *aPlainText, void *aCipherText, uint32_t aLength, bool aEncrypt,
|
||||
void *aTag);
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
} // extern "C"
|
||||
#endif
|
||||
|
||||
#endif // OPENTHREAD_CRYPTO_H_
|
||||
@@ -50,6 +50,7 @@ libopenthread_a_SOURCES = \
|
||||
crypto/aes_ccm.cpp \
|
||||
crypto/aes_ecb.cpp \
|
||||
crypto/hmac_sha256.cpp \
|
||||
crypto/openthread-crypto.cpp \
|
||||
crypto/mbedtls.cpp \
|
||||
crypto/sha256.cpp \
|
||||
mac/mac.cpp \
|
||||
|
||||
@@ -0,0 +1,98 @@
|
||||
/*
|
||||
* Copyright (c) 2016, 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 the C APIs for openthread crypto library.
|
||||
*/
|
||||
|
||||
#include <openthread.h>
|
||||
#include <common/debug.hpp>
|
||||
#include <common/code_utils.hpp>
|
||||
#include <openthread-crypto.h>
|
||||
#include <crypto/hmac_sha256.hpp>
|
||||
#include <crypto/aes_ccm.hpp>
|
||||
|
||||
namespace Thread {
|
||||
namespace Crypto {
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
void otCryptoHmacSha256(
|
||||
const uint8_t *aKey, uint16_t aKeyLength,
|
||||
const uint8_t *aBuf, uint16_t aBufLength,
|
||||
uint8_t *aHash)
|
||||
{
|
||||
HmacSha256 hmac;
|
||||
|
||||
assert((aKey != NULL) && (aBuf != NULL) && (aHash != NULL));
|
||||
|
||||
hmac.Start(aKey, aKeyLength);
|
||||
hmac.Update(aBuf, aBufLength);
|
||||
hmac.Finish(aHash);
|
||||
}
|
||||
|
||||
void otCryptoAesCcm(
|
||||
const uint8_t *aKey, uint16_t aKeyLength,
|
||||
uint8_t aTagLength,
|
||||
const void *aNonce, uint8_t aNonceLength,
|
||||
const void *aHeader, uint32_t aHeaderLength,
|
||||
void *aPlainText, void *aCipherText, uint32_t aLength, bool aEncrypt,
|
||||
void *aTag)
|
||||
{
|
||||
AesCcm aesCcm;
|
||||
uint8_t tagLength;
|
||||
|
||||
assert((aKey != NULL) && (aNonce != NULL) && (aPlainText != NULL) && (aCipherText != NULL) && (aTag != NULL));
|
||||
|
||||
SuccessOrExit(aesCcm.SetKey(aKey, aKeyLength));
|
||||
aesCcm.Init(aHeaderLength, aLength, aTagLength, aNonce, aNonceLength);
|
||||
|
||||
if (aHeaderLength != 0)
|
||||
{
|
||||
assert(aHeader != NULL);
|
||||
aesCcm.Header(aHeader, aHeaderLength);
|
||||
}
|
||||
|
||||
aesCcm.Payload(aPlainText, aCipherText, aLength, aEncrypt);
|
||||
aesCcm.Finalize(aTag, &tagLength);
|
||||
|
||||
assert(aTagLength == tagLength);
|
||||
|
||||
exit:
|
||||
return;
|
||||
}
|
||||
|
||||
#ifdef __cplusplus
|
||||
} // extern "C"
|
||||
#endif
|
||||
|
||||
} // namespace Crypto
|
||||
} // namespace Thread
|
||||
Reference in New Issue
Block a user