Struct http_signature_normalization_actix::middleware::VerifySignature

pub struct VerifySignature<T>(_, _, _, _);

The Verify signature middleware

let middleware = VerifySignature::new(MyVerifier::new(), Config::default())
    .authorization()
    .optional();

HttpServer::new(move || {
    App::new()
        .wrap(middleware.clone())
        .route("/protected", web::post().to(|_: SignatureVerified| "Verified Authorization Header"))
        .route("/unprotected", web::post().to(|| "No verification required"))
})

Implementations

impl<T> VerifySignature<T> where
    T: SignatureVerify, 

pub fn new(verify_signature: T, config: Config) -> Self

Create a new middleware for verifying HTTP Signatures. A type implementing SignatureVerify is required, as well as a Config

By default, this middleware expects to verify Signature headers, and requires the presence of the header

pub fn authorization(self) -> Self

Verify Authorization headers instead of Signature headers

pub fn optional(self) -> Self

Mark the presence of a Signature or Authorization header as optional

If a header is present, it will be verified, but if there is not one present, the request is passed through. This can be used to set a global middleware, and then guard each route handler with the SignatureVerified type.

Trait Implementations

impl<T: Clone> Clone for VerifySignature<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for VerifySignature<T>

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

Formats the value using the given formatter.

impl<T, S, B> Transform<S, ServiceRequest> for VerifySignature<T> where
    T: SignatureVerify + Clone + 'static,
    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
    S::Error: 'static,
    B: MessageBody + 'static, 

type Response = ServiceResponse<B>

Responses given by the service.

type Error = Error

Errors produced by the service.

type Transform = VerifyMiddleware<T, S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<Self::Transform, Self::InitError>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

pub fn map_init_err<F, E>(self, f: F) -> TransformMapInitErr<Self, S, Req, F, E> where
    F: Fn(Self::InitError) -> E + Clone, 

Map this transform's factory error to a different error, returning a new transform service factory.