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

actix-remote-ip

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

2 releases

0.1.0 Apr 29, 2023

#12 in #client-ip

Download history 23/week @ 2024-01-09 12/week @ 2024-01-16 9/week @ 2024-01-23 11/week @ 2024-01-30 20/week @ 2024-02-06 16/week @ 2024-02-13 49/week @ 2024-02-20 42/week @ 2024-02-27 28/week @ 2024-03-05 46/week @ 2024-03-12 87/week @ 2024-03-19 125/week @ 2024-03-26 179/week @ 2024-04-02 144/week @ 2024-04-09 143/week @ 2024-04-16 79/week @ 2024-04-23

561 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

~17–29MB
~525K SLoC