Skip to content

Commit

Permalink
fix: update FFI docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Hugo Rosenkranz-Costa committed Mar 12, 2024
1 parent 5143e92 commit 544df49
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions crates/cover_crypt/src/ffi/generate_cc_keys.rs
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ pub unsafe extern "C" fn h_generate_user_secret_key(
/// - `current_mpk_ptr` : current master public key
/// - `current_mpk_len` : current master public key length
/// - `policy_ptr` : Policy to use to update the master keys (JSON)
/// - `policy_len` : length of the policy (in bytes)
/// # Safety
pub unsafe extern "C" fn h_update_master_keys(
updated_msk_ptr: *mut i8,
Expand Down Expand Up @@ -205,6 +206,7 @@ pub unsafe extern "C" fn h_update_master_keys(
/// - `current_mpk_len` : current master public key length
/// - `access_policy_ptr` : Policy to use to update the master keys (JSON)
/// - `policy_ptr` : Policy to use to update the master keys (JSON)
/// - `policy_len` : length of the policy (in bytes)
/// # Safety
pub unsafe extern "C" fn h_rekey_master_keys(
updated_msk_ptr: *mut i8,
Expand Down Expand Up @@ -285,15 +287,11 @@ pub unsafe extern "C" fn h_rekey_master_keys(
/// - `updated_msk_ptr` : Output buffer containing the updated master secret
/// key
/// - `updated_msk_len` : Size of the updated master secret key output buffer
/// - `updated_mpk_ptr` : Output buffer containing the updated master public
/// key
/// - `updated_mpk_len` : Size of the updated master public key output buffer
/// - `current_msk_ptr` : current master secret key
/// - `current_msk_len` : current master secret key length
/// - `current_mpk_ptr` : current master public key
/// - `current_mpk_len` : current master public key length
/// - `access_policy_ptr` : Policy to use to update the master keys (JSON)
/// - `policy_ptr` : Policy to use to update the master keys (JSON)
/// - `policy_len` : length of the policy (in bytes)
/// # Safety
pub unsafe extern "C" fn h_prune_master_secret_key(
updated_msk_ptr: *mut i8,
Expand Down

0 comments on commit 544df49

Please sign in to comment.