Tiny crate to determine real client IP address on Actix
Go to file
Pierre Hubert e38483eb56
continuous-integration/drone/push Build is passing Details
Merge pull request 'Update Rust crate futures-util to 0.3.30' (#7) from renovate/futures-util-0.x into master
Reviewed-on: #7
2024-03-25 09:50:35 +00:00
src Add base code (#1) 2023-04-29 09:00:57 +00:00
.drone.yml Add base code (#1) 2023-04-29 09:00:57 +00:00
.gitignore Initial commit 2023-04-29 10:06:53 +02:00
Cargo.lock Update Rust crate futures-util to 0.3.30 2024-03-23 00:22:05 +00:00
Cargo.toml Update Rust crate futures-util to 0.3.30 2024-03-23 00:22:05 +00:00
README.md Add base code (#1) 2023-04-29 09:00:57 +00:00
renovate.json Configure Renovate (#2) 2023-05-01 11:41:13 +00:00

README.md

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;
    // ...
}