api

Documentation

Overview

Package api provides the API endpoints for the witness.

Index

• Constants
• type CosignedSTH
• type UpdateRequest

Constants

const (
	// HTTPGetSTH is the path of the URL to get an STH.  The
	// placeholder is for the logID (an alphanumeric string).
	HTTPGetSTH = "/ctwitness/v0/logs/%s/sth"
	// HTTPUpdate is the path of the URL to update to a new STH.
	// Again the placeholder is for the logID.
	HTTPUpdate = "/ctwitness/v0/logs/%s/update"
	// HTTPGetLogs is the path of the URL to get a list of all logs the
	// witness is aware of.
	HTTPGetLogs = "/ctwitness/v0/logs"
)

Types

type CosignedSTH

type CosignedSTH struct {
	ct.SignedTreeHead
	WitnessSigs []ct.DigitallySigned `json:"witness_signatures"`
}

CosignedSTH has all the fields from a CT SignedTreeHead but adds a WitnessSigs field that holds the extra witness signatures.

type UpdateRequest

type UpdateRequest struct {
	STH   []byte
	Proof [][]byte
}

UpdateRequest encodes the inputs to the witness Update function: a (raw) STH byte slice and a consistency proof (slice of slices). The logID is part of the request URL.