Struct jwt_compact::alg::StrongKey

source ·
pub struct StrongKey<T>(/* private fields */);
Expand description

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§

source§

impl StrongKey<RsaPrivateKey>

source

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

Converts this private key to a public key.

source§

impl<T> StrongKey<T>

source

pub fn into_inner(self) -> T

Returns the wrapped value.

Trait Implementations§

source§

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

source§

fn as_ref(&self) -> &T

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

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

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

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.
source§

impl TryFrom<Hs256Key> for StrongKey<Hs256Key>

§

type Error = WeakKeyError<Hs256Key>

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<Hs384Key> for StrongKey<Hs384Key>

§

type Error = WeakKeyError<Hs384Key>

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<Hs512Key> for StrongKey<Hs512Key>

§

type Error = WeakKeyError<Hs512Key>

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<RsaPrivateKey> for StrongKey<RsaPrivateKey>

§

type Error = WeakKeyError<RsaPrivateKey>

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<RsaPublicKey> for StrongKey<RsaPublicKey>

§

type Error = WeakKeyError<RsaPublicKey>

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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

source§

impl<T> StructuralEq for StrongKey<T>

source§

impl<T> StructuralPartialEq for StrongKey<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for StrongKey<T>
where T: RefUnwindSafe,

§

impl<T> Send for StrongKey<T>
where T: Send,

§

impl<T> Sync for StrongKey<T>
where T: Sync,

§

impl<T> Unpin for StrongKey<T>
where T: Unpin,

§

impl<T> UnwindSafe for StrongKey<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToHex for T
where T: AsRef<[u8]>,

source§

fn encode_hex<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca)
source§

fn encode_hex_upper<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA)
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V