Documentation for users

Meant for users who want try Sigsum and understand how it works:

• Command-line tools: generate keys, sign, submit, and offline verify
• Getting started: step-by-step demo of key-usage transparency
• Monitor tooling: poll the logs to detect signatures produced by your keys

Documentation for operators

Meant for operators who want to stand up bastions, logs, and witnesses:

• Filippo’s litebastion implementation: introduction to the litebastion software
• Filippo’s litewitness implementation: introduction to the litewitness software
• Sigsum’s log-go implementation: introduction to the log server architecture
• Sigsum’s log-go ansible collection: ansible for getting the log server software up and running
• Sigsum’s litebastion ansible role: ansible for getting the litebastion software up and running

Documentation for contributors

Meant for contributors and others who follow the project in detail:

• Archive: various notes and weekly meeting minutes
• C2SP: forum where the project collaborates on community specifications
• Design: notes and background on the Sigsum design
• Proposals: supplementary material to push decisions forward

Maintained specifications

Meant for implementers who need to know about bits and bytes:

• Bastion host protocol: release candidate
• Sigsum log server protocol: stable v1 release
• Sigsum proof bundle format: work in progress
• Sigsum trust policy format: work in progress
• Witness cosignature format: release candidate
• Witness cosigning protocol: release candidate