Docs: link to a third-party SecurityAnalyzerBase implementation (ACGS rules) in the security guide?

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

メンテナーはふだん 1 日以内に返信

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

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
52/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
documentation

調査の方向性

Start with sdk/guides/security.mdx and read the “Custom Security Analyzer Implementation” section. Check the guide’s conventions for linking community packages and whether third-party examples belong here or in OpenHands/extensions; the issue asks maintainers to decide before a PR is opened. Done means the link’s placement and wording are agreed on.

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

説明

The SDK security guide (sdk/guides/security.mdx) shows how to write a custom analyzer by subclassing
SecurityAnalyzerBase ("Custom Security Analyzer Implementation"). I maintain a small community package that
does this, openhands-acgs (Apache-2.0, https://github.com/acgs-ai/openhands-acgs).
It rates each action with declarative ACGS rules:

  • ACGSSecurityAnalyzer.security_risk(action) returns HIGH when a blocking rule matches, when a rule asks for
    human review, or when the action cannot be evaluated, and LOW otherwise. analyze_action adds the verdict,
    the rule IDs and the reason as SecurityAnalysis.details, never argument values.
  • It is a pydantic model like the built-in analyzers, so it is saved and restored with persisted conversations.

Because an analyzer only rates risk, the package documents that it is a risk signal plus confirmation, not a
hard block
. With the default NeverConfirm() policy, a HIGH action still runs. The recommended setup is
therefore:

from openhands.sdk.security.confirmation_policy import ConfirmRisky
from openhands_acgs import ACGSSecurityAnalyzer, resolve_confirmation

analyzer = ACGSSecurityAnalyzer()
conversation.set_security_analyzer(analyzer)
conversation.set_confirmation_policy(ConfirmRisky())  # pause on HIGH

# when execution_status == WAITING_FOR_CONFIRMATION:
resolve_confirmation(conversation, analyzer, approve)  # rejects ACGS denials, asks `approve` otherwise
conversation.run()

resolve_confirmation calls reject_pending_actions when any pending action is denied. It is tested offline with
a real LocalConversation and TestLLM against openhands-sdk 1.54.0 and 1.59.0, on Python 3.12 to 3.14.

Question: would a one- or two-sentence link to it be welcome, for example at the end of "Custom Security
Analyzer Implementation"? Something like:

For a community example, see openhands-acgs, which rates actions
with ACGS rules and rejects denied actions while the conversation waits for confirmation.

If links to third-party packages do not belong in this guide, or should live in OpenHands/extensions instead,
that is fine. I would not open a PR before you say where, if anywhere, it fits. The package is not affiliated with
or endorsed by OpenHands.

主要言語
MDX
スター
19
フォーク
104
平均マージ
2日 12時間
マージ済み PR(30日)
80

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

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

OpenHands/docs のほかの issue

OpenHands/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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