Skip to content

privacy.md

Latest commit

 

History

History
54 lines (45 loc) · 2.98 KB

privacy.md

File metadata and controls

54 lines (45 loc) · 2.98 KB
Raw

Privacy And Redaction

Agents Shipgate is local-first. A scan reads local manifests and tool-surface artifacts, then writes local reports under the configured output directory. The CLI does not upload tool schemas, prompts, reports, credentials, or telemetry.

The Agents Shipgate Codex plugin is skill-only. It gives Codex workflow instructions for running the local agents-shipgate CLI; it does not declare apps, MCP servers, hooks, bundled credentials, or a hosted service. Any command execution happens in the user's Codex workspace and uses the locally installed CLI.

Public scan artifacts are redacted by default before they are written:

  • report.json, report.md, and report.sarif
  • Release Evidence Packet outputs (packet.json, packet.md, packet.html, and packet.pdf when PDF support is installed)
  • Verify artifacts derived from the redacted report and verifier projections: verifier.json, verify-run.json, and pr-comment.md
  • GitHub step summaries
  • explain-finding output loaded from an existing report.json
  • JSON logs under AGENTS_SHIPGATE_LOG_FORMAT=json

Redaction is best-effort and deterministic. It uses known secret patterns (OpenAI-style API keys, AWS access keys and STS-like IDs, GitHub classic and fine-grained tokens, Stripe API and webhook secrets, Slack tokens, JWTs, common database URLs, bearer tokens, and labeled secret values) plus obvious sensitive leaf keys such as password, token, secret, and authorization. It is not a replacement for a full secret scanner.

Every emitted v0.18+ report includes privacy_audit. The audit confirms that the redaction layer ran, names the redaction rules and sensitive-field inventory versions, lists output surfaces covered by the scan, and records aggregate redaction counts by structural path. The audit never includes original values or hashes/verifiers of original values.

verify-run.json is a reproducibility artifact, not a secret scanner or raw input dump. It records local path metadata plus SHA-256 hashes for the manifest, baseline file when supplied, loaded policy packs, and emitted artifacts. Those hashes are intended to prove byte identity for local verification inputs and outputs; they are not redaction hashes of sensitive field values. Report v0.27 also includes loaded_policy_packs[].sha256 as part of policy-pack distribution metadata for organization audit; verify-run.json copies the loaded pack hashes into the run-input provenance when they are available.

Audit paths are structural summaries, not exact JSONPath selectors. Simple object keys are preserved, while complex dotted or colon-separated map keys may be collapsed to <key> and secret-bearing keys are shown as <redacted>.

The sensitive-field inventory is machine-readable at report-sensitive-fields.json. It classifies top-level report fields and packet-derived sections as secret_value, credential_metadata, free_text, path_metadata, schema_metadata, hash_only, or public_control_metadata.