Get the "real ip" of an incoming request
  • Rust 95.5%
  • Nix 4.5%
Find a file
2024-11-29 19:08:10 +01:00
.github/workflows init 2024-11-27 20:15:01 +01:00
src switch to taking a HeaderMap instead of Request 2024-11-29 19:08:10 +01:00
.envrc init 2024-11-27 20:15:01 +01:00
.gitignore init 2024-11-27 20:15:01 +01:00
Cargo.lock misc 2024-11-28 22:33:31 +01:00
Cargo.toml misc 2024-11-28 22:33:31 +01:00
flake.lock init 2024-11-27 20:15:01 +01:00
flake.nix readme 2024-11-29 18:58:08 +01:00
README.md switch to taking a HeaderMap instead of Request 2024-11-29 19:08:10 +01:00

real-ip

Get the "real-ip" of an incoming request using the "forwarded", "x-forwarded-for" or "x-real-ip" headers set by reverse proxies.

See the crate documentation for more details and examples.

Example

use http::Request;
use std::net::IpAddr;
use ipnetwork::IpNetwork;
use real_ip::real_ip;

// in a real program this info would of course come from the http server
let incoming_ip = IpAddr::from([10, 0, 0, 1]);
let request = Request::builder().header("x-forwarded-for", "192.0.2.1").body(()).unwrap();

// the reverse-proxies in our network that we trust
let trusted_proxies = [
    IpAddr::from([10, 0, 0, 1]).into(),
];
let client_ip = real_ip(request.headers(), incoming_ip, &trusted_proxies);
assert_eq!(Some(IpAddr::from([192, 0, 2, 1])), client_ip);