Skip to content

Commit 9873556

Browse files
Explain that index used in key extract derivation method is bit index
Signed-off-by: Jacob Prud'homme <[email protected]>
1 parent d5f61ba commit 9873556

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

cryptoki/src/mechanism/misc.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,19 @@ impl<'a> KeyDerivationStringData<'a> {
4040
}
4141
}
4242

43-
/// A parameter indicating the index of the base key from which to extract the
44-
/// derived key.
43+
/// A parameter indicating the index of the bit in the the base key from which
44+
/// to extract the derived key.
4545
#[derive(Debug, Clone, Copy)]
4646
#[repr(transparent)]
4747
pub struct ExtractParams(CK_EXTRACT_PARAMS);
4848

4949
impl ExtractParams {
50-
/// Construct parameter from index to extract the derived key from the base
51-
/// key.
50+
/// Construct parameter from index of bit from which to extract the derived
51+
/// key from the base key.
5252
///
5353
/// # Arguments
5454
///
55-
/// * `index` - The index from which to extract the derived key from the base key.
55+
/// * `index` - The bit index from which to extract the derived key from the base key.
5656
pub fn new(index: usize) -> Self {
5757
Self(
5858
index

0 commit comments

Comments
 (0)