entry

Documentation

Overview

Package entry implements a simple replacement strategy as a mapper.

Index

• func FromLeafValue(value []byte) (*pb.SignedEntry, error)
• func MapLogItemFn(m *mutator.LogMessage, emit func(index []byte, mutation *pb.EntryUpdate)) error
• func MutateFn(oldSignedEntry, newSignedEntry *pb.SignedEntry) (*pb.SignedEntry, error)
• func ToLeafValue(update *pb.SignedEntry) ([]byte, error)
• type Mutation
  • func NewMutation(index []byte, directoryID, userID string) *Mutation
  • func (m *Mutation) EqualsPrevious(leafValue *pb.SignedEntry) bool
  • func (m *Mutation) EqualsRequested(leafValue *pb.SignedEntry) bool
  • func (m *Mutation) ReplaceAuthorizedKeys(pubkeys *tinkpb.Keyset) error
  • func (m *Mutation) SerializeAndSign(signers []*tink.KeysetHandle) (*pb.EntryUpdate, error)
  • func (m *Mutation) SetCommitment(data []byte) error
  • func (m *Mutation) SetPrevious(oldValue []byte, copyPrevious bool) error

Functions

func FromLeafValue

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

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

func MapLogItemFn

func MapLogItemFn(m *mutator.LogMessage, emit func(index []byte, mutation *pb.EntryUpdate)) error

MapLogItemFn maps elements from *mutator.LogMessage to KV<index, *pb.EntryUpdate>.

func MutateFn

func MutateFn(oldSignedEntry, newSignedEntry *pb.SignedEntry) (*pb.SignedEntry, error)

MutateFn verifies that newSignedEntry is a valid mutation for oldSignedEntry and returns the application of newSignedEntry to oldSignedEntry.

func ToLeafValue

func ToLeafValue(update *pb.SignedEntry) ([]byte, error)

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

Types

type Mutation

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

Mutation provides APIs for manipulating entries.

func NewMutation

func NewMutation(index []byte, directoryID, 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) EqualsPrevious

func (m *Mutation) EqualsPrevious(leafValue *pb.SignedEntry) bool

EqualsPrevious returns true if the leafValue is equal to the value of entry at the time this mutation was made.

func (*Mutation) EqualsRequested

func (m *Mutation) EqualsRequested(leafValue *pb.SignedEntry) bool

EqualsRequested 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 *tinkpb.Keyset) error

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

func (*Mutation) SerializeAndSign

func (m *Mutation) SerializeAndSign(signers []*tink.KeysetHandle) (*pb.EntryUpdate, 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.