Skip to content

fix (wh_message): Standardize Message Translation and Enhance Safety #236

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
billphipps merged 1 commit into from
Dec 17, 2025
Merged

fix (wh_message): Standardize Message Translation and Enhance Safety #236

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
30 changes: 15 additions & 15 deletions src/wh_message_comm.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ int wh_MessageComm_TranslateInitRequest(uint16_t magic,
(dest == NULL) ) {
return WH_ERROR_BADARGS;
}
dest->client_id = wh_Translate32(magic, src->client_id);
WH_T32(magic, dest, src, client_id);
return 0;
}

Expand All @@ -53,8 +53,8 @@ int wh_MessageComm_TranslateInitResponse(uint16_t magic,
(dest == NULL) ) {
return WH_ERROR_BADARGS;
}
dest->client_id = wh_Translate32(magic, src->client_id);
dest->server_id = wh_Translate32(magic, src->server_id);
WH_T32(magic, dest, src, client_id);
WH_T32(magic, dest, src, server_id);
return 0;
}

Expand All @@ -68,18 +68,18 @@ int wh_MessageComm_TranslateInfoResponse(uint16_t magic,
}
memcpy(dest->version, src->version, sizeof(dest->version));
memcpy(dest->build, src->build, sizeof(dest->build));
dest->cfg_comm_data_len = wh_Translate32(magic, src->cfg_comm_data_len);
dest->cfg_nvm_object_count = wh_Translate32(magic, src->cfg_nvm_object_count);
dest->cfg_server_keycache_count = wh_Translate32(magic, src->cfg_server_keycache_count);
dest->cfg_server_keycache_bufsize = wh_Translate32(magic, src->cfg_server_keycache_bufsize);
dest->cfg_server_keycache_bigcount = wh_Translate32(magic, src->cfg_server_keycache_bigcount);
dest->cfg_server_keycache_bigbufsize = wh_Translate32(magic, src->cfg_server_keycache_bigbufsize);
dest->cfg_server_customcb_count = wh_Translate32(magic, src->cfg_server_customcb_count);
dest->cfg_server_dmaaddr_count = wh_Translate32(magic, src->cfg_server_dmaaddr_count);
dest->debug_state = wh_Translate32(magic, src->debug_state);
dest->boot_state = wh_Translate32(magic, src->boot_state);
dest->lifecycle_state = wh_Translate32(magic, src->lifecycle_state);
dest->nvm_state = wh_Translate32(magic, src->nvm_state);
WH_T32(magic, dest, src, cfg_comm_data_len);
WH_T32(magic, dest, src, cfg_nvm_object_count);
WH_T32(magic, dest, src, cfg_server_keycache_count);
WH_T32(magic, dest, src, cfg_server_keycache_bufsize);
WH_T32(magic, dest, src, cfg_server_keycache_bigcount);
WH_T32(magic, dest, src, cfg_server_keycache_bigbufsize);
WH_T32(magic, dest, src, cfg_server_customcb_count);
WH_T32(magic, dest, src, cfg_server_dmaaddr_count);
WH_T32(magic, dest, src, debug_state);
WH_T32(magic, dest, src, boot_state);
WH_T32(magic, dest, src, lifecycle_state);
WH_T32(magic, dest, src, nvm_state);
return 0;
}

Expand Down
8 changes: 6 additions & 2 deletions src/wh_message_crypto.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@ int wh_MessageCrypto_TranslateMlDsaVerifyResponse(
*/

/* DMA Buffer translation */
int wh_MessageCrypto_TranslateDmaBuffer(uint16_t magic,
static int wh_MessageCrypto_TranslateDmaBuffer(uint16_t magic,
const whMessageCrypto_DmaBuffer* src,
whMessageCrypto_DmaBuffer* dest)
{
Expand All @@ -743,13 +743,17 @@ int wh_MessageCrypto_TranslateDmaBuffer(uint16_t magic,
}

/* DMA Address status translation */
int wh_MessageCrypto_TranslateDmaAddrStatus(
static int wh_MessageCrypto_TranslateDmaAddrStatus(
uint16_t magic, const whMessageCrypto_DmaAddrStatus* src,
whMessageCrypto_DmaAddrStatus* dest)
{
if ((src == NULL) || (dest == NULL)) {
return WH_ERROR_BADARGS;
}
return wh_MessageCrypto_TranslateDmaBuffer(magic, &src->badAddr,
&dest->badAddr);
}

/* SHA224 DMA Request translation */
int wh_MessageCrypto_TranslateSha2DmaRequest(
uint16_t magic, const whMessageCrypto_Sha2DmaRequest* src,
Expand Down
37 changes: 14 additions & 23 deletions src/wh_message_customcb.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,24 +43,16 @@ static void _translateCustomData(uint16_t magic, uint32_t translatedType,
/* right now, no further translations required */
} break;
case WH_MESSAGE_CUSTOM_CB_TYPE_DMA32: {
dst->dma32.client_addr =
wh_Translate32(magic, src->dma32.client_addr);
dst->dma32.client_sz =
wh_Translate32(magic, src->dma32.client_sz);
dst->dma32.server_addr =
wh_Translate32(magic, src->dma32.server_addr);
dst->dma32.server_sz =
wh_Translate32(magic, src->dma32.server_sz);
WH_T32(magic, dst, src, dma32.client_addr);
WH_T32(magic, dst, src, dma32.client_sz);
WH_T32(magic, dst, src, dma32.server_addr);
WH_T32(magic, dst, src, dma32.server_sz);
} break;
case WH_MESSAGE_CUSTOM_CB_TYPE_DMA64: {
dst->dma64.client_addr =
wh_Translate64(magic, src->dma64.client_addr);
dst->dma64.client_sz =
wh_Translate64(magic, src->dma64.client_sz);
dst->dma64.server_addr =
wh_Translate64(magic, src->dma64.server_addr);
dst->dma64.server_sz =
wh_Translate64(magic, src->dma64.server_sz);
WH_T64(magic, dst, src, dma64.client_addr);
WH_T64(magic, dst, src, dma64.client_sz);
WH_T64(magic, dst, src, dma64.server_addr);
WH_T64(magic, dst, src, dma64.server_sz);
} break;
default: {
/* reserved message types - no translation for now */
Expand All @@ -82,8 +74,8 @@ int wh_MessageCustomCb_TranslateRequest(uint16_t magic,
return WH_ERROR_BADARGS;
}

dst->id = wh_Translate32(magic, src->id);
dst->type = wh_Translate32(magic, src->type);
WH_T32(magic, dst, src, id);
WH_T32(magic, dst, src, type);
_translateCustomData(magic, dst->type, &src->data, &dst->data);

return WH_ERROR_OK;
Expand All @@ -97,14 +89,13 @@ int wh_MessageCustomCb_TranslateResponse(uint16_t magic,
if ((src == NULL) || (dst == NULL)) {
return WH_ERROR_BADARGS;
}

dst->rc = wh_Translate32(magic, src->rc);
dst->err = wh_Translate32(magic, src->err);
WH_T32(magic, dst, src, rc);
WH_T32(magic, dst, src, err);

/* TODO: should we continue to translate responses for err != 0?
* Probably still should...*/
dst->id = wh_Translate32(magic, src->id);
dst->type = wh_Translate32(magic, src->type);
WH_T32(magic, dst, src, id);
WH_T32(magic, dst, src, type);
_translateCustomData(magic, dst->type, &src->data, &dst->data);

return WH_ERROR_OK;
Expand Down
4 changes: 2 additions & 2 deletions wolfhsm/wh_message_crypto.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,7 @@ typedef struct {
uint32_t loLen;
/* intermediate hash value */
uint8_t hash[64]; /* TODO (HM) WC_SHA512_DIGEST_SIZE */
int hashType;
uint32_t hashType;
} resumeState;
/* Flag indicating to the server that this is the last block and it should
* finalize the hash. If set, inBlock may be only partially full*/
Expand All @@ -694,7 +694,7 @@ typedef struct {
uint32_t hiLen;
uint32_t loLen;
uint8_t hash[64]; /* TODO WC_SHA512_DIGEST_SIZE */
int hashType;
uint32_t hashType;
} whMessageCrypto_Sha2Response;

int wh_MessageCrypto_TranslateSha512Request(
Expand Down