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 Hash(tree *trillian.Tree) (crypto.Hash, error)
- func Hasher(tree *trillian.Tree) (merkle.TreeHasher, error)
- func NewContext(ctx context.Context, tree *trillian.Tree) context.Context
- func Signer(ctx context.Context, sf keys.SignerFactory, tree *trillian.Tree) (*tcrypto.Signer, error)
- type GetOpts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FromContext ¶
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 Hasher ¶
func Hasher(tree *trillian.Tree) (merkle.TreeHasher, error)
Hasher returns a merkle.TreeHasher of the kind configured for the tree.
func NewContext ¶
NewContext returns a ctx with the given tree.
Types ¶
type GetOpts ¶
type GetOpts struct {
// TreeType is the expected type of the tree. Use trillian.TreeType_UNKNOWN_TREE_TYPE to
// allow any type.
TreeType trillian.TreeType
// Readonly is whether the tree will be used for read-only purposes.
Readonly bool
}
GetOpts contains validation options for GetTree.
Source Files
Click to show internal directories.
Click to hide internal directories.