Access log: the pairing poll's ?secret= and a socket's ?ticket= are masked too
This commit is contained in:
@@ -62,21 +62,23 @@ from fluksio.flow.workers import PythonWorkerPool
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
#: A credential in a query string: the live socket's and a worker's `?token=`.
|
||||
_TOKEN_IN_QUERY = re.compile(r"([?&][\w-]*token=)[^&\s]+")
|
||||
#: A credential in a query string: the live socket's `?token=` or `?ticket=`, a
|
||||
#: worker's `?token=`, the pairing poll's `?secret=`.
|
||||
_CREDENTIAL_IN_QUERY = re.compile(r"([?&](?:[\w-]*token|[\w-]*secret|ticket)=)[^&\s]+")
|
||||
|
||||
|
||||
class _RedactTokens(logging.Filter):
|
||||
"""Keep query-string credentials out of uvicorn's request lines.
|
||||
|
||||
uvicorn logs each request and websocket handshake with its query string,
|
||||
and the live socket and a worker's attach carry their token there.
|
||||
and the live socket, a worker's attach and a device polling for its
|
||||
pairing carry their credential there.
|
||||
"""
|
||||
|
||||
def filter(self, record: logging.LogRecord) -> bool:
|
||||
if isinstance(record.args, tuple):
|
||||
record.args = tuple(
|
||||
_TOKEN_IN_QUERY.sub(r"\1***", arg) if isinstance(arg, str) else arg
|
||||
_CREDENTIAL_IN_QUERY.sub(r"\1***", arg) if isinstance(arg, str) else arg
|
||||
for arg in record.args
|
||||
)
|
||||
return True
|
||||
|
||||
Reference in New Issue
Block a user