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

Abierto
#1,035 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
52/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

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.

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

Descripción

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.

Lenguaje dominante
MDX
Estrellas
19
Forks
104
Merge medio
2 d 12 h
PR fusionados (30 d)
80

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

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 OpenHands/docs

Todos los issues de OpenHands/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.