Skip to content

gh-135361: update documentation for remote_debugger_script audit event #135362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Zheaoli
Copy link
Contributor

@Zheaoli Zheaoli commented Jun 10, 2025

Fix #135361

…t event

Signed-off-by: Manjusaka <me@manjusaka.me>
vstinner
vstinner previously approved these changes Jun 11, 2025
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

The audit event is logged in Python/ceval_gil.c:

static inline void run_remote_debugger_script(PyObject *path)
{
    if (0 != PySys_Audit("remote_debugger_script", "O", path)) {
        PyErr_FormatUnraisable(
            "Audit hook failed for remote debugger script %U", path);
        return;
    }
...

@vstinner
Copy link
Member

cc @pablogsal

@vstinner vstinner dismissed their stale review June 11, 2025 13:10

I misunderstood the audit event. It's recorded by the debugged process. The documentation should clarify that.

@@ -1933,6 +1933,8 @@ always available. Unless explicitly noted otherwise, all variables are read-only
interpreter is pre-release (alpha, beta, or release candidate) then the
local and remote interpreters must be the same exact version.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I misunderstood the audit event. It's recorded by the debugged process. The documentation should clarify that.

Or maybe the audit event should also be logged by the process which calls sys.remote_exec().

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can do both no?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can update and add more info, BTW I think we can logged the event at both side

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should get an audit event in sys.remote_exec() yes

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need a new issue for that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

Record the remote_debugger_script audit event in doc
3 participants