darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-22 00:11:16 -05:00
Code Issues Packages Projects Releases Wiki Activity

Rename "key" to "secret" for consistency

Browse Source 
While "key" is the term used by the JWT library, all the rest of
our code - the ApiKey model, the Python client - all use the term
"secret" instead. Although "secret" is less precise than "key", it
does help avoid confusion with (api) key (as a model object).
This commit is contained in:
Ben Thorner
2021-08-03 15:36:41 +01:00
parent 4b7ad89f6a
commit a3cbea218f
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
tests/app/authentication/test_authentication.py
View File

@@ -42,10 +42,10 @@ def requires_my_internal_app_auth():
requires_internal_auth('my-internal-app') requires_internal_auth('my-internal-app')
def create_custom_jwt_token(headers=None, payload=None, key=None): def create_custom_jwt_token(headers=None, payload=None, secret=None):
# code copied from notifications_python_client.authentication.py::create_jwt_token # code copied from notifications_python_client.authentication.py::create_jwt_token
headers = headers or {"typ": 'JWT', "alg": 'HS256'} headers = headers or {"typ": 'JWT', "alg": 'HS256'}
return jwt.encode(payload=payload, key=key or str(uuid.uuid4()), headers=headers) return jwt.encode(payload=payload, key=secret or str(uuid.uuid4()), headers=headers)
@pytest.fixture @pytest.fixture
@@ -154,7 +154,7 @@ def test_decode_jwt_token_should_not_allow_old_iat(
): ):
token = create_custom_jwt_token( token = create_custom_jwt_token(
payload={'iss': 'something', 'iat': int(time.time()) - 60}, payload={'iss': 'something', 'iat': int(time.time()) - 60},
key=sample_api_key.secret, secret=sample_api_key.secret,
) )
with pytest.raises(AuthError) as exc: with pytest.raises(AuthError) as exc:
@@ -172,7 +172,7 @@ def test_decode_jwt_token_should_not_allow_extra_claims(
'iat': int(time.time()), 'iat': int(time.time()),
'aud': 'notifications.service.gov.uk' # extra claim that we don't support 'aud': 'notifications.service.gov.uk' # extra claim that we don't support
}, },
key=sample_api_key.secret, secret=sample_api_key.secret,
) )
with pytest.raises(AuthError) as exc: with pytest.raises(AuthError) as exc: