client

package
v0.0.0-...-f1c747c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2017 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

Package client verifies responses from the Trillian log.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LogClient

type LogClient struct {
	LogID int64
	// contains filtered or unexported fields
}

LogClient represents a client for a given Trillian log instance.

func New

func New(logID int64, client trillian.TrillianLogClient, hasher merkle.TreeHasher, pubKey crypto.PublicKey) *LogClient

New returns a new LogClient.

func (*LogClient) AddLeaf

func (c *LogClient) AddLeaf(ctx context.Context, data []byte) error

AddLeaf adds leaf to the append only log. Blocks until it gets a verifiable response.

func (*LogClient) GetByIndex

func (c *LogClient) GetByIndex(ctx context.Context, index int64) (*trillian.LogLeaf, error)

GetByIndex returns a single leaf at the requested index.

func (*LogClient) ListByIndex

func (c *LogClient) ListByIndex(ctx context.Context, start, count int64) ([]*trillian.LogLeaf, error)

ListByIndex returns the requested leaves by index.

func (*LogClient) Root

func (c *LogClient) Root() trillian.SignedLogRoot

Root returns the last valid root seen by UpdateRoot. Returns an empty SignedLogRoot if UpdateRoot has not been called.

func (*LogClient) UpdateRoot

func (c *LogClient) UpdateRoot(ctx context.Context) error

UpdateRoot retrieves the current SignedLogRoot. Verifies the signature, and the consistency proof if this is not the first root this client has seen.

func (*LogClient) VerifyInclusion

func (c *LogClient) VerifyInclusion(ctx context.Context, data []byte) error

VerifyInclusion updates the log root and ensures that the given leaf data has been included in the log.

func (*LogClient) VerifyInclusionAtIndex

func (c *LogClient) VerifyInclusionAtIndex(ctx context.Context, data []byte, index int64) error

VerifyInclusionAtIndex updates the log root and ensures that the given leaf data has been included in the log at a particular index.

func (LogClient) VerifyInclusionByHash

func (c LogClient) VerifyInclusionByHash(trusted *trillian.SignedLogRoot, leafHash []byte, proof *trillian.Proof) error

VerifyInclusionByHash verifies the inclusion proof for data

func (LogClient) VerifyRoot

func (c LogClient) VerifyRoot(trusted, newRoot *trillian.SignedLogRoot,
	consistency [][]byte) error

VerifyRoot verifies that newRoot is a valid append-only operation from trusted. If trusted.TreeSize is zero, a consistency proof is not needed.

type LogVerifier

type LogVerifier interface {
	// VerifyRoot verifies that newRoot is a valid append-only operation from trusted.
	// If trusted.TreeSize is zero, an append-only proof is not needed.
	VerifyRoot(trusted, newRoot *trillian.SignedLogRoot, consistency [][]byte) error
	// VerifyInclusionAtIndex verifies that the inclusion proof for data at index matches
	// the currently trusted root. The inclusion proof must be requested for Root().TreeSize.
	VerifyInclusionAtIndex(trusted *trillian.SignedLogRoot, data []byte, leafIndex int64, proof [][]byte) error
	// VerifyInclusionByHash verifies the inclusion proof for data
	VerifyInclusionByHash(trusted *trillian.SignedLogRoot, leafHash []byte, proof *trillian.Proof) error
}

LogVerifier verifies responses from a Trillian Log.

func NewLogVerifier

func NewLogVerifier(hasher merkle.TreeHasher, pubKey crypto.PublicKey) LogVerifier

NewLogVerifier returns an object that can verify output from Trillian Logs.

type MockLogClient

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

MockLogClient supports applying mutations to the return values of the TrillianLogClient

func (*MockLogClient) GetConsistencyProof

GetConsistencyProof forwards requests and modifies responses.

func (*MockLogClient) GetEntryAndProof

GetEntryAndProof forwards requests.

func (*MockLogClient) GetInclusionProof

GetInclusionProof forwards requests and modifies the response.

func (*MockLogClient) GetInclusionProofByHash

GetInclusionProofByHash forwards requests.

func (*MockLogClient) GetLatestSignedLogRoot

GetLatestSignedLogRoot forwards requests.

func (*MockLogClient) GetLeavesByHash

GetLeavesByHash forwards requests.

func (*MockLogClient) GetLeavesByIndex

GetLeavesByIndex forwards requests.

func (*MockLogClient) GetSequencedLeafCount

GetSequencedLeafCount forwards requests.

func (*MockLogClient) QueueLeaf

QueueLeaf forwards requests.

func (*MockLogClient) QueueLeaves

QueueLeaves forwards requests.

type VerifyingLogClient

type VerifyingLogClient interface {
	// AddLeaf adds data to the Trillian Log and blocks until an inclusion proof
	// is available. If no proof is available within the ctx deadline, DeadlineExceeded
	// is returned.
	AddLeaf(ctx context.Context, data []byte) error
	// VerifyInclusion ensures that data has been included in the log
	// via an inclusion proof.
	VerifyInclusion(ctx context.Context, data []byte) error
	// VerifyInclusionAtIndex ensures that data has been included in the log
	// via in inclusion proof for a particular index.
	VerifyInclusionAtIndex(ctx context.Context, data []byte, index int64) error
	// UpdateRoot fetches and verifies the current SignedTreeRoot.
	// It checks signatures as well as consistency proofs from the last-seen root.
	UpdateRoot(ctx context.Context) error
	// Root provides the last root obtained by UpdateRoot.
	Root() trillian.SignedLogRoot

	// GetByIndex returns a single leaf. Does not verify the leaf's inclusion proof.
	GetByIndex(ctx context.Context, index int64) (*trillian.LogLeaf, error)
	// ListByIndex returns a contiguous range. Does not verify the leaf's inclusion proof.
	ListByIndex(ctx context.Context, start, count int64) ([]*trillian.LogLeaf, error)
}

VerifyingLogClient is a client that verifies output from Trillian.

Directories

Path Synopsis
Package backoff allows retrying an operation with backoff.
Package backoff allows retrying an operation with backoff.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL