-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathtest_auth_token_provider.py
355 lines (295 loc) · 14.3 KB
/
test_auth_token_provider.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
# Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
"""Tests for `aws-msk-iam-sasl-signer-python` package."""
import base64
import unittest
from datetime import datetime, timezone
from unittest import mock
from urllib.parse import parse_qs, urlparse
import botocore.credentials
from botocore.credentials import CredentialProvider, Credentials
from botocore.exceptions import ParamValidationError, ProfileNotFound
from click.testing import CliRunner
from aws_msk_iam_sasl_signer import cli
from aws_msk_iam_sasl_signer.MSKAuthTokenProvider import (
ACTION_NAME, ACTION_TYPE, DEFAULT_STS_SESSION_NAME,
DEFAULT_TOKEN_EXPIRY_SECONDS, LIB_NAME,
__load_credentials_from_aws_credentials_provider__,
__load_credentials_from_aws_profile__,
__load_credentials_from_aws_role_arn__, __load_default_credentials__,
generate_auth_token, generate_auth_token_from_credentials_provider,
generate_auth_token_from_profile, generate_auth_token_from_role_arn)
class TestCredentialProvider(CredentialProvider):
__test__ = False
def load(self):
return Credentials(
access_key="MOCK_AWS_ACCESS_KEY",
secret_key="MOCK_AWS_SECRET_KEY",
token="MOCK_AWS_TOKEN",
)
class TestGenerateAuthToken(unittest.TestCase):
def setUp(self):
self.region = "us-west-2"
self.aws_profile = "dev"
self.role_arn = "arn:aws:iam::123456789012:role/MyRole"
self.endpoint_url = "https://kafka.us-west-2.amazonaws.com/"
self.mock_access_key = "MOCK_AWS_ACCESS_KEY"
self.mock_secret_key = "MOCK_AWS_SECRET_KEY"
self.mock_token = "MOCK_AWS_TOKEN"
def test_generate_auth_token_with_invalid_credentials_type(self):
aws_credentials = {"AccessKeyId": self.mock_access_key}
expected_error_message = "aws_credentials_provider should be of " \
"type botocore.credentials.CredentialProvider"
with self.assertRaisesRegex(TypeError, expected_error_message):
generate_auth_token_from_credentials_provider(self.region,
aws_credentials)
def test_generate_auth_token_with_invalid_credentials_content(self):
expected_error_message = "missing 1 required positional argument: " \
"'secret_key'"
with self.assertRaisesRegex(TypeError, expected_error_message):
Credentials(self.mock_access_key)
@mock.patch("botocore.session")
def test_load_default_credentials(self, mock_session):
mock_botocore_session = mock_session.Session.return_value
mock_botocore_session.get_credentials.return_value = Credentials(
self.mock_access_key, self.mock_secret_key
)
creds = __load_default_credentials__()
mock_session.Session.assert_called_once_with()
mock_botocore_session.get_credentials.assert_called_once()
self.assertIsInstance(creds, Credentials)
self.assertEqual(creds.access_key, self.mock_access_key)
self.assertEqual(creds.secret_key, self.mock_secret_key)
@mock.patch("botocore.session")
def test_load_credentials_with_aws_profile(self, mock_session):
mock_botocore_session = mock_session.Session.return_value
mock_botocore_session.get_credentials.return_value = Credentials(
self.mock_access_key, self.mock_secret_key
)
creds = __load_credentials_from_aws_profile__(self.aws_profile)
mock_session.Session.assert_called_once_with(profile=self.aws_profile)
mock_botocore_session.get_credentials.assert_called_once()
self.assertIsInstance(creds, Credentials)
self.assertEqual(creds.access_key, self.mock_access_key)
self.assertEqual(creds.secret_key, self.mock_secret_key)
@mock.patch("botocore.session")
def test_load_credentials_with_missing_profile(self, mock_session):
mock_session.Session.side_effect = ProfileNotFound(profile="missing")
expected_error_message = "The config profile \\(missing\\) could not" \
" be found"
with self.assertRaisesRegex(ProfileNotFound, expected_error_message):
__load_credentials_from_aws_profile__("missing")
mock_session.Session.assert_called_once_with(profile="missing")
@mock.patch("boto3.client")
def test_load_credentials_with_valid_arn(self, mock_boto_client):
mock_credentials = {
"AccessKeyId": self.mock_access_key,
"SecretAccessKey": self.mock_secret_key,
"SessionToken": self.mock_token,
}
mock_sts_client = mock_boto_client.return_value
mock_sts_client.assume_role.return_value = {
"Credentials": mock_credentials}
creds = __load_credentials_from_aws_role_arn__(self.role_arn)
mock_sts_client.assume_role.assert_called_with(
RoleArn=self.role_arn, RoleSessionName=DEFAULT_STS_SESSION_NAME
)
self.assertIsInstance(creds, Credentials)
self.assertEqual(creds.access_key, self.mock_access_key)
self.assertEqual(creds.secret_key, self.mock_secret_key)
self.assertEqual(creds.token, self.mock_token)
@mock.patch("boto3.client")
def test_load_credentials_with_invalid_arn(self, mock_boto_client):
mock_sts_client = mock.Mock()
mock_sts_client.assume_role.side_effect = ParamValidationError(
report=None)
mock_boto_client.return_value = mock_sts_client
with self.assertRaises(ParamValidationError):
__load_credentials_from_aws_role_arn__("invalid-arn")
mock_sts_client.assume_role.assert_called_once_with(
RoleArn="invalid-arn", RoleSessionName=DEFAULT_STS_SESSION_NAME
)
@mock.patch("boto3.client")
def test_load_credentials_with_valid_arn_and_session_name(self,
mock_boto):
mock_credentials = {
"AccessKeyId": self.mock_access_key,
"SecretAccessKey": self.mock_secret_key,
"SessionToken": self.mock_token,
}
mock_sts_client = mock_boto.return_value
mock_sts_client.assume_role.return_value = {
"Credentials": mock_credentials}
creds = __load_credentials_from_aws_role_arn__(self.role_arn,
"MY-SESSION")
mock_sts_client.assume_role.assert_called_with(
RoleArn=self.role_arn, RoleSessionName="MY-SESSION"
)
self.assertIsInstance(creds, Credentials)
self.assertEqual(creds.access_key, self.mock_access_key)
self.assertEqual(creds.secret_key, self.mock_secret_key)
self.assertEqual(creds.token, self.mock_token)
def test_load_credentials_with_credentials_provider(self):
test_credential_provider = TestCredentialProvider()
creds = __load_credentials_from_aws_credentials_provider__(
test_credential_provider
)
self.assertIsInstance(creds, Credentials)
self.assertEqual(creds.access_key, self.mock_access_key)
self.assertEqual(creds.secret_key, self.mock_secret_key)
self.assertEqual(creds.token, self.mock_token)
@mock.patch(
"aws_msk_iam_sasl_signer.MSKAuthTokenProvider"
".__load_default_credentials__"
)
def test_generate_auth_token(self, mock_load_credentials):
mock_credentials = Credentials(
self.mock_access_key, self.mock_secret_key, self.mock_token
)
mock_load_credentials.return_value = mock_credentials
auth_token, expiry_ms = generate_auth_token(self.region)
self.assertTokenIsAsExpected(auth_token, expiry_ms)
@mock.patch(
"aws_msk_iam_sasl_signer.MSKAuthTokenProvider"
".__load_credentials_from_aws_profile__"
)
def test_generate_auth_token_from_aws_profile(self, mock_load_credentials):
mock_credentials = Credentials(
self.mock_access_key, self.mock_secret_key, self.mock_token
)
mock_load_credentials.return_value = mock_credentials
auth_token, expiry_ms = generate_auth_token_from_profile(
self.region, self.aws_profile)
self.assertTokenIsAsExpected(auth_token, expiry_ms)
@mock.patch(
"aws_msk_iam_sasl_signer.MSKAuthTokenProvider"
".__load_credentials_from_aws_role_arn__"
)
def test_generate_auth_token_from_role_arn(self, mock_load_credentials):
mock_credentials = Credentials(
self.mock_access_key, self.mock_secret_key, self.mock_token
)
mock_load_credentials.return_value = mock_credentials
auth_token, expiry_ms = generate_auth_token_from_role_arn(
self.region, self.aws_profile)
self.assertTokenIsAsExpected(auth_token, expiry_ms)
@mock.patch(
"aws_msk_iam_sasl_signer.MSKAuthTokenProvider"
".__load_credentials_from_aws_credentials_provider__"
)
def test_generate_auth_token_with_credentials_provider(self,
load_credentials):
mock_credentials = Credentials(
self.mock_access_key, self.mock_secret_key, self.mock_token
)
load_credentials.return_value = mock_credentials
credential_provider = botocore.credentials.ContainerProvider()
auth_token, expiry_ms = generate_auth_token_from_credentials_provider(
self.region, credential_provider
)
self.assertTokenIsAsExpected(auth_token, expiry_ms)
@mock.patch(
"aws_msk_iam_sasl_signer.MSKAuthTokenProvider"
".__load_credentials_from_aws_credentials_provider__"
)
def test_generate_auth_token_with_empty_credentials(self,
load_credentials):
mock_credentials = Credentials("", "")
load_credentials.return_value = mock_credentials
credential_provider = botocore.credentials.ContainerProvider()
expected_error_message = "AWS Credentials can not be empty"
with self.assertRaisesRegex(ValueError, expected_error_message):
generate_auth_token_from_credentials_provider(
self.region, credential_provider
)
@mock.patch(
"aws_msk_iam_sasl_signer.MSKAuthTokenProvider"
".__load_default_credentials__"
)
@mock.patch(
"aws_msk_iam_sasl_signer.MSKAuthTokenProvider"
".__load_credentials_from_aws_profile__"
)
@mock.patch(
"aws_msk_iam_sasl_signer.MSKAuthTokenProvider"
".__load_credentials_from_aws_role_arn__"
)
def test_command_line_interface(
self, mock_load_credentials, mock_profile_credentials,
mock_role_credentials
):
mock_credentials = Credentials(
self.mock_access_key, self.mock_secret_key, self.mock_token
)
mock_load_credentials.return_value = mock_credentials
mock_profile_credentials.return_value = mock_credentials
mock_role_credentials.return_value = mock_credentials
runner = CliRunner()
result = runner.invoke(cli.execute, ["--region", self.region])
self.assertEqual(result.exit_code, 0)
output = result.output.strip()[1:-1].split(", ")
self.assertTokenIsAsExpected(output[0][1:-1], int(output[1]))
result = runner.invoke(
cli.execute,
["--region", self.region, "--aws-profile", self.aws_profile]
)
self.assertEqual(result.exit_code, 0)
output = result.output.strip()[1:-1].split(", ")
self.assertTokenIsAsExpected(output[0][1:-1], int(output[1]))
result = runner.invoke(
cli.execute, ["--region", self.region, "--role-arn", self.role_arn]
)
self.assertEqual(result.exit_code, 0)
output = result.output.strip()[1:-1].split(", ")
self.assertTokenIsAsExpected(output[0][1:-1], int(output[1]))
help_result = runner.invoke(cli.execute, ["--help"])
self.assertEqual(help_result.exit_code, 0)
def test_command_line_interface_invalid(self):
runner = CliRunner()
result = runner.invoke(cli.execute)
self.assertEqual(result.exit_code, 2)
self.assertEqual(result.return_value, None)
result = runner.invoke(
cli.execute,
[
"--region",
self.region,
"--aws-profile",
self.aws_profile,
"--role-arn",
self.role_arn,
],
)
self.assertEqual(result.exit_code, 2)
self.assertEqual(result.return_value, None)
def assertTokenIsAsExpected(self, auth_token, expiry_ms):
self.assertIsNotNone(auth_token)
self.assertIsNotNone(expiry_ms)
# Add padding to ensure decoding does not complain of no padding
padded_auth_token = auth_token + "===="
decoded_signed_url = base64.urlsafe_b64decode(
padded_auth_token).decode("utf-8")
self.assertTrue(decoded_signed_url.startswith(self.endpoint_url))
parsed_url = urlparse(decoded_signed_url)
query_params = parse_qs(parsed_url.query)
self.assertEqual(query_params[ACTION_TYPE][0], ACTION_NAME)
self.assertEqual(query_params["X-Amz-Algorithm"][0],
"AWS4-HMAC-SHA256")
self.assertEqual(
query_params["X-Amz-Expires"][0], str(DEFAULT_TOKEN_EXPIRY_SECONDS)
)
self.assertEqual(query_params["X-Amz-Security-Token"][0],
"MOCK_AWS_TOKEN")
credential = query_params["X-Amz-Credential"][0]
self.assertEqual(credential.split("/")[0], "MOCK_AWS_ACCESS_KEY")
self.assertEqual(query_params["X-Amz-SignedHeaders"][0], "host")
self.assertIsNotNone(query_params["X-Amz-Signature"][0])
date_obj = datetime.strptime(query_params["X-Amz-Date"][0],
"%Y%m%dT%H%M%SZ")
current_utc_time = datetime.utcnow()
self.assertTrue(date_obj < current_utc_time)
self.assertTrue(query_params["User-Agent"][0].startswith(LIB_NAME))
actual_expiration_ms = 1000 * (
int(query_params["X-Amz-Expires"][0])
+ date_obj.replace(tzinfo=timezone.utc).timestamp())
self.assertEqual(expiry_ms, actual_expiration_ms)