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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
"""Tests for the validators module."""
import pytest
import rfc3986
from rfc3986 import exceptions
from rfc3986 import validators
def test_defaults():
"""Verify the default Validator settings."""
validator = validators.Validator()
assert validator.required_components == {
c: False for c in validator.COMPONENT_NAMES
}
assert validator.allow_password is True
assert validator.allowed_schemes == set()
assert validator.allowed_hosts == set()
assert validator.allowed_ports == set()
def test_allowing_schemes():
"""Verify the ability to select schemes to be allowed."""
validator = validators.Validator().allow_schemes("http", "https")
assert "http" in validator.allowed_schemes
assert "https" in validator.allowed_schemes
def test_allowing_hosts():
"""Verify the ability to select hosts to be allowed."""
validator = validators.Validator().allow_hosts(
"pypi.python.org",
"pypi.org",
)
assert "pypi.python.org" in validator.allowed_hosts
assert "pypi.org" in validator.allowed_hosts
def test_allowing_ports():
"""Verify the ability select ports to be allowed."""
validator = validators.Validator().allow_ports("80", "100")
assert "80" in validator.allowed_ports
assert "100" in validator.allowed_ports
def test_requiring_invalid_component():
"""Verify that we validate required component names."""
with pytest.raises(ValueError):
validators.Validator().require_presence_of("frob")
def test_checking_validity_of_component():
"""Verify that we validate components we're validating."""
with pytest.raises(ValueError):
validators.Validator().check_validity_of("frob")
def test_use_of_password():
"""Verify the behaviour of {forbid,allow}_use_of_password."""
validator = validators.Validator()
assert validator.allow_password is True
validator.forbid_use_of_password()
assert validator.allow_password is False
validator.allow_use_of_password()
assert validator.allow_password is True
@pytest.mark.parametrize(
"uri",
[
rfc3986.uri_reference("https://user:password@github.com"),
rfc3986.uri_reference("https://user:password@github.com/path"),
rfc3986.uri_reference("https://user:password@github.com/path?query"),
rfc3986.uri_reference(
"https://user:password@github.com/path?query#frag"
),
rfc3986.uri_reference("//user:password@github.com"),
],
)
def test_forbidden_passwords(uri):
"""Verify that passwords are disallowed."""
validator = validators.Validator().forbid_use_of_password()
with pytest.raises(exceptions.PasswordForbidden):
validator.validate(uri)
@pytest.mark.parametrize(
"uri",
[
rfc3986.uri_reference("https://user@github.com"),
rfc3986.uri_reference("https://user@github.com/path"),
rfc3986.uri_reference("https://user@github.com/path?query"),
rfc3986.uri_reference("https://user@github.com/path?query#frag"),
rfc3986.uri_reference("//user@github.com"),
rfc3986.uri_reference("//github.com"),
rfc3986.uri_reference("https://github.com"),
],
)
def test_passwordless_uris_pass_validation(uri):
"""Verify password-less URLs validate properly."""
validator = validators.Validator().forbid_use_of_password()
validator.validate(uri)
@pytest.mark.parametrize(
"uri",
[
rfc3986.uri_reference("https://"),
rfc3986.uri_reference("/path/to/resource"),
],
)
def test_missing_host_component(uri):
"""Verify that missing host components cause errors."""
validators.Validator().validate(uri)
validator = validators.Validator().require_presence_of("host")
with pytest.raises(exceptions.MissingComponentError):
validator.validate(uri)
@pytest.mark.parametrize(
"uri",
[
rfc3986.uri_reference("https://"),
rfc3986.uri_reference("//google.com"),
rfc3986.uri_reference("//google.com?query=value"),
rfc3986.uri_reference("//google.com#fragment"),
rfc3986.uri_reference("https://google.com"),
rfc3986.uri_reference("https://google.com#fragment"),
rfc3986.uri_reference("https://google.com?query=value"),
],
)
def test_missing_path_component(uri):
"""Verify that missing path components cause errors."""
validator = validators.Validator().require_presence_of("path")
with pytest.raises(exceptions.MissingComponentError):
validator.validate(uri)
@pytest.mark.parametrize(
"uri",
[
rfc3986.uri_reference("//google.com"),
rfc3986.uri_reference("//google.com?query=value"),
rfc3986.uri_reference("//google.com#fragment"),
],
)
def test_multiple_missing_components(uri):
"""Verify that multiple missing components are caught."""
validator = validators.Validator().require_presence_of("scheme", "path")
with pytest.raises(exceptions.MissingComponentError) as captured_exc:
validator.validate(uri)
exception = captured_exc.value
assert 2 == len(exception.args[-1])
@pytest.mark.parametrize(
"uri",
[
rfc3986.uri_reference("smtp://"),
rfc3986.uri_reference("telnet://"),
],
)
def test_ensure_uri_has_a_scheme(uri):
"""Verify validation with allowed schemes."""
validator = validators.Validator().allow_schemes("https", "http")
with pytest.raises(exceptions.UnpermittedComponentError):
validator.validate(uri)
@pytest.mark.parametrize(
"uri, failed_component",
[
(rfc3986.uri_reference("git://github.com"), "scheme"),
(rfc3986.uri_reference("http://github.com"), "scheme"),
(rfc3986.uri_reference("ssh://gitlab.com"), "host"),
(rfc3986.uri_reference("https://gitlab.com"), "host"),
],
)
def test_allowed_hosts_and_schemes(uri, failed_component):
"""Verify each of these fails."""
validator = (
validators.Validator()
.allow_schemes(
"https",
"ssh",
)
.allow_hosts(
"github.com",
"git.openstack.org",
)
)
with pytest.raises(exceptions.UnpermittedComponentError) as caught_exc:
validator.validate(uri)
exc = caught_exc.value
assert exc.component_name == failed_component
@pytest.mark.parametrize(
"uri",
[
rfc3986.uri_reference("https://github.com/sigmavirus24"),
rfc3986.uri_reference("ssh://github.com/sigmavirus24"),
rfc3986.uri_reference("ssh://ssh@github.com:22/sigmavirus24"),
rfc3986.uri_reference("https://github.com:443/sigmavirus24"),
rfc3986.uri_reference("https://gitlab.com/sigmavirus24"),
rfc3986.uri_reference("ssh://gitlab.com/sigmavirus24"),
rfc3986.uri_reference("ssh://ssh@gitlab.com:22/sigmavirus24"),
rfc3986.uri_reference("https://gitlab.com:443/sigmavirus24"),
rfc3986.uri_reference("https://bitbucket.org/sigmavirus24"),
rfc3986.uri_reference("ssh://bitbucket.org/sigmavirus24"),
rfc3986.uri_reference("ssh://ssh@bitbucket.org:22/sigmavirus24"),
rfc3986.uri_reference("https://bitbucket.org:443/sigmavirus24"),
rfc3986.uri_reference("https://git.openstack.org/sigmavirus24"),
rfc3986.uri_reference("ssh://git.openstack.org/sigmavirus24"),
rfc3986.uri_reference("ssh://ssh@git.openstack.org:22/sigmavirus24"),
rfc3986.uri_reference("https://git.openstack.org:443/sigmavirus24"),
rfc3986.uri_reference(
"ssh://ssh@git.openstack.org:22/sigmavirus24?foo=bar#fragment"
),
rfc3986.uri_reference(
"ssh://git.openstack.org:22/sigmavirus24?foo=bar#fragment"
),
rfc3986.uri_reference("ssh://git.openstack.org:22/?foo=bar#fragment"),
rfc3986.uri_reference(
"ssh://git.openstack.org:22/sigmavirus24#fragment"
),
rfc3986.uri_reference("ssh://git.openstack.org:22/#fragment"),
rfc3986.uri_reference("ssh://git.openstack.org:22/"),
rfc3986.uri_reference(
"ssh://ssh@git.openstack.org:22/?foo=bar#fragment"
),
rfc3986.uri_reference(
"ssh://ssh@git.openstack.org:22/sigmavirus24#fragment"
),
rfc3986.uri_reference("ssh://ssh@git.openstack.org:22/#fragment"),
rfc3986.uri_reference("ssh://ssh@git.openstack.org:22/"),
],
)
def test_successful_complex_validation(uri):
"""Verify we do not raise ValidationErrors for good URIs."""
validators.Validator().allow_schemes("https", "ssh",).allow_hosts(
"github.com",
"bitbucket.org",
"gitlab.com",
"git.openstack.org",
).allow_ports("22", "443",).require_presence_of(
"scheme",
"host",
"path",
).check_validity_of(
"scheme",
"userinfo",
"host",
"port",
"path",
"query",
"fragment",
).validate(
uri
)
def test_invalid_uri_generates_error(invalid_uri):
"""Verify we catch invalid URIs."""
uri = rfc3986.uri_reference(invalid_uri)
with pytest.raises(exceptions.InvalidComponentsError):
validators.Validator().check_validity_of("host").validate(uri)
def test_invalid_uri_with_invalid_path(invalid_uri):
"""Verify we catch multiple invalid components."""
uri = rfc3986.uri_reference(invalid_uri)
uri = uri.copy_with(path="#foobar")
with pytest.raises(exceptions.InvalidComponentsError):
validators.Validator().check_validity_of(
"host",
"path",
).validate(uri)
def test_validating_rfc_4007_ipv6_zone_ids():
"""Verify that RFC 4007 IPv6 Zone IDs are invalid
host/authority but after normalization are valid
"""
uri = rfc3986.uri_reference("http://[::1%eth0]")
with pytest.raises(exceptions.InvalidComponentsError):
validators.Validator().check_validity_of("host").validate(uri)
uri = uri.normalize()
assert uri.host == "[::1%25eth0]"
validators.Validator().check_validity_of("host").validate(uri)
|
