instance

Documentation

Index

• type Config
• type Handler
  • func (h Handler) Path() string
  • func (a Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Instance
  • func (i *Instance) Handlers() []Handler

Types

type Config

type Config struct {
	LogID      string        // H(public key), then hex-encoded
	TreeID     int64         // Merkle tree identifier used by Trillian
	Prefix     string        // The portion between base URL and st/v0 (may be "")
	MaxRange   int64         // Maximum number of leaves per get-leaves request
	Deadline   time.Duration // Deadline used for gRPC requests
	Interval   time.Duration // Cosigning frequency
	ShardStart uint64        // Shard interval start (num seconds since UNIX epoch)

	// Witnesses map trusted witness identifiers to public verification keys
	Witnesses map[types.Hash]types.PublicKey
}

Config is a collection of log parameters

type Handler

type Handler struct {
	Instance *Instance
	Endpoint types.Endpoint
	Method   string
	Handler  func(context.Context, *Instance, http.ResponseWriter, *http.Request) (int, error)
}

Handler implements the http.Handler interface, and contains a reference to a sigsum server instance as well as a function that uses it.

func (Handler) Path

func (h Handler) Path() string

Path returns a path that should be configured for this handler

func (Handler) ServeHTTP

func (a Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP is part of the http.Handler interface

type Instance

type Instance struct {
	Config                      // configuration parameters
	Client   db.Client          // provides access to the Trillian backend
	Signer   crypto.Signer      // provides access to Ed25519 private key
	Stateman state.StateManager // coordinates access to (co)signed tree heads
	DNS      dns.Verifier       // checks if domain name knows a public key
}

Instance is an instance of the log's front-end

func (*Instance) Handlers

func (i *Instance) Handlers() []Handler

Handlers returns a list of sigsum handlers