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

Aperta
#1,035 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
52/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
MDX
Stelle
19
Fork
104
Merge medio
2g 12h
PR unite (30g)
80

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenHands/docs

Tutte le issue di OpenHands/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.