entry

Documentation

Overview

Package entry implements a simple replacement strategy as a mapper.

Index

• func FromLeafValue(value []byte) (*pb.Entry, error)
• func ToLeafValue(update proto.Message) ([]byte, error)
• type Mutation
  • func NewMutation(index []byte, domainID, appID, userID string) *Mutation
  • func (m *Mutation) Check(newLeaf []byte) (bool, error)
  • func (m *Mutation) ReplaceAuthorizedKeys(pubkeys []*keyspb.PublicKey) error
  • func (m *Mutation) SerializeAndSign(signers []signatures.Signer, trustedTreeSize int64) (*pb.UpdateEntryRequest, error)
  • func (m *Mutation) SetCommitment(data []byte) error
  • func (m *Mutation) SetPrevious(oldValue []byte, copyPrevious bool) error
• type Mutator
  • func New() *Mutator
  • func (*Mutator) Mutate(oldValue, update proto.Message) (proto.Message, error)

Functions

func FromLeafValue

func FromLeafValue(value []byte) (*pb.Entry, error)

FromLeafValue takes a trillian.MapLeaf.LeafValue and returns and instantiated Entry or nil if the passes LeafValue was nil.

func ToLeafValue

func ToLeafValue(update proto.Message) ([]byte, error)

ToLeafValue converts the update object into a serialized object to store in the map.

Types

type Mutation

type Mutation struct {
	// contains filtered or unexported fields
}

Mutation provides APIs for manipulating entries.

func NewMutation

func NewMutation(index []byte, domainID, appID, userID string) *Mutation

NewMutation creates a mutation object from a previous value which can be modified. To create a new value: - Create a new mutation for a user starting with the previous value with NewMutation. - Change the value with SetCommitment and ReplaceAuthorizedKeys. - Finalize the changes and create the mutation with SerializeAndSign.

func (*Mutation) Check

func (m *Mutation) Check(newLeaf []byte) (bool, error)

Check verifies that an update was successfully applied. Returns nil if newLeaf is equal to the entry in this mutation.

func (*Mutation) ReplaceAuthorizedKeys

func (m *Mutation) ReplaceAuthorizedKeys(pubkeys []*keyspb.PublicKey) error

ReplaceAuthorizedKeys sets authorized keys to pubkeys. pubkeys must contain at least one key.

func (*Mutation) SerializeAndSign

func (m *Mutation) SerializeAndSign(signers []signatures.Signer, trustedTreeSize int64) (*pb.UpdateEntryRequest, error)

SerializeAndSign produces the mutation.

func (*Mutation) SetCommitment

func (m *Mutation) SetCommitment(data []byte) error

SetCommitment updates entry to be a commitment to data.

func (*Mutation) SetPrevious

func (m *Mutation) SetPrevious(oldValue []byte, copyPrevious bool) error

SetPrevious sets the previous hash. If copyPrevious is true, AuthorizedKeys and Commitment are also copied.

type Mutator

type Mutator struct{}

Mutator defines mutations to simply replace the current map value with the contents of the mutation.

func New

func New() *Mutator

New creates a new entry mutator.

func (*Mutator) Mutate

func (*Mutator) Mutate(oldValue, update proto.Message) (proto.Message, error)

Mutate verifies that this is a valid mutation for this item and applies mutation to value. Repeated applications of Mutate on the same input produce the same output. OldValue and update are both SignedKV protos.