alee/fieldwitness
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
e4f68fc83a
fieldwitness/docs/index.md
Aaron D. Lee 490f9d4a1d Rebrand SooSeF to FieldWitness 
Complete project rebrand for better positioning in the press freedom
and digital security space. FieldWitness communicates both field
deployment and evidence testimony — appropriate for the target audience
of journalists, NGOs, and human rights organizations.

Rename mapping:
- soosef → fieldwitness (package, CLI, all imports)
- soosef.stegasoo → fieldwitness.stego
- soosef.verisoo → fieldwitness.attest
- ~/.soosef/ → ~/.fwmetadata/ (innocuous data dir name)
- SOOSEF_DATA_DIR → FIELDWITNESS_DATA_DIR
- SoosefConfig → FieldWitnessConfig
- SoosefError → FieldWitnessError

Also includes:
- License switch from MIT to GPL-3.0
- C2PA bridge module (Phase 0-2 MVP): cert.py, export.py, vendor_assertions.py
- README repositioned to lead with provenance/federation, stego backgrounded
- Threat model skeleton at docs/security/threat-model.md
- Planning docs: docs/planning/c2pa-integration.md, docs/planning/gtm-feasibility.md

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 15:05:13 -04:00

2.1 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.

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.