Struct JwtSecret

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

Expand description

Value-object holding a reference to a hex-encoded 256-bit secret key.

A JWT secret key is used to secure JWT-based authentication. The secret key is a shared secret between the server and the client and is used to calculate a digital signature for the JWT, which is included in the JWT along with its payload.

See also: Secret key - Engine API specs

Implementations§

impl JwtSecret

pub fn from_hex<S>(hex: S) -> Result<JwtSecret, JwtError>
where S: AsRef<str>,

Creates an instance of JwtSecret.

Returns an error if one of the following applies:

hex is not a valid hexadecimal string
hex argument length is less than JWT_SECRET_LEN

This strips the leading 0x, if any.

pub fn from_file(fpath: &Path) -> Result<JwtSecret, JwtError>

Available on crate feature std only.

Tries to load a JwtSecret from the specified file path. I/O or secret validation errors might occur during read operations in the form of a JwtError.

pub fn try_create_random(fpath: &Path) -> Result<JwtSecret, JwtError>

Available on crate feature std only.

Creates a random JwtSecret and tries to store it at the specified path. I/O errors might occur during write operations in the form of a JwtError

pub fn validate(&self, jwt: &str) -> Result<(), JwtError>

Available on crate feature serde only.

Validates a JWT token along the following rules:

The JWT signature is valid.
The JWT is signed with the HMAC + SHA256 (HS256) algorithm.
The JWT iat (issued-at) claim is a timestamp within +-60 seconds from the current time.
The JWT exp (expiration time) claim is validated by default if defined.

See also: JWT Claims - Engine API specs

pub fn random() -> JwtSecret

Generates a random JwtSecret containing a hex-encoded 256 bit secret key.

pub fn encode(&self, claims: &Claims) -> Result<String, Error>

Available on crate feature serde only.

Encode the header and claims given and sign the payload using the algorithm from the header and the key.

pub const fn as_bytes(&self) -> &[u8] ⓘ

Returns the secret key as a byte slice.

Trait Implementations§

impl Clone for JwtSecret

fn clone(&self) -> JwtSecret

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

impl Debug for JwtSecret

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

Formats the value using the given formatter. Read more

impl FromStr for JwtSecret

type Err = JwtError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<JwtSecret, <JwtSecret as FromStr>::Err>

Parses a string s to return a value of this type. Read more

impl PartialEq for JwtSecret

fn eq(&self, other: &JwtSecret) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

impl Copy for JwtSecret

impl Eq for JwtSecret

impl StructuralPartialEq for JwtSecret

Auto Trait Implementations§

impl Freeze for JwtSecret

impl RefUnwindSafe for JwtSecret

impl Send for JwtSecret

impl Sync for JwtSecret

impl Unpin for JwtSecret

impl UnwindSafe for JwtSecret

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)

Performs copy-assignment from self to dst. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,

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

impl<T> MaybeSendSync for T

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes