Commit 11f9c6f2 authored by Dominik Ermel's avatar Dominik Ermel Committed by Dominik Ermel
Browse files

bootutil: Improve logging coverage 



Add additional log lines to allow easier tracking potential
failures in image validation.

Signed-off-by: default avatarDominik Ermel <dominik.ermel@nordicsemi.no>
parent e3dcbab3

boot/bootutil/src/bootutil_misc.c

+17 −0
Original line number Diff line number Diff line
@@ -155,6 +155,9 @@ int boot_trailer_scramble_offset(const struct flash_area *fa, size_t alignment, 
{

    int ret = 0;



    BOOT_LOG_DBG("boot_trailer_scramble_offset: flash_area %p, alignment %u",

                 fa, (unsigned int)alignment);



    /* Not allowed to enforce alignment smaller than device allows */

    if (alignment < flash_area_align(fa)) {

        alignment = flash_area_align(fa);
@@ -176,6 +179,9 @@ int boot_trailer_scramble_offset(const struct flash_area *fa, size_t alignment, 
        *off = flash_area_get_size(fa) - ALIGN_DOWN(boot_trailer_sz(alignment), alignment);

    }



    BOOT_LOG_DBG("boot_trailer_scramble_offset: final alignment %u, offset %u",

                 (unsigned int)alignment, (unsigned int)*off);



    return ret;

}
@@ -187,6 +193,8 @@ int boot_header_scramble_off_sz(const struct flash_area *fa, int slot, size_t *o 
    size_t loff = 0;

    struct flash_sector sector;



    BOOT_LOG_DBG("boot_header_scramble_off_sz: slot %d", slot);



    (void)slot;

#if defined(MCUBOOT_SWAP_USING_OFFSET)

    /* In case of swap offset, header of secondary slot image is positioned
@@ -215,6 +223,8 @@ int boot_header_scramble_off_sz(const struct flash_area *fa, int slot, size_t *o 
    }

    *off = loff;



    BOOT_LOG_DBG("boot_header_scramble_off_sz: size %u", (unsigned int)*size);



    return ret;

}
@@ -601,6 +611,9 @@ boot_erase_region(const struct flash_area *fa, uint32_t off, uint32_t size, bool 
{

    int rc = 0;



    BOOT_LOG_DBG("boot_erase_region: flash_area %p, offset %d, size %d, backwards == %d",

                 fa, off, size, (int)backwards);



    if (off >= flash_area_get_size(fa) || (flash_area_get_size(fa) - off) < size) {

        rc = -1;

        goto end;
@@ -608,6 +621,8 @@ boot_erase_region(const struct flash_area *fa, uint32_t off, uint32_t size, bool 
        uint32_t end_offset = 0;

        struct flash_sector sector;



        BOOT_LOG_DBG("boot_erase_region: device with erase");



        if (backwards) {

            /* Get the lowest page offset first */

            rc = flash_area_get_sector(fa, off, &sector);
@@ -681,6 +696,8 @@ boot_erase_region(const struct flash_area *fa, uint32_t off, uint32_t size, bool 
                off += 1;

            }

        }

    } else {

        BOOT_LOG_DBG("boot_erase_region: device without erase");

    }



end:

boot/bootutil/src/bootutil_public.c

+18 −4
Original line number Diff line number Diff line
@@ -324,7 +324,7 @@ boot_write_magic(const struct flash_area *fap) 
    memset(&magic[0], erased_val, sizeof(magic));

    memcpy(&magic[BOOT_MAGIC_ALIGN_SIZE - BOOT_MAGIC_SZ], BOOT_IMG_MAGIC, BOOT_MAGIC_SZ);



    BOOT_LOG_DBG("writing magic; fa_id=%d off=0x%lx (0x%lx)",

    BOOT_LOG_DBG("boot_write_magic: fa_id=%d off=0x%lx (0x%lx)",

                 flash_area_get_id(fap), (unsigned long)off,

                 (unsigned long)(flash_area_get_off(fap) + off));

    rc = flash_area_write(fap, pad_off, &magic[0], BOOT_MAGIC_ALIGN_SIZE);
@@ -350,9 +350,14 @@ boot_write_trailer(const struct flash_area *fap, uint32_t off, 
    uint32_t align;

    int rc;



    BOOT_LOG_DBG("boot_write_trailer: for %p at %d, size = %d",

                 fap, off, inlen);



    align = flash_area_align(fap);

    align = ALIGN_UP(inlen, align);

    if (align > BOOT_MAX_ALIGN) {

        /* This should never happen */

        assert(0);

        return -1;

    }

    erased_val = flash_area_erased_val(fap);
@@ -593,6 +598,9 @@ boot_set_next(const struct flash_area *fa, bool active, bool confirm) 
    struct boot_swap_state slot_state;

    int rc;



    BOOT_LOG_DBG("boot_set_next: fa %p active == %d, confirm == %d",

                 fa, (int)active, (int)confirm);



    if (active) {

        /* The only way to set active slot for next boot is to confirm it,

         * as DirectXIP will conclude that, since slot has not been confirmed
@@ -603,6 +611,7 @@ boot_set_next(const struct flash_area *fa, bool active, bool confirm) 


    rc = boot_read_swap_state(fa, &slot_state);

    if (rc != 0) {

        BOOT_LOG_DBG("boot_set_next: error %d reading state", rc);

        return rc;

    }
@@ -730,6 +739,8 @@ boot_set_confirmed_multi(int image_index) 


    rc = flash_area_open(FLASH_AREA_IMAGE_PRIMARY(image_index), &fap);

    if (rc != 0) {

        BOOT_LOG_DBG("boot_set_confirmed_multi: error %d opening image %d",

                     rc, image_index);

        return BOOT_EFLASH;

    }
@@ -757,11 +768,12 @@ int 
boot_image_load_header(const struct flash_area *fa_p,

                       struct image_header *hdr)

{

    uint32_t size;

    uint32_t size = 0;

    int rc = flash_area_read(fa_p, 0, hdr, sizeof *hdr);



    BOOT_LOG_DBG("boot_image_load_header: from %p, result %d", fa_p, rc);



    if (rc != 0) {

        rc = BOOT_EFLASH;

        BOOT_LOG_ERR("Failed reading image header");

        return BOOT_EFLASH;

    }
@@ -780,6 +792,8 @@ boot_image_load_header(const struct flash_area *fa_p, 


    if (!boot_u32_safe_add(&size, hdr->ih_img_size, hdr->ih_hdr_size) ||

        size >= flash_area_get_size(fa_p)) {

        BOOT_LOG_ERR("Image size bigger than designated area: %lu > %lu",

                     (unsigned long)size, (unsigned long)flash_area_get_size(fa_p));

        return BOOT_EBADIMAGE;

    }

boot/bootutil/src/ed25519_psa.c

+2 −0
Original line number Diff line number Diff line
@@ -29,6 +29,8 @@ int ED25519_verify(const uint8_t *message, size_t message_len, 
    psa_key_id_t kid;

    int ret = 0;        /* Fail by default */



    BOOT_LOG_DBG("ED25519_verify: PSA implementation");



    /* Initialize PSA Crypto */

    status = psa_crypto_init();

    if (status != PSA_SUCCESS) {

boot/bootutil/src/encrypted.c

+8 −0
Original line number Diff line number Diff line
@@ -43,6 +43,9 @@ 
#include "bootutil/enc_key.h"

#include "bootutil/sign_key.h"

#include "bootutil/crypto/common.h"

#include "bootutil/bootutil_log.h"



BOOT_LOG_MODULE_DECLARE(mcuboot);



#include "bootutil_priv.h"
@@ -383,6 +386,8 @@ boot_decrypt_key(const uint8_t *buf, uint8_t *enckey) 
    uint8_t *cpend;

    size_t olen;

#endif



    BOOT_LOG_DBG("boot_decrypt_key");

#if defined(MCUBOOT_ENCRYPT_EC256)

    bootutil_ecdh_p256_context ecdh_p256;

#endif
@@ -597,8 +602,11 @@ boot_enc_load(struct boot_loader_state *state, int slot, 
#endif

    int rc;



    BOOT_LOG_DBG("boot_enc_load: slot %d", slot);



    /* Already loaded... */

    if (enc_state[slot].valid) {

        BOOT_LOG_DBG("boot_enc_load: already loaded");

        return 1;

    }

boot/bootutil/src/encrypted_psa.c

+3 −1
Original line number Diff line number Diff line
@@ -134,9 +134,11 @@ boot_decrypt_key(const uint8_t *buf, uint8_t *enckey) 
    uint8_t iv_and_key[PSA_CIPHER_IV_LENGTH(PSA_KEY_TYPE_AES, PSA_ALG_CTR) +

                       BOOT_ENC_KEY_SIZE];



    BOOT_LOG_DBG("boot_decrypt_key: PSA ED25519");



    psa_ret = psa_crypto_init();

    if (psa_ret != PSA_SUCCESS) {

        BOOT_LOG_ERR("AES crypto init failed %d", psa_ret);

        BOOT_LOG_ERR("PSA crypto init failed %d", psa_ret);

        return -1;

    }

CRA Git | Maintained and supported by SUSTech CRA and CCSE