Added HMAC-SHA1, IEEE 802.11 PRF and NIST AES KW libraries

Author: Mika Leppänen

source/Service_Libs/hmac/hmac_sha1.c

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "nsconfig.h"
+#include <string.h>
+#include "ns_types.h"
+#include "ns_list.h"
+#include "ns_trace.h"
+#include "mbedtls/md.h"
+#include "Service_Libs/hmac/hmac_sha1.h"
+
+#define TRACE_GROUP "hmac"
+
+int8_t hmac_sha1_calc(const uint8_t *key, uint16_t key_len, const uint8_t *data, uint16_t data_len, uint8_t *result)
+{
+    // Extensive debug for now, to be disabled later
+    tr_debug("hmac_sha_1 key %s\n", trace_array(key, key_len));
+
+    const uint8_t *print_data = data;
+    uint16_t print_data_len = data_len;
+    while (true) {
+        tr_debug("hmac_sha_1 data %s\n", trace_array(print_data, print_data_len > 32 ? 32 : print_data_len));
+        if (print_data_len > 32) {
+            print_data_len -= 32;
+            print_data += 32;
+        } else {
+            break;
+        }
+    }
+
+    const mbedtls_md_type_t md_type = MBEDTLS_MD_SHA1;
+    const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_type);
+    if (md_info == NULL) {
+        return -1;
+    }
+
+    mbedtls_md_context_t ctx;
+
+    mbedtls_md_init(&ctx);
+    if (mbedtls_md_setup(&ctx, md_info, 1) != 0) {
+        return -1;
+    }
+    if (mbedtls_md_hmac_starts(&ctx, (const unsigned char *) key, key_len) != 0) {
+        goto error;
+    }
+    if (mbedtls_md_hmac_update(&ctx, (const unsigned char *) data, data_len) != 0) {
+        goto error;
+    }
+    if (mbedtls_md_hmac_finish(&ctx, result) != 0) {
+        goto error;
+    }
+    mbedtls_md_free(&ctx);
+
+    tr_debug("hmac_sha_1 result %s\n", trace_array(result, 20));
+    return 0;
+
+error:
+    mbedtls_md_free(&ctx);
+    return -1;
+}

source/Service_Libs/hmac/hmac_sha1.h

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef HMAC_SHA1_
+#define HMAC_SHA1_
+
+/**
+ * \brief Calculate HMAC-SHA1-160
+ *
+ *  Calculate HMAC-SHA1-160
+ *
+ * \param key pointer to key
+ * \param key_len key length
+ * \param data pointer to data
+ * \param data_len data length
+ * \param result pointer to result, must be at least 160 bytes
+ *
+ * \return < 0 failure
+ * \return >= 0 success
+ *
+ */
+int8_t hmac_sha1_calc(const uint8_t *key, uint16_t key_len, const uint8_t *data, uint16_t data_len, uint8_t *result);
+
+#endif /* HMAC_SHA1_ */

source/Service_Libs/ieee_802_11/ieee_802_11.c

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "nsconfig.h"
+#include <string.h>
+#include "ns_types.h"
+#include "ns_list.h"
+#include "ns_trace.h"
+#include "mbedtls/md.h"
+#include "Service_Libs/ieee_802_11/ieee_802_11.h"
+#include "Service_Libs/hmac/hmac_sha1.h"
+
+#define TRACE_GROUP "ieee_prf"
+
+uint16_t ieee_802_11_prf_setup(ieee_802_11_prf_t *prf, uint16_t bits, uint16_t a_len, uint16_t b_len)
+{
+    prf->bits = bits;
+    prf->a_len = a_len;
+    prf->b_len = b_len;
+    return a_len + 1 + b_len + 1; // A string + Y + B string + X (index)
+}
+
+uint8_t *ieee_802_11_prf_get_a_string(ieee_802_11_prf_t *prf, uint8_t *string)
+{
+    (void) prf;
+    return string;
+}
+
+uint8_t *ieee_802_11_prf_get_b_string(ieee_802_11_prf_t *prf, uint8_t *string)
+{
+    return string + prf->a_len + 1;
+}
+
+uint16_t ieee_802_11_prf_starts(ieee_802_11_prf_t *prf, const uint8_t *key, uint16_t key_len)
+{
+    prf->key = key;
+    prf->key_len = key_len;
+
+    uint8_t iterations = (prf->bits + 159) / 160;
+    uint16_t result_len = 160 / 8 * iterations;
+    return result_len;
+}
+
+void ieee_802_11_prf_update(ieee_802_11_prf_t *prf, uint8_t *string)
+{
+    prf->string = string;
+    prf->string[prf->a_len] = 0x00; /* Y (0) */
+}
+
+int8_t ieee_802_11_prf_finish(ieee_802_11_prf_t *prf, uint8_t *result)
+{
+    uint16_t string_len = prf->a_len + 1 + prf->b_len + 1;
+
+    for (uint8_t i = 0; i < (prf->bits + 159) / 160; i++) {
+        prf->string[prf->a_len + 1 + prf->b_len] = i; /* X (index) */
+        if (hmac_sha1_calc(prf->key, prf->key_len, prf->string, string_len, result) < 0) {
+            return -1;
+        }
+        result += 160 / 8;
+    }
+
+    return 0;
+}

source/Service_Libs/ieee_802_11/ieee_802_11.h

@@ -0,0 +1,129 @@
+/*
+ * Copyright (c) 2016-2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef IEEE_802_11_
+#define IEEE_802_11_
+
+typedef struct {
+    const uint8_t *key;   /**< Key string */
+    uint8_t *string;      /**< Data string (A string + Y + B string + X) */
+    uint16_t bits;        /**< Number of PRF bits */
+    uint16_t key_len;     /**< Key string length */
+    uint16_t a_len;       /**< A string length */
+    uint16_t b_len;       /**< B string length */
+} ieee_802_11_prf_t;
+
+/*
+    From IEEE 802.11 chapter 11.6.1.2 PRF:
+
+    In the following, K is a key; A is a unique label for each different purpose
+    of the PRF; B is a variable-length string; Y is a single octet containing 0;
+    X is a single octet containing the loop parameter i; and || denotes concatenation:
+
+    H-SHA-1(K, A, B, X) ← HMAC-SHA-1(K, A || Y || B || X)
+
+    PRF(K, A, B, Len)
+        for i ← 0 to (Len+159)/160 do
+            R ← R || H-SHA-1(K, A, B, i)
+        return L(R, 0, Len)
+
+    PRF-128(K, A, B) = PRF(K, A, B, 128)
+    PRF-192(K, A, B) = PRF(K, A, B, 192)
+    PRF-256(K, A, B) = PRF(K, A, B, 256)
+    PRF-384(K, A, B) = PRF(K, A, B, 384)
+    PRF-512(K, A, B) = PRF(K, A, B, 512)
+*/
+
+/**
+ * \brief Setup IEEE 802.11 PRF
+ *
+ *  Update is made based on failed and successful message sending
+ *  attempts for a message.
+ *
+ * \param prf pointer to PRF data
+ * \param bits number of bits
+ * \param a_len A string length
+ * \param b_len B string length
+ *
+ * \return length of the combined string that is input parameter for further functions
+ *         (this is length of the A string + Y + B string + X)
+ */
+uint16_t ieee_802_11_prf_setup(ieee_802_11_prf_t *prf, uint16_t bits, uint16_t a_len, uint16_t b_len);
+
+/**
+ * \brief Get A string pointer
+ *
+ *  Get a pointer to A string start that is used to write A string contents
+ *
+ * \param prf pointer to PRF data
+ * \param string pointer to input string
+ *
+ * \return pointer to A string part of the input string
+ */
+uint8_t *ieee_802_11_prf_get_a_string(ieee_802_11_prf_t *prf, uint8_t *string);
+
+/**
+ * \brief Get B string pointer
+ *
+ *  Get a pointer to B string start that is used to write B string contents
+ *
+ * \param prf pointer to PRF data
+ * \param string pointer to input string
+ *
+ * \return pointer to B string part of the input string
+ */
+uint8_t *ieee_802_11_prf_get_b_string(ieee_802_11_prf_t *prf, uint8_t *string);
+
+/**
+ * \brief Start PRF process
+ *
+ *  Start PRF process
+ *
+ * \param prf pointer to PRF data
+ * \param key key
+ * \param key_len key length
+ *
+ * \return length of the return string
+ */
+uint16_t ieee_802_11_prf_starts(ieee_802_11_prf_t *prf, const uint8_t *key, uint16_t key_len);
+
+/**
+ * \brief Update PRF process
+ *
+ *  Update PRF process
+ *
+ * \param prf pointer to PRF data
+ * \param string pointer to input string
+ *
+ */
+void ieee_802_11_prf_update(ieee_802_11_prf_t *prf, uint8_t *string);
+
+/**
+ * \brief Finish PRF process
+ *
+ *  Finish PRF process
+ *
+ * \param prf pointer to PRF data
+ * \param result pointer to result string
+ *
+ * \return < 0 failure
+ * \return >= 0 success
+ *
+ */
+int8_t ieee_802_11_prf_finish(ieee_802_11_prf_t *prf, uint8_t *result);
+
+#endif /* IEEE_802_11_*/