Merge pull request #5 from simmscmi/master

add nRFCrypto_Hmac wrapper with example

Author: hathach

examples/hmac/.feather52832.test.skip

@@ -0,0 +1,77 @@
+#include "Adafruit_nRFCrypto.h"
+#include <Adafruit_TinyUSB.h> // for Serial
+
+/* Input data for testing
+ * to verify the result, run openssl on your PC
+ * and compare the result with this sketch
+ *
+ *  $ echo -ne "Hello World!" | openssl dgst -sha1 -hmac "secret"
+ *    (stdin)= 5efed98b0787c83f9cb0135ba283c390ca49320e
+ *
+ *  $ echo -ne "Hello World!" | openssl dgst -sha224 -hmac "secret"
+ *    (stdin)= d1f9ff720c7558366f2b67e672b4f4ee7cb58b5803cd9e46380123f2
+ *
+ *  $ echo -ne "Hello World!" | openssl dgst -sha256 -hmac "secret"
+ *    (stdin)= 6fa7b4dea28ee348df10f9bb595ad985ff150a4adfd6131cca677d9acee07dc6
+ *
+ *  $ echo -ne "Hello World!" | openssl dgst -sha512 -hmac "secret"
+ *    (stdin)= fd3716eb8e1903ecb8deb9320f1baecf0f8dbe04e4c4c71e64fbb37080222ca42deb0b646cabeb53e269a2446507fb5442961656f8007959bd330ef48df0e13e
+*/
+uint8_t input_data[] = // "Hello World!"
+{
+  0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20,
+  0x57, 0x6f, 0x72, 0x6c, 0x64, 0x21
+};
+
+uint8_t key[] = // "secret"
+{
+  0x73, 0x65, 0x63, 0x72, 0x65, 0x74
+};
+
+nRFCrypto_Hmac hmac;
+
+// the setup function runs once when you press reset or power the board
+void setup()
+{
+  // initialize digital pin LED_BUILTIN as an output.
+  pinMode(LED_BUILTIN, OUTPUT);
+
+  while( !Serial) delay(10);
+  Serial.println("nRFCrypto Hmac example");
+
+  nRFCrypto.begin();
+
+  test_hmac(CRYS_HASH_SHA1_mode   , "SHA-1");
+  test_hmac(CRYS_HASH_SHA224_mode , "SHA-224");
+  test_hmac(CRYS_HASH_SHA256_mode , "SHA-256");
+  test_hmac(CRYS_HASH_SHA512_mode , "SHA-512");
+
+  nRFCrypto.end();
+}
+
+void test_hmac(CRYS_HASH_OperationMode_t mode, const char* modestr)
+{
+  uint32_t result[16];
+  uint8_t  result_len; // depending on Hash mode
+
+  hmac.begin(mode, key, sizeof(key));
+  hmac.update(input_data, sizeof(input_data));
+  result_len = hmac.end(result);
+
+  Serial.print("                      ");
+  Serial.flush();
+  Serial.println(modestr);
+
+  Serial.printBuffer( (uint8_t*) result, result_len, ' ', 16);
+
+  Serial.println();
+  Serial.println();
+
+  Serial.flush();
+}
+
+void loop()
+{
+  digitalToggle(LED_BUILTIN);
+  delay(1000);
+}

examples/hmac/.feather52833.test.skip

@@ -1,4 +1,4 @@
-/* 
+/*
  * The MIT License (MIT)
  *
  * Copyright (c) 2020 Ha Thach (tinyusb.org) for Adafruit Industries
@@ -30,6 +30,7 @@
 
 #include "nRFCrypto_Random.h"
 #include "nRFCrypto_Hash.h"
+#include "nRFCrypto_Hmac.h"
 #include "ecc/nRFCrypto_ECC.h"
 
 class Adafruit_nRFCrypto

examples/hmac/hmac.ino

@@ -0,0 +1,63 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2023 Marcus Schmid (lanaticasylum.de)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "Adafruit_nRFCrypto.h"
+
+uint8_t digestSize(CRYS_HASH_OperationMode_t mode) {
+    switch (mode) {
+        case CRYS_HASH_SHA1_mode:
+            return CRYS_HASH_SHA1_DIGEST_SIZE_IN_BYTES;
+        case CRYS_HASH_SHA224_mode:
+            return CRYS_HASH_SHA224_DIGEST_SIZE_IN_BYTES;
+        case CRYS_HASH_SHA256_mode:
+            return CRYS_HASH_SHA256_DIGEST_SIZE_IN_BYTES;
+        case CRYS_HASH_SHA384_mode:
+            return CRYS_HASH_SHA384_DIGEST_SIZE_IN_BYTES;
+        case CRYS_HASH_SHA512_mode:
+            return CRYS_HASH_SHA512_DIGEST_SIZE_IN_BYTES;
+        case CRYS_HASH_MD5_mode:
+            return CRYS_HASH_MD5_DIGEST_SIZE_IN_BYTES;
+        default:
+            return 0;
+    }
+}
+
+nRFCrypto_Hmac::nRFCrypto_Hmac(void) { _digest_size = 0; }
+
+bool nRFCrypto_Hmac::begin(CRYS_HASH_OperationMode_t mode, uint8_t *key_ptr,
+                           uint16_t keySize) {
+    _digest_size = digestSize(mode);
+    VERIFY_ERROR(CRYS_HMAC_Init(&_context, mode, key_ptr, keySize), false);
+    return true;
+}
+
+bool nRFCrypto_Hmac::update(uint8_t data[], size_t size) {
+    VERIFY_ERROR(CRYS_HMAC_Update(&_context, data, size), false);
+    return true;
+}
+
+uint8_t nRFCrypto_Hmac::end(uint32_t result[16]) {
+    VERIFY_ERROR(CRYS_HMAC_Finish(&_context, result), 0);
+    return _digest_size;
+}

src/Adafruit_nRFCrypto.h

@@ -0,0 +1,45 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2023 Marcus Schmid (lanaticasylum.de)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef NRFCRYPTO_HMAC_H_
+#define NRFCRYPTO_HMAC_H_
+
+#include "nrf_cc310/include/crys_hash.h"
+#include "nrf_cc310/include/crys_hmac.h"
+
+class nRFCrypto_Hmac
+{
+  public:
+    nRFCrypto_Hmac(void);
+
+    bool begin(CRYS_HASH_OperationMode_t mode, uint8_t *key_ptr, uint16_t keySize);
+    bool update(uint8_t data[], size_t size);
+    uint8_t end(uint32_t result[16]);
+
+  private:
+    CRYS_HMACUserContext_t _context;
+    uint8_t _digest_size;
+};
+
+#endif /* NRFCRYPTO_HMAC_H_ */