summaryrefslogtreecommitdiffhomepage
path: root/test/test_forwarded_header.py
blob: c3f4a4c6414c21186c994a4cc304d39fc6ba5a87 (plain) (blame)
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
import pytest
from unit.applications.lang.python import ApplicationPython

prerequisites = {'modules': {'python': 'any'}}

client = ApplicationPython()


@pytest.fixture(autouse=True)
def setup_method_fixture():
    client.load('forwarded_header')


def forwarded_header(forwarded):
    assert 'success' in client.conf(
        {
            "127.0.0.1:7081": {
                "forwarded": forwarded,
                "pass": "applications/forwarded_header",
            },
            "[::1]:7082": {
                "forwarded": forwarded,
                "pass": "applications/forwarded_header",
            },
        },
        'listeners',
    ), 'listeners configure'


def get_fwd(sock_type='ipv4', xff=None, xfp=None):
    port = 7081 if sock_type == 'ipv4' else 7082

    headers = {'Connection': 'close'}

    if xff is not None:
        headers['X-Forwarded-For'] = xff

    if xfp is not None:
        headers['X-Forwarded-Proto'] = xfp

    return client.get(sock_type=sock_type, port=port, headers=headers)[
        'headers'
    ]


def get_addr(*args, **kwargs):
    return get_fwd(*args, **kwargs)['Remote-Addr']


def get_scheme(*args, **kwargs):
    return get_fwd(*args, **kwargs)['Url-Scheme']


def test_forwarded_header_single_ip():
    forwarded_header(
        {
            'client_ip': 'X-Forwarded-For',
            'protocol': 'X-Forwarded-Proto',
            'source': '123.123.123.123',
        }
    )

    resp = get_fwd(xff='1.1.1.1', xfp='https')
    assert resp['Remote-Addr'] == '127.0.0.1', 'both headers addr'
    assert resp['Url-Scheme'] == 'http', 'both headers proto'

    assert get_addr() == '127.0.0.1', 'ipv4 default addr'
    assert get_addr('ipv6') == '::1', 'ipv6 default addr'
    assert get_addr(xff='1.1.1.1') == '127.0.0.1', 'bad source'
    assert get_addr(xff='blah') == '127.0.0.1', 'bad xff'
    assert get_addr('ipv6', '1.1.1.1') == '::1', 'bad source ipv6'

    assert get_scheme() == 'http', 'ipv4 default proto'
    assert get_scheme('ipv6') == 'http', 'ipv6 default proto'
    assert get_scheme(xfp='https') == 'http', 'bad proto'
    assert get_scheme(xfp='blah') == 'http', 'bad xfp'
    assert get_scheme('ipv6', xfp='https') == 'http', 'bad proto ipv6'

    forwarded_header(
        {
            'client_ip': 'X-Forwarded-For',
            'protocol': 'X-Forwarded-Proto',
            'source': '127.0.0.1',
        }
    )

    resp = get_fwd(xff='1.1.1.1', xfp='https')
    assert resp['Remote-Addr'] == '1.1.1.1', 'both headers addr 2'
    assert resp['Url-Scheme'] == 'https', 'both headers proto 2'

    assert get_addr() == '127.0.0.1', 'ipv4 default addr 2'
    assert get_addr('ipv6') == '::1', 'ipv6 default addr 2'
    assert get_addr(xff='1.1.1.1') == '1.1.1.1', 'xff replace'
    assert get_addr('ipv6', '1.1.1.1') == '::1', 'bad source ipv6 2'

    assert get_scheme() == 'http', 'ipv4 default proto 2'
    assert get_scheme('ipv6') == 'http', 'ipv6 default proto 2'
    assert get_scheme(xfp='https') == 'https', 'xfp replace'
    assert get_scheme(xfp='on') == 'https', 'xfp replace 2'
    assert get_scheme('ipv6', xfp='https') == 'http', 'bad proto ipv6 2'

    forwarded_header(
        {
            'client_ip': 'X-Forwarded-For',
            'protocol': 'X-Forwarded-Proto',
            'source': '!127.0.0.1',
        }
    )

    assert get_addr(xff='1.1.1.1') == '127.0.0.1', 'bad source 3'
    assert get_addr('ipv6', '1.1.1.1') == '1.1.1.1', 'xff replace 2'
    assert get_scheme(xfp='https') == 'http', 'bad proto 2'
    assert get_scheme('ipv6', xfp='https') == 'https', 'xfp replace 3'


def test_forwarded_header_ipv4():
    forwarded_header(
        {
            'client_ip': 'X-Forwarded-For',
            'protocol': 'X-Forwarded-Proto',
            'source': '127.0.0.1',
        }
    )

    assert get_addr(xff='8.8.8.8, 84.23.23.11') == '84.23.23.11', 'xff replace'
    assert (
        get_addr(xff='8.8.8.8, 84.23.23.11, 127.0.0.1') == '127.0.0.1'
    ), 'xff replace 2'
    assert (
        get_addr(xff=['8.8.8.8', '127.0.0.1, 10.0.1.1']) == '10.0.1.1'
    ), 'xff replace multi'

    assert get_scheme(xfp='http, https') == 'http', 'xfp replace'
    assert get_scheme(xfp='http, https, http') == 'http', 'xfp replace 2'
    assert (
        get_scheme(xfp=['http, https', 'http', 'https']) == 'http'
    ), 'xfp replace multi'


def test_forwarded_header_ipv6():
    forwarded_header(
        {
            'client_ip': 'X-Forwarded-For',
            'protocol': 'X-Forwarded-Proto',
            'source': '::1',
        }
    )

    assert get_addr(xff='1.1.1.1') == '127.0.0.1', 'bad source ipv4'

    for ip in [
        'f607:7403:1e4b:6c66:33b2:843f:2517:da27',
        '2001:db8:3c4d:15::1a2f:1a2b',
        '2001::3c4d:15:1a2f:1a2b',
        '::11.22.33.44',
    ]:
        assert get_addr('ipv6', ip) == ip, 'replace'

    assert get_scheme(xfp='https') == 'http', 'bad source ipv4'

    for proto in ['http', 'https']:
        assert get_scheme('ipv6', xfp=proto) == proto, 'replace'


def test_forwarded_header_recursive():
    forwarded_header(
        {
            'client_ip': 'X-Forwarded-For',
            'recursive': True,
            'source': ['127.0.0.1', '10.50.0.17', '10.5.2.1'],
        }
    )

    assert get_addr(xff='1.1.1.1') == '1.1.1.1', 'xff chain'
    assert get_addr(xff='1.1.1.1, 10.5.2.1') == '1.1.1.1', 'xff chain 2'
    assert (
        get_addr(xff='8.8.8.8, 1.1.1.1, 10.5.2.1') == '1.1.1.1'
    ), 'xff chain 3'
    assert (
        get_addr(xff='10.50.0.17, 10.5.2.1, 10.5.2.1') == '10.50.0.17'
    ), 'xff chain 4'
    assert (
        get_addr(xff=['8.8.8.8', '1.1.1.1, 127.0.0.1']) == '1.1.1.1'
    ), 'xff replace multi'
    assert (
        get_addr(xff=['8.8.8.8', '1.1.1.1, 127.0.0.1', '10.5.2.1']) == '1.1.1.1'
    ), 'xff replace multi 2'
    assert (
        get_addr(xff=['10.5.2.1', '10.50.0.17, 1.1.1.1', '10.5.2.1'])
        == '1.1.1.1'
    ), 'xff replace multi 3'
    assert (
        get_addr(xff='8.8.8.8, 2001:db8:3c4d:15::1a2f:1a2b, 127.0.0.1')
        == '2001:db8:3c4d:15::1a2f:1a2b'
    ), 'xff chain ipv6'


def test_forwarded_header_case_insensitive():
    forwarded_header(
        {
            'client_ip': 'x-forwarded-for',
            'protocol': 'x-forwarded-proto',
            'source': '127.0.0.1',
        }
    )

    assert get_addr() == '127.0.0.1', 'ipv4 default addr'
    assert get_addr('ipv6') == '::1', 'ipv6 default addr'
    assert get_addr(xff='1.1.1.1') == '1.1.1.1', 'replace'

    assert get_scheme() == 'http', 'ipv4 default proto'
    assert get_scheme('ipv6') == 'http', 'ipv6 default proto'
    assert get_scheme(xfp='https') == 'https', 'replace 1'
    assert get_scheme(xfp='oN') == 'https', 'replace 2'


def test_forwarded_header_source_empty():
    forwarded_header(
        {
            'client_ip': 'X-Forwarded-For',
            'protocol': 'X-Forwarded-Proto',
            'source': [],
        }
    )

    assert get_addr(xff='1.1.1.1') == '127.0.0.1', 'empty source xff'
    assert get_scheme(xfp='https') == 'http', 'empty source xfp'


def test_forwarded_header_source_range():
    forwarded_header(
        {
            'client_ip': 'X-Forwarded-For',
            'protocol': 'X-Forwarded-Proto',
            'source': '127.0.0.0-127.0.0.1',
        }
    )

    assert get_addr(xff='1.1.1.1') == '1.1.1.1', 'source range'
    assert get_addr('ipv6', '1.1.1.1') == '::1', 'source range 2'


def test_forwarded_header_invalid():
    assert 'error' in client.conf(
        {
            "127.0.0.1:7081": {
                "forwarded": {"source": '127.0.0.1'},
                "pass": "applications/forwarded_header",
            }
        },
        'listeners',
    ), 'invalid forward'

    def check_invalid_source(source):
        assert 'error' in client.conf(
            {
                "127.0.0.1:7081": {
                    "forwarded": {
                        "client_ip": "X-Forwarded-For",
                        "source": source,
                    },
                    "pass": "applications/forwarded_header",
                }
            },
            'listeners',
        ), 'invalid source'

    check_invalid_source(None)
    check_invalid_source('a')
    check_invalid_source(['a'])