Skip to content

Commit bedda8a

Browse files
miyazakhmiyazakh
committed
Add crypto timeout to RNG and AES
Updated based on Copilot's suggestions
1 parent 3f08169 commit bedda8a

File tree

10 files changed

+492
-30
lines changed

10 files changed

+492
-30
lines changed

‎src/wh_client_crypto.c‎

Lines changed: 65 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,27 @@ static int _getCryptoResponse(uint8_t* respBuf, uint16_t type,
180180

181181
return header->rc;
182182
}
183+
static int _wait_response_with_crypttimeout(whClientContext *ctx,
184+
uint16_t *out_group, uint16_t *out_action,
185+
uint16_t *out_size, void* data)
186+
{
187+
int ret = WH_ERROR_OK;
188+
do {
189+
ret = wh_Client_RecvResponse(ctx, out_group, out_action, out_size, data);
190+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT)
191+
if (ret == WH_ERROR_NOTREADY) {
192+
/* Check for crypto timeout */
193+
int chk = wh_CommClient_CheckTimeout(ctx->comm);
194+
if (chk == WH_ERROR_CRYPTIMEOUT) {
195+
return WH_ERROR_CRYPTIMEOUT;
196+
} else if (chk < 0 && chk != WH_ERROR_OK) {
197+
return chk;
198+
}
199+
}
200+
#endif
201+
} while (ret == WH_ERROR_NOTREADY);
202+
return ret;
203+
}
183204

184205
/** Implementations */
185206
int wh_Client_RngGenerate(whClientContext* ctx, uint8_t* out, uint32_t size)
@@ -233,9 +254,14 @@ int wh_Client_RngGenerate(whClientContext* ctx, uint8_t* out, uint32_t size)
233254

234255
/* Send request and get response */
235256
ret = wh_Client_SendRequest(ctx, group, action, req_len, dataPtr);
257+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT)
258+
if (ret == WH_ERROR_OK) {
259+
ret = wh_CommClient_InitCryptTimeout(ctx->comm);
260+
}
261+
#endif
236262
if (ret == 0) {
237263
do {
238-
ret = wh_Client_RecvResponse(ctx, &group, &action, &res_len,
264+
ret = _wait_response_with_crypttimeout(ctx, &group, &action, &res_len,
239265
dataPtr);
240266
} while (ret == WH_ERROR_NOTREADY);
241267
}
@@ -420,14 +446,21 @@ int wh_Client_AesCtr(whClientContext* ctx, Aes* aes, int enc, const uint8_t* in,
420446
wh_Utils_Hexdump("[client] req packet: \n", (uint8_t*)req, req_len);
421447
#endif
422448
ret = wh_Client_SendRequest(ctx, group, action, req_len, dataPtr);
449+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT)
450+
if (ret == WH_ERROR_OK) {
451+
ret = wh_CommClient_InitCryptTimeout(ctx->comm);
452+
}
453+
#endif
423454
/* read response */
424455
if (ret == WH_ERROR_OK) {
425456
/* Response packet */
426457
uint16_t res_len = 0;
427458
do {
428459
ret =
429-
wh_Client_RecvResponse(ctx, &group, &action, &res_len, dataPtr);
460+
_wait_response_with_crypttimeout(ctx, &group, &action,
461+
&res_len, dataPtr);
430462
} while (ret == WH_ERROR_NOTREADY);
463+
431464
if (ret == WH_ERROR_OK) {
432465
ret = _getCryptoResponse(dataPtr, type, (uint8_t**)&res);
433466
if (ret == WH_ERROR_OK) {
@@ -542,14 +575,21 @@ int wh_Client_AesEcb(whClientContext* ctx, Aes* aes, int enc, const uint8_t* in,
542575
wh_Utils_Hexdump("[client] req packet: \n", (uint8_t*)req, req_len);
543576
#endif
544577
ret = wh_Client_SendRequest(ctx, group, action, req_len, dataPtr);
578+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT)
579+
if (ret == WH_ERROR_OK) {
580+
ret = wh_CommClient_InitCryptTimeout(ctx->comm);
581+
}
582+
#endif
545583
/* read response */
546584
if (ret == WH_ERROR_OK) {
547585
/* Response packet */
548586
uint16_t res_len = 0;
549587
do {
550588
ret =
551-
wh_Client_RecvResponse(ctx, &group, &action, &res_len, dataPtr);
589+
_wait_response_with_crypttimeout(ctx, &group, &action,
590+
&res_len, dataPtr);
552591
} while (ret == WH_ERROR_NOTREADY);
592+
553593
if (ret == WH_ERROR_OK) {
554594
ret = _getCryptoResponse(dataPtr, type, (uint8_t**)&res);
555595
if (ret == WH_ERROR_OK) {
@@ -661,14 +701,21 @@ int wh_Client_AesCbc(whClientContext* ctx, Aes* aes, int enc, const uint8_t* in,
661701
wh_Utils_Hexdump("[client] req packet: \n", (uint8_t*)req, req_len);
662702
#endif
663703
ret = wh_Client_SendRequest(ctx, group, action, req_len, dataPtr);
704+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT)
705+
if (ret == WH_ERROR_OK) {
706+
ret = wh_CommClient_InitCryptTimeout(ctx->comm);
707+
}
708+
#endif
664709
/* read response */
665710
if (ret == WH_ERROR_OK) {
666711
/* Response packet */
667712
uint16_t res_len = 0;
668713
do {
669714
ret =
670-
wh_Client_RecvResponse(ctx, &group, &action, &res_len, dataPtr);
715+
_wait_response_with_crypttimeout(ctx, &group, &action,
716+
&res_len, dataPtr);
671717
} while (ret == WH_ERROR_NOTREADY);
718+
672719
if (ret == WH_ERROR_OK) {
673720
ret = _getCryptoResponse(dataPtr, type, (uint8_t**)&res);
674721
if (ret == WH_ERROR_OK) {
@@ -795,11 +842,17 @@ int wh_Client_AesGcm(whClientContext* ctx, Aes* aes, int enc, const uint8_t* in,
795842

796843
/* Send request and receive response */
797844
ret = wh_Client_SendRequest(ctx, group, action, req_len, dataPtr);
845+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT)
846+
if (ret == WH_ERROR_OK) {
847+
ret = wh_CommClient_InitCryptTimeout(ctx->comm);
848+
}
849+
#endif
798850
if (ret == 0) {
799851
uint16_t res_len = 0;
800852
do {
801853
ret =
802-
wh_Client_RecvResponse(ctx, &group, &action, &res_len, dataPtr);
854+
_wait_response_with_crypttimeout(ctx, &group, &action,
855+
&res_len, dataPtr);
803856
} while (ret == WH_ERROR_NOTREADY);
804857

805858
if (ret == WH_ERROR_OK) {
@@ -1005,11 +1058,17 @@ int wh_Client_AesGcmDma(whClientContext* ctx, Aes* aes, int enc,
10051058
if (ret == WH_ERROR_OK) {
10061059
ret = wh_Client_SendRequest(ctx, group, action, reqLen, dataPtr);
10071060
}
1061+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT)
1062+
if (ret == WH_ERROR_OK) {
1063+
ret = wh_CommClient_InitCryptTimeout(ctx->comm);
1064+
}
1065+
#endif
10081066
if (ret == 0) {
10091067
uint16_t resLen = 0;
10101068
do {
10111069
ret =
1012-
wh_Client_RecvResponse(ctx, &group, &action, &resLen, dataPtr);
1070+
_wait_response_with_crypttimeout(ctx, &group, &action,
1071+
&resLen, dataPtr);
10131072
} while (ret == WH_ERROR_NOTREADY);
10141073

10151074
if (ret == WH_ERROR_OK) {

‎src/wh_comm.c‎

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,11 @@ int wh_CommClient_Init(whCommClient* context, const whCommClientConfig* config)
7474
context->transport_context = config->transport_context;
7575
context->client_id = config->client_id;
7676
context->connect_cb = config->connect_cb;
77-
77+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT)
78+
context->crypt_timeout_cb = config->crypt_timeout_cb;
79+
context->crypt_timeout_enabled = config->crypt_timeout_enabled;
80+
context->crypt_timeout = config->crypt_timeout;
81+
#endif
7882
if (context->transport_cb->Init != NULL) {
7983
rc = context->transport_cb->Init(context->transport_context,
8084
config->transport_config, NULL, NULL);
@@ -211,6 +215,69 @@ int wh_CommClient_Cleanup(whCommClient* context)
211215
return rc;
212216
}
213217

218+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT)
219+
static uint64_t wh_timeval_to_ms64(const WOLFHSM_TIMEVAL* tv)
220+
{
221+
if (tv == NULL) return 0;
222+
return (uint64_t)tv->tv_sec * 1000ULL + (uint64_t)((tv->tv_usec) / 1000ULL);
223+
}
224+
/* Set Crypto Time Out if needed */
225+
int wh_CommClient_InitCryptTimeout(whCommClient* context)
226+
{
227+
if (context == NULL)
228+
return WH_ERROR_BADARGS;
229+
/* if feature not enabled, nothing to do */
230+
if (context->crypt_timeout_enabled != 1)
231+
return WH_ERROR_OK;
232+
if (context->crypt_timeout_cb == NULL ||
233+
context->crypt_timeout_cb->GetCurrentTime == NULL)
234+
return WH_ERROR_BADARGS;
235+
236+
/* cache conversion of crypt_timeout to milliseconds */
237+
context->crypt_timeout_ms = wh_timeval_to_ms64(&context->crypt_timeout);
238+
/* initialize start time */
239+
context->crypt_start_time =
240+
context->crypt_timeout_cb->GetCurrentTime(1);
241+
242+
return WH_ERROR_OK;
243+
}
244+
245+
/* Check Crypto Timeout */
246+
int wh_CommClient_CheckTimeout(whCommClient* context)
247+
{
248+
uint64_t current_ms = 0;
249+
uint64_t elapsed_ms = 0;
250+
uint64_t timeout_ms = 0;
251+
252+
if (context == NULL) return WH_ERROR_BADARGS;
253+
254+
if (context->crypt_timeout_enabled != 1)
255+
return WH_ERROR_OK;
256+
257+
if (context->crypt_timeout_cb == NULL ||
258+
context->crypt_timeout_cb->GetCurrentTime == NULL)
259+
return WH_ERROR_BADARGS;
260+
261+
timeout_ms = context->crypt_timeout_ms;
262+
if (timeout_ms == 0)
263+
return WH_ERROR_OK;
264+
265+
/* check timeout by user cb if defined */
266+
if (context->crypt_timeout_cb->CheckTimeout != NULL) {
267+
return context->crypt_timeout_cb->CheckTimeout(
268+
&context->crypt_start_time, timeout_ms);
269+
}
270+
271+
/* Otherwise compute elapsed using user-provided GetCurrentTime */
272+
current_ms = context->crypt_timeout_cb->GetCurrentTime(0);
273+
elapsed_ms = current_ms - context->crypt_start_time;
274+
if (elapsed_ms > timeout_ms) {
275+
return WH_ERROR_CRYPTIMEOUT;
276+
}
277+
278+
return WH_ERROR_OK;
279+
}
280+
#endif /* WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT */
214281
#endif /* WOLFHSM_CFG_ENABLE_CLIENT */
215282

216283
/** Server Functions */

‎test/Makefile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,9 @@ else
135135
DEF += -DWOLFHSM_CFG_IS_TEST_SERVER
136136
endif
137137

138+
ifeq ($(CRYPTIMEOUT),1)
139+
DEF += -DWOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT
140+
endif
138141

139142
## Source files
140143
# Assembly source files

‎test/config/wolfhsm_cfg.h‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,11 @@
6161

6262
#define WOLFHSM_CFG_SERVER_NVM_FLASH_LOG
6363

64+
/* Enable client crypto timeout feature for testing */
65+
#if defined(WOLFHSM_CFG_ENABLE_CLIENT_CRYPTIMEOUT) && \
66+
defined(WOLFHSM_CFG_TEST_POSIX)
67+
#define WOLFHSM_CFG_CLIENT_CRYPTIMEOUT_SEC (2)
68+
#define WOLFHSM_CFG_TEST_CLIENT_CRYPTIMEOUT
69+
#endif /* WOLFHSM_CFG_TEST_CLIENT_CRYPTIMEOUT */
70+
6471
#endif /* WOLFHSM_CFG_H_ */

‎test/wh_test_common.c‎

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@
2626
#include <wolfhsm/wh_error.h>
2727

2828
#include "wh_test_common.h"
29-
29+
#if defined(WOLFHSM_CFG_TEST_CLIENT_CRYPTIMEOUT)
30+
#include <sys/time.h> /* For gettimeofday */
31+
#endif
3032

3133
/**
3234
* Helper function to configure and select an NVM backend for testing.
@@ -90,3 +92,52 @@ int whTest_NvmCfgBackend(whTestNvmBackendType type,
9092

9193
return 0;
9294
}
95+
96+
#if defined(WOLFHSM_CFG_TEST_CLIENT_CRYPTIMEOUT)
97+
#include <time.h>
98+
#include <sys/time.h> /* For gettimeofday */
99+
100+
uint64_t whTest_GetCurrentTime(int reset)
101+
{
102+
(void)reset;
103+
#if defined(CLOCK_MONOTONIC)
104+
struct timespec ts;
105+
106+
if (clock_gettime(CLOCK_MONOTONIC, &ts) != 0)
107+
return 0;
108+
109+
/* Convert to milliseconds number. */
110+
return (uint64_t)ts.tv_sec * 1000ULL +
111+
(uint64_t)ts.tv_nsec / 1000000ULL;
112+
#else
113+
struct timeval tv;
114+
if (gettimeofday(&tv, 0) < 0)
115+
return 0;
116+
/* Convert to milliseconds number. */
117+
return (uint64_t)(tv.tv_sec * 1000ULL + tv.tv_usec / 1000ULL);
118+
#endif
119+
}
120+
/* start_time stores the time (in milliseconds) returned by the GetCurrentTime()
121+
* callback when the operation started.
122+
* The actual unit depends on the GetCurrentTime() implementation.
123+
* timeout_ms represents the timeout in milliseconds, which is derived from
124+
* the crypt_timeout value in whCommClientConfig.
125+
*/
126+
int whTest_CheckCryptoTimeout(uint64_t* start_time, uint64_t timeout_ms)
127+
{
128+
uint64_t current_time;
129+
uint64_t elapsed_time;
130+
131+
if (start_time == NULL) return WH_ERROR_BADARGS;
132+
if (timeout_ms == 0) return WH_ERROR_OK;
133+
134+
current_time = whTest_GetCurrentTime(0);
135+
elapsed_time = current_time - *start_time;
136+
137+
if (elapsed_time > timeout_ms) {
138+
return WH_ERROR_CRYPTIMEOUT;
139+
}
140+
141+
return WH_ERROR_OK;
142+
}
143+
#endif /* WOLFHSM_CFG_TEST_CLIENT_CRYPTIMEOUT */

‎test/wh_test_common.h‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,4 +139,13 @@ int whTest_NvmCfgBackend(whTestNvmBackendType type,
139139
whTestNvmBackendUnion* nvmSetup, whNvmConfig* nvmCfg,
140140
whFlashRamsimCfg* fCfg, whFlashRamsimCtx* fCtx,
141141
const whFlashCb* fCb);
142+
uint64_t whTest_GetCurrentTime(int reset);
143+
int whTest_CheckCryptoTimeout(uint64_t* start_time, uint64_t timeout_ms);
144+
145+
#define WH_CLIENT_CRYPTO_TIMEOUT_CB \
146+
{ \
147+
.GetCurrentTime = whTest_GetCurrentTime, \
148+
.CheckTimeout = whTest_CheckCryptoTimeout, \
149+
}
150+
142151
#endif /* WH_TEST_COMMON_H_ */

0 commit comments

Comments
 (0)