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
|
# coding: utf-8
# Copyright 2024 IBM All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# pylint: disable=missing-docstring
import logging
from ibm_cloud_sdk_core import base_service
from ibm_cloud_sdk_core.authenticators import NoAuthAuthenticator
from ibm_cloud_sdk_core.logger import LoggingFilter
from .utils.http_utils import local_server
def test_redact_secrets():
redact_secrets = LoggingFilter.redact_secrets
assert "secret" not in redact_secrets("Authorization: Bearer secret")
assert "secret" not in redact_secrets("Authorization: Basic secret")
assert "secret" not in redact_secrets("X-Authorization: secret")
assert "secret" not in redact_secrets("ApIKey=secret")
assert "secret" not in redact_secrets("ApI_Key=secret")
assert "secret" not in redact_secrets("passCode=secret")
assert "secret" not in redact_secrets("PASSword=secret")
assert "secret" not in redact_secrets("toKen=secret")
assert "secret" not in redact_secrets("client_id=secret")
assert "secret" not in redact_secrets("client_x509_cert_url=secret")
assert "secret" not in redact_secrets("client_id=secret")
assert "secret" not in redact_secrets("key=secret")
assert "secret" not in redact_secrets("project_id=secret")
assert "DaSecret" not in redact_secrets("secret=DaSecret")
assert "secret" not in redact_secrets("subscriptionId=secret")
assert "secret" not in redact_secrets("tenantId=secret")
assert "secret" not in redact_secrets("thumbprint=secret")
assert "secret" not in redact_secrets("token_uri=secret")
assert "secret" not in redact_secrets('xxx "apIKEy": "secret",xxx')
assert "secret" not in redact_secrets('xxx "apI_KEy": "secret",xxx')
assert "secret" not in redact_secrets('xxx "pAsSCoDe": "secret",xxx')
assert "secret" not in redact_secrets('xxx "passWORD": "secret",xxx')
assert "secret" not in redact_secrets('xxx {"token": "secret"},xxx')
assert "secret" not in redact_secrets('xxx "aadClientId": "secret",xxx')
assert "secret" not in redact_secrets('xxx "aadClientSecret": "secret",xxx')
assert "secret" not in redact_secrets('xxx "auth": "secret",xxx')
assert "secret" not in redact_secrets('xxx "auth_provider_x509_cert_url": "secret",xxx')
assert "secret" not in redact_secrets('xxx "auth_uri": "secret",xxx')
assert "secret" not in redact_secrets('xxx "client_email": "secret",xxx')
# Now use a real-world example, to validate the correct behavior.
assert (
redact_secrets(
'GET / HTTP/1.1\r\nHost: localhost:3335\r\n'
+ 'User-Agent: ibm-python-sdk-core-3.20.6 os.name=Darwin os.version=23.6.0 python.version=3.11.10\r\n'
+ 'Accept-Encoding: gzip, deflate\r\nAccept: */*\r\nAuthorization: token-foo-bar-123\r\n'
+ 'Connection: keep-alive\r\n\r\n'
)
== 'GET / HTTP/1.1\r\nHost: localhost:3335\r\n'
+ 'User-Agent: ibm-python-sdk-core-3.20.6 os.name=Darwin os.version=23.6.0 python.version=3.11.10\r\n'
+ 'Accept-Encoding: gzip, deflate\r\nAccept: */*\r\nAuthorization: [redacted]\r\nConnection: keep-alive\r\n\r\n'
)
# Simulate a real-world scenario.
@local_server(3335)
def test_redact_secrets_log(caplog):
# Since we use a real BaseService here, we need to set the logging level
# to DEBUG in its module, to simulate the real behavior.
original_logging_level = base_service.logger.level
base_service.logger.setLevel(logging.DEBUG)
try:
service = base_service.BaseService(service_url="http://localhost:3335", authenticator=NoAuthAuthenticator())
prepped = service.prepare_request('GET', url='/', headers={'Authorization': 'token-foo-bar-123'})
res = service.send(prepped)
except Exception as ex:
raise ex
finally:
# And now we restore the logger's level to the original value.
base_service.logger.setLevel(original_logging_level)
assert res is not None
# Make sure the request has been logged and the token is redacted.
assert "Authorization" in caplog.text
assert "token" not in caplog.text
|
