Add example bootloader (#10)

Add an example bootloader and application that use the SUIT manifest.

.gitignore

+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+
+# Executables
+*.exe
+*.out
+*.app
+
+BUILD

.mbed

+ROOT=.
+TARGET=nrf52840_dk

LICENSE

+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
\ No newline at end of file

README.md

+# suitloader
+
+Demonstration bootloader to be used with SUIT manifests as described in [draft-ietf-suit-manifest](https://datatracker.ietf.org/doc/draft-ietf-suit-manifest/). This bootloader is derived from [mbed-bootloader](https://github.com/ARMmbed/mbed-bootloader).
+
+## Build instructions
+
+1. Install `mbed-cli` https://github.com/ARMmbed/mbed-cli
+1. Run `mbed deploy` to pull in dependencies
+1. Compile by running `mbed compile -t GCC_ARM -m NRF52840_DK --profile release`

mbed-os.lib

+https://github.com/ARMmbed/mbed-os/

mbed_app.json

+{
+    "requires": ["bare-metal",
+                 "rtos-api",
+                 "storage",
+                 "storage_filesystem",
+                 "SecureStore",
+                 "storage_tdb_internal",
+                 "mbed-bootloader",
+                 "mbedtls",
+                 "system-storage",
+                 "filesystem",
+                 "filesystemstore",
+                 "littlefs",
+                 "fat_chan",
+                 "spif",
+                 "qspif",
+                 "sd",
+                 "flashiap-block-device",
+                 "direct-access-devicekey",
+                 "tdbstore",
+                 "device_key",
+                 "mbed-trace"
+    ],
+    "config": {
+        "documentation": {
+            "options": [
+                    "The following memory map describes the partitioning of the NRF52840_DK",
+                    "+--------------------------+ <-+ 0x100000",
+                    "|                          |",
+                    "|        Slot B App        | Size: 0x7BC00",
+                    "|                          |",
+                    "+--------------------------+ <-+ 0x84400",
+                    "|  Slot B Metadata Header  |",
+                    "+--------------------------+ <-+ 0x84000",
+                    "|                          |",
+                    "|        Slot A App        | Size: 0x7BC00",
+                    "|                          |",
+                    "+--------------------------+ <-+ 0x8400",
+                    "|  Slot A Metadata Header  |",
+                    "+--------------------------+ <-+ 0x8000",
+                    "|                          |",
+                    "|        Bootloader        |",
+                    "|                          |",
+                    "+--------------------------+ <-+ 0"
+            ]
+        }
+    },
+    "macros": [
+        "SUIT_BOOTLOADER_SLOT_A_OFFSET=0x8000",
+        "SUIT_BOOTLOADER_SLOT_B_OFFSET=0x84000",
+        "SUIT_BOOTLOADER_HEADER_SIZE=0x400"
+    ],
+    "target_overrides": {
+        "*": {
+            "target.default_lib"                       : "small",
+            "platform.use-mpu"                         : false,
+            "platform.default-serial-baud-rate"        : 115200,
+            "mbed-bootloader.use-kvstore-rot"          : 0,
+            "target.restrict_size"                     : "0x8000",
+        },
+        "NRF52840_DK": {
+            "target.static_memory_defines"     : true,
+            "target.features_remove"           : ["CRYPTOCELL310"],
+            "target.macros_remove"             : ["MBEDTLS_CONFIG_HW_SUPPORT"],
+            "target.macros_add"                : ["NRFX_RNG_ENABLED=1", "RNG_ENABLED=1", "NRF_QUEUE_ENABLED=1"]
+        }
+    }
+}

mbed_lib.json

+{
+    "name": "mbed-bootloader",
+    "config": {
+        "application-start-address": {
+            "help": "Address to the beginning of the active application firmware in flash",
+            "required": true
+        },
+        "application-jump-address": {
+            "help": "Jump address for running the active application firmware (if different from application-start-address)"
+        },
+        "max-application-size": {
+            "help": "Maximum size of the active application",
+            "value": "DEFAULT_MAX_APPLICATION_SIZE"
+        },
+        "max-copy-retries": {
+            "help": "number of retries for copying candidate image onto the active image area",
+            "value": 1,
+            "macro_name": "MAX_COPY_RETRIES"
+        },
+        "max-boot-retries": {
+            "help": "number of retries for booting into the active image",
+            "value": 3,
+            "macro_name": "MAX_BOOT_RETRIES"
+        },
+        "show-serial-output": {
+            "help": "Show boot status and progress on serial output. Disable output to save space on headless devices.",
+            "value": 1,
+            "macro_name": "SHOW_SERIAL_OUTPUT"
+        },
+        "use-kvstore-rot": {
+            "help": "use nvstore implementation of the ROT to authenticate firmware headers",
+            "value": 1,
+            "macro_name": "ARM_BOOTLOADER_USE_KVSTORE_ROT"
+        },
+        "default-max-application-size":{
+            "help": "The max application size",
+            "value": "(MBED_ROM_START + MBED_ROM_SIZE - MBED_CONF_MBED_BOOTLOADER_APPLICATION_START_ADDRESS)",
+            "macro_name": "DEFAULT_MAX_APPLICATION_SIZE"
+        },
+        "bootloader-size":{
+            "help": "bootloader size",
+            "value": "(32*1024)",
+            "macro_name": "MBED_BOOTLOADER_SIZE"
+        },
+        "startup-delay": {
+            "help": "Startup delay before initializing the storage hardware. (In milliseconds)",
+            "value": 0
+        }
+    },
+    "macros": [
+        "MBED_FAULT_HANDLER_DISABLED",
+        "MBEDTLS_USER_CONFIG_FILE=\"bootloader_mbedtls_user_config.h\"",
+        "ARM_UC_PROFILE_MBED_CLOUD_CLIENT=1",
+        "ARM_UC_FEATURE_CRYPTO_PAL=0",
+        "ARM_UC_FEATURE_CRYPTO_MBEDTLS=1",
+        "Mutex=PlatformMutex",
+        "ARM_UC_PAAL_TRACE_ENABLE=0"
+    ],
+    "target_overrides": {
+        "*": {
+            "target.features_remove": ["LWIP", "STORAGE"]
+        }
+    }
+}

mbed_settings.py

+"""
+mbed SDK
+Copyright (c) 2016 ARM Limited
+
+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.
+"""
+
+from os.path import join, abspath, dirname
+
+#ROOT = abspath(join(dirname(__file__), "."))
+
+##############################################################################
+# Build System Settings
+##############################################################################
+#BUILD_DIR = abspath(join(ROOT, "build"))
+
+# ARM
+#ARM_PATH = "C:/Program Files/ARM"
+
+# GCC ARM
+#GCC_ARM_PATH = ""
+
+# IAR
+#IAR_PATH = "C:/Program Files (x86)/IAR Systems/Embedded Workbench 7.0/arm"
+
+# Goanna static analyser. Please overload it in private_settings.py
+#GOANNA_PATH = "c:/Program Files (x86)/RedLizards/Goanna Central 3.2.3/bin"
+
+#BUILD_OPTIONS = []
+
+# mbed.org username
+#MBED_ORG_USER = ""
+
+# Print compiler warnings and errors as link format
+#PRINT_COMPILER_OUTPUT_AS_LINK = False

source/bootloader_common.c

+// ----------------------------------------------------------------------------
+// Copyright 2016-2017 ARM Ltd.
+//
+// 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 "bootloader_common.h"
+
+/* buffer used in storage operations */
+uint8_t buffer_array[BUFFER_SIZE];
+
+/* variable for exposing the most recent event */
+uint32_t event_callback = CLEAR_EVENT;
+
+/* lookup table for printing hexadecimal values */
+const char hexTable[16] = {'0', '1', '2', '3', '4', '5', '6', '7',
+                           '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
+                          };
+
+
+#if DEVICE_SERIAL && SHOW_SERIAL_OUTPUT
+
+#include "hal/serial_api.h"
+
+static serial_t uart = { 0 };
+
+/* module variable for keeping track of initialization */
+static bool not_initialized = true;
+
+/**
+ * @brief Initialization serial port if needed.
+ *.
+ */
+static void init_serial()
+{
+    if (not_initialized)
+    {
+        not_initialized = false;
+
+        serial_init(&uart, STDIO_UART_TX, STDIO_UART_RX);
+#if MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE
+        serial_baud(&uart, MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
+#endif
+    }
+}
+
+/**
+ * @brief Function that directly outputs to serial port in blocking mode.
+ *
+ * @param string outputed to serial port.
+ */
+void boot_debug(const char *s)
+{
+    init_serial();
+
+    while(*s) {
+        serial_putc(&uart, *s);
+        s++;
+    }
+}
+
+#else
+
+/**
+ * @brief Fake function for boot debug.
+ *
+ * @param unused.
+ */
+void boot_debug(const char *s)
+{
+    (void)s;
+}
+
+#endif // DEVICE_SERIAL && SHOW_SERIAL_OUTPUT
+
+/**
+ * @brief Event handler for UCP callbacks.
+ *
+ * @param event Event
+ */
+void arm_ucp_event_handler(uint32_t event)
+{
+    event_callback = event;
+}

source/bootloader_common.h

+// ----------------------------------------------------------------------------
+// Copyright 2016-2017 ARM Ltd.
+//
+// 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 BOOTLOADER_COMMON_H
+#define BOOTLOADER_COMMON_H
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define SIZEOF_SHA256  (256/8)
+
+#ifndef BUFFER_SIZE
+#define BUFFER_SIZE (16 * 1024)
+#endif
+
+#define CLEAR_EVENT 0xFFFFFFFF
+
+enum {
+    RESULT_SUCCESS,
+    RESULT_ERROR,
+    RESULT_EMPTY
+};
+
+extern uint8_t buffer_array[BUFFER_SIZE];
+
+extern uint32_t event_callback;
+extern const char hexTable[16];
+
+void arm_ucp_event_handler(uint32_t event);
+
+void boot_debug(const char *s);
+
+#define MBED_BOOTLOADER_ASSERT(condition, ...) { \
+    if (!(condition)) {                          \
+        boot_debug("[ERR ] ASSERT\r\n");                   \
+        /* coverity[no_escape] */                \
+        while (1) __WFI();                       \
+    }                                            \
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // BOOTLOADER_COMMON_H

source/bootloader_mbedtls_user_config.h

+// ----------------------------------------------------------------------------
+// Copyright 2016-2017 ARM Ltd.
+//
+// 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 MBEDTLS_CUSTOM_CONFIG_H
+#define MBEDTLS_CUSTOM_CONFIG_H
+
+/* System support */
+#define MBEDTLS_HAVE_ASM
+
+#define MBEDTLS_SHA256_SMALLER
+#define MBEDTLS_CIPHER_MODE_CTR
+
+#undef MBEDTLS_SHA512_C
+#undef MBEDTLS_MD5_C
+#undef MBEDTLS_MD4_C
+#undef MBEDTLS_SHA1_C
+
+// Remove RSA, save 20KB at total
+#undef MBEDTLS_RSA_C
+#undef MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
+
+// Remove error messages, save 10KB of ROM
+#undef MBEDTLS_ERROR_C
+
+// Remove selftesting and save 11KB of ROM
+#undef MBEDTLS_SELF_TEST
+
+// Reduces ROM size by 30 kB
+#undef MBEDTLS_ERROR_STRERROR_DUMMY
+#undef MBEDTLS_VERSION_FEATURES
+#undef MBEDTLS_DEBUG_C
+
+#include "mbedtls/check_config.h"
+
+#endif /* MBEDTLS_CUSTOM_CONFIG_H */

source/bootloader_platform.c

+// ----------------------------------------------------------------------------
+// Copyright 2016-2017 ARM Ltd.
+//
+// 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 "bootloader_platform.h"
+
+bool existsErrorMessageLeadingToReboot(void)
+{
+    return false;
+}
+
+const char *errorMessageLeadingToReboot(void)
+{
+    return "<error message leading to reboot>";
+}