README
¶
sigsum-go
Sigsum is a system for public and transparent logging of signed checksums, see sigsum.org for an overview of the system.
This repository contains a Go library and client tools for interacting with the system servers.
Documentation
The doc directory includes documentation of these tools, and the file formats for the policy files and the proofs of logging used by the tools. See https://www.sigsum.org/docs/ for protocol specifications, and documentation of other parts of the Sigsum system.
See the RELEASES file for information about how sigsum-go is released, and the NEWS file for a summary of changes between releases.
Development
You are encouraged to file issues and open merge requests. Sign up on our GitLab instance or login using a supported identity provider like GitHub.
Testing
Besides go unit tests (go test ./...), the tests
directory contains integration tests for all command line tools, in
the form of shell scripts. They are all run by the top-level make check Makefile target.
Contact
- IRC room
#sigsum@ OFTC.net - Matrix room
#sigsumwhich is bridged with IRC - The sigsum-general mailing list
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
sigsum-witness
A witness implementation capable of cosigning a single Sigsum log, identified by that log's public key, and corresponding "sigsum.org/..." origin line.
|
A witness implementation capable of cosigning a single Sigsum log, identified by that log's public key, and corresponding "sigsum.org/..." origin line. |
|
internal
|
|
|
pkg
|
|
|
api
The api package defines the abstract api between sigsum servers.
|
The api package defines the abstract api between sigsum servers. |
|
ascii
Package ascii implements an ASCII key-value parser and writer.
|
Package ascii implements an ASCII key-value parser and writer. |
|
crypto
package crypto provides lowest-level crypto types and primitives used by sigsum
|
package crypto provides lowest-level crypto types and primitives used by sigsum |
|
log
package log provides a simple logger with leveled log messages.
|
package log provides a simple logger with leveled log messages. |
|
merkle
package merkle provides hashing operations that can be used to verify a Sigsum log's Merkle tree.
|
package merkle provides hashing operations that can be used to verify a Sigsum log's Merkle tree. |
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
server
package server implements the http-layer of the Sigsum apis.
|
package server implements the http-layer of the Sigsum apis. |
|
submit
package submit acts as a sigsum submit client It submits a leaf to a log, and collects a sigsum proof.
|
package submit acts as a sigsum submit client It submits a leaf to a log, and collects a sigsum proof. |
|
submit-token
package token validates a sigsum submit-token.
|
package token validates a sigsum submit-token. |
|
tests
|
|