-
Notifications
You must be signed in to change notification settings - Fork 7
/
auth_logging_test.py
393 lines (360 loc) · 12 KB
/
auth_logging_test.py
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
"""Tests for logging in the /auth route."""
from __future__ import annotations
import base64
from unittest.mock import ANY
import pytest
from httpx import AsyncClient
from safir.datetime import format_datetime_for_logging
from gafaelfawr.factory import Factory
from gafaelfawr.models.token import Token
from ..support.constants import TEST_HOSTNAME
from ..support.logging import parse_log
from ..support.tokens import create_session_token
@pytest.mark.asyncio
async def test_success(
client: AsyncClient, factory: Factory, caplog: pytest.LogCaptureFixture
) -> None:
token_data = await create_session_token(factory, scopes=["exec:admin"])
# Successful request with X-Forwarded-For and a bearer token.
caplog.clear()
r = await client.get(
"/auth",
params={"scope": "exec:admin"},
headers={
"Authorization": f"Bearer {token_data.token}",
"X-Original-Uri": "/foo",
"X-Forwarded-For": "192.0.2.1",
},
)
assert r.status_code == 200
expected_log = {
"auth_uri": "/foo",
"event": "Token authorized",
"httpRequest": {
"requestMethod": "GET",
"requestUrl": f"https://{TEST_HOSTNAME}/auth?scope=exec%3Aadmin",
"remoteIp": "192.0.2.1",
},
"required_scopes": ["exec:admin"],
"satisfy": "all",
"scopes": ["exec:admin"],
"severity": "info",
"token": token_data.token.key,
"token_source": "bearer",
"user": token_data.username,
}
assert parse_log(caplog) == [expected_log]
# Successful request with HTTP Basic authentication in the username.
basic = f"{token_data.token}:x-oauth-basic".encode()
basic_b64 = base64.b64encode(basic).decode()
caplog.clear()
r = await client.get(
"/auth",
params={"scope": "exec:admin"},
headers={
"Authorization": f"Basic {basic_b64}",
"X-Original-Uri": "/foo",
"X-Forwarded-For": "192.0.2.1",
},
)
assert r.status_code == 200
expected_log["token_source"] = "basic-username"
assert parse_log(caplog) == [expected_log]
# The same with HTTP Basic in the password.
basic = f"x-oauth-basic:{token_data.token}".encode()
basic_b64 = base64.b64encode(basic).decode()
caplog.clear()
r = await client.get(
"/auth",
params={"scope": "exec:admin"},
headers={
"Authorization": f"Basic {basic_b64}",
"X-Original-Uri": "/foo",
"X-Forwarded-For": "192.0.2.1",
},
)
assert r.status_code == 200
expected_log["token_source"] = "basic-password"
assert parse_log(caplog) == [expected_log]
@pytest.mark.asyncio
async def test_authorization_failed(
client: AsyncClient, factory: Factory, caplog: pytest.LogCaptureFixture
) -> None:
token_data = await create_session_token(factory, scopes=["exec:admin"])
caplog.clear()
r = await client.get(
"/auth",
params={"scope": "exec:test", "satisfy": "any"},
headers={
"Authorization": f"Bearer {token_data.token}",
"X-Original-Uri": "/foo",
},
)
assert r.status_code == 403
assert parse_log(caplog) == [
{
"auth_uri": "/foo",
"error": "Token missing required scope",
"event": "Permission denied",
"httpRequest": {
"requestMethod": "GET",
"requestUrl": (
f"https://{TEST_HOSTNAME}/auth"
"?scope=exec%3Atest&satisfy=any"
),
"remoteIp": "127.0.0.1",
},
"required_scopes": ["exec:test"],
"satisfy": "any",
"scopes": ["exec:admin"],
"severity": "warning",
"token": token_data.token.key,
"token_source": "bearer",
"user": token_data.username,
}
]
@pytest.mark.asyncio
async def test_original_url(
client: AsyncClient, factory: Factory, caplog: pytest.LogCaptureFixture
) -> None:
token_data = await create_session_token(factory)
caplog.clear()
r = await client.get(
"/auth",
params={"scope": "exec:admin"},
headers={
"Authorization": f"bearer {token_data.token}",
"X-Original-Url": "https://example.com/test",
},
)
assert r.status_code == 403
expected_log = {
"auth_uri": "https://example.com/test",
"error": "Token missing required scope",
"event": "Permission denied",
"httpRequest": {
"requestMethod": "GET",
"requestUrl": f"https://{TEST_HOSTNAME}/auth?scope=exec%3Aadmin",
"remoteIp": "127.0.0.1",
},
"required_scopes": ["exec:admin"],
"satisfy": "all",
"scopes": ["user:token"],
"severity": "warning",
"token": token_data.token.key,
"token_source": "bearer",
"user": token_data.username,
}
assert parse_log(caplog) == [expected_log]
# Check with both X-Original-URI and X-Original-URL. The former should
# override the latter.
caplog.clear()
r = await client.get(
"/auth",
params={"scope": "exec:admin"},
headers={
"Authorization": f"bearer {token_data.token}",
"X-Original-URI": "/foo",
"X-Original-URL": "https://example.com/test",
},
)
assert r.status_code == 403
expected_log["auth_uri"] = "/foo"
assert parse_log(caplog) == [expected_log]
@pytest.mark.asyncio
async def test_chained_x_forwarded(
client: AsyncClient, factory: Factory, caplog: pytest.LogCaptureFixture
) -> None:
token_data = await create_session_token(factory)
caplog.clear()
r = await client.get(
"/auth",
params={"scope": "exec:admin"},
headers={
"Authorization": f"bearer {token_data.token}",
"X-Forwarded-For": "2001:db8:85a3:8d3:1319:8a2e:370:734, 10.0.0.1",
"X-Forwarded-Proto": "https, http",
"X-Original-Uri": "/foo",
},
)
assert r.status_code == 403
assert parse_log(caplog) == [
{
"auth_uri": "/foo",
"error": "Token missing required scope",
"event": "Permission denied",
"httpRequest": {
"requestMethod": "GET",
"requestUrl": (
f"https://{TEST_HOSTNAME}/auth?scope=exec%3Aadmin"
),
"remoteIp": "2001:db8:85a3:8d3:1319:8a2e:370:734",
},
"required_scopes": ["exec:admin"],
"satisfy": "all",
"scopes": ["user:token"],
"severity": "warning",
"token": token_data.token.key,
"token_source": "bearer",
"user": token_data.username,
}
]
@pytest.mark.asyncio
async def test_invalid_token(
client: AsyncClient, caplog: pytest.LogCaptureFixture
) -> None:
caplog.clear()
r = await client.get(
"/auth",
params={"scope": "exec:admin"},
headers={"Authorization": "Bearer blah"},
)
assert r.status_code == 401
assert parse_log(caplog) == [
{
"auth_uri": "NONE",
"error": "Token does not start with gt-",
"event": "Invalid token",
"httpRequest": {
"requestMethod": "GET",
"requestUrl": (
f"https://{TEST_HOSTNAME}/auth?scope=exec%3Aadmin"
),
"remoteIp": "127.0.0.1",
},
"required_scopes": ["exec:admin"],
"satisfy": "all",
"severity": "warning",
"token_source": "bearer",
}
]
@pytest.mark.asyncio
async def test_notebook(
client: AsyncClient, factory: Factory, caplog: pytest.LogCaptureFixture
) -> None:
token_data = await create_session_token(
factory, group_names=["admin"], scopes=["exec:admin", "read:all"]
)
assert token_data.expires
caplog.clear()
r = await client.get(
"/auth",
params={"scope": "exec:admin", "notebook": "true"},
headers={
"Authorization": f"Bearer {token_data.token}",
"X-Original-Uri": "/foo",
},
)
assert r.status_code == 200
notebook_token = Token.from_str(r.headers["X-Auth-Request-Token"])
assert parse_log(caplog) == [
{
"auth_uri": "/foo",
"event": "Token authorized",
"httpRequest": {
"requestMethod": "GET",
"requestUrl": ANY,
"remoteIp": "127.0.0.1",
},
"required_scopes": ["exec:admin"],
"satisfy": "all",
"scopes": ["exec:admin", "read:all"],
"severity": "info",
"token": token_data.token.key,
"token_source": "bearer",
"user": token_data.username,
},
{
"auth_uri": "/foo",
"event": "Created new notebook token",
"httpRequest": {
"requestMethod": "GET",
"requestUrl": ANY,
"remoteIp": "127.0.0.1",
},
"required_scopes": ["exec:admin"],
"satisfy": "all",
"scopes": ["exec:admin", "read:all"],
"severity": "info",
"token": token_data.token.key,
"token_key": notebook_token.key,
"token_expires": format_datetime_for_logging(token_data.expires),
"token_source": "bearer",
"token_userinfo": {
"email": token_data.email,
"name": token_data.name,
"uid": token_data.uid,
"gid": token_data.gid,
"groups": [{"id": 1000, "name": "admin"}],
},
"user": token_data.username,
},
]
@pytest.mark.asyncio
async def test_internal(
client: AsyncClient, factory: Factory, caplog: pytest.LogCaptureFixture
) -> None:
token_data = await create_session_token(
factory, group_names=["admin"], scopes=["exec:admin", "read:all"]
)
assert token_data.expires
caplog.clear()
r = await client.get(
"/auth",
params={
"scope": "exec:admin",
"delegate_to": "a-service",
"delegate_scope": "read:all",
},
headers={
"Authorization": f"Bearer {token_data.token}",
"X-Original-Uri": "/foo",
},
)
assert r.status_code == 200
notebook_token = Token.from_str(r.headers["X-Auth-Request-Token"])
assert parse_log(caplog) == [
{
"auth_uri": "/foo",
"event": "Token authorized",
"httpRequest": {
"requestMethod": "GET",
"requestUrl": ANY,
"remoteIp": "127.0.0.1",
},
"required_scopes": ["exec:admin"],
"satisfy": "all",
"scopes": ["exec:admin", "read:all"],
"severity": "info",
"token": token_data.token.key,
"token_source": "bearer",
"user": token_data.username,
},
{
"auth_uri": "/foo",
"event": "Created new internal token",
"httpRequest": {
"requestMethod": "GET",
"requestUrl": ANY,
"remoteIp": "127.0.0.1",
},
"required_scopes": ["exec:admin"],
"satisfy": "all",
"scopes": ["exec:admin", "read:all"],
"severity": "info",
"token": token_data.token.key,
"token_key": notebook_token.key,
"token_expires": format_datetime_for_logging(token_data.expires),
"token_scopes": ["read:all"],
"token_service": "a-service",
"token_source": "bearer",
"token_userinfo": {
"email": token_data.email,
"name": token_data.name,
"uid": token_data.uid,
"gid": token_data.gid,
"groups": [{"id": 1000, "name": "admin"}],
},
"user": token_data.username,
},
]