api

Documentation

Index

• Constants
• type CertificateRequest
• type CertificateResponse
• type ClientOption
  • func WithTimeout(timeout time.Duration) ClientOption
  • func WithUserAgent(userAgent string) ClientOption
• type Key
• type LegacyClient
  • func NewClient(url *url.URL, opts ...ClientOption) LegacyClient
• type RootResponse

Constants

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

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

Types

type CertificateRequest

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

	// +optional
	SignedEmailAddress []byte `json:"signedEmailAddress"`

	// +optional
	CertificateSigningRequest []byte `json:"certificateSigningRequest"`
}

type CertificateResponse

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

type ClientOption

type ClientOption func(*clientOptions)

ClientOption is a functional option for customizing static signatures.

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption

WithTimeout sets the request timeout for the client

func WithUserAgent

func WithUserAgent(userAgent string) ClientOption

WithUserAgent sets the media type of the signature.

type Key

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

type LegacyClient

type LegacyClient 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)
}

LegacyClient is the interface for accessing the Fulcio API.

func NewClient

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

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

type RootResponse

type RootResponse struct {
	ChainPEM []byte
}