Adding C APIs for crypto opereation HMAC and AES-CCM (#868)

2026-08-21 01:49:52 +00:00 · 2016-10-24 12:08:53 -07:00
parent 78d4b678e3
commit d6fa21e368
4 changed files with 195 additions and 0 deletions
@@ -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_