-
Notifications
You must be signed in to change notification settings - Fork 268
/
test_auth.py
505 lines (438 loc) · 18.8 KB
/
test_auth.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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
import uuid
from typing import Dict, List, Union
from unittest.mock import Mock
import pytest
from botbuilder.schema import Activity
from botframework.connector.auth import (
AuthenticationConfiguration,
AuthenticationConstants,
JwtTokenValidation,
SimpleCredentialProvider,
EmulatorValidation,
EnterpriseChannelValidation,
ChannelValidation,
ClaimsIdentity,
MicrosoftAppCredentials,
GovernmentConstants,
GovernmentChannelValidation,
SimpleChannelProvider,
ChannelProvider,
)
async def jwt_token_validation_validate_auth_header_with_channel_service_succeeds(
app_id: str,
pwd: str,
channel_service_or_provider: Union[str, ChannelProvider],
header: str = None,
):
if header is None:
header = f"Bearer {MicrosoftAppCredentials(app_id, pwd).get_access_token()}"
credentials = SimpleCredentialProvider(app_id, pwd)
result = await JwtTokenValidation.validate_auth_header(
header,
credentials,
channel_service_or_provider,
"",
"https://webchat.botframework.com/",
)
assert result.is_authenticated
# TODO: Consider changing to unittest to use ddt for Credentials tests
class TestAuth:
EmulatorValidation.TO_BOT_FROM_EMULATOR_TOKEN_VALIDATION_PARAMETERS.ignore_expiration = (
True
)
ChannelValidation.TO_BOT_FROM_CHANNEL_TOKEN_VALIDATION_PARAMETERS.ignore_expiration = (
True
)
@pytest.mark.asyncio
async def test_claims_validation(self):
claims: List[Dict] = []
default_auth_config = AuthenticationConfiguration()
# No validator should pass.
await JwtTokenValidation.validate_claims(default_auth_config, claims)
# ClaimsValidator configured but no exception should pass.
mock_validator = Mock()
auth_with_validator = AuthenticationConfiguration(
claims_validator=mock_validator
)
# Configure IClaimsValidator to fail
mock_validator.side_effect = PermissionError("Invalid claims.")
with pytest.raises(PermissionError) as excinfo:
await JwtTokenValidation.validate_claims(auth_with_validator, claims)
assert "Invalid claims." in str(excinfo.value)
@pytest.mark.asyncio
async def test_connector_auth_header_correct_app_id_and_service_url_should_validate(
self,
):
header = (
"Bearer "
+ MicrosoftAppCredentials(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
).get_access_token()
)
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", ""
)
result = await JwtTokenValidation.validate_auth_header(
header, credentials, "", "https://webchat.botframework.com/"
)
result_with_provider = await JwtTokenValidation.validate_auth_header(
header,
credentials,
SimpleChannelProvider(),
"https://webchat.botframework.com/",
)
assert result
assert result_with_provider
@pytest.mark.asyncio
async def test_connector_auth_header_with_different_bot_app_id_should_not_validate(
self,
):
header = (
"Bearer "
+ MicrosoftAppCredentials(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
).get_access_token()
)
credentials = SimpleCredentialProvider(
"00000000-0000-0000-0000-000000000000", ""
)
with pytest.raises(Exception) as excinfo:
await JwtTokenValidation.validate_auth_header(
header, credentials, "", "https://webchat.botframework.com/"
)
assert "Unauthorized" in str(excinfo.value)
with pytest.raises(Exception) as excinfo2:
await JwtTokenValidation.validate_auth_header(
header,
credentials,
SimpleChannelProvider(),
"https://webchat.botframework.com/",
)
assert "Unauthorized" in str(excinfo2.value)
@pytest.mark.asyncio
async def test_connector_auth_header_and_no_credential_should_not_validate(self):
header = (
"Bearer "
+ MicrosoftAppCredentials(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
).get_access_token()
)
credentials = SimpleCredentialProvider("", "")
with pytest.raises(Exception) as excinfo:
await JwtTokenValidation.validate_auth_header(
header, credentials, "", "https://webchat.botframework.com/"
)
assert "Unauthorized" in str(excinfo.value)
with pytest.raises(Exception) as excinfo2:
await JwtTokenValidation.validate_auth_header(
header,
credentials,
SimpleChannelProvider(),
"https://webchat.botframework.com/",
)
assert "Unauthorized" in str(excinfo2.value)
@pytest.mark.asyncio
async def test_empty_header_and_no_credential_should_throw(self):
header = ""
credentials = SimpleCredentialProvider("", "")
with pytest.raises(Exception) as excinfo:
await JwtTokenValidation.validate_auth_header(header, credentials, "", None)
assert "auth_header" in str(excinfo.value)
with pytest.raises(Exception) as excinfo2:
await JwtTokenValidation.validate_auth_header(
header, credentials, SimpleChannelProvider(), None
)
assert "auth_header" in str(excinfo2.value)
@pytest.mark.asyncio
async def test_emulator_msa_header_correct_app_id_and_service_url_should_validate(
self,
):
header = (
"Bearer "
+ MicrosoftAppCredentials(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
).get_access_token()
)
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", ""
)
result = await JwtTokenValidation.validate_auth_header(
header, credentials, "", "https://webchat.botframework.com/"
)
result_with_provider = await JwtTokenValidation.validate_auth_header(
header,
credentials,
SimpleChannelProvider(),
"https://webchat.botframework.com/",
)
assert result
assert result_with_provider
@pytest.mark.asyncio
async def test_emulator_msa_header_and_no_credential_should_not_validate(self):
# pylint: disable=protected-access
header = (
"Bearer "
+ MicrosoftAppCredentials(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
).get_access_token()
)
credentials = SimpleCredentialProvider(
"00000000-0000-0000-0000-000000000000", ""
)
with pytest.raises(Exception) as excinfo:
await JwtTokenValidation.validate_auth_header(header, credentials, "", None)
assert "Unauthorized" in str(excinfo._excinfo)
with pytest.raises(Exception) as excinfo2:
await JwtTokenValidation.validate_auth_header(
header, credentials, SimpleChannelProvider(), None
)
assert "Unauthorized" in str(excinfo2._excinfo)
# Tests with a valid Token and service url; and ensures that Service url is added to Trusted service url list.
@pytest.mark.asyncio
async def test_channel_msa_header_valid_service_url_should_be_trusted(self):
activity = Activity(
service_url="https://smba.trafficmanager.net/amer-client-ss.msg/"
)
header = (
"Bearer "
+ MicrosoftAppCredentials(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
).get_access_token()
)
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", ""
)
await JwtTokenValidation.authenticate_request(activity, header, credentials)
assert MicrosoftAppCredentials.is_trusted_service(
"https://smba.trafficmanager.net/amer-client-ss.msg/"
)
@pytest.mark.asyncio
# Tests with a valid Token and invalid service url and ensures that Service url is NOT added to
# Trusted service url list.
async def test_channel_msa_header_invalid_service_url_should_not_be_trusted(self):
activity = Activity(service_url="https://webchat.botframework.com/")
header = (
"Bearer "
+ MicrosoftAppCredentials(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
).get_access_token()
)
credentials = SimpleCredentialProvider(
"7f74513e-6f96-4dbc-be9d-9a81fea22b88", ""
)
with pytest.raises(Exception) as excinfo:
await JwtTokenValidation.authenticate_request(activity, header, credentials)
assert "Unauthorized" in str(excinfo.value)
assert not MicrosoftAppCredentials.is_trusted_service(
"https://webchat.botframework.com/"
)
@pytest.mark.asyncio
async def test_channel_msa_header_from_user_specified_tenant(self):
activity = Activity(
service_url="https://smba.trafficmanager.net/amer-client-ss.msg/"
)
header = "Bearer " + MicrosoftAppCredentials(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F", "microsoft.com"
).get_access_token(True)
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", ""
)
claims = await JwtTokenValidation.authenticate_request(
activity, header, credentials
)
assert claims.get_claim_value("tid") == "72f988bf-86f1-41af-91ab-2d7cd011db47"
@pytest.mark.asyncio
# Tests with no authentication header and makes sure the service URL is not added to the trusted list.
async def test_channel_authentication_disabled_should_be_anonymous(self):
activity = Activity(service_url="https://webchat.botframework.com/")
header = ""
credentials = SimpleCredentialProvider("", "")
claims_principal = await JwtTokenValidation.authenticate_request(
activity, header, credentials
)
assert claims_principal.is_authenticated
assert not claims_principal.claims
@pytest.mark.asyncio
# Tests with no authentication header and makes sure the service URL is not added to the trusted list.
async def test_channel_authentication_disabled_service_url_should_not_be_trusted(
self,
):
activity = Activity(service_url="https://webchat.botframework.com/")
header = ""
credentials = SimpleCredentialProvider("", "")
await JwtTokenValidation.authenticate_request(activity, header, credentials)
assert not MicrosoftAppCredentials.is_trusted_service(
"https://webchat.botframework.com/"
)
@pytest.mark.asyncio
async def test_emulator_auth_header_correct_app_id_and_service_url_with_gov_channel_service_should_validate(
self,
):
await jwt_token_validation_validate_auth_header_with_channel_service_succeeds(
"2cd87869-38a0-4182-9251-d056e8f0ac24", # emulator creds
"2.30Vs3VQLKt974F",
GovernmentConstants.CHANNEL_SERVICE,
)
await jwt_token_validation_validate_auth_header_with_channel_service_succeeds(
"2cd87869-38a0-4182-9251-d056e8f0ac24", # emulator creds
"2.30Vs3VQLKt974F",
SimpleChannelProvider(GovernmentConstants.CHANNEL_SERVICE),
)
@pytest.mark.asyncio
async def test_emulator_auth_header_correct_app_id_and_service_url_with_private_channel_service_should_validate(
self,
):
await jwt_token_validation_validate_auth_header_with_channel_service_succeeds(
"2cd87869-38a0-4182-9251-d056e8f0ac24", # emulator creds
"2.30Vs3VQLKt974F",
"TheChannel",
)
await jwt_token_validation_validate_auth_header_with_channel_service_succeeds(
"2cd87869-38a0-4182-9251-d056e8f0ac24", # emulator creds
"2.30Vs3VQLKt974F",
SimpleChannelProvider("TheChannel"),
)
@pytest.mark.asyncio
async def test_government_channel_validation_succeeds(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
await GovernmentChannelValidation.validate_identity(
ClaimsIdentity(
{"iss": "https://api.botframework.us", "aud": credentials.app_id}, True
),
credentials,
)
@pytest.mark.asyncio
async def test_government_channel_validation_no_authentication_fails(self):
with pytest.raises(Exception) as excinfo:
await GovernmentChannelValidation.validate_identity(
ClaimsIdentity({}, False), None
)
assert "Unauthorized" in str(excinfo.value)
@pytest.mark.asyncio
async def test_government_channel_validation_no_issuer_fails(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
with pytest.raises(Exception) as excinfo:
await GovernmentChannelValidation.validate_identity(
ClaimsIdentity({"peanut": "peanut"}, True), credentials
)
assert "Unauthorized" in str(excinfo.value)
@pytest.mark.asyncio
async def test_government_channel_validation_wrong_issuer_fails(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
with pytest.raises(Exception) as excinfo:
await GovernmentChannelValidation.validate_identity(
ClaimsIdentity({"iss": "peanut"}, True), credentials
)
assert "Unauthorized" in str(excinfo.value)
@pytest.mark.asyncio
async def test_government_channel_validation_no_audience_fails(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
with pytest.raises(Exception) as excinfo:
await GovernmentChannelValidation.validate_identity(
ClaimsIdentity({"iss": "https://api.botframework.us"}, True),
credentials,
)
assert "Unauthorized" in str(excinfo.value)
@pytest.mark.asyncio
async def test_government_channel_validation_wrong_audience_fails(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
with pytest.raises(Exception) as excinfo:
await GovernmentChannelValidation.validate_identity(
ClaimsIdentity(
{"iss": "https://api.botframework.us", "aud": "peanut"}, True
),
credentials,
)
assert "Unauthorized" in str(excinfo.value)
@pytest.mark.asyncio
async def test_enterprise_channel_validation_succeeds(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
await EnterpriseChannelValidation.validate_identity(
ClaimsIdentity(
{"iss": "https://api.botframework.com", "aud": credentials.app_id}, True
),
credentials,
)
@pytest.mark.asyncio
async def test_enterprise_channel_validation_no_authentication_fails(self):
with pytest.raises(Exception) as excinfo:
await EnterpriseChannelValidation.validate_identity(
ClaimsIdentity({}, False), None
)
assert "Unauthorized" in str(excinfo.value)
@pytest.mark.asyncio
async def test_enterprise_channel_validation_no_issuer_fails(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
with pytest.raises(Exception) as excinfo:
await EnterpriseChannelValidation.validate_identity(
ClaimsIdentity({"peanut": "peanut"}, True), credentials
)
assert "Unauthorized" in str(excinfo.value)
@pytest.mark.asyncio
async def test_enterprise_channel_validation_wrong_issuer_fails(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
with pytest.raises(Exception) as excinfo:
await EnterpriseChannelValidation.validate_identity(
ClaimsIdentity({"iss": "peanut"}, True), credentials
)
assert "Unauthorized" in str(excinfo.value)
@pytest.mark.asyncio
async def test_enterprise_channel_validation_no_audience_fails(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
with pytest.raises(Exception) as excinfo:
await GovernmentChannelValidation.validate_identity(
ClaimsIdentity({"iss": "https://api.botframework.com"}, True),
credentials,
)
assert "Unauthorized" in str(excinfo.value)
@pytest.mark.asyncio
async def test_enterprise_channel_validation_wrong_audience_fails(self):
credentials = SimpleCredentialProvider(
"2cd87869-38a0-4182-9251-d056e8f0ac24", "2.30Vs3VQLKt974F"
)
with pytest.raises(Exception) as excinfo:
await GovernmentChannelValidation.validate_identity(
ClaimsIdentity(
{"iss": "https://api.botframework.com", "aud": "peanut"}, True
),
credentials,
)
assert "Unauthorized" in str(excinfo.value)
def test_get_app_id_from_claims(self):
v1_claims = {}
v2_claims = {}
app_id = str(uuid.uuid4())
# Empty list
assert not JwtTokenValidation.get_app_id_from_claims(v1_claims)
# AppId there but no version (assumes v1)
v1_claims[AuthenticationConstants.APP_ID_CLAIM] = app_id
assert JwtTokenValidation.get_app_id_from_claims(v1_claims) == app_id
# AppId there with v1 version
v1_claims[AuthenticationConstants.VERSION_CLAIM] = "1.0"
assert JwtTokenValidation.get_app_id_from_claims(v1_claims) == app_id
# v2 version but no azp
v2_claims[AuthenticationConstants.VERSION_CLAIM] = "2.0"
assert not JwtTokenValidation.get_app_id_from_claims(v2_claims)
# v2 version but no azp
v2_claims[AuthenticationConstants.AUTHORIZED_PARTY] = app_id
assert JwtTokenValidation.get_app_id_from_claims(v2_claims) == app_id