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 2 commits into
base: main
Choose a base branch
from
Open

Add checking in SHE response handlers #391

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e852e3f
Add checking in SHE response handlers
padelsbach May 29, 2026
8616f78
Address PR comments
padelsbach Jun 1, 2026
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
228 changes: 177 additions & 51 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) {

@padelsbach padelsbach May 29, 2026

Copy link
Copy Markdown
Contributor Author

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 ||
Comment on lines +100 to +101

@bigbrett bigbrett Jun 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

all these group and action checks are redundant, as they are handled in the comm layer. Otherwise every single client response check would need these.

Also, do you think the size check could be pushed down to the comm layer somehow in a uniform way, perhaps via same mechanism as #389 and #388? Currently these would need to be done inline everywhere.

Note we dont care THAT much about this fuzzing style stuff - currently the threat model is such that transports are trusted. If someone can modify data in your transport, all bets are off. So temped to just not do the infinite bikeshedding around input sanitation that fenrir keeps pointing out....

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,22 @@ 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)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
/* payload is only present on success, so validate its size before copy */
if (ret == 0) {
if (dataSz < sizeof(*resp) + resp->sz) {
ret = WH_ERROR_ABORTED;
}
else if (sz < resp->sz) {
ret = WH_ERROR_BADARGS;
ret = WH_ERROR_BUFFER_SIZE;
}
else {
memcpy(out, packOut, resp->sz);
Expand Down Expand Up @@ -712,11 +795,22 @@ 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)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
/* payload is only present on success, so validate its size before copy */
if (ret == 0) {
if (dataSz < sizeof(*resp) + resp->sz) {
ret = WH_ERROR_ABORTED;
}
else if (sz < resp->sz) {
ret = WH_ERROR_BADARGS;
ret = WH_ERROR_BUFFER_SIZE;
}
else {
memcpy(out, packOut, resp->sz);
Expand Down Expand Up @@ -780,11 +874,22 @@ 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)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
/* payload is only present on success, so validate its size before copy */
if (ret == 0) {
if (dataSz < sizeof(*resp) + resp->sz) {
ret = WH_ERROR_ABORTED;
}
else if (sz < resp->sz) {
ret = WH_ERROR_BADARGS;
ret = WH_ERROR_BUFFER_SIZE;
}
else {
memcpy(out, packOut, resp->sz);
Expand Down Expand Up @@ -852,11 +957,22 @@ 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)) {
ret = WH_ERROR_ABORTED;
}
}
if (ret == 0) {
ret = resp->rc;
}
/* payload is only present on success, so validate its size before copy */
if (ret == 0) {
if (dataSz < sizeof(*resp) + resp->sz) {
ret = WH_ERROR_ABORTED;
}
else if (sz < resp->sz) {
ret = WH_ERROR_BADARGS;
ret = WH_ERROR_BUFFER_SIZE;
}
else {
memcpy(out, packOut, resp->sz);
Expand Down Expand Up @@ -919,13 +1035,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 +1112,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