MonkeyCanCode commented on code in PR #4772: URL: https://github.com/apache/polaris/pull/4772#discussion_r3444872492
########## client/python/apache_polaris/cli/log_sanitizer.py: ########## @@ -0,0 +1,132 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# +""" +Sanitize Polaris CLI debug log output. + +``polaris --debug`` logs HTTP traffic to stderr. Known credential fields and +OAuth token endpoint payloads are redacted before writing. +""" + +import json +import sys +from typing import Any +from urllib.parse import parse_qsl, urlencode + +REDACTED = "***REDACTED***" +OAUTH_TOKEN_BODY_REDACTED = "<redacted sensitive authentication payload>" +SANITIZE_FAILURE_MESSAGE = "<redacted: unable to sanitize payload>" + +# Compared case-insensitively; ``-`` and ``_`` are treated interchangeably. +SENSITIVE_HEADERS = {"authorization"} +SENSITIVE_BODY_KEYS = {"client_secret", "access_token", "refresh_token"} + + +def _normalize_key(key: str) -> str: Review Comment: As the sensitive parts are well-known, those helper functions are a bit over-engineering iMO. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
