larksuite / larksuite/oapi-sdk-python
Redact access_key and ticket from WebSocket lifecycle INFO logs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 559
- Forks
- 102
- PR merge metrics
- No merged PRs in 30d
Description
Problem
Client._connect() and _disconnect() log the complete WebSocket connection URL at INFO level. The URL returned by the Lark WebSocket endpoint contains sensitive access_key and ticket query values, so normal lifecycle logs can disclose credentials to stdout, journals, or downstream log collectors.
The current default-branch code passes the original URL directly to both log calls:
logger.info(self._fmt_log("connected to {}", conn_url))logger.info(self._fmt_log("disconnected to {}", self._conn_url))
Reproduce / evidence
Using only fictional values, suppose _get_conn_url() returns:
wss://msg-frontier.example.test/ws/v2?fpid=493&access_key=access-key-test-value&service_id=33554678&ticket=ticket-test-value
After a connection and disconnect, the INFO messages include both access-key-test-value and ticket-test-value verbatim. The same original URL is also correctly required by websockets.connect(); the connection input itself must not be changed.
I searched current issues, pull requests, and default-branch code for msg-frontier, access_key, ticket, connected to, redact websocket URL, and sanitize URL query. I did not find an issue or PR that covers redaction of both WebSocket lifecycle log messages.
Required fix
Please redact only the values of the access_key and ticket query parameters before formatting the connection and disconnection INFO messages, while preserving the original URL for connection state and websockets.connect().
The log-safe representation should preserve non-sensitive query parameters and enough endpoint context for diagnostics. Ideally it should also preserve query ordering, repeated parameters, percent-encoding, empty/value-less parameters, and fragments except for replacing the two sensitive values.
Please add regression tests proving that:
- neither lifecycle log contains the original
access_keyorticketvalue; - non-sensitive URL context remains visible;
websockets.connect()receives the exact original URL; and- both connection and disconnection logs use the redacted representation.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at Client._connect() and _disconnect(), then inspect the existing lifecycle logging and regression-test structure. Done means both INFO messages redact only the access_key and ticket values while retaining other URL context, and websockets.connect() still receives the exact original URL.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- security
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100