Struct jwt_compact::alg::StrongKey

pub struct StrongKey<T>(/* private fields */);

Wrapper around keys allowing to enforce key strength requirements.

The wrapper signifies that the key has supported strength as per the corresponding algorithm spec. For example, RSA keys must have length at least 2,048 bits per RFC 7518. Likewise, HS* keys must have at least the length of the hash output (e.g., 32 bytes for HS256). Since these requirements sometimes clash with backward compatibility (and sometimes a lesser level of security is enough), notion of key strength is implemented in such an opt-in, composable way.

It’s easy to convert a StrongKey<T> to T via into_inner() or to access &T via AsRef impl. In contrast, the reverse transformation is fallible, and is defined with the help of TryFrom. The error type for TryFrom is WeakKeyError, a simple wrapper around a weak key.

Examples

See StrongAlg docs for an example of usage.

Implementations

impl StrongKey<RsaPrivateKey>

pub fn to_public_key(&self) -> StrongKey<RsaPublicKey>

Converts this private key to a public key.

impl<T> StrongKey<T>

pub fn into_inner(self) -> T

Returns the wrapped value.

Trait Implementations

impl<T> AsRef<T> for StrongKey<T>

fn as_ref(&self) -> &T

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

impl<T: Clone> Clone for StrongKey<T>

fn clone(&self) -> StrongKey<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for StrongKey<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for StrongKey<T>

fn eq(&self, other: &StrongKey<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 TryFrom<Hs384Key> for StrongKey<Hs384Key>

type Error = WeakKeyError<Hs384Key>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Hs512Key> for StrongKey<Hs512Key>

type Error = WeakKeyError<Hs512Key>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<RsaPrivateKey> for StrongKey<RsaPrivateKey>

type Error = WeakKeyError<RsaPrivateKey>

The type returned in the event of a conversion error.

fn try_from(key: RsaPrivateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RsaPublicKey> for StrongKey<RsaPublicKey>

type Error = WeakKeyError<RsaPublicKey>

The type returned in the event of a conversion error.

fn try_from(key: RsaPublicKey) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Copy> Copy for StrongKey<T>

impl<T: Eq> Eq for StrongKey<T>

impl<T> StructuralEq for StrongKey<T>

impl<T> StructuralPartialEq for StrongKey<T>