webhooks

type AcceptFunc ¶

type AcceptFunc func(context.Context) (Response, error)

AcceptFunc captures the verified, engine-owned source identity and performs durable acceptance. A verifier must return it only after authenticating the exact request bytes.

type AdmitFunc ¶

type AdmitFunc func(context.Context, Metadata) error

AdmitFunc performs a cheap check before Soro reads the request body. It may reject abusive traffic but cannot authenticate a delivery; Verify still owns provider authentication over the exact body bytes.

type Definition ¶

type Definition struct {
	Name         string
	Path         string
	ContentTypes []string
	MaxBodyBytes int64
	Timeout      time.Duration
	Admit        AdmitFunc
	Verify       VerifyFunc
}

Definition declares one POST endpoint relative to an engine's API mount. Zero limits use the package defaults.

type Metadata ¶

type Metadata struct {
	Method     string
	URL        *url.URL
	Host       string
	Header     http.Header
	PathValues map[string]string
	RemoteAddr string
	ReceivedAt time.Time
}

Metadata is the detached request metadata available before Soro reads the body. It is suitable for cheap per-address or per-path admission checks. Path values are routing hints only and must not be trusted as source identity.

func (metadata Metadata) PathValue(name string) string

type Observation ¶

type Observation struct {
	Engine     string
	Endpoint   string
	StatusCode int
	Outcome    string
	BodyBytes  int64
	Duration   time.Duration
}

type Observer ¶

type Observer func(context.Context, Observation)

type Option ¶

type Option func(*settings)

func WithClock(clock func() time.Time) Option

func WithMaxConcurrentBodyReads(limit int) Option

func WithObserver(observer Observer) Option

type Registry ¶

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

Registry owns webhook routes installed on a host HTTP mux.

func New(mux *http.ServeMux, options ...Option) (*Registry, error)

func (registry *Registry) Routes() []Route

func (registry *Registry) Scope(owner, prefix string) (*Scope, error)

type Request ¶

type Request struct {
	Method     string
	URL        *url.URL
	Host       string
	Header     http.Header
	Body       []byte
	PathValues map[string]string
	RemoteAddr string
	ReceivedAt time.Time
}

Request is the detached transport evidence supplied to an engine. Body is the exact bounded byte sequence read from the HTTP request; Soro does not decompress or parse it before verification.

func (request Request) PathValue(name string) string

type Response ¶

type Response struct {
	StatusCode int
	Header     http.Header
	Body       []byte
}

type Route ¶

type Route struct {
	Engine       string
	Name         string
	Method       string
	Path         string
	ContentTypes []string
	MaxBodyBytes int64
	Timeout      time.Duration
}

type Scope ¶

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

func (scope *Scope) Freeze()

func (scope *Scope) Frozen() bool

func (scope *Scope) Owner() string

func (scope *Scope) Prefix() string

func (scope *Scope) Register(definition Definition) error

type VerifyFunc ¶

type VerifyFunc func(context.Context, Request) (AcceptFunc, error)

VerifyFunc authenticates a request and returns the only function allowed to accept it. This keeps provider-specific identities and secrets inside the owning engine without an untyped shared claims container.