Skip to content

Commit

Permalink
Update some comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ashman-p committed Dec 10, 2023
1 parent 25fab93 commit 0262251
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions src/sig_stfl/sig_stfl.h
Original file line number Diff line number Diff line change
Expand Up @@ -340,11 +340,12 @@ typedef struct OQS_SIG_STFL_SECRET_KEY {

/**
* Store Secret Key Function
* Callback function used to securely store key data after a signature generation
* Callback function used to securely store key data after a signature generation.
* When populated, this pointer points to the application supplied secure storage function.
* @param[in] sk_buf The serialized secret key data to secure store
* @param[in] buf_len length of data to secure
* @param[in] context application supplied data used to locate where this secret key
* is stored
* is stored (passed in at the time the function pointer was set).
*
* @return OQS_SUCCESS or OQS_ERROR
* Ideally written to secure device
Expand All @@ -359,6 +360,15 @@ typedef struct OQS_SIG_STFL_SECRET_KEY {
*/
void (*free_key)(OQS_SIG_STFL_SECRET_KEY *sk);

/*
* Secure storage for private keys used in stateful signature schemes is outside the scope of the OQS library.
* This is the responsibility of any adopting application. The application must supply
* a function to for this purpose. A callback function and context data must be set in-order
* to perform stateful signature generation.
* The context var may contain, for example an HSM context, a filename or other such data that
* is used to store the private key. This var is passed into the OQS lib when the application sets
* the callback function use to save/update the private key.
*/
/**
* Set Secret Key store callback Function
*
Expand Down

0 comments on commit 0262251

Please sign in to comment.