Skip to content

Add checking in SHE response handlers #391

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

Open
padelsbach wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add checking in SHE response handlers #391

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
224 changes: 169 additions & 55 deletions src/wh_client_she.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,13 @@ int wh_Client_SheSetUidResponse(whClientContext* c)

resp = (whMessageShe_SetUidResponse*)wh_CommClient_GetDataPtr(c->comm);
ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == WH_ERROR_OK) {
Copy link
Copy Markdown
Contributor Author

@padelsbach padelsbach May 29, 2026

Choose a reason for hiding this comment

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

Could macro'ize this, but not sure if that's more readable

if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_SET_UID ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == WH_ERROR_OK) {
ret = resp->rc;
}
Expand Down Expand Up @@ -150,6 +157,13 @@ int wh_Client_SheSecureBoot(whClientContext* c, uint8_t* bootloader,
initResp = (whMessageShe_SecureBootInitResponse*)respBuf;
} while (ret == WH_ERROR_NOTREADY);
}
if (ret == 0) {
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_SECURE_BOOT_INIT ||
dataSz < sizeof(*initResp)) {
ret = WH_ERROR_ABORTED;
}
}

/* send update sub command until we've sent the entire bootloader */
while (ret == 0 && bootloaderSent < bootloaderLen) {
Expand Down Expand Up @@ -186,6 +200,15 @@ int wh_Client_SheSecureBoot(whClientContext* c, uint8_t* bootloader,
respBuf);
} while (ret == WH_ERROR_NOTREADY);
}
if (ret == 0) {
whMessageShe_SecureBootUpdateResponse* updateResp =
(whMessageShe_SecureBootUpdateResponse*)respBuf;
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_SECURE_BOOT_UPDATE ||
dataSz < sizeof(*updateResp)) {
ret = WH_ERROR_ABORTED;
}
}

/* increment sent */
if (ret == 0) {
Expand All @@ -205,6 +228,13 @@ int wh_Client_SheSecureBoot(whClientContext* c, uint8_t* bootloader,
finishResp = (whMessageShe_SecureBootFinishResponse*)respBuf;
} while (ret == WH_ERROR_NOTREADY);
}
if (ret == 0) {
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_SECURE_BOOT_FINISH ||
dataSz < sizeof(*finishResp)) {
ret = WH_ERROR_ABORTED;
}
}

if (ret == 0) {
ret = finishResp->rc;
Expand Down Expand Up @@ -242,13 +272,18 @@ int wh_Client_SheGetStatusResponse(whClientContext* c, uint8_t* sreg)
resp = (whMessageShe_GetStatusResponse*)wh_CommClient_GetDataPtr(c->comm);

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);

/* return error or set sreg */
if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR)
ret = resp->rc;
else
*sreg = resp->sreg;
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_GET_STATUS ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
*sreg = resp->sreg;
}
return ret;
}
Expand Down Expand Up @@ -307,15 +342,20 @@ int wh_Client_SheLoadKeyResponse(whClientContext* c, uint8_t* messageFour,

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR) {
ret = resp->rc;
}
else {
/* copy out message 4 and 5 */
memcpy(messageFour, resp->messageFour, sizeof(resp->messageFour));
memcpy(messageFive, resp->messageFive, sizeof(resp->messageFive));
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_LOAD_KEY ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
/* copy out message 4 and 5 */
memcpy(messageFour, resp->messageFour, sizeof(resp->messageFour));
memcpy(messageFive, resp->messageFive, sizeof(resp->messageFive));
}
return ret;
}

Expand Down Expand Up @@ -366,6 +406,13 @@ int wh_Client_SheLoadPlainKeyResponse(whClientContext* c)
(whMessageShe_LoadPlainKeyResponse*)wh_CommClient_GetDataPtr(c->comm);

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_LOAD_PLAIN_KEY ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
Expand Down Expand Up @@ -417,18 +464,23 @@ int wh_Client_SheExportRamKeyResponse(whClientContext* c, uint8_t* messageOne,

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR) {
ret = resp->rc;
}
else {
memcpy(messageOne, resp->messageOne, sizeof(resp->messageOne));
memcpy(messageTwo, resp->messageTwo, sizeof(resp->messageTwo));
memcpy(messageThree, resp->messageThree,
sizeof(resp->messageThree));
memcpy(messageFour, resp->messageFour, sizeof(resp->messageFour));
memcpy(messageFive, resp->messageFive, sizeof(resp->messageFive));
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_EXPORT_RAM_KEY ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
memcpy(messageOne, resp->messageOne, sizeof(resp->messageOne));
memcpy(messageTwo, resp->messageTwo, sizeof(resp->messageTwo));
memcpy(messageThree, resp->messageThree,
sizeof(resp->messageThree));
memcpy(messageFour, resp->messageFour, sizeof(resp->messageFour));
memcpy(messageFive, resp->messageFive, sizeof(resp->messageFive));
}

return ret;
}
Expand Down Expand Up @@ -473,6 +525,13 @@ int wh_Client_SheInitRndResponse(whClientContext* c)

resp = (whMessageShe_InitRngResponse*)wh_CommClient_GetDataPtr(c->comm);
ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_INIT_RND ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
Expand Down Expand Up @@ -516,15 +575,21 @@ int wh_Client_SheRndResponse(whClientContext* c, uint8_t* out, uint32_t* outSz)
resp = (whMessageShe_RndResponse*)wh_CommClient_GetDataPtr(c->comm);

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);

if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR)
ret = resp->rc;
else {
memcpy(out, resp->rnd, sizeof(resp->rnd));
*outSz = sizeof(resp->rnd);
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_RND ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
memcpy(out, resp->rnd, sizeof(resp->rnd));
*outSz = sizeof(resp->rnd);
}

return ret;
}

Expand Down Expand Up @@ -577,6 +642,13 @@ int wh_Client_SheExtendSeedResponse(whClientContext* c)
resp = (whMessageShe_ExtendSeedResponse*)wh_CommClient_GetDataPtr(c->comm);
ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);

if (ret == 0) {
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_EXTEND_SEED ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
Expand Down Expand Up @@ -640,11 +712,19 @@ int wh_Client_SheEncEcbResponse(whClientContext* c, uint8_t* out, uint32_t sz)

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR) {
ret = resp->rc;
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_ENC_ECB ||
dataSz < sizeof(*resp) ||
dataSz < sizeof(*resp) + resp->sz) {
Copy link
Copy Markdown

@wolfSSL-Fenrir-bot wolfSSL-Fenrir-bot May 29, 2026

Choose a reason for hiding this comment

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

🔵 [Low] Payload length checked before response error · Incorrect error handling

The variable-length response handlers validate resp->sz before resp->rc, so a header-only SHE error response with a nonzero size is returned as WH_ERROR_ABORTED instead of the SHE error.

Fix: Check only the fixed header first, read resp->rc, and validate resp->sz only when resp->rc == WH_ERROR_OK.

ret = WH_ERROR_ABORTED;
}
else if (sz < resp->sz) {
ret = WH_ERROR_BADARGS;
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
if (sz < resp->sz) {
ret = WH_ERROR_BUFFER_SIZE;
}
else {
memcpy(out, packOut, resp->sz);
Expand Down Expand Up @@ -712,11 +792,19 @@ int wh_Client_SheEncCbcResponse(whClientContext* c, uint8_t* out, uint32_t sz)

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR) {
ret = resp->rc;
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_ENC_CBC ||
dataSz < sizeof(*resp) ||
dataSz < sizeof(*resp) + resp->sz) {
ret = WH_ERROR_ABORTED;
}
else if (sz < resp->sz) {
ret = WH_ERROR_BADARGS;
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
if (sz < resp->sz) {
ret = WH_ERROR_BUFFER_SIZE;
}
else {
memcpy(out, packOut, resp->sz);
Expand Down Expand Up @@ -780,11 +868,19 @@ int wh_Client_SheDecEcbResponse(whClientContext* c, uint8_t* out, uint32_t sz)

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR) {
ret = resp->rc;
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_DEC_ECB ||
dataSz < sizeof(*resp) ||
dataSz < sizeof(*resp) + resp->sz) {
ret = WH_ERROR_ABORTED;
}
else if (sz < resp->sz) {
ret = WH_ERROR_BADARGS;
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
if (sz < resp->sz) {
ret = WH_ERROR_BUFFER_SIZE;
}
else {
memcpy(out, packOut, resp->sz);
Expand Down Expand Up @@ -852,11 +948,19 @@ int wh_Client_SheDecCbcResponse(whClientContext* c, uint8_t* out, uint32_t sz)

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR) {
ret = resp->rc;
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_DEC_CBC ||
dataSz < sizeof(*resp) ||
dataSz < sizeof(*resp) + resp->sz) {
ret = WH_ERROR_ABORTED;
}
else if (sz < resp->sz) {
ret = WH_ERROR_BADARGS;
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
if (sz < resp->sz) {
ret = WH_ERROR_BUFFER_SIZE;
}
else {
memcpy(out, packOut, resp->sz);
Expand Down Expand Up @@ -919,13 +1023,18 @@ int wh_Client_SheGenerateMacResponse(whClientContext* c, uint8_t* out,

ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR) {
ret = resp->rc;
}
else {
memcpy(out, resp->mac, WH_SHE_KEY_SZ);
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_GEN_MAC ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
memcpy(out, resp->mac, WH_SHE_KEY_SZ);
}
return ret;
}

Expand Down Expand Up @@ -991,13 +1100,18 @@ int wh_Client_SheVerifyMacResponse(whClientContext* c, uint8_t* outStatus)
resp = (whMessageShe_VerifyMacResponse*)wh_CommClient_GetDataPtr(c->comm);
ret = wh_Client_RecvResponse(c, &group, &action, &dataSz, (uint8_t*)resp);
if (ret == 0) {
if (resp->rc != WH_SHE_ERC_NO_ERROR) {
ret = resp->rc;
}
else {
*outStatus = resp->status;
if (group != WH_MESSAGE_GROUP_SHE ||
action != WH_SHE_VERIFY_MAC ||
dataSz < sizeof(*resp)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
if (ret == 0) {
*outStatus = resp->status;
}
return ret;
}

Expand Down
Loading