Struct actix_ip_filter::IPFilter

pub struct IPFilter { /* fields omitted */ }

Middleware for filter IP of HTTP requests

Implementations

impl IPFilter

pub fn new() -> Self

Construct IPFilter middleware with no arguments

pub fn new_with_opts(
    allowlist: Vec<&str>,
    blocklist: Vec<&str>,
    use_x_real_ip: bool
) -> Self

Construct IPFilter middleware with the provided arguments and no limiting pattern.

pub fn new_with_opts_limited(
    allowlist: Vec<&str>,
    blocklist: Vec<&str>,
    limitlist: Vec<&str>,
    use_x_real_ip: bool
) -> Self

Construct IPFilter middleware with the provided arguments and limiting patterns.

pub fn x_real_ip(self, enabled: bool) -> Self

Use X-REAL-IP header to check IP if it is found in request.

pub fn allow(self, allowlist: Vec<&str>) -> Self

Set allow IP list, it supported glob pattern. It will allow all if vec is empty.

Example

let middleware = IPFilter::new()
    .allow(vec!["127.??.6*.12", "!1.2.*.4'"]);

pub fn block(self, blocklist: Vec<&str>) -> Self

Set block IP list, it supported glob pattern.

Example

let middleware = IPFilter::new()
    .block(vec!["127.??.6*.12", "!1.2.*.4'"]);

pub fn limit_to(self, limitlist: Vec<&str>) -> Self

Set endpoint limit list, supporting glob pattern.

Example

let middleware = IPFilter::new()
    .limit_to(vec!["/path/to/protected/resource*", "/protected/file/type/*.csv"]);

pub fn on_allow(
    self,
    handler: fn(_: &Self, _: &str, _: &ServiceRequest)
) -> Self

Add allow handler.

Example

fn my_custom_handler(filter: &IPFilter, ip: &str, req: &ServiceRequest) {
    // Do smth
}

let middleware = IPFilter::new()
    .on_allow(my_custom_handler);

pub fn on_block(
    self,
    handler: fn(_: &Self, _: &str, _: &ServiceRequest) -> Option<HttpResponse>
) -> Self

Add block handler.

Example

use actix_web::error::ErrorForbidden;
use actix_web::HttpResponse;

fn my_custom_handler(filter: &IPFilter, ip: &str, req: &ServiceRequest) -> Option<HttpResponse> {
    Some(HttpResponse::Forbidden().body("My custom forbidden message!"))
}

let middleware = IPFilter::new()
    .on_block(my_custom_handler);

Trait Implementations

impl Default for IPFilter

fn default() -> Self

Returns the “default value” for a type.

impl<S, B> Transform<S, ServiceRequest> for IPFilter where
    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
    S::Future: 'static,
    B: MessageBody + 'static, 

type Response = ServiceResponse<EitherBody<B>>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = IPFilterMiddleware<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