http-ip 0.1.8

Utilities to determine HTTP client IP
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

use http_ip::tonic014::{MetadataMap, MetadataMapClientIp};
use http_ip::filter::{self, Cidr};

use core::net::IpAddr;

const FORWARDED: &str = "forwarded";
const X_FORWARDED_FOR: &str = "x-forwarded-for";

#[test]
fn should_format_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(FORWARDED, "By=\"[2001:db8:cafe::17]:4711\",For=127.0.0.1".parse().unwrap());
    headers.append(FORWARDED, "For=unknown,For=_hidden".parse().unwrap());
    //x-forwarded-for is not used when Forwarded is present
    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let display = headers.get_header_value_fmt(FORWARDED).to_string();
    assert_eq!(display, "By=\"[2001:db8:cafe::17]:4711\",For=127.0.0.1 ,For=unknown,For=_hidden");
}

#[test]
fn should_extract_left_most_ip_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(FORWARDED, "By=\"[2001:db8:cafe::17]:4711\",For=127.0.0.1".parse().unwrap());
    headers.append(FORWARDED, "For=unknown,For=_hidden".parse().unwrap());
    //x-forwarded-for is not used when Forwarded is present
    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let ip = headers.extract_leftmost_forwarded_ip().expect("to have IP");
    let expected_ip: IpAddr = "127.0.0.1".parse().unwrap();
    assert_eq!(expected_ip, ip);
}

#[test]
fn should_not_extract_left_most_ip_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(FORWARDED, "By=\"[2001:db8:cafe::17]:4711\",For=_hidden".parse().unwrap());
    headers.append(FORWARDED, "For=unknown,For=127.0.0.1".parse().unwrap());
    //x-forwarded-for is not used when Forwarded is present
    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let result = headers.extract_leftmost_forwarded_ip();
    assert!(result.is_none(), "Unexpected IP={:?}", result);
}

#[test]
fn should_extract_x_left_most_ip_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let ip = headers.extract_leftmost_forwarded_ip().expect("to have IP");
    let expected_ip: IpAddr = "203.0.113.195".parse().unwrap();
    assert_eq!(expected_ip, ip);
}

#[test]
fn should_extract_right_most_ip_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(FORWARDED, "By=\"[2001:db8:cafe::17]:4711\",For=_hidden".parse().unwrap());
    headers.append(FORWARDED, "For=unknown,For=127.0.0.1".parse().unwrap());
    //x-forwarded-for is not used when Forwarded is present
    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let ip = headers.extract_rightmost_forwarded_ip().expect("to have IP");
    let expected_ip: IpAddr = "127.0.0.1".parse().unwrap();
    assert_eq!(expected_ip, ip);
}

#[test]
fn should_not_extract_right_most_ip_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(FORWARDED, "By=\"[2001:db8:cafe::17]:4711\",For=127.0.0.1".parse().unwrap());
    headers.append(FORWARDED, "For=unknown,For=_hidden".parse().unwrap());
    //x-forwarded-for is not used when Forwarded is present
    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let result = headers.extract_rightmost_forwarded_ip();
    assert!(result.is_none(), "Unexpected IP={:?}", result);
}

#[test]
fn should_extract_x_right_most_ip_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let ip = headers.extract_rightmost_forwarded_ip().expect("to have IP");
    let expected_ip: IpAddr = "198.51.100.178".parse().unwrap();
    assert_eq!(expected_ip, ip);
}

#[test]
fn should_extract_filtered_by_ip_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(FORWARDED, "By=\"[2001:db8:cafe::17]:4711\",For=127.0.0.1".parse().unwrap());
    headers.append(FORWARDED, "For=192.168.0.1,For=10.0.0.1".parse().unwrap());
    //x-forwarded-for is not used when Forwarded is present
    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let filtered_ip: IpAddr = "10.0.0.1".parse().unwrap();
    let expected_ip: IpAddr = "192.168.0.1".parse().unwrap();
    let result = headers.extract_filtered_forwarded_ip(&filtered_ip).expect("to get ip");
    assert_eq!(result, expected_ip);
}

#[test]
fn should_extract_x_filtered_by_ip_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(X_FORWARDED_FOR, "127.0.0.1".parse().unwrap());
    headers.append(X_FORWARDED_FOR, "192.168.0.1,10.0.0.1".parse().unwrap());

    let filtered_ip: IpAddr = "10.0.0.1".parse().unwrap();
    let expected_ip: IpAddr = "192.168.0.1".parse().unwrap();
    let result = headers.extract_filtered_forwarded_ip(&filtered_ip).expect("to get ip");
    assert_eq!(result, expected_ip);
}

#[test]
fn should_extract_filtered_by_cidr_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(FORWARDED, "By=\"[2001:db8:cafe::17]:4711\",For=127.0.0.1".parse().unwrap());
    headers.append(FORWARDED, "For=192.168.0.1,For=10.0.0.1".parse().unwrap());
    //x-forwarded-for is not used when Forwarded is present
    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let filtered_ip = Cidr::from_text("10.0.0.0/31").expect("to parse");
    let expected_ip: IpAddr = "192.168.0.1".parse().unwrap();
    let result = headers.extract_filtered_forwarded_ip(&filtered_ip).expect("to get ip");
    assert_eq!(result, expected_ip);

    let filtered_ip = Cidr::from_text("10.0.0.0/1").expect("to parse");
    let expected_ip: IpAddr = "192.168.0.1".parse().unwrap();
    let result = headers.extract_filtered_forwarded_ip(&filtered_ip).expect("to get ip");
    assert_eq!(result, expected_ip);
}

#[test]
fn should_not_extract_filtered_by_cidr_from_header_map() {
    let mut headers = MetadataMap::new();

    headers.append(FORWARDED, "By=\"[2001:db8:cafe::17]:4711\",For=127.0.0.1".parse().unwrap());
    headers.append(FORWARDED, "For=192.168.0.1,For=10.0.0.1".parse().unwrap());
    //x-forwarded-for is not used when Forwarded is present
    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let filtered_ip = Cidr::from_text("10.0.0.0/32").expect("to parse");
    let expected_ip: IpAddr = "10.0.0.1".parse().unwrap();
    let result = headers.extract_filtered_forwarded_ip(&filtered_ip).expect("to get ip");
    assert_eq!(result, expected_ip);

    let filtered_ip = Cidr::from_text("10.0.0.0/24").expect("to parse");
    let expected_ip: IpAddr = "192.168.0.1".parse().unwrap();
    let result = headers.extract_filtered_forwarded_ip(&filtered_ip).expect("to get ip");
    assert_eq!(result, expected_ip);

    let filtered_ip = Cidr::from_text("10.0.0.0/24").expect("to parse");
    let expected_ip: IpAddr = "127.0.0.1".parse().unwrap();
    let result = headers.extract_filtered_forwarded_ip_after(2, &filtered_ip).expect("to get ip");
    assert_eq!(result, expected_ip);
}

#[test]
fn should_extract_filtered_by_cidr_from_header_map_with_or() {
    let mut headers = MetadataMap::new();

    headers.append(FORWARDED, "By=\"[2001:db8:cafe::17]:4711\",For=127.0.0.1".parse().unwrap());
    headers.append(FORWARDED, "For=192.168.0.1,For=10.0.0.1".parse().unwrap());
    //x-forwarded-for is not used when Forwarded is present
    headers.append(X_FORWARDED_FOR, "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,198.51.100.178".parse().unwrap());

    let filtered_ip = Cidr::from_text("10.0.0.0/32").expect("to parse");
    let filtered_ip2: IpAddr = "10.0.0.1".parse().expect("to parse");
    let filter = filter::or(filtered_ip, filtered_ip2);
    let expected_ip: IpAddr = "192.168.0.1".parse().unwrap();
    let result = headers.extract_filtered_forwarded_ip(&filter).expect("to get ip");
    assert_eq!(result, expected_ip);
}