#client-ip #remote #ip-address #extractor #tiny #header #real

actix-remote-ip

Tiny extractor to get real client IP address, parsing X-Forwarded-For header

2 releases

0.1.0 Apr 29, 2023

#8 in #client-ip

Download history 134/week @ 2024-11-24 295/week @ 2024-12-01 269/week @ 2024-12-08 244/week @ 2024-12-15 102/week @ 2024-12-22 91/week @ 2024-12-29 198/week @ 2025-01-05 75/week @ 2025-01-12 137/week @ 2025-01-19 68/week @ 2025-01-26 106/week @ 2025-02-02 10/week @ 2025-02-09 46/week @ 2025-02-16 35/week @ 2025-02-23 93/week @ 2025-03-02 159/week @ 2025-03-09

333 downloads per month

GPL-2.0-or-later

10KB
187 lines

Actix Remote IP extractor

Build Status Crate

Tiny extractor of remote user IP address, that handles reverse proxy.

The X-Forwarded-For header is automatically parsed when the request comes from a defined proxy, to determine the real remote client IP Address.

Note : regarding IPv6 addresses, the local part of the address is discarded. For example, the IPv6 client 2001:0db8:85a3:0000:0000:8a2e:0370:7334 will be returned as 2001:0db8:85a3:0000:0000:0000:0000:0000

Configuration

Configure it when you configure your Actix server:

HttpServer::new(move || {
    App::new()
        .app_data(web::Data::new(RemoteIPConfig {
            proxy: Some("IP".to_string())
        }))
    // ...
})

Usage

In your route, add a RemoteIP parameter:

#[get("/")]
async fn home(remote_ip: RemoteIP) -> HttpResponse {
    let ip: IpAddr = remote_ip.0;
    // ...
}

Dependencies

~15–26MB
~448K SLoC