Skip to content

bootutil: Drop slot number and boot_state from most boot_enc functions #2501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 21, 2025
Merged

bootutil: Drop slot number and boot_state from most boot_enc functions #2501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions boot/boot_serial/src/boot_serial_encryption.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ boot_image_validate_encrypted(struct boot_loader_state *state,
if (rc < 0) {
FIH_RET(fih_rc);
}
rc = boot_enc_set_key(BOOT_CURR_ENC(state), BOOT_SLOT_SECONDARY, bs);
rc = boot_enc_set_key(BOOT_CURR_ENC_SLOT(state, BOOT_SLOT_SECONDARY), bs->enckey[BOOT_SLOT_SECONDARY]);
if (rc < 0) {
FIH_RET(fih_rc);
}
Expand Down Expand Up @@ -169,7 +169,7 @@ decrypt_region_inplace(struct boot_loader_state *state,
blk_sz = tlv_off - (off + bytes_copied);
}
}
boot_enc_decrypt(BOOT_CURR_ENC(state), slot,
boot_enc_decrypt(BOOT_CURR_ENC_SLOT(state, slot),
(off + bytes_copied + idx) - hdr->ih_hdr_size, blk_sz,
blk_off, &buf[idx]);
}
Expand Down Expand Up @@ -239,7 +239,7 @@ decrypt_image_inplace(const struct flash_area *fa_p,
if (rc < 0) {
FIH_RET(fih_rc);
}
if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC(state), BOOT_SLOT_PRIMARY, bs)) {
if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC_SLOT(state, BOOT_SLOT_PRIMARY), bs->enckey[BOOT_SLOT_PRIMARY])) {
FIH_RET(fih_rc);
}
}
Expand Down
14 changes: 7 additions & 7 deletions boot/bootutil/include/bootutil/enc_key.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,18 @@ struct boot_loader_state;
/* Decrypt random, symmetric encryption key */
int boot_decrypt_key(const uint8_t *buf, uint8_t *enckey);

int boot_enc_init(struct enc_key_data *enc_state, uint8_t slot);
int boot_enc_drop(struct enc_key_data *enc_state, uint8_t slot);
int boot_enc_set_key(struct enc_key_data *enc_state, uint8_t slot,
const struct boot_status *bs);
int boot_enc_init(struct enc_key_data *enc_state);
int boot_enc_drop(struct enc_key_data *enc_state);
int boot_enc_set_key(struct enc_key_data *enc_state, const uint8_t *key);
int boot_enc_load(struct boot_loader_state *state, int slot,
const struct image_header *hdr, const struct flash_area *fap,
struct boot_status *bs);
bool boot_enc_valid(struct enc_key_data *enc_state, int slot);
void boot_enc_encrypt(struct enc_key_data *enc_state, int slot,
bool boot_enc_valid(const struct enc_key_data *enc_state);
void boot_enc_encrypt(struct enc_key_data *enc_state,
uint32_t off, uint32_t sz, uint32_t blk_off, uint8_t *buf);
void boot_enc_decrypt(struct enc_key_data *enc_state, int slot,
void boot_enc_decrypt(struct enc_key_data *enc_state,
uint32_t off, uint32_t sz, uint32_t blk_off, uint8_t *buf);
/* Note that boot_enc_zeorize takes BOOT_CURR_ENC, not BOOT_CURR_ENC_SLOT */
void boot_enc_zeroize(struct enc_key_data *enc_state);

#ifdef __cplusplus
Expand Down
7 changes: 2 additions & 5 deletions boot/bootutil/src/bootutil_img_hash.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ bootutil_img_hash(struct boot_loader_state *state,
int fa_ret;
#endif
#if defined(MCUBOOT_ENC_IMAGES)
struct enc_key_data *enc_state;
int image_index;
#endif
#if defined(MCUBOOT_SWAP_USING_OFFSET)
Expand All @@ -91,16 +90,14 @@ bootutil_img_hash(struct boot_loader_state *state,

#ifdef MCUBOOT_ENC_IMAGES
if (state == NULL) {
enc_state = NULL;
image_index = 0;
} else {
enc_state = BOOT_CURR_ENC(state);
image_index = BOOT_CURR_IMG(state);
}

/* Encrypted images only exist in the secondary slot */
if (MUST_DECRYPT(fap, image_index, hdr) &&
!boot_enc_valid(enc_state, 1)) {
!boot_enc_valid(BOOT_CURR_ENC_SLOT(state, BOOT_SLOT_SECONDARY))) {
BOOT_LOG_DBG("bootutil_img_hash: error encrypted image found in primary slot");
return -1;
}
Expand Down Expand Up @@ -182,7 +179,7 @@ bootutil_img_hash(struct boot_loader_state *state,

if (off >= hdr_size && off < tlv_off) {
blk_off = (off - hdr_size) & 0xf;
boot_enc_decrypt(enc_state, slot, off - hdr_size,
boot_enc_decrypt(BOOT_CURR_ENC_SLOT(state, slot), off - hdr_size,
blk_sz, blk_off, tmp_buf);
}
}
Expand Down
2 changes: 2 additions & 0 deletions boot/bootutil/src/bootutil_priv.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,8 +483,10 @@ static inline bool boot_u16_safe_add(uint16_t *dest, uint16_t a, uint16_t b)
#endif
#ifdef MCUBOOT_ENC_IMAGES
#define BOOT_CURR_ENC(state) ((state)->enc[BOOT_CURR_IMG(state)])
#define BOOT_CURR_ENC_SLOT(state, slot) (&((state)->enc[BOOT_CURR_IMG(state)][slot]))
#else
#define BOOT_CURR_ENC(state) NULL
#define BOOT_CURR_ENC_SLOT(state, slot) NULL
#endif
#define BOOT_IMG(state, slot) ((state)->imgs[BOOT_CURR_IMG(state)][(slot)])
#define BOOT_IMG_AREA(state, slot) (BOOT_IMG(state, slot).area)
Expand Down
37 changes: 17 additions & 20 deletions boot/bootutil/src/encrypted.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,7 @@ boot_enc_load(struct boot_loader_state *state, int slot,
const struct image_header *hdr, const struct flash_area *fap,
struct boot_status *bs)
{
struct enc_key_data *enc_state = BOOT_CURR_ENC(state);
struct enc_key_data *enc_state = BOOT_CURR_ENC_SLOT(state, slot);
uint32_t off;
uint16_t len;
struct image_tlv_iter it;
Expand All @@ -587,13 +587,13 @@ boot_enc_load(struct boot_loader_state *state, int slot,
BOOT_LOG_DBG("boot_enc_load: slot %d", slot);

/* Already loaded... */
if (enc_state[slot].valid) {
if (boot_enc_valid(enc_state)) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not for this PR but in future we need to do rework the code and do expression checks properly, e.g. if (boot_enc_valid(enc_state) == true) {

BOOT_LOG_DBG("boot_enc_load: already loaded");
return 1;
}

/* Initialize the AES context */
boot_enc_init(enc_state, slot);
boot_enc_init(enc_state);

#if defined(MCUBOOT_SWAP_USING_OFFSET)
it.start_off = boot_get_state_secondary_offset(state, fap);
Expand Down Expand Up @@ -627,48 +627,46 @@ boot_enc_load(struct boot_loader_state *state, int slot,
}

int
boot_enc_init(struct enc_key_data *enc_state, uint8_t slot)
boot_enc_init(struct enc_key_data *enc_state)
{
bootutil_aes_ctr_init(&enc_state[slot].aes_ctr);
bootutil_aes_ctr_init(&enc_state->aes_ctr);
return 0;
}

int
boot_enc_drop(struct enc_key_data *enc_state, uint8_t slot)
boot_enc_drop(struct enc_key_data *enc_state)
{
bootutil_aes_ctr_drop(&enc_state[slot].aes_ctr);
enc_state[slot].valid = 0;
bootutil_aes_ctr_drop(&enc_state->aes_ctr);
enc_state->valid = 0;
return 0;
}

int
boot_enc_set_key(struct enc_key_data *enc_state, uint8_t slot,
const struct boot_status *bs)
boot_enc_set_key(struct enc_key_data *enc_state, const uint8_t *key)
{
int rc;

rc = bootutil_aes_ctr_set_key(&enc_state[slot].aes_ctr, bs->enckey[slot]);
rc = bootutil_aes_ctr_set_key(&enc_state->aes_ctr, key);
if (rc != 0) {
boot_enc_drop(enc_state, slot);
boot_enc_drop(enc_state);
return -1;
}

enc_state[slot].valid = 1;
enc_state->valid = 1;

return 0;
}

bool
boot_enc_valid(struct enc_key_data *enc_state, int slot)
boot_enc_valid(const struct enc_key_data *enc_state)
{
return enc_state[slot].valid;
return enc_state->valid;
}

void
boot_enc_encrypt(struct enc_key_data *enc_state, int slot, uint32_t off,
boot_enc_encrypt(struct enc_key_data *enc, uint32_t off,
uint32_t sz, uint32_t blk_off, uint8_t *buf)
{
struct enc_key_data *enc = &enc_state[slot];
uint8_t nonce[16];

/* Nothing to do with size == 0 */
Expand All @@ -688,10 +686,9 @@ boot_enc_encrypt(struct enc_key_data *enc_state, int slot, uint32_t off,
}

void
boot_enc_decrypt(struct enc_key_data *enc_state, int slot, uint32_t off,
boot_enc_decrypt(struct enc_key_data *enc, uint32_t off,
uint32_t sz, uint32_t blk_off, uint8_t *buf)
{
struct enc_key_data *enc = &enc_state[slot];
uint8_t nonce[16];

/* Nothing to do with size == 0 */
Expand All @@ -718,7 +715,7 @@ boot_enc_zeroize(struct enc_key_data *enc_state)
{
uint8_t slot;
for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {
(void)boot_enc_drop(enc_state, slot);
(void)boot_enc_drop(&enc_state[slot]);
}
memset(enc_state, 0, sizeof(struct enc_key_data) * BOOT_NUM_SLOTS);
}
Expand Down
16 changes: 8 additions & 8 deletions boot/bootutil/src/loader.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ boot_image_check(struct boot_loader_state *state, struct image_header *hdr,
if (rc < 0) {
FIH_RET(fih_rc);
}
if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC(state), BOOT_SLOT_SECONDARY, bs)) {
if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC_SLOT(state, BOOT_SLOT_SECONDARY), bs->enckey[BOOT_SLOT_SECONDARY])) {
FIH_RET(fih_rc);
}
}
Expand Down Expand Up @@ -1378,11 +1378,11 @@ boot_copy_region(struct boot_loader_state *state,
}
}
if (source_slot == 0) {
boot_enc_encrypt(BOOT_CURR_ENC(state), source_slot,
boot_enc_encrypt(BOOT_CURR_ENC_SLOT(state, source_slot),
(abs_off + idx) - hdr->ih_hdr_size, blk_sz,
blk_off, &buf[idx]);
} else {
boot_enc_decrypt(BOOT_CURR_ENC(state), source_slot,
boot_enc_decrypt(BOOT_CURR_ENC_SLOT(state, source_slot),
(abs_off + idx) - hdr->ih_hdr_size, blk_sz,
blk_off, &buf[idx]);
}
Expand Down Expand Up @@ -1496,7 +1496,7 @@ boot_copy_image(struct boot_loader_state *state, struct boot_status *bs)
if (rc < 0) {
return BOOT_EBADIMAGE;
}
if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC(state), BOOT_SLOT_SECONDARY, bs)) {
if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC_SLOT(state, BOOT_SLOT_SECONDARY), bs->enckey[BOOT_SLOT_SECONDARY])) {
return BOOT_EBADIMAGE;
}
}
Expand Down Expand Up @@ -1618,7 +1618,7 @@ boot_swap_image(struct boot_loader_state *state, struct boot_status *bs)
assert(rc >= 0);

if (rc == 0) {
rc = boot_enc_set_key(BOOT_CURR_ENC(state), BOOT_SLOT_PRIMARY, bs);
rc = boot_enc_set_key(BOOT_CURR_ENC_SLOT(state, BOOT_SLOT_PRIMARY), bs->enckey[BOOT_SLOT_PRIMARY]);
assert(rc == 0);
} else {
rc = 0;
Expand All @@ -1642,7 +1642,7 @@ boot_swap_image(struct boot_loader_state *state, struct boot_status *bs)
assert(rc >= 0);

if (rc == 0) {
rc = boot_enc_set_key(BOOT_CURR_ENC(state), BOOT_SLOT_SECONDARY, bs);
rc = boot_enc_set_key(BOOT_CURR_ENC_SLOT(state, BOOT_SLOT_SECONDARY), bs->enckey[BOOT_SLOT_SECONDARY]);
assert(rc == 0);
} else {
rc = 0;
Expand Down Expand Up @@ -1673,7 +1673,7 @@ boot_swap_image(struct boot_loader_state *state, struct boot_status *bs)
#ifdef MCUBOOT_ENC_IMAGES
for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {

boot_enc_init(BOOT_CURR_ENC(state), slot);
boot_enc_init(BOOT_CURR_ENC_SLOT(state, slot));

rc = boot_read_enc_key(fap, slot, bs);
assert(rc == 0);
Expand All @@ -1685,7 +1685,7 @@ boot_swap_image(struct boot_loader_state *state, struct boot_status *bs)
}

if (i != BOOT_ENC_KEY_SIZE) {
boot_enc_set_key(BOOT_CURR_ENC(state), slot, bs);
boot_enc_set_key(BOOT_CURR_ENC_SLOT(state, slot), bs->enckey[slot]);
}
}
#endif
Expand Down
4 changes: 2 additions & 2 deletions boot/bootutil/src/ram_load.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ boot_decrypt_and_copy_image_to_sram(struct boot_loader_state *state,
}

/* if rc > 0 then the key has already been loaded */
if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC(state), slot, &bs)) {
if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC_SLOT(state, slot), bs.enckey[slot])) {
goto done;
}

Expand All @@ -176,7 +176,7 @@ boot_decrypt_and_copy_image_to_sram(struct boot_loader_state *state,
* Part of the chunk is encrypted payload */
blk_sz = tlv_off - (bytes_copied);
}
boot_enc_decrypt(BOOT_CURR_ENC(state), slot,
boot_enc_decrypt(BOOT_CURR_ENC_SLOT(state, slot),
(bytes_copied + idx) - hdr->ih_hdr_size, blk_sz,
blk_off, cur_dst);
bytes_copied += chunk_sz;
Expand Down
Loading