Struct JwtBuilder 

pub struct JwtBuilder { /* private fields */ }

Sub-builder for JWT settings.

Entered via AuthBuilder::with_jwt(); call done() to return to the parent builder.

Implementations

impl JwtBuilder

pub fn secret(self, secret: impl Into<String>) -> Self

Set JWT secret key.

Must be at least 32 characters for HMAC algorithms.

Example

use auth_framework::prelude::*;

let builder = AuthFramework::builder()
    .with_jwt().secret("my-long-secret-key-32-chars-min!!").done();

pub fn secret_from_env(self, env_var: &str) -> Self

Set JWT secret from environment variable.

Example

use auth_framework::prelude::*;

let builder = AuthFramework::builder()
    .with_jwt().secret_from_env("MY_JWT_SECRET").done();

pub fn issuer(self, issuer: impl Into<String>) -> Self

Set JWT issuer.

Example

use auth_framework::prelude::*;

let builder = AuthFramework::builder()
    .with_jwt().secret("secret-key-at-least-32-characters!!").issuer("my-service").done();

pub fn audience(self, audience: impl Into<String>) -> Self

Set JWT audience.

Example

use auth_framework::prelude::*;

let builder = AuthFramework::builder()
    .with_jwt().secret("secret-key-at-least-32-characters!!").audience("my-api").done();

pub fn token_lifetime(self, lifetime: Duration) -> Self

Set token lifetime.

Example

use auth_framework::prelude::*;
use std::time::Duration;

let builder = AuthFramework::builder()
    .with_jwt()
    .secret("secret-key-at-least-32-characters!!")
    .token_lifetime(Duration::from_secs(1800))
    .done();

pub fn refresh_token_lifetime(self, lifetime: Duration) -> Self

Set refresh token lifetime (defaults to 7 days).

Example

use auth_framework::prelude::*;
use std::time::Duration;

let builder = AuthFramework::builder()
    .with_jwt()
    .secret("secret-key-at-least-32-characters!!")
    .refresh_token_lifetime(Duration::from_secs(86400))
    .done();

pub fn algorithm(self, algorithm: JwtAlgorithm) -> Self

Set the JWT signing algorithm (defaults to HS256).

Example

use auth_framework::prelude::*;
use auth_framework::config::JwtAlgorithm;

let builder = AuthFramework::builder()
    .with_jwt()
    .secret("secret-key-at-least-32-characters!!")
    .algorithm(JwtAlgorithm::HS512)
    .done();

pub fn done(self) -> AuthBuilder

Complete JWT configuration and return to main builder.

Example

use auth_framework::prelude::*;

let builder = AuthFramework::builder()
    .with_jwt().secret("secret-key-at-least-32-characters!!").done()
    .with_storage().memory().done();