httptransport

Documentation

Overview

Package httptransport contains the HTTP logic for implementing the Clair(v4) HTTP API v1.

Index

• Constants
• Variables
• func DiscoveryHandler(_ context.Context, prefix string, topt otelhttp.Option) http.Handler
• func New(ctx context.Context, conf *config.Config, indexer indexer.Service, ...) (http.Handler, error)
• type IndexerV1
  • func NewIndexerV1(_ context.Context, prefix string, srv indexer.Service, topt otelhttp.Option) (*IndexerV1, error)
  • func (h *IndexerV1) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type MatcherV1
  • func NewMatcherV1(_ context.Context, prefix string, srv matcher.Service, ...) *MatcherV1
  • func (h *MatcherV1) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type NotificationV1
  • func NewNotificationV1(_ context.Context, prefix string, srv notifier.Service, topt otelhttp.Option) (*NotificationV1, error)
  • func (h *NotificationV1) ServeHTTP(w http.ResponseWriter, r *http.Request)
• Bugs

Constants

const (
	IndexAPIPath                 = indexerRoot + apiRoot + "index_report"
	IndexReportAPIPath           = indexerRoot + apiRoot + "index_report/"
	IndexStateAPIPath            = indexerRoot + apiRoot + "index_state"
	AffectedManifestAPIPath      = indexerRoot + internalRoot + "affected_manifest/"
	VulnerabilityReportPath      = matcherRoot + apiRoot + "vulnerability_report/"
	UpdateOperationAPIPath       = matcherRoot + internalRoot + "update_operation"
	UpdateOperationDeleteAPIPath = matcherRoot + internalRoot + "update_operation/"
	UpdateDiffAPIPath            = matcherRoot + internalRoot + "update_diff"
	NotificationAPIPath          = notifierRoot + apiRoot + "notification/"
	KeysAPIPath                  = notifierRoot + apiRoot + "services/notifier/keys"
	KeyByIDAPIPath               = notifierRoot + apiRoot + "services/notifier/keys/"
	OpenAPIV1Path                = "/openapi/v1"
)

These are the various endpoints of the v1 API.

const IntraserviceIssuer = `clair-intraservice`

IntraserviceIssuer is the issuer that will be used if Clair is configured to mint its own JWTs.

Variables

var ErrMediaType = errors.New("no common media type")

ErrMediaType is returned if no common media types can be found for a given request.

Functions

func DiscoveryHandler

func DiscoveryHandler(_ context.Context, prefix string, topt otelhttp.Option) http.Handler

DiscoveryHandler serves the embedded OpenAPI spec.

func New

func New(ctx context.Context, conf *config.Config, indexer indexer.Service, matcher matcher.Service, notifier notifier.Service) (http.Handler, error)

New configures an http.Handler serving the v1 API or a portion of it, according to the passed Config object.

Types

type IndexerV1

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

IndexerV1 is a consolidated Indexer endpoint.

func NewIndexerV1

func NewIndexerV1(_ context.Context, prefix string, srv indexer.Service, topt otelhttp.Option) (*IndexerV1, error)

NewIndexerV1 returns an http.Handler serving the Indexer V1 API rooted at "prefix".

func (*IndexerV1) ServeHTTP

func (h *IndexerV1) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler.

type MatcherV1

type MatcherV1 struct {
	Cache time.Duration
	// contains filtered or unexported fields
}

MatcherV1 is a consolidated Matcher endpoint.

func NewMatcherV1

func NewMatcherV1(_ context.Context, prefix string, srv matcher.Service, indexerSrv indexer.Service, cacheAge time.Duration, topt otelhttp.Option) *MatcherV1

NewMatcherV1 returns an http.Handler serving the Matcher V1 API rooted at "prefix".

func (*MatcherV1) ServeHTTP

func (h *MatcherV1) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler.

type NotificationV1

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

NotificationV1 is a Notification endpoint.

func NewNotificationV1

func NewNotificationV1(_ context.Context, prefix string, srv notifier.Service, topt otelhttp.Option) (*NotificationV1, error)

NewNotificationV1 returns an http.Handler serving the Notification V1 API rooted at "prefix".

func (*NotificationV1) ServeHTTP

func (h *NotificationV1) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler.

Notes

Bugs

• Content type negotiation does an O(n*m) comparison driven on user input, which may be a DoS issue.