在开发 Web 服务的时候,我们可能会需要透过客户端的 IP 地址,来协助判断其所在的地区。一般来说,透过 HTTP 协定获取客户端 IP 的来源有三个地方,一个是 Socket 连接的 IP 地址,一个是 HTTP 请求中的 X-Real-IP 标头字段,一个是 HTTP 请求中的 X-Forwarded-For 标头字段。

为什么不能直接用 Socket 连接的 IP 地址?因为 HTTP 连接并不是单纯地一点对一点,客户端有可能会透过几个正向代理服务器(Proxy Server),经过一些我们架设的反向代理服务器(Reverse Proxy Server),才链接到我们的 Web 服务器。如果 Web 服务器中的 Web 应用程序是直接取用 Socket 连接的 IP 地址的话,就只会得到我们自己架设的反向代理服务器的 IP 地址。

代理服务器在转发 HTTP 请求时,可以替 HTTP 请求加上 X-Real-IP 标头字段,来保留客户端的真实 IP 地址信息,如此一来 Web 应用程序就可以借由读取 HTTP 请求中的 X-Real-IP 标头字段来获取客户端的真实 IP 地址。有些代理服务器,还会将自己的 IP 添加到 X-Forwarded-For 标头字段中,形成一个 IP 链,如下:

X-Forwarded-For: client_ip, proxy_1_ip, proxy_2_ip, proxy_3_ip

在实作 Rocket 的请求守卫时,request::Request 结构实体虽然有提供一些方法可以取得 Socket 连接的 IP 地址和 X-Real-IP 标头字段的 IP 地址,但由于过于低级,很难直接拿来做实务上的应用。

Client's IP Address Request Guard for Rocket Framework

「Client's IP Address Request Guard for Rocket Framework」是笔者开发出来的套件,提供两个请求守卫,可以正确取得客户端的 IP 地址,或是取得客户端的真实 IP 地址。

Crates.io

Cargo.toml

rocket-client-addr = "*"

使用方法

rocket_client_addr 这个 crate 提供的 ClientAddr 结构体可以当作请求守卫,能正确取得客户端的 IP 地址。如果有代理服务器,就会取得最后的代理服务器的 IP 地址,但会略过本地端的代理服务器。

以下是一个使用范例:

#[macro_use]
extern crate rocket;

use rocket_client_addr::ClientAddr;

#[get("/ipv4")]
fn ipv4(client_addr: &ClientAddr) -> String {
    client_addr.get_ipv4_string().unwrap()
}

#[get("/ipv6")]
fn ipv6(client_addr: &ClientAddr) -> String {
    client_addr.get_ipv6_string()
}

#[launch]
fn rocket() -> _ {
    rocket::build().mount("/", routes![ipv4]).mount("/", routes![ipv6])
}

rocket_client_addr 这个 crate 提供的 ClientRealAddr 结构体可以当作请求守卫,能正确取得客户端的真实 IP 地址。

以下是一个使用范例:

#[macro_use]
extern crate rocket;

use rocket_client_addr::ClientRealAddr;

#[get("/ipv4")]
fn ipv4(client_addr: &ClientRealAddr) -> String {
    client_addr.get_ipv4_string().unwrap()
}

#[get("/ipv6")]
fn ipv6(client_addr: &ClientRealAddr) -> String {
    client_addr.get_ipv6_string()
}

#[launch]
fn rocket() -> _ {
    rocket::build().mount("/", routes![ipv4]).mount("/", routes![ipv6])
}