DevRunbook-Public/content/playbooks/security-hygiene-audit/playbook.yaml

apiVersion: devrunbook.io/v1alpha1
kind: Playbook
metadata:
  id: security-reliability.security-hygiene-audit
  slug: security-hygiene-audit
  version: 1.0.0
  title: Security Hygiene Audit
  summary: Review authentication, authorization, secrets, input validation, dependency risk and unsafe defaults within a defined
    application scope.
  category: security-reliability
  tags:
  - security
  - audit
  - threat-model
  lifecycle: reviewed
  riskTier: high
  authors:
  - name: DevRunbook Core Team
  license: MIT
package:
  files:
  - path: prompt.md
    role: template
    digest: true
    exportByDefault: false
  - path: README.md
    role: documentation
    digest: true
    exportByDefault: false
  - path: CHANGELOG.md
    role: changelog
    digest: true
    exportByDefault: false
  - path: examples/minimal.yaml
    role: example
    digest: true
    exportByDefault: false
  - path: evaluations/static-structure.yaml
    role: evaluation
    digest: true
    exportByDefault: false
spec:
  type: run-pack
  intent:
    problem: Development work around security hygiene audit is often underspecified, inconsistently executed or reported without
      enough evidence.
    outcome: Review authentication, authorization, secrets, input validation, dependency risk and unsafe defaults within a
      defined application scope.
    whenToUse:
    - Use this playbook when the repository needs a bounded security hygiene audit task with explicit evidence and completion
      criteria.
    - Use it when Codex should follow a repeatable workflow rather than improvise from a one-line request.
    whenNotToUse:
    - Do not use it when the desired outcome or authority boundaries are still materially undecided.
    - Do not use it to access unavailable production credentials, bypass safeguards or claim validation that cannot be performed.
  modes:
  - inspect
  - plan
  defaultMode: inspect
  autonomy:
    min: observe
    max: diagnose
    default: diagnose
  inputs:
  - key: scope
    label: Scope
    description: Describe the repository, application and deployment boundaries to assess.
    type: multiline
    required: true
    sensitive: false
    includeInOutput: true
  - key: deploymentContext
    label: Deployment context
    description: Describe trust boundaries, exposure, users, data and runtime environment.
    type: multiline
    required: true
    sensitive: false
    includeInOutput: true
  compatibility:
    repositoryRequired: true
    languages: []
    frameworks: []
    packageManagers: []
    databases: []
    deploymentTypes: []
    requiredProfileCapabilities: []
    incompatibleConditions: []
  guardrails:
  - id: guardrail-1
    severity: blocking
    text: Remain read-only and do not attempt exploitation against live or external systems.
  - id: guardrail-2
    severity: blocking
    text: Redact secrets and private data from all evidence.
  - id: guardrail-3
    severity: blocking
    text: Separate code-level findings from deployment assumptions and unsupported hypotheses.
  workflow:
  - id: model-scope
    title: Model scope and trust
    instruction: Identify assets, users, trust boundaries, exposure and data sensitivity.
    required: true
  - id: inspect-auth
    title: Inspect identity boundaries
    instruction: Review authentication, session, authorization, ownership and privilege transitions.
    required: true
  - id: inspect-inputs
    title: Inspect input and output safety
    instruction: Review validation, serialization, uploads, archives, rendering and error disclosure.
    required: true
  - id: inspect-secrets
    title: Inspect secrets and dependencies
    instruction: Review secret handling, dependency risk, configuration and build artifacts.
    required: true
  - id: inspect-operations
    title: Inspect operational security
    instruction: Review logging, backups, containers, network exposure, headers and update procedures.
    required: true
  - id: validate-findings
    title: Validate findings
    instruction: Use safe static and configured tooling, verify false positives and record limitations.
    required: true
  - id: prioritize
    title: Prioritize remediation
    instruction: Rank findings by exploitability, impact, confidence and practical repair sequence.
    required: true
  validation:
    commandRoles:
    - security-scan
    - dependency-audit
    checks:
    - id: check-1
      type: assertion
      description: Every high or critical finding includes evidence, impact, confidence and remediation.
      blocking: true
      evidence: Referenced files, command results or explicit review notes.
    - id: check-2
      type: assertion
      description: No live exploitation or secret disclosure occurs.
      blocking: true
      evidence: Referenced files, command results or explicit review notes.
    - id: command-security-scan
      type: command
      description: Run the resolved security-scan command when the repository profile provides it and record the result.
      blocking: false
      evidence: Resolved command, exit status and concise result summary.
    - id: command-dependency-audit
      type: command
      description: Run the resolved dependency-audit command when the repository profile provides it and record the result.
      blocking: false
      evidence: Resolved command, exit status and concise result summary.
  completion:
    criteria:
    - Findings include evidence, exploitability context and remediation priority.
    - The report states that it is not a formal penetration test.
    - Validation evidence and unresolved limitations are reported honestly.
  failurePolicy:
    onValidationFailure: Investigate failures caused by the current work, repair them when they remain within scope, rerun
      affected validation and report any genuine blocker without claiming success.
    onAmbiguity: Use repository evidence and existing conventions for minor reversible choices. Preserve current behavior
      and stop before any material irreversible decision that the specification does not resolve.
    onMissingContext: Inspect the repository for missing non-sensitive context. Never invent commands, credentials, production
      behavior or validation results; report what remains unavailable.
    onOutOfScopeCause: Explain the evidenced out-of-scope cause, avoid unrelated changes and provide the smallest safe follow-up
      recommendation.
    onExternalDependencyUnavailable: Use an approved local substitute or fixture only when it preserves the behavior under
      test. Otherwise record the blocked validation and do not claim the external path succeeded.
    onUnableToReproduce: Record attempted reproduction, environment and observed evidence. Do not apply speculative production
      changes; provide the narrowest next diagnostic action.
  reporting:
    sections:
    - id: outcome
      title: Outcome
      required: true
      description: State the delivered result or audit conclusion without overstating evidence.
    - id: evidence
      title: Evidence and scope
      required: true
      description: List inspected or changed areas and the evidence supporting the result.
    - id: validation
      title: Validation
      required: true
      description: Report commands, manual checks and their actual outcomes.
    - id: risks
      title: Risks and limitations
      required: true
      description: State residual risk, inaccessible evidence and untested conditions.
    - id: follow-up
      title: Recommended follow-up
      required: true
      description: List the smallest useful next actions or state None.
  template:
    main: prompt.md
    partials: []
  exports:
    prompt: true
    markdown: true
    runPack: true
    agentsSuggestion: false
quality:
  reviewStatus: editorial-reviewed
  testedStacks: []
  knownLimitations:
  - Repository-specific effectiveness depends on the accuracy of the selected profile and the evidence available to Codex.
  evaluationCaseIds:
  - security-hygiene-audit.static-structure