Merge #18547

18547: sys: PSA Crypto API implementation r=MrKevinWeiss a=Einhornhool ### Contribution description This adds an implementation of the ARM [PSA Crypto API](https://armmbed.github.io/mbed-crypto/html/index.html) specification to RIOT. It is a cryptographic API that supports software and hardware backends as well as the use of multiple secure elements, which can be configured with Kconfig. It integrates indirect, identifier based key management to support persistent storage of key material in local memory and devices with protected key storage. A description of the implementation design and an evaluation of the processing time and memory overhead in RIOT has been published here: [Usable Security for an IoT OS: Integrating the Zoo of Embedded Crypto Components Below a Common API](https://arxiv.org/abs/2208.09281) #### Implementation status So far this implementation supports the following operations: - Volatile key storage - AES in CBC mode - Hashes (MD5, SHA1, SHA224, SHA256) - HMAC SHA256 - ECDSA with NIST P192 and P256 curves The following backends are supported so far: - RIOT Cipher Module - RIOT Hash Module - Micro ECC library package - Cryptocell 310 hardware accelerator on the Nordic NRF52840dk - Microchip ATECC608A secure element Other operations and backends as well as persistent key storage can and will be implemented by me and anyone who wants to contribute in the future. ### Testing procedure So far there is a show case application in `examples/psa_crypto` to demonstrate the usage and configuration of different backends of the API (refer to the application README for more information). Co-authored-by: Lena Boeckmann <lena.boeckmann@haw-hamburg.de>
RIOT-OS · Sep 4, 2023 · 9be022a · 9be022a
2 parents 949dcd3 + a0ccbce
commit 9be022a
Show file tree

Hide file tree

Showing 139 changed files with 23,955 additions and 69 deletions.
diff --git a/boards/common/nrf52/include/cfg_i2c_default.h b/boards/common/nrf52/include/cfg_i2c_default.h
@@ -36,7 +36,15 @@ static const i2c_conf_t i2c_config[] = {
         .scl = 27,
         .sda = 26,
         .speed = I2C_SPEED_NORMAL
+    },
+#ifdef BOARD_NRF52840DK
+    {
+        .dev = NRF_TWIM0,
+        .scl = 28,
+        .sda = 29,
+        .speed = I2C_SPEED_NORMAL
     }
+#endif
 };
 #define I2C_NUMOF           ARRAY_SIZE(i2c_config)
 /** @} */

diff --git a/cpu/nrf52/Kconfig b/cpu/nrf52/Kconfig
@@ -69,6 +69,15 @@ config CPU_MODEL_NRF52840XXAA
     select HAS_BLE_PHY_CODED
     select HAS_RADIO_NRF802154
     select HAS_PERIPH_UART_NONBLOCKING
+    select HAS_PERIPH_HASH_SHA_1
+    select HAS_PERIPH_HASH_SHA_224
+    select HAS_PERIPH_HASH_SHA_256
+    select HAS_PERIPH_HASH_SHA_512
+    select HAS_PERIPH_HMAC_SHA_256
+    select HAS_PERIPH_CIPHER_AES_128_CBC
+    select HAS_PERIPH_ECC_P192R1
+    select HAS_PERIPH_ECC_P256R1
+    select HAS_PERIPH_CRYPTOCELL_310
 
 ## CPU common symbols
 config CPU_FAM

diff --git a/cpu/nrf52/Makefile.dep b/cpu/nrf52/Makefile.dep
@@ -36,5 +36,6 @@ ifneq (,$(filter periph_spi,$(USEMODULE)))
   USEMODULE += periph_spi_gpio_mode
 endif
 
+include $(RIOTCPU)/nrf52/periph/Makefile.dep
 include $(RIOTCPU)/nrf5x_common/Makefile.dep
 include $(RIOTCPU)/cortexm_common/Makefile.dep
diff --git a/cpu/nrf52/Makefile.features b/cpu/nrf52/Makefile.features
@@ -10,6 +10,18 @@ ifneq (,$(filter nrf52811xxaa nrf52820xxaa nrf52833xxaa nrf52840xxaa,$(CPU_MODEL
   FEATURES_PROVIDED += radio_nrf802154
 endif
 
+# crypto features
+ifneq (,$(filter nrf52840xxaa,$(CPU_MODEL)))
+  FEATURES_PROVIDED += periph_hash_sha_1
+  FEATURES_PROVIDED += periph_hash_sha_224
+  FEATURES_PROVIDED += periph_hash_sha_256
+  FEATURES_PROVIDED += periph_hash_sha_512
+  FEATURES_PROVIDED += periph_hmac_sha_256
+  FEATURES_PROVIDED += periph_cipher_aes_128_cbc
+  FEATURES_PROVIDED += periph_ecc_p192r1
+  FEATURES_PROVIDED += periph_ecc_p256r1
+endif
+
 ifeq (,$(filter nrf52832%,$(CPU_MODEL)))
   FEATURES_PROVIDED += periph_uart_nonblocking
 endif
@@ -33,6 +45,10 @@ ifneq (,$(filter nrf52811% nrf52820% nrf52833% nrf52840%,$(CPU_MODEL)))
   FEATURES_PROVIDED += ble_phy_coded
 endif
 
+ifneq (,$(filter nrf52840%,$(CPU_MODEL)))
+  FEATURES_PROVIDED += periph_cryptocell_310
+endif
+
 FEATURES_PROVIDED += ble_adv_ext
 
 include $(RIOTCPU)/nrf5x_common/Makefile.features
diff --git a/cpu/nrf52/periph/Kconfig b/cpu/nrf52/periph/Kconfig
@@ -12,6 +12,61 @@ config MODULE_SAUL_NRF_VDDH
     depends on HAS_PERIPH_ADC
     select MODULE_PERIPH_ADC
 
+config MODULE_PERIPH_CRYPTOCELL_310
+    bool
+    depends on HAS_PERIPH_CRYPTOCELL_310
+    select PACKAGE_DRIVER_CRYPTOCELL_310
+
+# Asymmetric Crypto Peripheral
+config MODULE_PERIPH_ECC_P192R1
+    bool
+    depends on HAS_PERIPH_ECC_P192R1
+    select MODULE_PERIPH_CRYPTOCELL_310
+    select MODULE_PSA_CRYPTOCELL_310_ECC_P192
+
+config MODULE_PERIPH_ECC_P256R1
+    bool
+    depends on HAS_PERIPH_ECC_P256R1
+    select MODULE_PERIPH_CRYPTOCELL_310
+    select MODULE_PSA_CRYPTOCELL_310_ECC_P256
+
+# Hash Related Symbols
+config MODULE_PERIPH_HASH_SHA_1
+    bool
+    depends on HAS_PERIPH_HASH_SHA_1
+    select MODULE_PERIPH_CRYPTOCELL_310
+    select MODULE_PSA_CRYPTOCELL_310_HASHES_SHA1
+
+config MODULE_PERIPH_HASH_SHA_224
+    bool
+    depends on HAS_PERIPH_HASH_SHA_224
+    select MODULE_PERIPH_CRYPTOCELL_310
+    select MODULE_PSA_CRYPTOCELL_310_HASHES_SHA224
+
+config MODULE_PERIPH_HASH_SHA_256
+    bool
+    depends on HAS_PERIPH_HASH_SHA_256
+    select MODULE_PERIPH_CRYPTOCELL_310
+    select MODULE_PSA_CRYPTOCELL_310_HASHES_SHA256
+
+config MODULE_PERIPH_HASH_SHA_512
+    bool
+    depends on HAS_PERIPH_HASH_SHA_512
+    select MODULE_PERIPH_CRYPTOCELL_310
+    select MODULE_PSA_CRYPTOCELL_310_HASHES_SHA512
+
+config MODULE_PERIPH_CIPHER_AES_128_CBC
+    bool
+    depends on HAS_PERIPH_CIPHER_AES_128_CBC
+    select MODULE_PERIPH_CRYPTOCELL_310
+    select MODULE_PSA_CRYPTOCELL_310_AES_CBC
+
+config MODULE_PERIPH_HMAC_SHA_256
+    bool
+    depends on HAS_PERIPH_HMAC_SHA_256
+    select MODULE_PERIPH_CRYPTOCELL_310
+    select MODULE_PSA_CRYPTOCELL_310_HMAC
+
 endif # TEST_KCONFIG
 
 config HAVE_SAUL_NRF_VDDH

diff --git a/cpu/nrf52/periph/Makefile.dep b/cpu/nrf52/periph/Makefile.dep
@@ -0,0 +1,39 @@
+ifneq (,$(filter periph_ecc_p192r1,$(USEMODULE)))
+  USEPKG += driver_cryptocell_310
+  USEMODULE += psa_cryptocell_310_ecc_p192
+endif
+
+ifneq (,$(filter periph_ecc_p256r1,$(USEMODULE)))
+  USEPKG += driver_cryptocell_310
+  USEMODULE += psa_cryptocell_310_ecc_p256
+endif
+
+ifneq (,$(filter periph_hash_sha_1,$(USEMODULE)))
+  USEPKG += driver_cryptocell_310
+  USEMODULE += psa_cryptocell_310_hashes_sha1
+endif
+
+ifneq (,$(filter periph_hash_sha_224,$(USEMODULE)))
+  USEPKG += driver_cryptocell_310
+  USEMODULE += psa_cryptocell_310_hashes_sha224
+endif
+
+ifneq (,$(filter periph_hash_sha_256,$(USEMODULE)))
+  USEPKG += driver_cryptocell_310
+  USEMODULE += psa_cryptocell_310_hashes_sha256
+endif
+
+ifneq (,$(filter periph_hash_sha_512,$(USEMODULE)))
+  USEPKG += driver_cryptocell_310
+  USEMODULE += psa_cryptocell_310_hashes_sha512
+endif
+
+ifneq (,$(filter periph_cipher_aes_128_cbc,$(USEMODULE)))
+  USEPKG += driver_cryptocell_310
+  USEMODULE += psa_cryptocell_310_aes_cbc
+endif
+
+ifneq (,$(filter periph_hmac_sha_256,$(USEMODULE)))
+  USEPKG += driver_cryptocell_310
+  USEMODULE += psa_cryptocell_310_hmac
+endif
diff --git a/dist/tools/codespell/ignored_words.txt b/dist/tools/codespell/ignored_words.txt
@@ -162,3 +162,9 @@ noe
 
 # NWE (Negative Write Enable) ==> NEW
 nwe
+
+# rsource (used to include Kconfig files) ==> resource, source
+rsource
+
+# SHS (abbreviation for Secure Hash Standard) => SSH, NHS
+shs