Merge pull request #72 from LDong-Arm/generate_rot

Generate DeviceKey Root of Trust, update Mbed CLI 2 support

Author: Patater

.travis.yml

@@ -74,14 +74,11 @@ matrix:
         # version, we must instead delete the Travis copy of CMake.
         - sudo rm -rf /usr/local/cmake*
         - pip install --upgrade mbed-tools
-        - pip install prettytable==0.7.2
-        - pip install future==0.16.0
-        - pip install "Jinja2>=2.10.1,<2.11"
-        - pip install "intelhex>=1.3,<=2.2.1"
+        - mbedtools deploy
+        - pip install -r mbed-os/tools/cmake/requirements.txt
       script:
-        - mbedtools checkout
-        - echo mbedtools build -t GCC_ARM -m ${TARGET_NAME} -b ${PROFILE}
-        - mbedtools build -t GCC_ARM -m ${TARGET_NAME} -b ${PROFILE}
+        - echo mbedtools compile -t GCC_ARM -m ${TARGET_NAME} -b ${PROFILE}
+        - mbedtools compile -t GCC_ARM -m ${TARGET_NAME} -b ${PROFILE}
         - ccache -s
 
     - <<: *cmake-build-test

CMakeLists.txt

@@ -13,8 +13,6 @@ add_subdirectory(${MBED_PATH})
 
 add_executable(${APP_TARGET})
 
-mbed_configure_app_target(${APP_TARGET})
-
 project(${APP_TARGET})
 
 target_sources(${APP_TARGET}

README.md

@@ -12,37 +12,62 @@ The application injects a dummy root of trust (ROT) if true random number genera
 * An mbed-os supported development board.
 * A micro-USB cable.
 
-**NOTE:** Currently this application defines settings only for K66F board. Please refer to [Storage Configuration](https://os.mbed.com/docs/mbed-os/latest/reference/storage.html) from Mbed OS documentation as the DeviceKey requires KVStore to be configured.
+## Mbed OS build tools
 
-##  Getting started ##
+### Mbed CLI 2
+Starting with version 6.5, Mbed OS uses Mbed CLI 2. It uses Ninja as a build system, and CMake to generate the build environment and manage the build process in a compiler-independent manner. If you are working with Mbed OS version prior to 6.5 then check the section [Mbed CLI 1](#mbed-cli-1).
+1. [Install Mbed CLI 2](https://os.mbed.com/docs/mbed-os/latest/build-tools/install-or-upgrade.html).
+1. From the command-line, import the example: `mbed-tools import mbed-os-example-devicekey`
+1. Change the current directory to where the project was imported.
 
- 1. Import the example.
+### Mbed CLI 1
+1. [Install Mbed CLI 1](https://os.mbed.com/docs/mbed-os/latest/quick-start/offline-with-mbed-cli.html).
+1. From the command-line, import the example: `mbed import mbed-os-example-devicekey`
+1. Change the current directory to where the project was imported.
 
-    ```
-    mbed import mbed-os-example-devicekey
-    cd mbed-os-example-devicekey
-    ```
+## Building and running
 
- 2. Compile and generate binary.
+1. Connect a USB cable between the USB port on the target and the host computer.
+1. Run the following command to build the example project and program the microcontroller flash memory:
 
-    For example, for `GCC`:
+    * Mbed CLI 2
 
+    ```bash
+    $ mbed-tools compile -m <TARGET> -t <TOOLCHAIN> --flash --sterm
     ```
-    mbed compile -t GCC_ARM -m <your device>
+
+    * Mbed CLI 1
+
+    ```bash
+    $ mbed compile -m <TARGET> -t <TOOLCHAIN> --flash --sterm
     ```
-   
- 3. Open a serial console session with the target platform using the following parameters:
 
-    * **Baud rate:** 9600
-    * **Data bits:** 8
-    * **Stop bits:** 1
-    * **Parity:** None
+Your PC may take a few minutes to compile your code.
+
+The binary is located at:
+
+* **Mbed CLI 2** -
+  `./cmake_build/<TARGET>/develop/<TOOLCHAIN>/mbed-os-example-devicekey.bin`
 
- 5. Copy the application `mbed-os-example-devicekey.bin` in the folder `mbed-os-example-devicekey/BUILD/<TARGET NAME>/<PLATFORM NAME>` onto the target board.
+* **Mbed CLI 1** - `./BUILD/<TARGET>/<TOOLCHAIN>/mbed-os-example-devicekey.bin`.
 
- 6. Press the **RESET** button on the board to run the program
+You can manually copy the binary to the target, which gets mounted on the host
+computer through USB, rather than using the `--flash` option.
+
+You can also open a serial terminal separately, rather than using the `--sterm`
+option, with the following command:
+
+* Mbed CLI 2
+    ```bash
+    $ mbed-tools sterm
+    ```
+
+* Mbed CLI 1
+    ```bash
+    $ mbed sterm
+    ```
 
- 7. The serial console should now display a series of results. 
+The expected log can be found in [`tests/devicekey.log`](tests/devicekey.log).
 
 ## Troubleshooting
 

main.cpp

@@ -56,15 +56,27 @@ int main()
     //If TRNG is not available it is a must to inject the ROT before the first call to derive key method.
     printf("\n--- No TRNG support for this device. injecting ROT. ---\n");
     ret = inject_rot_key();
-    if (DEVICEKEY_SUCCESS != ret && DEVICEKEY_ALREADY_EXIST != ret) {
-        printf("\n--- Error, injection of ROT key has failed with status %d ---\n", ret);
+    if (DEVICEKEY_ALREADY_EXIST == ret) {
+        printf("\n--- ROT Key already exists in the persistent memory. ---\n", ret);
+    } else if (DEVICEKEY_SUCCESS == ret) {
+        printf("\n--- ROT Key injected and stored in persistent memory. ---\n", ret);
+    } else {
+        printf("--- Error, injection of RoT key failed with error code %d ---\n", ret);
         return -1;
     }
 
-    if ( DEVICEKEY_ALREADY_EXIST == ret ) {
+#else
+
+    // The ROT must be present before the first call to derive key method.
+    printf("\n--- Generating ROT. ---\n");
+    ret = devkey.generate_root_of_trust();
+    if (DEVICEKEY_ALREADY_EXIST == ret) {
         printf("\n--- ROT Key already exists in the persistent memory. ---\n", ret);
+    } else if (DEVICEKEY_SUCCESS == ret) {
+        printf("\n--- ROT Key generated and stored in persistent memory. ---\n", ret);
     } else {
-        printf("\n--- ROT Key injected and stored in persistent memory. ---\n", ret);
+        printf("--- Error, generation of RoT key failed with error code %d ---\n", ret);
+        return -1;
     }
 
 #endif