pySCG: Python Hardening Guide: we should mention and explain audit hooks, sys.audit and sys.addaudithook

Abierto
  • ¿Algo no está bien?
#18 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation, security

Línea de trabajo

Read the logging rules in the CWE-532 guideline linked from the issue and review PEP 578 alongside the example01.py example in the issue. Decide whether audit hooks should be explained in a log related rule and whether they help separate internal and user facing logs; done means the relevant guidance clearly explains the recommendation and its limits.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

sys.audit allows to create events that can be used during audits as demonstrated in example01.py
aduprocess.py Popen class has a line that creates an audit event looking like this:
sys.audit("subprocess.Popen", executable, args, cwd, env)

These type of events are Python internal and not handled unless there is a listener/hook.
The example01.py creates the audit method that is attached/hooked into the Python audit system via sys.addaudtihook(audit).
The audit method allows any sort of handling of an event including suppressing functions.

example01.py:

"""
Playing around with audit hooks
https://www.youtube.com/watch?v=sIibadhDqaw
https://github.com/ossf/wg-best-practices-os-developers/issues
"""
import sys
from typing import Any
import subprocess


def audit(event: str, args: tuple[Any, ...]) -> None:
    """ foo """
    # if "subprocess" in event:
    print("audit::", event, args)


sys.addaudithook(audit)

# compile(None, '<stdin>')
# print('hi')
subprocess.Popen(('echo', 'hi'))
import email

In our rules about logging we recommend to prevent sensitive information such as system internals to end-users. We recommend to split logging between internal and user facing. The use facing has sensitive system-internal information removed. Audit logs should be mentioned as part of one of the log related rules. We will need to investigate if the use of audit logs can be recommended to solve the issue around splitting back-ed, front-end.

related guideline:
PEP 578 – Python Runtime Audit Hooks
CWE-532: Insertion of Sensitive Information into Log File

Lenguaje dominante
Python
Estrellas
2
Forks
2
Merge medio
11 min
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ossf/python-secure-coding-guide

Todos los issues de ossf/python-secure-coding-guide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.