botcheck

type AnswerStore interface {
	// Use records challengeID as answered for endpoint, kept until expires,
	// and reports false when it was answered before.
	Use(ctx context.Context, challengeID, endpoint string, expires time.Time) (bool, error)
	// Recent counts the challenges endpoint had answered since since.
	Recent(ctx context.Context, endpoint string, since time.Time) (int, error)
	// Sweep deletes the answers whose challenge expired before now.
	Sweep(ctx context.Context, now time.Time) (int64, error)
}

type Challenge struct {
	// Check is the name of the check the endpoint names.
	Check string `json:"check" example:"default"`
	// Provider is pow, turnstile or hcaptcha.
	Provider string `json:"provider" example:"pow"`
	// Token is the proof-of-work challenge; the answer is Token~counter, the
	// counter whose SHA-256 of Token~counter has Difficulty leading zero bits.
	Token      string `json:"token,omitempty"`
	Difficulty int    `json:"difficulty,omitempty"`
	// SiteKey is the Turnstile or hCaptcha widget's site key; the answer is
	// the token the widget produces.
	SiteKey   string    `json:"site_key,omitempty"`
	ExpiresAt time.Time `json:"expires_at,omitzero"`
}

type Check struct {
	// Name is how an endpoint names the check.
	Name string `json:"name" example:"default"`
	// Provider is pow, turnstile or hcaptcha.
	Provider string `json:"provider" example:"pow"`
	// SiteKey is the Turnstile or hCaptcha site key a page renders the
	// widget with. It is public.
	SiteKey string `json:"site_key"`
	// SecretName is the stored secret (Admin > Secrets) holding the
	// provider's secret key, whose allow_connections names SecretUse and
	// which lists no personas. The key never leaves the server.
	SecretName string `json:"secret_name"`
	// Difficulty is the proof-of-work's leading zero bits while an endpoint
	// is quiet, and MaxDifficulty the most a flood raises it to.
	Difficulty    int `json:"difficulty"`
	MaxDifficulty int `json:"max_difficulty"`
	// RateThreshold is the answers a minute an endpoint takes before each
	// doubling of its rate adds a bit of difficulty.
	RateThreshold int `json:"rate_threshold"`
	// ChallengeTTLSeconds is how long a challenge may be answered.
	ChallengeTTLSeconds int       `json:"challenge_ttl_seconds"`
	CreatedBy           string    `json:"created_by,omitempty"`
	UpdatedBy           string    `json:"updated_by,omitempty"`
	CreatedAt           time.Time `json:"created_at,omitzero"`
	UpdatedAt           time.Time `json:"updated_at,omitzero"`
}

type Checker struct {
	Checks  Store
	Answers AnswerStore
	// Key signs proof-of-work challenges; nil leaves the deployment unable to
	// issue one.
	Key []byte
	// Secret reads the stored secret holding a provider's secret key.
	Secret func(ctx context.Context, name string) (string, error)
	// Verifier asks a provider about a token.
	Verifier interface {
		Verify(ctx context.Context, provider, secret, token string) error
	}
	// Now is the clock; nil is time.Now.
	Now func() time.Time
}

type InUseError struct {
	Name      string
	Endpoints []string
}

type Input struct {
	Provider            *string `json:"provider,omitempty"`
	SiteKey             *string `json:"site_key,omitempty"`
	SecretName          *string `json:"secret_name,omitempty"`
	Difficulty          *int    `json:"difficulty,omitempty"`
	MaxDifficulty       *int    `json:"max_difficulty,omitempty"`
	RateThreshold       *int    `json:"rate_threshold,omitempty"`
	ChallengeTTLSeconds *int    `json:"challenge_ttl_seconds,omitempty"`
}

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

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

type Store interface {
	// List is every check, by name.
	List(ctx context.Context) ([]Check, error)
	// Get is one check, ErrNotFound when no check has the name.
	Get(ctx context.Context, name string) (Check, error)
	// Put creates or replaces a check, keeping the creation stamp of the one
	// it replaces.
	Put(ctx context.Context, c Check, author string) (Check, error)
	// Delete removes a check, ErrNotFound when none has the name and an
	// *InUseError naming the endpoints when any names it.
	Delete(ctx context.Context, name string) error
	// UsedBy is each check's endpoints, by check name.
	UsedBy(ctx context.Context) (map[string][]string, error)
}

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