Struct actix_jwt_session::Authenticated

pub struct Authenticated<T> {
    pub claims: Arc<T>,
    pub jwt_encoding_key: Arc<EncodingKey>,
    pub algorithm: Algorithm,
}

Extractable user session which requires presence of JWT in request. If there’s no JWT endpoint which requires this structure will automatically returns 401.

Examples:

use actix_web::get;
use actix_web::HttpResponse;
use actix_jwt_session::Authenticated;

#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct AppClaims { id: uuid::Uuid, sub: String }
impl actix_jwt_session::Claims for AppClaims {
    fn jti(&self) -> uuid::Uuid { self.id }
    fn subject(&self) -> &str { &self.sub }
}

// If there's no JWT in request server will automatically returns 401
#[get("/session")]
async fn read_session(session: Authenticated<AppClaims>) -> HttpResponse {
    let encoded = session.encode().unwrap(); // JWT as encrypted string
    HttpResponse::Ok().finish()
}

Fields

claims: Arc<T>

jwt_encoding_key: Arc<EncodingKey>

algorithm: Algorithm

Implementations

impl<T: Claims> Authenticated<T>

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

Encode claims as JWT encrypted string

Trait Implementations

impl<T: Clone> Clone for Authenticated<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Deref for Authenticated<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Claims> FromRequest for Authenticated<T>

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Authenticated<T>, Error>>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, _payload: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.