client

type CheckpointFetcherFunc ¶

type CheckpointFetcherFunc func(ctx context.Context) ([]byte, error)

CheckpointFetcherFunc is the signature of a function which can retrieve the latest checkpoint from a log's data storage.

Note that the implementation of this MUST return (either directly or wrapped) an os.ErrIsNotExist when the file referenced by path does not exist, e.g. a HTTP based implementation MUST return this error when it receives a 404 StatusCode.

type ConsensusCheckpointFunc ¶

type ConsensusCheckpointFunc func(ctx context.Context, logSigV note.Verifier, origin string) (*log.Checkpoint, []byte, *note.Note, error)

ConsensusCheckpointFunc is a function which returns the largest checkpoint known which is signed by logSigV and satisfies some consensus algorithm.

This is intended to provide a hook for adding a consensus view of a log, e.g. via witnessing.

func UnilateralConsensus(f CheckpointFetcherFunc) ConsensusCheckpointFunc

type EntryBundleFetcherFunc ¶

type EntryBundleFetcherFunc func(ctx context.Context, bundleIndex uint64, p uint8) ([]byte, error)

EntryBundleFetcherFunc is the signature of a function which can fetch the raw data for a given entry bundle.

Note that the implementation of this MUST return (either directly or wrapped) an os.ErrIsNotExist when the file referenced by path does not exist, e.g. a HTTP based implementation MUST return this error when it receives a 404 StatusCode.

type ErrInconsistency ¶

type ErrInconsistency struct {
	SmallerRaw []byte
	LargerRaw  []byte
	Proof      [][]byte

	Wrapped error
}

ErrInconsistency should be returned when there has been an error proving consistency between log states. The raw log state representations are included as-returned by the target log, this ensures that evidence of inconsistent log updates are available to the caller of the method(s) returning this error.

func (e ErrInconsistency) Error() string

func (e ErrInconsistency) Unwrap() error

type FileFetcher ¶

type FileFetcher struct {
	Root string
}

FileFetcher knows how to fetch log artifacts from a filesystem rooted at Root.

func (f FileFetcher) ReadCheckpoint(_ context.Context) ([]byte, error)

func (f FileFetcher) ReadEntryBundle(_ context.Context, i uint64, p uint8) ([]byte, error)

func (f FileFetcher) ReadTile(_ context.Context, l, i uint64, p uint8) ([]byte, error)

type HTTPFetcher ¶

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

HTTPFetcher knows how to fetch log artifacts from a log being served via HTTP.

func NewHTTPFetcher(rootURL *url.URL, c *http.Client) (*HTTPFetcher, error)

func (h HTTPFetcher) ReadCheckpoint(ctx context.Context) ([]byte, error)

func (h HTTPFetcher) ReadEntryBundle(ctx context.Context, i uint64, p uint8) ([]byte, error)

func (h HTTPFetcher) ReadTile(ctx context.Context, l, i uint64, p uint8) ([]byte, error)

func (h *HTTPFetcher) SetAuthorizationHeader(v string)

type LogStateTracker ¶

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

LogStateTracker represents a client-side view of a target log's state. This tracker handles verification that updates to the tracked log state are consistent with previously seen states.

func NewLogStateTracker(ctx context.Context, tF TileFetcherFunc, checkpointRaw []byte, nV note.Verifier, origin string, cc ConsensusCheckpointFunc) (*LogStateTracker, error)

func (lst *LogStateTracker) Latest() log.Checkpoint

func (lst *LogStateTracker) Update(ctx context.Context) ([]byte, [][]byte, []byte, error)

type ProofBuilder ¶

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

ProofBuilder knows how to build inclusion and consistency proofs from tiles. Since the tiles commit only to immutable nodes, the job of building proofs is slightly more complex as proofs can touch "ephemeral" nodes, so these need to be synthesized.

func NewProofBuilder(ctx context.Context, treeSize uint64, f TileFetcherFunc) (*ProofBuilder, error)

func (pb *ProofBuilder) ConsistencyProof(ctx context.Context, smaller, larger uint64) ([][]byte, error)

func (pb *ProofBuilder) InclusionProof(ctx context.Context, index uint64) ([][]byte, error)

type TileFetcherFunc ¶

type TileFetcherFunc func(ctx context.Context, level, index uint64, p uint8) ([]byte, error)

TileFetcherFunc is the signature of a function which can fetch the raw data for a given tile.

Note that the implementation of this MUST return (either directly or wrapped) an os.ErrIsNotExist when the file referenced by path does not exist, e.g. a HTTP based implementation MUST return this error when it receives a 404 StatusCode.