publish

Documentation

Overview

Package publish defines the exposure keys publishing API.

Package publish defines the exposure keys publishing API.

Package publish defines the exposure keys publishing API.

Package publish defines the exposure keys publishing API.

Index

• type Config
  • func (c *Config) AuthorizedAppConfig() *authorizedapp.Config
  • func (c *Config) DatabaseConfig() *database.Config
  • func (c *Config) DebugReleaseSameDayKeys() bool
  • func (c *Config) KeyManagerConfig() *keys.Config
  • func (c *Config) MaxExposureKeys() uint
  • func (c *Config) MaxIntervalStartAge() time.Duration
  • func (c *Config) MaxSameDayKeys() uint
  • func (c *Config) MaxSymptomOnsetDays() uint
  • func (c *Config) ObservabilityExporterConfig() *observability.Config
  • func (c *Config) SecretManagerConfig() *secrets.Config
  • func (c *Config) TruncateWindow() time.Duration
• type PublishHandler
  • func NewHandler(ctx context.Context, config *Config, env *serverenv.ServerEnv) (*PublishHandler, error)
  • func (h *PublishHandler) Handle() http.Handler
  • func (h *PublishHandler) HandleV1Alpha1() http.Handler

Types

type Config

type Config struct {
	AuthorizedApp         authorizedapp.Config
	Database              database.Config
	SecretManager         secrets.Config
	KeyManager            keys.Config
	Verification          verification.Config
	ObservabilityExporter observability.Config
	RevisionToken         revision.Config

	Port             string `env:"PORT, default=8080"`
	MaxKeysOnPublish uint   `env:"MAX_KEYS_ON_PUBLISH, default=30"`
	// Provides compatibility w/ 1.5 release.
	MaxSameStartIntervalKeys     uint          `env:"MAX_SAME_START_INTERVAL_KEYS, default=3"`
	MaxIntervalAge               time.Duration `env:"MAX_INTERVAL_AGE_ON_PUBLISH, default=360h"`
	MaxMagnitudeSymptomOnsetDays uint          `env:"MAX_SYMPTOM_ONSET_DAYS, default=21"`
	CreatedAtTruncateWindow      time.Duration `env:"TRUNCATE_WINDOW, default=1h"`

	RevisionKeyCacheDuration time.Duration `env:"REVISION_KEY_CACHE_DURATION, default=1m"`

	// API Versions.
	EnableV1Alpha1API bool `env:"ENABLE_V1ALPHA1_API, default=true"`

	// If set and if a publish request has no regions (v1alpha1) and the health authority
	// has no regions configured, then this default will be assumed.
	// This is present for an upgrade edgecase where empty region list used to mean "all regions"
	// Should only be set if a server is being operated in a single region.
	DefaultRegion string `env:"DEFAULT_REGION"`

	// Flags for local development and testing. This will cause still valid keys
	// to not be embargoed.
	// Normally "still valid" keys can be accepted, but are embargoed.
	ReleaseSameDayKeys      bool `env:"DEBUG_RELEASE_SAME_DAY_KEYS"`
	DebugLogBadCertificates bool `env:"DEBUG_LOG_BAD_CERTIFICATES"`
}

Config represents the configuration and associated environment variables for the publish components.

func (*Config) AuthorizedAppConfig

func (c *Config) AuthorizedAppConfig() *authorizedapp.Config

func (*Config) DatabaseConfig

func (c *Config) DatabaseConfig() *database.Config

func (*Config) DebugReleaseSameDayKeys

func (c *Config) DebugReleaseSameDayKeys() bool

func (*Config) KeyManagerConfig

func (c *Config) KeyManagerConfig() *keys.Config

func (*Config) MaxExposureKeys

func (c *Config) MaxExposureKeys() uint

func (*Config) MaxIntervalStartAge

func (c *Config) MaxIntervalStartAge() time.Duration

func (*Config) MaxSameDayKeys

func (c *Config) MaxSameDayKeys() uint

func (*Config) MaxSymptomOnsetDays

func (c *Config) MaxSymptomOnsetDays() uint

func (*Config) ObservabilityExporterConfig

func (c *Config) ObservabilityExporterConfig() *observability.Config

func (*Config) SecretManagerConfig

func (c *Config) SecretManagerConfig() *secrets.Config

func (*Config) TruncateWindow

func (c *Config) TruncateWindow() time.Duration

type PublishHandler

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

func NewHandler

func NewHandler(ctx context.Context, config *Config, env *serverenv.ServerEnv) (*PublishHandler, error)

NewHandler creates common API handler for the publish API. This supports all current versions of the API and each defines it's own entry point via an http.HandlerFunc

func (*PublishHandler) Handle

func (h *PublishHandler) Handle() http.Handler

Handle returns an http.Handler that can process V1 publish requests.

func (*PublishHandler) HandleV1Alpha1

func (h *PublishHandler) HandleV1Alpha1() http.Handler