Skip to main content

Jwt

Struct Jwt 

Source
pub struct Jwt<C> { /* private fields */ }
Expand description

JWT bearer-token authentication plugin produced by Auth::jwt_hs256.

This plugin reads Authorization: Bearer <jwt> (scheme matched case-insensitively), verifies the token’s signature and standard claims against the configured key and validation, and on success inserts the decoded claims of type C as the principal. Handlers then read those claims via Principal<C>. A missing token, a bad signature, or a failed validation (e.g. an expired exp) leaves the call unauthenticated rather than erroring.

Unlike Bearer there is no verify closure: trust comes from the cryptographic signature, and the claims are deserialized directly into C. Construct it with Auth::jwt_hs256.

§Type parameter

  • C — the claims type, which must be serde::de::DeserializeOwned + Clone + Send + Sync + 'static. By default jsonwebtoken validates exp, so include an exp field in C.

§Examples

use churust_core::{Churust, TestClient};
use churust_auth::{Auth, Principal};
use jsonwebtoken::{encode, EncodingKey, Header};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Clone)]
struct Claims { sub: String, exp: usize }

let secret = b"shhh";
let token = encode(
    &Header::default(),
    &Claims { sub: "u1".into(), exp: 9_999_999_999 },
    &EncodingKey::from_secret(secret),
).unwrap();

let app = Churust::server()
    .install(Auth::jwt_hs256::<Claims>(secret))
    .routing(|r| {
        r.get("/who", |Principal(c): Principal<Claims>| async move { c.sub });
    })
    .build();

let res = TestClient::new(app)
    .get("/who")
    .header("authorization", &format!("Bearer {token}"))
    .send()
    .await;
assert_eq!(res.text(), "u1");

Trait Implementations§

Source§

impl<C> Plugin for Jwt<C>
where C: DeserializeOwned + Clone + Send + Sync + 'static,

Source§

fn install(self: Box<Self>, app: &mut AppBuilder)

Install this plugin into the builder (register middleware, state, etc.). Consumes the boxed plugin.

Auto Trait Implementations§

§

impl<C> Freeze for Jwt<C>

§

impl<C> RefUnwindSafe for Jwt<C>

§

impl<C> Send for Jwt<C>

§

impl<C> Sync for Jwt<C>

§

impl<C> Unpin for Jwt<C>

§

impl<C> UnsafeUnpin for Jwt<C>

§

impl<C> UnwindSafe for Jwt<C>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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