client

type Bundle ¶ added in v1.0.0

type Bundle struct {
	// RangeInfo decribes which of the entries in this bundle are relevent.
	RangeInfo layout.RangeInfo
	// Data is the raw serialised bundle, as fetched from the log.
	//
	// For a tlog-tiles compliant log, this can be unmarshaled using api.EntryBundle.
	Data []byte
}

Bundle represents an entry bundle in a log, along with some metadata about which parts of the bundle are relevent.

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 Entry ¶ added in v1.0.0

type Entry[T any] struct {
	// Index is the index of the entry in the log.
	Index uint64
	// Entry is the entry from the log.
	Entry T
}

Entry represents a single leaf in a log.

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:

• when asked to fetch a partial entry bundle (i.e. p != 0), fall-back to fetching the corresponding full bundle if the partial one does not exist.
• return (either directly or wrapped) an os.ErrIsNotExist when neither the requested bundle nor any fallback bundle exists.

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(ctx context.Context, i uint64, p uint8) ([]byte, error)

func (f FileFetcher) ReadTile(ctx 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. This object constructs a cache internally to make it efficient for multiple operations at a given tree size.

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:

• when asked to fetch a partial tile (i.e. p != 0), fall-back to fetching the corresponding full tile if the partial one does not exist.
• return (either directly or wrapped) an os.ErrIsNotExist when neither the requested tile nor any fallback tile exists.

type TreeSizeFunc ¶ added in v1.0.0

type TreeSizeFunc func(ctx context.Context) (uint64, error)

TreeSizeFunc is a function which knows how to return the current tree size of a log.