trees

Documentation

Overview

Package trees contains utility method for retrieving trees and acquiring objects (hashers, signers) associated with them.

Index

• func FromContext(ctx context.Context) (*trillian.Tree, bool)
• func GetTree(ctx context.Context, s storage.AdminStorage, treeID int64, opts GetOpts) (*trillian.Tree, error)
• func NewContext(ctx context.Context, tree *trillian.Tree) context.Context
• type GetOpts
  • func NewGetOpts(op OpType, types ...trillian.TreeType) GetOpts
• type OpType
  • func (i OpType) String() string

Functions

func FromContext

func FromContext(ctx context.Context) (*trillian.Tree, bool)

FromContext returns the tree within ctx if present, together with an indication of whether a tree was present.

func GetTree

func GetTree(ctx context.Context, s storage.AdminStorage, treeID int64, opts GetOpts) (*trillian.Tree, error)

GetTree returns the specified tree, either from the ctx (if present) or read from storage. The tree will be validated according to GetOpts before returned. Tree state is also considered (for example, deleted tree will return NotFound errors).

func NewContext

func NewContext(ctx context.Context, tree *trillian.Tree) context.Context

NewContext returns a ctx with the given tree.

Types

type GetOpts

type GetOpts struct {
	// TreeTypes is a set of allowed tree types. If empty, any type is allowed.
	TreeTypes map[trillian.TreeType]bool
	// Operation indicates what operation is being performed.
	Operation OpType
}

GetOpts contains validation options for GetTree.

func NewGetOpts

func NewGetOpts(op OpType, types ...trillian.TreeType) GetOpts

NewGetOpts creates GetOps that allows the listed set of tree types, and optionally forces the tree to be readonly.

type OpType

type OpType int

OpType indicates how a tree is to be used and participates in permissions decisions.

const (
	// Unknown is an access type that will always get rejected.
	Unknown OpType = iota
	// Admin access is for general administration purposes.
	Admin
	// Query implies access to serve query, typically readonly.
	Query
	// QueueLog is log specific - adding entries to the queue.
	QueueLog
	// SequenceLog is log specific - integrating entries into the tree.
	SequenceLog
	// UpdateMap is map specific - set / update leaves.
	UpdateMap
)

func (OpType) String

func (i OpType) String() string