#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

#11 in #client-ip

Download history 47/week @ 2024-03-14 128/week @ 2024-03-21 99/week @ 2024-03-28 205/week @ 2024-04-04 148/week @ 2024-04-11 113/week @ 2024-04-18 67/week @ 2024-04-25 74/week @ 2024-05-02 187/week @ 2024-05-09 175/week @ 2024-05-16 228/week @ 2024-05-23 119/week @ 2024-05-30 181/week @ 2024-06-06 187/week @ 2024-06-13 196/week @ 2024-06-20 224/week @ 2024-06-27

793 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

~14–28MB
~463K SLoC