Struct JwtSecret

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

Available on crate feature jwt only.

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: AsRef<str>>(hex: S) -> Result<Self, JwtError>

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<Self, 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<Self, 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() -> Self

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.

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

Performs copy-assignment from source.

impl Debug for JwtSecret

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

Formats the value using the given formatter.

impl FromStr for JwtSecret

type Err = JwtError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl PartialEq for JwtSecret

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

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

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