docs(security): document the S11 kill-switch refusal codes and operator recovery

Aperta Adatta ai principianti
#9,237 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à
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
70/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva

Direzione di ricerca

Inizia da §10.2 (Kill switch) in docs/security/agent-principals.md, poi leggi il codice unito nella PR #9220 (commit 2373ec835) per confermare i percorsi di rifiuto PERSIST_UNCONFIRMED e TOO_MANY_LABELS e la lettura di principals-disabled.json all'avvio. Confronta il testo di aiuto di chroxy agent con il documento. È completato quando §10.2 nomina entrambi i codici con le relative azioni dell'operatore, indica il limite di 256 label, descrive la lettura fail-closed all'avvio e il ripristino con chroxy agent enable --all, e il testo di aiuto è coerente.

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

Descrizione

documentation from-review

Context

Identified during review of PR #9220 (S11 of #9112, merged as 2373ec835).

Location: docs/security/agent-principals.md §10.2 (Kill switch)

Description

The kill switch that PR #9220 added returns two refusal codes the operator contract does not name yet. The doc also does not describe how to recover from a bad flag file found at boot.

  • PERSIST_UNCONFIRMED (from principal_admin_enable / chroxy agent enable): the enable was written, but the write was not confirmed durable (for example, the directory fsync failed).
    • The daemon stays disabled.
    • Because the flag file may already read "enabled", a restart could apply it.
    • Operator action: run enable again once the disk is healthy, or run disable to make the disabled state durable.
  • TOO_MANY_LABELS (from principal_admin_disable --label): the label set would exceed the 256-label bound that the writer and the boot reader share. Nothing is written.
    • Operator action: use --all.
  • Boot recovery: an unreadable, corrupt, untrusted (mode, owner or symlink) or oversized principals-disabled.json fails closed to "disabled for all".
    • The documented recovery is chroxy agent enable --all.

Acceptance Criteria

  • §10.2 names PERSIST_UNCONFIRMED and TOO_MANY_LABELS, each with its operator action.
  • §10.2 states the 256-label bound.
  • §10.2 describes the fail-closed boot read and the chroxy agent enable --all recovery path.
  • The chroxy agent help text and the doc agree.
  • Docs only, with no behaviour change.
Lingua principale
JavaScript
Stelle
7
Fork
1
Merge medio
2h 19m
PR unite (30g)
263

Preparare l'ambiente

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 blamechris/chroxy

Tutte le issue di blamechris/chroxy

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.