Skip to content

Support AES-CTR and AES-ECB #155

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
bigbrett merged 5 commits into from
Sep 12, 2025
Merged

Support AES-CTR and AES-ECB #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8be5f33
implement AES-CTR and AES-ECB
miyazakh Aug 21, 2025
518b428
addressed review comments
miyazakh Sep 2, 2025
daa3f2b
addressed review comments
miyazakh Sep 3, 2025
95ef24c
remove unnecessary logic
miyazakh Sep 9, 2025
689fcb8
increase MAX_BENCH_OPS
miyazakh Sep 11, 2025
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
256 changes: 239 additions & 17 deletions benchmark/bench_modules/wh_bench_mod_aes.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,46 +39,269 @@ static const byte key256[] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,

enum { DECRYPT = 0, ENCRYPT = 1 };

#if defined(WOLFSSL_AES_COUNTER)
static int _benchAesCtr(whClientContext* client, whBenchOpContext* ctx, int id,
const uint8_t* key, size_t keyLen, int encrypt)
{
int ret = 0;
int needEvict = 0;
whKeyId keyId = WH_KEYID_ERASED;
Aes aes[1];
char keyLabel[] = "key label";
/* Input size is largest multiple of AES block size that fits in buffer */
const size_t inLen =
(WOLFHSM_CFG_BENCH_DATA_BUFFER_SIZE / WC_AES_BLOCK_SIZE) *
WC_AES_BLOCK_SIZE;
int i;

#if defined(WOLFHSM_CFG_BENCH_INIT_DATA_BUFFERS)
/* Initialize the input buffer with something non-zero */
memset(WH_BENCH_DATA_IN_BUFFER, 0xAA, inLen);
memset(WH_BENCH_DATA_OUT_BUFFER, 0xAA, inLen);
#endif

/* Initialize the aes struct */
ret = wc_AesInit(aes, NULL, WH_DEV_ID);
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wc_AesInit %d\n", ret);
return ret;
}

/* cache the key on the HSM */
ret = wh_Client_KeyCache(client, 0, (uint8_t*)keyLabel, sizeof(keyLabel),
(uint8_t*)key, keyLen, &keyId);
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wh_Client_KeyCache %d\n", ret);
goto exit;
}

needEvict = 1;

/* set the keyId on the struct */
ret = wh_Client_AesSetKeyId(aes, keyId);
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wh_Client_SetKeyIdAes %d\n", ret);
goto exit;
}

ret = wh_Bench_SetDataSize(ctx, id, inLen);
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wh_Bench_SetDataSize %d\n", ret);
goto exit;
}

for (i = 0; i < WOLFHSM_CFG_BENCH_CRYPT_ITERS; i++) {
int benchStartRet;
int benchStopRet;

if (encrypt) {
benchStartRet = wh_Bench_StartOp(ctx, id);
ret = wc_AesCtrEncrypt(aes, WH_BENCH_DATA_OUT_BUFFER,
WH_BENCH_DATA_IN_BUFFER, inLen);
benchStopRet = wh_Bench_StopOp(ctx, id);
}
else {
benchStartRet = wh_Bench_StartOp(ctx, id);
ret = wc_AesCtrEncrypt(aes, WH_BENCH_DATA_OUT_BUFFER,
WH_BENCH_DATA_IN_BUFFER, inLen);
benchStopRet = wh_Bench_StopOp(ctx, id);
}

if (benchStartRet != 0) {
WH_BENCH_PRINTF("Failed to wh_Bench_StartOp %d\n", benchStartRet);
ret = benchStartRet;
goto exit;
}
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wc_AesCtrc%s %d\n",
encrypt ? "Encrypt" : "Decrypt", ret);
goto exit;
}
if (benchStopRet != 0) {
WH_BENCH_PRINTF("Failed to wh_Bench_StopOp %d\n", benchStopRet);
ret = benchStopRet;
goto exit;
}
}

exit:
wc_AesFree(aes);

if (needEvict) {
int evictRet = wh_Client_KeyEvict(client, keyId);
if (evictRet != 0) {
WH_BENCH_PRINTF("Failed to wh_Client_KeyEvict %d\n", evictRet);
if (ret == 0) {
ret = evictRet;
}
}
}
return ret;
}

int wh_Bench_Mod_Aes128CTREncrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params)
{
(void)params;
return _benchAesCtr(client, ctx, id, (uint8_t*)key128, sizeof(key128),
ENCRYPT);
}

int wh_Bench_Mod_Aes128CTRDecrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params)
{
(void)params;
return _benchAesCtr(client, ctx, id, (uint8_t*)key128, sizeof(key128),
DECRYPT);
}

int wh_Bench_Mod_Aes256CTREncrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params)
{
(void)params;
return _benchAesCtr(client, ctx, id, (uint8_t*)key256, sizeof(key256),
ENCRYPT);
}

int wh_Bench_Mod_Aes256CTRDecrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params)
{
(void)params;
return _benchAesCtr(client, ctx, id, (uint8_t*)key256, sizeof(key256),
DECRYPT);
}

#endif /* WOLFSSL_AES_COUNTER */
#if defined(HAVE_AES_ECB)
static int _benchAesEcb(whClientContext* client, whBenchOpContext* ctx, int id,
const uint8_t* key, size_t keyLen, int encrypt)
{
int ret = 0;
int needEvict = 0;
whKeyId keyId = WH_KEYID_ERASED;
Aes aes[1];
char keyLabel[] = "key label";
/* Input size is largest multiple of AES block size that fits in buffer */
const size_t inLen =
(WOLFHSM_CFG_BENCH_DATA_BUFFER_SIZE / WC_AES_BLOCK_SIZE) *
WC_AES_BLOCK_SIZE;
int i;

#if defined(WOLFHSM_CFG_BENCH_INIT_DATA_BUFFERS)
/* Initialize the input buffer with something non-zero */
memset(WH_BENCH_DATA_IN_BUFFER, 0xAA, inLen);
memset(WH_BENCH_DATA_OUT_BUFFER, 0xAA, inLen);
#endif

/* Initialize the aes struct */
ret = wc_AesInit(aes, NULL, WH_DEV_ID);
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wc_AesInit %d\n", ret);
return ret;
}

/* cache the key on the HSM */
ret = wh_Client_KeyCache(client, 0, (uint8_t*)keyLabel, sizeof(keyLabel),
(uint8_t*)key, keyLen, &keyId);
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wh_Client_KeyCache %d\n", ret);
goto exit;
}

needEvict = 1;

/* set the keyId on the struct */
ret = wh_Client_AesSetKeyId(aes, keyId);
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wh_Client_SetKeyIdAes %d\n", ret);
goto exit;
}

ret = wh_Bench_SetDataSize(ctx, id, inLen);
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wh_Bench_SetDataSize %d\n", ret);
goto exit;
}

for (i = 0; i < WOLFHSM_CFG_BENCH_CRYPT_ITERS; i++) {
int benchStartRet;
int benchStopRet;

if (encrypt) {
benchStartRet = wh_Bench_StartOp(ctx, id);
ret = wc_AesEcbEncrypt(aes, WH_BENCH_DATA_OUT_BUFFER,
WH_BENCH_DATA_IN_BUFFER, inLen);
benchStopRet = wh_Bench_StopOp(ctx, id);
}
else {
benchStartRet = wh_Bench_StartOp(ctx, id);
ret = wc_AesEcbDecrypt(aes, WH_BENCH_DATA_OUT_BUFFER,
WH_BENCH_DATA_IN_BUFFER, inLen);
benchStopRet = wh_Bench_StopOp(ctx, id);
}

if (benchStartRet != 0) {
WH_BENCH_PRINTF("Failed to wh_Bench_StartOp %d\n", benchStartRet);
ret = benchStartRet;
goto exit;
}
if (ret != 0) {
WH_BENCH_PRINTF("Failed to wc_AesEcb%s %d\n",
encrypt ? "Encrypt" : "Decrypt", ret);
goto exit;
}
if (benchStopRet != 0) {
WH_BENCH_PRINTF("Failed to wh_Bench_StopOp %d\n", benchStopRet);
ret = benchStopRet;
goto exit;
}
}

exit:
wc_AesFree(aes);

if (needEvict) {
int evictRet = wh_Client_KeyEvict(client, keyId);
if (evictRet != 0) {
WH_BENCH_PRINTF("Failed to wh_Client_KeyEvict %d\n", evictRet);
if (ret == 0) {
ret = evictRet;
}
}
}
return ret;
}

int wh_Bench_Mod_Aes128ECBEncrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params)
{
(void)client;
(void)ctx;
(void)id;
(void)params;
return WH_ERROR_NOTIMPL;
return _benchAesEcb(client, ctx, id, (uint8_t*)key128, sizeof(key128),
ENCRYPT);
}

int wh_Bench_Mod_Aes128ECBDecrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params)
{
(void)client;
(void)ctx;
(void)id;
(void)params;
return WH_ERROR_NOTIMPL;
return _benchAesEcb(client, ctx, id, (uint8_t*)key128, sizeof(key128),
DECRYPT);
}

int wh_Bench_Mod_Aes256ECBEncrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params)
{
(void)client;
(void)ctx;
(void)id;
(void)params;
return WH_ERROR_NOTIMPL;
return _benchAesEcb(client, ctx, id, (uint8_t*)key256, sizeof(key256),
ENCRYPT);
}

int wh_Bench_Mod_Aes256ECBDecrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params)
{
(void)client;
(void)ctx;
(void)id;
(void)params;
return WH_ERROR_NOTIMPL;
return _benchAesEcb(client, ctx, id, (uint8_t*)key256, sizeof(key256),
DECRYPT);
}
#endif /* HAVE_AES_ECB */

Expand All @@ -92,7 +315,6 @@ static int _benchAesCbc(whClientContext* client, whBenchOpContext* ctx, int id,
Aes aes[1];
char keyLabel[] = "key label";
/* Input size is largest multiple of AES block size that fits in buffer */
/* BUFFER-TODO */
const size_t inLen =
(WOLFHSM_CFG_BENCH_DATA_BUFFER_SIZE / WC_AES_BLOCK_SIZE) *
WC_AES_BLOCK_SIZE;
Expand Down
11 changes: 11 additions & 0 deletions benchmark/bench_modules/wh_bench_mod_all.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ int wh_Bench_Mod_Echo(whClientContext* client, whBenchOpContext* benchCtx,
/*
* AES benchmark module prototypes (wh_bench_mod_aes.c)
*/
int wh_Bench_Mod_Aes128CTREncrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params);

int wh_Bench_Mod_Aes128CTRDecrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params);
int wh_Bench_Mod_Aes128ECBEncrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params);

Expand All @@ -46,6 +51,12 @@ int wh_Bench_Mod_Aes128GCMEncrypt(whClientContext* client,
int wh_Bench_Mod_Aes128GCMDecrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params);

int wh_Bench_Mod_Aes256CTREncrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params);

int wh_Bench_Mod_Aes256CTRDecrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params);

int wh_Bench_Mod_Aes256ECBEncrypt(whClientContext* client,
whBenchOpContext* ctx, int id, void* params);

Expand Down
1 change: 1 addition & 0 deletions benchmark/config/user_settings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ extern "C" {
/** AES Options */
/* #define NO_AES */
#define HAVE_AESGCM
#define WOLFSSL_AES_COUNTER
#define GCM_TABLE_4BIT

#define WOLFSSL_AES_DIRECT
Expand Down
12 changes: 12 additions & 0 deletions benchmark/wh_bench.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,12 @@ typedef enum BenchModuleIdx {

/* AES */
#if !defined(NO_AES)
#if defined(WOLFSSL_AES_COUNTER)
BENCH_MODULE_IDX_AES_128_CTR_ENCRYPT,
BENCH_MODULE_IDX_AES_128_CTR_DECRYPT,
BENCH_MODULE_IDX_AES_256_CTR_ENCRYPT,
BENCH_MODULE_IDX_AES_256_CTR_DECRYPT,
#endif /* WOLFSSL_AES_COUNTER */
#if defined(HAVE_AES_ECB)
BENCH_MODULE_IDX_AES_128_ECB_ENCRYPT,
BENCH_MODULE_IDX_AES_128_ECB_DECRYPT,
Expand Down Expand Up @@ -233,6 +239,12 @@ static BenchModule g_benchModules[] = {

/* AES */
#if !defined(NO_AES)
#if defined(WOLFSSL_AES_COUNTER)
[BENCH_MODULE_IDX_AES_128_CTR_ENCRYPT] = {"AES-128-CTR-Encrypt", wh_Bench_Mod_Aes128CTREncrypt, BENCH_THROUGHPUT_XBPS, 0, NULL},
[BENCH_MODULE_IDX_AES_128_CTR_DECRYPT] = {"AES-128-CTR-Decrypt", wh_Bench_Mod_Aes128CTRDecrypt, BENCH_THROUGHPUT_XBPS, 0, NULL},
[BENCH_MODULE_IDX_AES_256_CTR_ENCRYPT] = {"AES-256-CTR-Encrypt", wh_Bench_Mod_Aes256CTREncrypt, BENCH_THROUGHPUT_XBPS, 0, NULL},
[BENCH_MODULE_IDX_AES_256_CTR_DECRYPT] = {"AES-256-CTR-Decrypt", wh_Bench_Mod_Aes256CTRDecrypt, BENCH_THROUGHPUT_XBPS, 0, NULL},
#endif /* WOLFSSL_AES_COUNTER */
#if defined(HAVE_AES_ECB)
[BENCH_MODULE_IDX_AES_128_ECB_ENCRYPT] = {"AES-128-ECB-Encrypt", wh_Bench_Mod_Aes128ECBEncrypt, BENCH_THROUGHPUT_XBPS, 0, NULL},
[BENCH_MODULE_IDX_AES_128_ECB_DECRYPT] = {"AES-128-ECB-Decrypt", wh_Bench_Mod_Aes128ECBDecrypt, BENCH_THROUGHPUT_XBPS, 0, NULL},
Expand Down
2 changes: 1 addition & 1 deletion benchmark/wh_bench_ops.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
#include <stdint.h>

/* Maximum number of operations that can be registered */
#define MAX_BENCH_OPS 79
#define MAX_BENCH_OPS 83
/* Maximum length of operation name */
#define MAX_OP_NAME 64

Expand Down
1 change: 1 addition & 0 deletions examples/posix/tcp/wh_client_tcp/user_settings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
#define HAVE_CURVE25519
#define HAVE_ECC
#define HAVE_AES_CBC
#define WOLFSSL_AES_COUNTER
#define HAVE_AESGCM
#define WOLFSSL_AES_DIRECT
#define WOLFSSL_CMAC
Expand Down
1 change: 1 addition & 0 deletions examples/posix/tcp/wh_server_tcp/user_settings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ extern "C" {
/** AES Options */
/* #define NO_AES */
#define HAVE_AESGCM
#define WOLFSSL_AES_COUNTER
#define GCM_TABLE_4BIT

#define WOLFSSL_AES_DIRECT
Expand Down
Loading