mbed-os

History

Yossi Levy 2adf5db881 Adding a test if device key buffer has changed after calling to entropy func. this should enable as to eliminate some rare cases when the trng fail but still return success.		2019-01-10 10:18:44 +02:00
..
TESTS/device_key/functionality	Don't use define checks on DEVICE_FOO macros (mbed code)	2018-12-20 10:16:42 +11:00
source	Adding a test if device key buffer has changed after calling to entropy func. this should enable as to eliminate some rare cases when the trng fail but still return success.	2019-01-10 10:18:44 +02:00
README.md	Fix README.md grammar mistakes	2018-05-09 11:22:15 +03:00
mbed_lib.json	…

README.md

DeviceKey

DeviceKey is a mechanism that implements key derivation from a root of trust key. The DeviceKey mechanism generates symmetric keys that security features need. You can use these keys for encryption, authentication and more. The DeviceKey API allows key derivation without exposing the actual root of trust, to reduce the possibility of accidental exposure of the root of trust outside the device.

We have implemented DeviceKey according to NIST SP 800-108, section "KDF in Counter Mode", with AES-CMAC as the pseudorandom function.

Root of Trust

The root of trust key, which DeviceKey uses to derive additional keys, is generated using the hardware random generator if it exists, or using a key injected to the device in the production process.

The characteristics required by this root of trust are:

It must be unique per device.
It must be difficult to guess.
It must be at least 128 bits.
It must be kept secret.

The DeviceKey feature keeps the root of trust key in internal storage, using the NVStore component. Internal storage provides protection from external physical attacks to the device.

The root of trust is generated at the first use of DeviceKey if the true random number generator is available in the device. If no true random number generator is available, you must pass the injected root of trust key to the DeviceKey before you call the key derivation API.

Key derivation API

generate_derived_key: This API generates a new key based on a string (salt) the caller provides. The same key is generated for the same salt. Generated keys can be 128 or 256 bits in length.

Root of Trust Injection API

device_inject_root_of_trust: You must call this API once in the lifecycle of the device, before any call to key derivation, if the device does not support True Random Number Generator (DEVICE_TRNG is not defined).

Using DeviceKey

DeviceKey is a singleton class, meaning that the system can have only a single instance of it.

To instantiate DeviceKey, you need to call its get_instance member function as following:

    DeviceKey &deviceKey = DeviceKey::get_instance();

Testing DeviceKey

Run the DeviceKey functionality test with the mbed command as follows:

    ```mbed test -n features-device_key-tests-device_key-functionality```