api

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Apr 6, 2022 License: Apache-2.0 Imports: 25 Imported by: 17

Documentation

Index

Constants

View Source 
const SigstorePublicServerURL = "https://fulcio.sigstore.dev"

SigstorePublicServerURL is the URL of Sigstore's public Fulcio service.

Variables

View Source 
var (
	MetricLatency = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Name: "fulcio_api_latency",
		Help: "API Latency on calls",
	}, []string{"code", "method"})

	RequestsCount = promauto.NewCounterVec(prometheus.CounterOpts{
		Name: "http_requests_total",
		Help: "Count all HTTP requests",
	}, []string{"code", "method"})
)

Functions

func ExtractSubject added in v0.2.0 

func ExtractSubject(ctx context.Context, tok *oidc.IDToken, publicKey crypto.PublicKey, challenge []byte) (*challenges.ChallengeResult, error)

func New added in v0.2.0 

func New(ct ctl.Client, ca certauth.CertificateAuthority) http.Handler

New creates a new http.Handler for serving the Fulcio API.

func WithMaxBytes added in v0.2.0 

func WithMaxBytes(next http.Handler, n int64) http.Handler

WithMaxBytes sets the max request size on a handler to n bytes.

Types

type CertificateRequest added in v0.2.0 

type CertificateRequest struct {
	// +required
	PublicKey Key `json:"publicKey"`

	// +required
	SignedEmailAddress []byte `json:"signedEmailAddress"`
}

type CertificateResponse added in v0.2.0 

type CertificateResponse struct {
	CertPEM  []byte
	ChainPEM []byte
	SCT      []byte
}

type Client added in v0.2.0 

type Client interface {
	// SigningCert sends the provided CertificateRequest to the /api/v1/signingCert
	// endpoint of a Fulcio API, authenticated with the provided bearer token.
	SigningCert(cr CertificateRequest, token string) (*CertificateResponse, error)
	// RootCert sends a request to get the current CA used by Fulcio.
	RootCert() (*RootResponse, error)
}

Client is the interface for accessing the Fulcio API.

func NewClient added in v0.2.0 

func NewClient(url *url.URL, opts ...ClientOption) Client

NewClient creates a new Fulcio API client talking to the provided URL.

type ClientOption added in v0.2.0 

type ClientOption func(*clientOptions)

ClientOption is a functional option for customizing static signatures.

func WithTimeout added in v0.2.0 

func WithTimeout(timeout time.Duration) ClientOption

WithTimeout sets the request timeout for the client

func WithUserAgent added in v0.2.0 

func WithUserAgent(userAgent string) ClientOption

WithUserAgent sets the media type of the signature.

type Key added in v0.2.0 

type Key struct {
	// +required
	Content   []byte `json:"content"`
	Algorithm string `json:"algorithm,omitempty"`
}

type RootResponse added in v0.2.0 

type RootResponse struct {
	ChainPEM []byte
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.