Struct jwt_compact::alg::Hs256Key

pub struct Hs256Key(/* private fields */);

Signing / verifying key for HS256 algorithm. Zeroed on drop.

Implementations

impl Hs256Key

pub fn generate<R: CryptoRng + RngCore>(rng: &mut R) -> StrongKey<Self>

Generates a random key using a cryptographically secure RNG.

pub fn new(bytes: impl AsRef<[u8]>) -> Self

Creates a key from the specified bytes.

Trait Implementations

impl AsMut<[u8]> for Hs256Key

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Hs256Key

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Hs256Key

fn clone(&self) -> Hs256Key

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Hs256Key

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&[u8]> for Hs256Key

fn from(bytes: &[u8]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Hs256Key> for JsonWebKey<'a>

fn from(key: &'a Hs256Key) -> JsonWebKey<'a>

Converts to this type from the input type.

impl SigningKey<Hs256> for Hs256Key

fn from_slice(raw: &[u8]) -> Result<Self>

Creates a key from raw bytes. Returns an error if the bytes do not represent a valid key.

fn to_verifying_key(&self) -> Self

Converts a signing key to a verification key.

fn as_bytes(&self) -> SecretBytes<'_>

Returns the key as raw bytes.

impl TryFrom<&JsonWebKey<'_>> for Hs256Key

type Error = JwkError

The type returned in the event of a conversion error.

fn try_from(jwk: &JsonWebKey<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Hs256Key> for StrongKey<Hs256Key>

type Error = WeakKeyError<Hs256Key>

The type returned in the event of a conversion error.

fn try_from(value: Hs256Key) -> Result<Self, Self::Error>

Performs the conversion.

impl VerifyingKey<Hs256> for Hs256Key

fn from_slice(raw: &[u8]) -> Result<Self>

Creates a key from raw bytes. Returns an error if the bytes do not represent a valid key.

fn as_bytes(&self) -> Cow<'_, [u8]>

Returns the key as raw bytes.

impl Zeroize for Hs256Key

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.