3a9cb17a5a
- Bump attest subpackage version from 0.1.0 to 0.2.0 - Add c2pa_bridge/ module to CLAUDE.md architecture tree - Add security/ and planning/ docs to CLAUDE.md and docs/index.md - Update federation architecture doc version to 0.3.0 - Verify zero remaining old branding references across all docs Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
50 lines
2.9 KiB
Markdown
50 lines
2.9 KiB
Markdown
# FieldWitness Documentation
|
|
|
|
## For Reporters and Field Users
|
|
|
|
| Document | Description |
|
|
|---|---|
|
|
| [Reporter Quick-Start](training/reporter-quickstart.md) | One-page card for Tier 1 USB users. Print, laminate, keep with the USB. |
|
|
| [Reporter Field Guide](training/reporter-field-guide.md) | Comprehensive guide: attesting photos, steganography, killswitch, backups, evidence packages. |
|
|
| [Emergency Card](training/emergency-card.md) | Wallet-sized reference for emergency data destruction. Print and laminate. |
|
|
|
|
## For Administrators
|
|
|
|
| Document | Description |
|
|
|---|---|
|
|
| [Admin Quick Reference](training/admin-reference.md) | CLI cheat sheet, hardening checklist, troubleshooting table. |
|
|
| [Admin Operations Guide](training/admin-operations-guide.md) | Full procedures: user management, drop box, federation, key rotation, incident response. |
|
|
| [Deployment Guide](deployment.md) | Three-tier deployment: bootable USB, Docker org server, Kubernetes federation relay. Threat level presets, security hardening, systemd setup. |
|
|
|
|
## Feature Guides
|
|
|
|
| Document | Description |
|
|
|---|---|
|
|
| [Federation Guide](federation.md) | Gossip protocol setup, offline bundles, peer management, relay deployment. |
|
|
| [Evidence Guide](evidence-guide.md) | Evidence packages, cold archives, selective disclosure, chain anchoring, legal discovery workflow. |
|
|
| [Source Drop Box](source-dropbox.md) | Anonymous file intake: tokens, EXIF pipeline, receipt codes, operational security. |
|
|
|
|
## Security
|
|
|
|
| Document | Description |
|
|
|---|---|
|
|
| [Threat Model](security/threat-model.md) | Adversary model, security guarantees, non-guarantees, cryptographic primitives, key management, known limitations. |
|
|
|
|
## Architecture (Developer Reference)
|
|
|
|
| Document | Description |
|
|
|---|---|
|
|
| [Federation Architecture](architecture/federation.md) | System design: threat model, layers (chain, bundles, federation), key domains, permission tiers. |
|
|
| [Chain Format Spec](architecture/chain-format.md) | CBOR record format, entropy witnesses, serialization, storage format, content types. |
|
|
| [Export Bundle Spec](architecture/export-bundle.md) | FIELDWITNESSX1 binary format, envelope encryption (X25519 + AES-256-GCM), Merkle trees. |
|
|
| [Federation Protocol Spec](architecture/federation-protocol.md) | CT-inspired server protocol: API endpoints, gossip, storage tiers, receipts, security model. |
|
|
|
|
## Planning
|
|
|
|
| Document | Description |
|
|
|---|---|
|
|
| [Why FieldWitness](planning/why-fieldwitness.md) | Problem statement, positioning, scenarios, and technical overview for non-technical audiences. |
|
|
| [C2PA Integration](planning/c2pa-integration.md) | C2PA bridge architecture, concept mapping, implementation phases, privacy design. |
|
|
| [Packaging Strategy](planning/packaging-strategy.md) | Hosted demo, standalone binary, mobile app, and onboarding flow design. |
|
|
| [GTM Feasibility](planning/gtm-feasibility.md) | Phased plan for credibility, community engagement, funding, and field testing. |
|