Skip to main content

EncryptedBodyBuilder

Struct EncryptedBodyBuilder 

Source
pub struct EncryptedBodyBuilder<T> { /* private fields */ }
Expand description

Route builder that expects a VEIL-encrypted request body of type T.

Obtained from ServerMechanism::encryption. On each matching request the raw body bytes are decrypted using the SerializationKey supplied there. If decryption fails for any reason (wrong key, mismatched secret, corrupted payload) the route immediately returns 403 Forbidden — the handler is never invoked.

Optionally attach shared state via state before finalising with onconnect / onconnect_sync.

Implementations§

Source§

impl<T> EncryptedBodyBuilder<T>
where T: Decode<()> + Send + 'static,

Source

pub fn onconnect<F, Fut, Re>(self, handler: F) -> SocketType
where F: Fn(T) -> Fut + Clone + Send + Sync + 'static, Fut: Future<Output = Result<Re, Rejection>> + Send, Re: Reply + Send,

Finalises this route with an async handler that receives the decrypted body as T.

On each request the raw body bytes are VEIL-decrypted using the SerializationKey configured on this builder. The handler is only invoked when decryption succeeds — a wrong key, mismatched secret, or corrupted body causes the route to return 403 Forbidden without ever reaching the handler. The T the closure receives is therefore always a trusted, fully-decrypted value ready to use.

The handler must return Result<impl Reply, Rejection>. Returns a SocketType ready to be passed to Server::mechanism.

Source

pub unsafe fn onconnect_sync<F, Re>(self, handler: F) -> SocketType
where F: Fn(T) -> Result<Re, Rejection> + Clone + Send + Sync + 'static, Re: Reply + Send + 'static,

Finalises this route with a synchronous handler that receives the decrypted body as T.

Decryption happens before the handler is dispatched to the thread pool: if the key is wrong or the body is corrupt the request is rejected with 403 Forbidden and the thread pool is not touched at all. The T handed to the closure is always a trusted, fully-decrypted value. The closure may block but must complete quickly.

Returns a SocketType ready to be passed to Server::mechanism.

§Safety

See ServerMechanism::onconnect_sync for the thread-pool safety notes.

Source

pub fn state<S: Clone + Send + Sync + 'static>( self, state: S, ) -> StatefulEncryptedBodyBuilder<T, S>

Attaches shared state S, transitioning to StatefulEncryptedBodyBuilder.

A fresh clone of S is injected alongside the decrypted T on every request. The handler will receive (state: S, body: T).

S must be Clone + Send + Sync + 'static.

Auto Trait Implementations§

§

impl<T> Freeze for EncryptedBodyBuilder<T>

§

impl<T> RefUnwindSafe for EncryptedBodyBuilder<T>
where T: RefUnwindSafe,

§

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

§

impl<T> Sync for EncryptedBodyBuilder<T>
where T: Sync,

§

impl<T> Unpin for EncryptedBodyBuilder<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for EncryptedBodyBuilder<T>

§

impl<T> UnwindSafe for EncryptedBodyBuilder<T>
where T: UnwindSafe,

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<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> PolicyExt for T
where T: ?Sized,

Source§

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

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