pub struct Key { /* private fields */ }Expand description
A key to use for HMAC signing.
Implementations
sourceimpl Key
impl Key
sourcepub fn generate(
algorithm: Algorithm,
rng: &dyn SecureRandom
) -> Result<Self, Unspecified>
pub fn generate(
algorithm: Algorithm,
rng: &dyn SecureRandom
) -> Result<Self, Unspecified>
Generate an HMAC signing key using the given digest algorithm with a
random value generated from rng.
The key will be digest_alg.output_len bytes long, based on the
recommendation in RFC 2104 Section 3.
sourcepub fn new(algorithm: Algorithm, key_value: &[u8]) -> Self
pub fn new(algorithm: Algorithm, key_value: &[u8]) -> Self
Construct an HMAC signing key using the given digest algorithm and key value.
key_value should be a value generated using a secure random number
generator (e.g. the key_value output by
SealingKey::generate_serializable()) or derived from a random key by
a key derivation function (e.g. ring::hkdf). In particular,
key_value shouldn’t be a password.
As specified in RFC 2104, if key_value is shorter than the digest
algorithm’s block length (as returned by digest::Algorithm::block_len,
not the digest length returned by digest::Algorithm::output_len) then
it will be padded with zeros. Similarly, if it is longer than the block
length then it will be compressed using the digest algorithm.
You should not use keys larger than the digest_alg.block_len because
the truncation described above reduces their strength to only
digest_alg.output_len * 8 bits. Support for such keys is likely to be
removed in a future version of ring.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Key
impl Send for Key
impl Sync for Key
impl Unpin for Key
impl UnwindSafe for Key
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more