alee/fieldwitness
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
5b0d90eeaf
fieldwitness/docs/index.md
Aaron D. Lee 3a9cb17a5a
Some checks failed
CI / lint (push) Failing after 13s
Details
CI / typecheck (push) Failing after 14s
Details
Update docs for v0.3.0 and bump attest module to v0.2.0 
- 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>
2026-04-02 18:30:52 -04:00

2.9 KiB
Raw Blame History

FieldWitness Documentation

For Reporters and Field Users

Document Description
Reporter Quick-Start One-page card for Tier 1 USB users. Print, laminate, keep with the USB.
Reporter Field Guide Comprehensive guide: attesting photos, steganography, killswitch, backups, evidence packages.
Emergency Card Wallet-sized reference for emergency data destruction. Print and laminate.

For Administrators

Document Description
Admin Quick Reference CLI cheat sheet, hardening checklist, troubleshooting table.
Admin Operations Guide Full procedures: user management, drop box, federation, key rotation, incident response.
Deployment Guide Three-tier deployment: bootable USB, Docker org server, Kubernetes federation relay. Threat level presets, security hardening, systemd setup.

Feature Guides

Document Description
Federation Guide Gossip protocol setup, offline bundles, peer management, relay deployment.
Evidence Guide Evidence packages, cold archives, selective disclosure, chain anchoring, legal discovery workflow.
Source Drop Box Anonymous file intake: tokens, EXIF pipeline, receipt codes, operational security.

Security

Document Description
Threat Model Adversary model, security guarantees, non-guarantees, cryptographic primitives, key management, known limitations.

Architecture (Developer Reference)

Document Description
Federation Architecture System design: threat model, layers (chain, bundles, federation), key domains, permission tiers.
Chain Format Spec CBOR record format, entropy witnesses, serialization, storage format, content types.
Export Bundle Spec FIELDWITNESSX1 binary format, envelope encryption (X25519 + AES-256-GCM), Merkle trees.
Federation Protocol Spec CT-inspired server protocol: API endpoints, gossip, storage tiers, receipts, security model.

Planning

Document Description
Why FieldWitness Problem statement, positioning, scenarios, and technical overview for non-technical audiences.
C2PA Integration C2PA bridge architecture, concept mapping, implementation phases, privacy design.
Packaging Strategy Hosted demo, standalone binary, mobile app, and onboarding flow design.
GTM Feasibility Phased plan for credibility, community engagement, funding, and field testing.