api

Documentation

Index

• Variables
• func ConfigureAPI(ranges sharding.LogRanges)
• func CreateLogEntryHandler(params entries.CreateLogEntryParams) middleware.Responder
• func GetLogEntryByIndexHandler(params entries.GetLogEntryByIndexParams) middleware.Responder
• func GetLogEntryByUUIDHandler(params entries.GetLogEntryByUUIDParams) middleware.Responder
• func GetLogInfoHandler(params tlog.GetLogInfoParams) middleware.Responder
• func GetLogProofHandler(params tlog.GetLogProofParams) middleware.Responder
• func GetPublicKeyHandler(params pubkey.GetPublicKeyParams) middleware.Responder
• func GetRekorVersionHandler(params server.GetRekorVersionParams) middleware.Responder
• func GetTimestampCertChainHandler(params timestamp.GetTimestampCertChainParams) middleware.Responder
• func RequestFromRekor(ctx context.Context, req pkcs9.TimeStampReq) ([]byte, error)
• func SearchIndexHandler(params index.SearchIndexParams) middleware.Responder
• func SearchIndexNotImplementedHandler(params index.SearchIndexParams) middleware.Responder
• func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Responder
• func TimestampResponseHandler(params timestamp.GetTimestampResponseParams) middleware.Responder
• type API
  • func NewAPI(ranges sharding.LogRanges) (*API, error)
• type Response
• type TrillianClient
  • func NewTrillianClient(ctx context.Context) TrillianClient

Variables

var (
	// Output of "git describe". The prerequisite is that the branch should be
	// tagged using the correct versioning strategy.
	GitVersion string = "devel"
	// SHA1 from git, output of $(git rev-parse HEAD)
	GitCommit = "unknown"
	// State of git tree, either "clean" or "dirty"
	GitTreeState = "unknown"
	// Build date in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ')
	BuildDate = "unknown"
)

Base version information.

This is the fallback data used when version information from git is not provided via go ldflags (e.g. via Makefile).

var (
	MetricLatency = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Name: "rekor_api_latency",
		Help: "Api Latency on calls",
	}, []string{"path", "code"})
)

Functions

func ConfigureAPI

func ConfigureAPI(ranges sharding.LogRanges)

func CreateLogEntryHandler

func CreateLogEntryHandler(params entries.CreateLogEntryParams) middleware.Responder

CreateLogEntryHandler creates new entry into log

func GetLogEntryByIndexHandler

func GetLogEntryByIndexHandler(params entries.GetLogEntryByIndexParams) middleware.Responder

GetLogEntryAndProofByIndexHandler returns the entry and inclusion proof for a specified log index

func GetLogEntryByUUIDHandler

func GetLogEntryByUUIDHandler(params entries.GetLogEntryByUUIDParams) middleware.Responder

GetLogEntryByUUIDHandler gets log entry and inclusion proof for specified UUID aka merkle leaf hash

func GetLogInfoHandler

func GetLogInfoHandler(params tlog.GetLogInfoParams) middleware.Responder

GetLogInfoHandler returns the current size of the tree and the STH

func GetLogProofHandler

func GetLogProofHandler(params tlog.GetLogProofParams) middleware.Responder

GetLogProofHandler returns information required to compute a consistency proof between two snapshots of log

func GetPublicKeyHandler

func GetPublicKeyHandler(params pubkey.GetPublicKeyParams) middleware.Responder

func GetRekorVersionHandler

func GetRekorVersionHandler(params server.GetRekorVersionParams) middleware.Responder

func GetTimestampCertChainHandler

func GetTimestampCertChainHandler(params timestamp.GetTimestampCertChainParams) middleware.Responder

func RequestFromRekor

func RequestFromRekor(ctx context.Context, req pkcs9.TimeStampReq) ([]byte, error)

func SearchIndexHandler

func SearchIndexHandler(params index.SearchIndexParams) middleware.Responder

func SearchIndexNotImplementedHandler

func SearchIndexNotImplementedHandler(params index.SearchIndexParams) middleware.Responder

func SearchLogQueryHandler

func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Responder

SearchLogQueryHandler searches log by index, UUID, or proposed entry and returns array of entries found with inclusion proofs

func TimestampResponseHandler

func TimestampResponseHandler(params timestamp.GetTimestampResponseParams) middleware.Responder

Types

type API

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

func NewAPI

func NewAPI(ranges sharding.LogRanges) (*API, error)

type Response

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

type TrillianClient

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

func NewTrillianClient

func NewTrillianClient(ctx context.Context) TrillianClient