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

オープン
#18 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Python
スター
2
フォーク
2
平均マージ
11分
マージ済み PR(30日)
2

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ossf/python-secure-coding-guide のほかの issue

ossf/python-secure-coding-guide の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。