Skip to content

(feat) Add masking to python middleware #955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Sep 18, 2024
Merged

(feat) Add masking to python middleware #955

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
9e5cb3a
Add masking to python middleware
Jan 25, 2024
3efa55b
add a test for mask
llimllib Jan 25, 2024
990725b
Authentication -> Authorization
llimllib Jan 25, 2024
7972aab
simplify imports
llimllib Jan 25, 2024
5f533d0
don't need get here
llimllib Jan 25, 2024
1389528
fix redact typing
llimllib Jan 25, 2024
a605487
simplify redaction
llimllib Jan 25, 2024
aae9565
fix tests authentication -> authorization
llimllib Jan 25, 2024
cb8f47b
Merge branch 'main' into add-python-hashing
AndriiAndreiev Sep 5, 2024
450ddd7
fix makefile syntax
AndriiAndreiev Sep 5, 2024
1723149
Fix failing tests
AndriiAndreiev Sep 5, 2024
6b07295
Fix lint issues
AndriiAndreiev Sep 5, 2024
ca2baee
Fix lint issue
AndriiAndreiev Sep 5, 2024
9883284
Fix test mask
AndriiAndreiev Sep 5, 2024
928640b
Change Authorization header masking logic
AndriiAndreiev Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/python/readme_metrics/Metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ def process(self, request, response: ResponseInfoWrapper) -> None:
)
if self.config.IS_DEVELOPMENT_MODE:
print(traceback.format_exc())
return

self.queue.put(payload)
if self.queue.qsize() >= self.config.BUFFER_LENGTH:
Expand Down
7 changes: 3 additions & 4 deletions packages/python/readme_metrics/PayloadBuilder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,6 @@ def _build_request_payload(self, request) -> dict:
"""
headers = self.redact_dict(request.headers)

# Mask the auth header
if "Authorization" in headers:
headers["Authorization"] = mask(headers["Authorization"])

queryString = parse.parse_qsl(self._get_query_string(request))

content_type = self._get_content_type(headers)
Expand Down Expand Up @@ -224,6 +220,9 @@ def _build_request_payload(self, request) -> dict:
"bodySize": -1,
}

if "Authorization" in headers:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at this point, if there is an Authorization header, won't there already be an unmasked Authorization header in payload["headers"]?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be my expectation too - does .append overwrite the existing header here, or do we need to forcefully delete it?

payload["headers"].append({"name": "Authorization", "value": mask(headers["Authorization"])})

if not post_data is False:
payload["postData"] = post_data

Expand Down
2 changes: 2 additions & 0 deletions packages/python/readme_metrics/tests/PayloadBuilder_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,8 @@ def test_auth_header_masked(self):
payload = self.createPayload(config)
data = payload(metrics.req, metrics.res, str(uuid.uuid4()))

auth_header = None

# Pull out the auth header
for header in data["request"]["log"]["entries"][0]["request"]["headers"]:
if header["name"] == "Authorization":
Expand Down
Loading