platform

package
v0.18.0 Latest Latest
Warning

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

Go to latest
Published: Nov 6, 2026 License: Apache-2.0 Imports: 37 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrNoMasterKey = errors.New("no master key: set SKAEL_MASTER_KEYS")

ErrNoMasterKey means no master key can seal or open a value.

Functions

func ClassifiedRateLimiter added in v0.9.0

func ClassifiedRateLimiter(cfg RateLimitConfig) func(http.Handler) http.Handler

ClassifiedRateLimiter returns middleware with a separate per-minute budget per route class. Auth is IP-only; other classes check an IP ceiling first (stops forged-key bursts before they grow the per-subject map), then a per-subject budget keyed by API key or IP.

func ClientIP added in v0.9.0

func ClientIP(trusted *TrustedProxies) func(http.Handler) http.Handler

ClientIP resolves the client address and stores it on the context. Replaces chi's RealIP, which trusts forwarding headers unconditionally — here they are read only when the peer is a configured trusted proxy.

func ClientIPFromRequest added in v0.9.0

func ClientIPFromRequest(r *http.Request) string

ClientIPFromRequest returns the resolved client address, falling back to the socket address when the ClientIP middleware is not installed.

func InitLogger

func InitLogger()

InitLogger configures zerolog. When LOG_FORMAT=pretty (or LOG_PRETTY=true), uses colorized console output for development. Otherwise outputs JSON for production/log aggregation.

func IsDuplicateKey

func IsDuplicateKey(err error) bool

IsDuplicateKey returns true if err is a Postgres unique-violation (SQLSTATE 23505).

func MetricsMiddleware added in v0.7.0

func MetricsMiddleware(next http.Handler) http.Handler

func Migrate

func Migrate(db *sql.DB) error

func MigrateDown

func MigrateDown(db *sql.DB) error

func MigrateStatus

func MigrateStatus(db *sql.DB) error

func MigrateUpTo added in v0.10.0

func MigrateUpTo(db *sql.DB, version int64) error

MigrateUpTo applies migrations up to and including version, leaving later ones unapplied. It exists so a migration can be tested against a database populated at the prior version — the only way that test means anything. A test that opens a fully-migrated database and then "upgrades" it passes with the migration deleted.

func NewPool

func NewPool(ctx context.Context, databaseURL string, cfg *PoolConfig) (*pgxpool.Pool, error)

func OpenDB

func OpenDB(databaseURL string) (*sql.DB, error)

func RequestID added in v0.7.0

func RequestID(next http.Handler) http.Handler

RequestID is a Chi-compatible middleware that reads X-Request-ID from the incoming request, or generates a UUID if absent. It sets the ID on the response header and in the request context.

func RequestIDFromContext added in v0.7.0

func RequestIDFromContext(ctx context.Context) string

RequestIDFromContext returns the request ID stored in ctx, or "".

func RequestLogger

func RequestLogger(next http.Handler) http.Handler

RequestLogger is a Chi-compatible middleware that logs every request using zerolog. Logs method, path, status, duration, and client IP.

The IP is the one ClientIP resolved, so the logs name the same client the rate limiter charged — reading a 429 against the wrong address would make every limiter incident impossible to trace.

func RequestScheme added in v0.16.0

func RequestScheme(r *http.Request, trusted *TrustedProxies) string

RequestScheme returns the scheme the client used. X-Forwarded-Proto counts only from a trusted proxy, the same rule as the client address.

func RunMigrations

func RunMigrations(ctx context.Context, pool *pgxpool.Pool) error

func SecurityHeaders added in v0.7.0

func SecurityHeaders(cookieSecure bool) func(http.Handler) http.Handler

SecurityHeaders returns middleware that sets common security response headers. When cookieSecure is true, Strict-Transport-Security is also set.

Types

type Config

type Config struct {
	DatabaseURL          string
	StoragePath          string
	ListenAddr           string
	DisableSignup        bool
	PublicURL            string
	SignupAllowedDomains string
	OIDCIssuer           string
	OIDCClientID         string
	OIDCClientSecret     string
	GoogleClientID       string
	GoogleClientSecret   string
	GitHubClientID       string
	GitHubClientSecret   string
	SMTPHost             string
	SMTPPort             int
	SMTPUsername         string
	SMTPPassword         string
	SMTPFrom             string
	GitHubToken          string

	// EventRetentionDays controls how many days of skill_events to keep.
	// Events older than this are purged on startup. 0 disables cleanup.
	EventRetentionDays int

	// ExternalScanCmd, when set, is an opt-in external security scanner command
	// run over each skill on publish/import (Phase 2). The token "{dir}" is
	// replaced with the skill directory and the command must emit SARIF on
	// stdout, e.g. "gitleaks dir {dir} --report-format sarif --report-path
	// /dev/stdout". Empty disables the feature.
	ExternalScanCmd     string
	ExternalScanTimeout time.Duration

	DBMaxConns          int
	DBMinConns          int
	DBMaxConnLifetime   time.Duration
	DBMaxConnIdleTime   time.Duration
	DBHealthCheckPeriod time.Duration

	CORSOrigins string
	LogLevel    string

	// TrustedProxies is the comma-separated list of proxy addresses and CIDR
	// blocks whose X-Forwarded-For / X-Real-IP headers may be believed. Empty
	// means trust none of them — see ParseTrustedProxies.
	TrustedProxies string

	// WebhookAllowPrivate opens private addresses and HTTP to webhook delivery,
	// for a consumer on the install\'s own network.
	WebhookAllowPrivate bool
	RateLimitAuth       int
	RateLimitEvents     int
	RateLimitRead       int
	RateLimitWrite      int
	RateLimitSuites     int

	// QualityFloor is the minimum headline quality score (0-100) a verified
	// evaluation must reach to release a version held for review. 0 (the
	// default) accepts any verified report with a complete panel and no
	// critical contract violations.
	QualityFloor float64

	// MasterKeys seals secrets stored from the UI, such as the GitHub App's
	// private key. Empty is valid: features that store a secret stay off.
	MasterKeys *Keyring
}

Config holds all runtime configuration for the skael server.

func LoadConfig

func LoadConfig() (*Config, error)

LoadConfig reads configuration from environment variables. DATABASE_URL is required; returns an error if absent. STORAGE_PATH defaults to "./data/skills" (or "s3://bucket/prefix" for S3); LISTEN_ADDR defaults to ":8080". DISABLE_SIGNUP=true prevents new registrations.

type Keyring added in v0.18.0

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

Keyring holds the master keys from SKAEL_MASTER_KEYS. The first key seals; every key opens, so a rotated-out key keeps old values readable until they are sealed again.

func ParseKeyring added in v0.18.0

func ParseKeyring(raw string) (*Keyring, error)

ParseKeyring parses "id:base64key" pairs separated by commas. Each key must decode to 32 bytes. An empty value is a keyring with no keys.

func (*Keyring) Enabled added in v0.18.0

func (k *Keyring) Enabled() bool

Enabled reports whether a key exists to seal with.

func (*Keyring) Open added in v0.18.0

func (k *Keyring) Open(value, aad string) ([]byte, error)

Open decrypts a value Seal produced, with the key its id names.

func (*Keyring) Seal added in v0.18.0

func (k *Keyring) Seal(plain []byte, aad string) (string, error)

Seal encrypts plain with the active key under AES-256-GCM. aad binds the value to where it is stored, so a sealed value copied to another column does not open. The result is "keyid:" followed by base64 of nonce||ciphertext.

type LocalStorage added in v0.5.0

type LocalStorage struct {
	BasePath string
}

LocalStorage provides local filesystem storage for skill archive files.

func NewLocalStorage added in v0.5.0

func NewLocalStorage(basePath string) (*LocalStorage, error)

NewLocalStorage creates a LocalStorage rooted at basePath, creating the directory if it does not already exist.

func (*LocalStorage) Delete added in v0.5.0

func (s *LocalStorage) Delete(_ context.Context, name string) error

Delete removes the file stored under name (relative to BasePath).

func (*LocalStorage) Ping added in v0.6.0

func (s *LocalStorage) Ping(_ context.Context) error

Ping verifies the base path still exists and is a directory.

func (*LocalStorage) Read added in v0.5.0

func (s *LocalStorage) Read(_ context.Context, name string) (io.ReadCloser, error)

Read opens the file stored under name (relative to BasePath) for reading. The caller is responsible for closing the returned ReadCloser.

func (*LocalStorage) Write added in v0.5.0

func (s *LocalStorage) Write(_ context.Context, name string, r io.Reader) (string, error)

Write stores the content from r under name (relative to BasePath). It uses an atomic write: content is first written to a .tmp file which is then renamed to the final destination, ensuring no partial files are visible. Returns the full path of the written file.

type PoolConfig added in v0.7.0

type PoolConfig struct {
	MaxConns          int
	MinConns          int
	MaxConnLifetime   time.Duration
	MaxConnIdleTime   time.Duration
	HealthCheckPeriod time.Duration
}

PoolConfig holds optional pgxpool tuning parameters. A nil value keeps pgxpool's built-in defaults.

type RateLimitConfig added in v0.9.0

type RateLimitConfig struct {
	Auth   int
	Events int
	Read   int
	Write  int
	Suites int
}

RateLimitConfig holds the per-minute request budget for each route class.

type S3Storage added in v0.5.0

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

S3Storage stores archives in any S3-compatible object store.

func (*S3Storage) Delete added in v0.5.0

func (s *S3Storage) Delete(ctx context.Context, name string) error

func (*S3Storage) Ping added in v0.6.0

func (s *S3Storage) Ping(ctx context.Context) error

Ping verifies the bucket is reachable.

func (*S3Storage) Read added in v0.5.0

func (s *S3Storage) Read(ctx context.Context, name string) (io.ReadCloser, error)

func (*S3Storage) Write added in v0.5.0

func (s *S3Storage) Write(ctx context.Context, name string, r io.Reader) (string, error)

type Storage

type Storage interface {
	// Write stores r under name and returns the stored key (name).
	Write(ctx context.Context, name string, r io.Reader) (string, error)
	// Read opens the blob stored under name; caller closes the ReadCloser.
	Read(ctx context.Context, name string) (io.ReadCloser, error)
	// Delete removes the blob stored under name.
	Delete(ctx context.Context, name string) error
	// Ping verifies the backing store is reachable (readiness checks).
	Ping(ctx context.Context) error
}

Storage abstracts archive blob storage (local filesystem or object storage). Names are relative keys, e.g. "code-review/abc123.tar.gz".

func NewStorageFromConfig added in v0.5.0

func NewStorageFromConfig(cfg *Config) (Storage, error)

NewStorageFromConfig builds the Storage backend selected by STORAGE_PATH: "s3://bucket/prefix" → S3; anything else → local filesystem.

type TrustedProxies added in v0.9.0

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

TrustedProxies is the set of peers whose forwarding headers may be believed. The zero value trusts nobody — correct for a directly-exposed server.

func ParseTrustedProxies added in v0.9.0

func ParseTrustedProxies(list string) *TrustedProxies

ParseTrustedProxies parses a comma-separated TRUSTED_PROXIES list of CIDR blocks or bare addresses. Unparseable entries are dropped with a warning — dropping is safe: a typo costs forwarded addresses, never spoofable ones.

func (*TrustedProxies) Contains added in v0.9.0

func (t *TrustedProxies) Contains(addr netip.Addr) bool

Contains reports whether addr belongs to a trusted proxy range.

func (*TrustedProxies) Empty added in v0.9.0

func (t *TrustedProxies) Empty() bool

Empty reports whether no proxy is trusted.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL