Skip to content
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

Update XMSS secret key object APIs, sync with LMS #1588

Merged
merged 32 commits into from
Nov 1, 2023
Merged

Update XMSS secret key object APIs, sync with LMS #1588

Show file tree
Hide file tree
Changes from 31 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
b05776c
Init
ducnguyen-sb Oct 20, 2023
77668b9
convert all variable length array to malloc/free
ducnguyen-sb Oct 20, 2023
ac3456a
refactor XMSS and XMSS^MT, shorten LOC
ducnguyen-sb Oct 22, 2023
03ebc65
clean up unused function
ducnguyen-sb Oct 22, 2023
54fa829
TODO: restore core_hash.c later
ducnguyen-sb Oct 22, 2023
aff21eb
Add activate_lock and activate_unlock functions
ducnguyen-sb Oct 22, 2023
6178748
Add `bool is_locked` to retain lock information, and adjust function …
ducnguyen-sb Oct 22, 2023
4ad3f42
cleanup test_sig_stfl.c
ducnguyen-sb Oct 22, 2023
c04295f
remove const in LMS_serialize_key and add `is_locked` to OQS_SIG_STFL…
ducnguyen-sb Oct 22, 2023
269ada6
fix astyle error
ducnguyen-sb Oct 22, 2023
0a924bf
fix astyle. I have to update local astyle to 3.4.10
ducnguyen-sb Oct 22, 2023
b23e898
remove incorrect comments
ducnguyen-sb Oct 22, 2023
7a0945b
remove unsued variables
ducnguyen-sb Oct 22, 2023
a36c288
fix if guard
ducnguyen-sb Oct 22, 2023
521afc7
fix const warnings
ducnguyen-sb Oct 22, 2023
8d47af8
fix namespace error. revert core_hash.c to original namespace separation
ducnguyen-sb Oct 22, 2023
b4c7ca0
move XMSS_free to internal of XMSS
ducnguyen-sb Oct 22, 2023
5a49b6b
Fix memory leaks
ducnguyen-sb Oct 22, 2023
1afc35c
fix astyle format
ducnguyen-sb Oct 22, 2023
2d817e1
fix typo
ducnguyen-sb Oct 22, 2023
ef1bb9a
improve readablity
ducnguyen-sb Oct 22, 2023
8e422a5
Update OID comment.
ducnguyen-sb Oct 24, 2023
f5b86ab
Trim the space
ducnguyen-sb Oct 24, 2023
fc0a7f4
Remove mutex status bool
ashman-p Oct 25, 2023
28e8773
Remove use of mutex status bool. Use recursive mutex” src/sig_stfl/lm…
ashman-p Oct 25, 2023
760d274
rename lock function
ducnguyen-sb Nov 1, 2023
1c71662
simplify the check with 0
ducnguyen-sb Nov 1, 2023
efbeec9
Fix grammar
ducnguyen-sb Nov 1, 2023
60e947c
add `const` back to serialize. Reorder parameters to follow liboqs co…
ducnguyen-sb Nov 1, 2023
b2d5670
use inner_serialize to avoid recursive lock
ducnguyen-sb Nov 1, 2023
9fbb5c3
add return code in case pthread API has errors
ducnguyen-sb Nov 1, 2023
2dab954
fix scan_build NULL error
ducnguyen-sb Nov 1, 2023
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
6 changes: 3 additions & 3 deletions src/sig_stfl/lms/sig_stfl_lms.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#include "sig_stfl_lms.h"

/* Convert LMS secret key object to byte string */
static OQS_STATUS OQS_SECRET_KEY_LMS_serialize_key(const OQS_SIG_STFL_SECRET_KEY *sk, size_t *sk_len, uint8_t **sk_buf_ptr);
static OQS_STATUS OQS_SECRET_KEY_LMS_serialize_key(uint8_t **sk_buf_ptr, size_t *sk_len, const OQS_SIG_STFL_SECRET_KEY *sk);

/* Insert lms byte string in an LMS secret key object */
static OQS_STATUS OQS_SECRET_KEY_LMS_deserialize_key(OQS_SIG_STFL_SECRET_KEY *sk, const size_t sk_len, const uint8_t *sk_buf, void *context);
Expand Down Expand Up @@ -1760,13 +1760,13 @@ void OQS_SECRET_KEY_LMS_free(OQS_SIG_STFL_SECRET_KEY *sk) {
}

/* Convert LMS secret key object to byte string */
static OQS_STATUS OQS_SECRET_KEY_LMS_serialize_key(const OQS_SIG_STFL_SECRET_KEY *sk, size_t *sk_len, uint8_t **sk_buf_ptr) {
static OQS_STATUS OQS_SECRET_KEY_LMS_serialize_key(uint8_t **sk_buf_ptr, size_t *sk_len, const OQS_SIG_STFL_SECRET_KEY *sk) {
OQS_STATUS status;
if (sk->lock_key && sk->mutex) {
sk->lock_key(sk->mutex);
}

status = oqs_serialize_lms_key(sk, sk_len, sk_buf_ptr);
status = oqs_serialize_lms_key(sk_buf_ptr, sk_len, sk);

if (sk->unlock_key && sk->mutex) {
sk->unlock_key(sk->mutex);
Expand Down
2 changes: 1 addition & 1 deletion src/sig_stfl/lms/sig_stfl_lms.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ int oqs_sig_stfl_lms_verify(const uint8_t *m, size_t mlen, const uint8_t *sm, si

void oqs_secret_lms_key_free(OQS_SIG_STFL_SECRET_KEY *sk);

OQS_STATUS oqs_serialize_lms_key(const OQS_SIG_STFL_SECRET_KEY *sk, size_t *sk_len, uint8_t **sk_key);
OQS_STATUS oqs_serialize_lms_key(uint8_t **sk_key, size_t *sk_len, const OQS_SIG_STFL_SECRET_KEY *sk);
OQS_STATUS oqs_deserialize_lms_key(OQS_SIG_STFL_SECRET_KEY *sk, const size_t sk_len, const uint8_t *sk_buf, void *context);
void oqs_lms_key_set_store_cb(OQS_SIG_STFL_SECRET_KEY *sk, secure_store_sk store_cb, void *context);

Expand Down
9 changes: 3 additions & 6 deletions src/sig_stfl/lms/sig_stfl_lms_functions.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ OQS_API OQS_STATUS OQS_SIG_STFL_alg_lms_sign(uint8_t *signature, size_t *signatu
OQS_STATUS status = OQS_ERROR;
OQS_STATUS rc_keyupdate = OQS_ERROR;
oqs_lms_key_data *lms_key_data = NULL;
const OQS_SIG_STFL_SECRET_KEY *sk;
uint8_t *sk_key_buf = NULL;
size_t sk_key_buf_len = 0;
void *context;
Expand Down Expand Up @@ -89,8 +88,7 @@ OQS_API OQS_STATUS OQS_SIG_STFL_alg_lms_sign(uint8_t *signature, size_t *signatu
* but, delete signature and the serialized key other wise
*/

sk = secret_key;
rc_keyupdate = oqs_serialize_lms_key(sk, &sk_key_buf_len, &sk_key_buf);
rc_keyupdate = oqs_serialize_lms_key(&sk_key_buf, &sk_key_buf_len, secret_key);
if (rc_keyupdate != OQS_SUCCESS) {
goto err;
}
Expand Down Expand Up @@ -121,8 +119,7 @@ OQS_API OQS_STATUS OQS_SIG_STFL_alg_lms_sign(uint8_t *signature, size_t *signatu
}

OQS_API OQS_STATUS OQS_SIG_STFL_alg_lms_verify(const uint8_t *message, size_t message_len,
const uint8_t *signature, size_t signature_len,
const uint8_t *public_key) {
const uint8_t *signature, size_t signature_len, const uint8_t *public_key) {

if (message == NULL || signature == NULL || public_key == NULL) {
return OQS_ERROR;
Expand Down Expand Up @@ -566,7 +563,7 @@ void oqs_secret_lms_key_free(OQS_SIG_STFL_SECRET_KEY *sk) {
* Convert LMS secret key object to byte string
* Writes secret key + aux data if present
*/
OQS_STATUS oqs_serialize_lms_key(const OQS_SIG_STFL_SECRET_KEY *sk, size_t *sk_len, uint8_t **sk_key) {
OQS_STATUS oqs_serialize_lms_key(uint8_t **sk_key, size_t *sk_len, const OQS_SIG_STFL_SECRET_KEY *sk) {

if (sk == NULL || sk_len == NULL || sk_key == NULL) {
return OQS_ERROR;
Expand Down
3 changes: 0 additions & 3 deletions src/sig_stfl/lms/sig_stfl_lms_wrap.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
#include "external/hss.h"
#include "external/hss_sign_inc.h"


/**
* @brief OQS_LMS_KEY object for HSS key pair
*/
Expand All @@ -17,7 +16,6 @@ typedef struct OQS_LMS_SIG_DATA oqs_lms_sig_data;

typedef struct OQS_LMS_SIG_DATA {


/* message buffer */
unsigned char *message;

Expand All @@ -33,4 +31,3 @@ typedef struct OQS_LMS_SIG_DATA {
} oqs_lms_sig_data;

#endif //OQS_SIG_STFL_LMS_H

46 changes: 16 additions & 30 deletions src/sig_stfl/sig_stfl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
OQS_API const char *OQS_SIG_STFL_alg_identifier(size_t i) {

const char *a[OQS_SIG_STFL_algs_length] = {
// XMSS
OQS_SIG_STFL_alg_xmss_sha256_h10,
OQS_SIG_STFL_alg_xmss_sha256_h16,
OQS_SIG_STFL_alg_xmss_sha256_h20,
Expand Down Expand Up @@ -42,6 +43,7 @@ OQS_API const char *OQS_SIG_STFL_alg_identifier(size_t i) {
OQS_SIG_STFL_alg_xmssmt_shake128_h60_3,
OQS_SIG_STFL_alg_xmssmt_shake128_h60_6,
OQS_SIG_STFL_alg_xmssmt_shake128_h60_12,
// LMS
OQS_SIG_STFL_alg_lms_sha256_n32_h5_w1,
OQS_SIG_STFL_alg_lms_sha256_n32_h5_w2,
OQS_SIG_STFL_alg_lms_sha256_n32_h5_w4,
Expand Down Expand Up @@ -799,54 +801,38 @@ OQS_API OQS_SIG_STFL_SECRET_KEY *OQS_SIG_STFL_SECRET_KEY_new(const char *method_
}
}

void OQS_SECRET_KEY_XMSS_free(OQS_SIG_STFL_SECRET_KEY *sk) {
if (sk == NULL) {
return;
}

OQS_MEM_secure_free(sk->secret_key_data, sk->length_secret_key);
sk->secret_key_data = NULL;
}

OQS_API void OQS_SIG_STFL_SECRET_KEY_free(OQS_SIG_STFL_SECRET_KEY *sk) {
if (sk == NULL) {
if (sk == NULL || sk->free_key == NULL) {
return;
}

/* Call object specific free */
if (sk->free_key) {
sk->free_key(sk);
}
sk->free_key(sk);

/* Free sk object */
OQS_MEM_secure_free(sk, sizeof(sk));
sk = NULL;
}

OQS_API void OQS_SIG_STFL_SECRET_KEY_SET_store_cb(OQS_SIG_STFL_SECRET_KEY *sk, secure_store_sk store_cb, void *context) {
if (sk) {
if (sk->set_scrt_key_store_cb) {
sk->set_scrt_key_store_cb(sk, store_cb, context);
}
if (sk == NULL || sk->set_scrt_key_store_cb == NULL) {
return;
}
sk->set_scrt_key_store_cb(sk, store_cb, context);
}

/* Convert secret key object to byte string */
OQS_API OQS_STATUS OQS_SECRET_KEY_STFL_serialize_key(const OQS_SIG_STFL_SECRET_KEY *sk, size_t *sk_len, uint8_t **sk_buf) {
if ((sk == NULL) || (sk_len == NULL) || (sk_buf == NULL)) {
return 0;
}
if (sk->serialize_key) {
return sk->serialize_key(sk, sk_len, sk_buf);
} else {
return 0;
OQS_API OQS_STATUS OQS_SECRET_KEY_STFL_serialize_key(uint8_t **sk_buf_ptr, size_t *sk_len, const OQS_SIG_STFL_SECRET_KEY *sk) {
if (sk == NULL || sk_len == NULL || sk_buf_ptr == NULL || sk->serialize_key == NULL) {
return OQS_ERROR;
}

return sk->serialize_key(sk_buf_ptr, sk_len, sk);
}

/* Insert secret key byte string in an Stateful secret key object */
OQS_API OQS_STATUS OQS_SECRET_KEY_STFL_deserialize_key(OQS_SIG_STFL_SECRET_KEY *sk, const size_t key_len, const uint8_t *sk_buf, void *context) {
if ((sk == NULL) || (sk_buf == NULL)) {
return OQS_ERROR;
}

if (sk->deserialize_key == NULL) {
if (sk == NULL || sk_buf == NULL || sk->deserialize_key == NULL) {
return OQS_ERROR;
}

Expand Down
Loading
Loading