fixup! sys/riotboot: riotboot head v2

Author: fabian18

sys/include/riotboot/flashwrite.h

@@ -150,7 +150,7 @@ int riotboot_flashwrite_init_raw(riotboot_flashwrite_t *state, int target_slot,
  * @brief   Initialize firmware update (riotboot version)
  *
  * This function initializes a firmware update, skipping riotboot's magic
- * number ("RIOT") by calling @ref riotboot_flashwrite_init_raw() with an
+ * number by calling @ref riotboot_flashwrite_init_raw() with an
  * offset of RIOTBOOT_FLASHWRITE_SKIPLEN (4). This ensures that riotboot will
  * ignore the slot until the magic number has been restored, e.g., through @ref
  * riotboot_flashwrite_finish().
@@ -163,7 +163,7 @@ int riotboot_flashwrite_init_raw(riotboot_flashwrite_t *state, int target_slot,
 static inline int riotboot_flashwrite_init(riotboot_flashwrite_t *state,
                                            int target_slot)
 {
-    /* initialize state, but skip "RIOT" */
+    /* initialize state, but skip magic number */
     return riotboot_flashwrite_init_raw(state, target_slot,
                                         RIOTBOOT_FLASHWRITE_SKIPLEN);
 }

sys/include/riotboot/hdr.h

@@ -17,7 +17,7 @@
  *
  * The header contains
  *
- * - "RIOT" as magic number
+ * - the magic number
  * - the application version
  * - the address where the RIOT firmware is found
  * - the checksum of the three previous fields
@@ -49,11 +49,13 @@ extern "C" {
  */
 #define RIOTBOOT_MAGIC_V2       0x54304952 /* "RI0T" */
 
+#ifndef DOXYGEN
 #if defined(MODULE_RIOTBOOT_HDR_V2)
 #  define RIOTBOOT_MAGIC        RIOTBOOT_MAGIC_V2
 #else
 #  define RIOTBOOT_MAGIC        RIOTBOOT_MAGIC_V1
 #endif
+#endif
 
 /**
  * @brief   Bit shift position of tentative boot counter
@@ -84,6 +86,9 @@ static_assert(CONFIG_RIOTBOOT_MAX_ATTEMPTS > 0,
 static_assert(CONFIG_RIOTBOOT_MAX_ATTEMPTS <= 4,
               "CONFIG_RIOTBOOT_MAX_ATTEMPTS must be <= 4");
 
+/**
+ * @brief   Image state enumeration
+ */
 typedef enum riotboot_hdr_img_state {
     RIOTBOOT_HDR_IMG_STATE_INSTALLED = 0x0f,    /**< Image is installed (1111) */
     RIOTBOOT_HDR_IMG_STATE_ACTIVATED = 0x0e,    /**< Image is activated (1110) */
@@ -95,7 +100,7 @@ typedef enum riotboot_hdr_img_state {
  * @brief Structure to store image header - All members are little endian
  */
 struct riotboot_hdr_v1 {
-    uint32_t magic_number;      /**< Header magic number (always "RIOT")              */
+    uint32_t magic_number;      /**< Header magic number                              */
     uint32_t version;           /**< Integer representing the partition version       */
     uint32_t start_addr;        /**< Address after the allocated space for the header */
     uint32_t chksum;            /**< Checksum of riotboot_hdr                         */
@@ -105,7 +110,7 @@ struct riotboot_hdr_v1 {
  * @brief Structure to store image header v2 - All members are little endian
  */
 struct riotboot_hdr_v2 {
-    uint32_t magic_number;              /**< Header magic number (always "RIOT")                */
+    uint32_t magic_number;              /**< Header magic number                                */
     uint32_t version;                   /**< Integer representing the partition version         */
     uint32_t start_addr;                /**< Address after the allocated space for the header   */
     uint32_t chksum;                    /**< Checksum of riotboot_hdr                           */

sys/riotboot/flashwrite_verify_sha256.c

@@ -20,6 +20,7 @@
  * @}
  */
 
+#include "riotboot/hdr.h"
 #include <stdint.h>
 #include <string.h>
 
@@ -49,7 +50,8 @@ int riotboot_flashwrite_verify_sha256(const uint8_t *sha256_digest,
 
     /* add RIOTBOOT_MAGIC since it isn't written into flash until
      * riotboot_flashwrite_finish()" */
-    sha256_update(&sha256, "RIOT", 4);
+    uint32_t magic = RIOTBOOT_MAGIC;
+    sha256_update(&sha256, &magic, 4);
 
     /* account for injected RIOTBOOT_MAGIC by skipping RIOTBOOT_MAGIC_LEN */
     sha256_update(&sha256, img_start + 4, img_len - 4);

sys/suit/storage/flashwrite.c

@@ -18,6 +18,7 @@
  *
  * @}
  */
+#include "riotboot/hdr.h"
 #include <string.h>
 
 #include "architecture.h"
@@ -121,17 +122,16 @@ static int _flashwrite_read(suit_storage_t *storage, uint8_t *buf,
 {
     suit_storage_flashwrite_t *fw = _get_fw(storage);
 
-    static const char _prefix[] = "RIOT";
-    static const size_t _prefix_len = sizeof(_prefix) - 1;
+    const uint32_t magic = RIOTBOOT_MAGIC;
     int target_slot = riotboot_slot_other();
     size_t slot_size = riotboot_slot_size(target_slot);
 
-    /* Insert the "RIOT" magic number */
-    if (offset < (_prefix_len)) {
-        size_t prefix_to_copy = _prefix_len - offset;
-        memcpy(buf, _prefix + offset, prefix_to_copy);
+    /* Insert the magic number */
+    if (offset < (sizeof(magic))) {
+        size_t prefix_to_copy = sizeof(magic) - offset;
+        memcpy(buf, &magic + offset, prefix_to_copy);
         len -= prefix_to_copy;
-        offset = _prefix_len;
+        offset = sizeof(magic);
         buf += prefix_to_copy;
 
     }
@@ -142,7 +142,7 @@ static int _flashwrite_read(suit_storage_t *storage, uint8_t *buf,
      * contains the magic number already copied above. */
     if (offset < RIOTBOOT_FLASHPAGE_BUFFER_SIZE) {
         const size_t chunk_remaining =
-            RIOTBOOT_FLASHPAGE_BUFFER_SIZE - _prefix_len;
+            RIOTBOOT_FLASHPAGE_BUFFER_SIZE - sizeof(magic);
         /* How much of the first page must be copied */
         size_t firstpage_to_copy = len > chunk_remaining ?
             (chunk_remaining) : len;