Redact access_key and ticket from WebSocket lifecycle INFO logs
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 78/100
Línea de trabajo
Comienza por Client._connect() y _disconnect(), y después inspecciona la estructura existente del registro del ciclo de vida y de las pruebas de regresión. Se considera terminado cuando ambos mensajes INFO redacten únicamente los valores de access_key y ticket, manteniendo el resto del contexto de la URL, y websockets.connect() siga recibiendo la URL original exacta.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Python
- Estrellas
- 559
- Forks
- 102
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de larksuite/oapi-sdk-python
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
larksuite/oapi-sdk-python#163 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
larksuite/oapi-sdk-python#162 · 1 comentario ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 94/100
larksuite/oapi-sdk-python#161 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
larksuite/oapi-sdk-python#160 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
larksuite/oapi-sdk-python#159 ·
Todos los issues de larksuite/oapi-sdk-python
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100