api

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

type Options struct {
	BaseURL   string                                     // default DefaultBaseURL
	Transport http.RoundTripper                          // default http.DefaultTransport
	Timeout   time.Duration                              // per request; default 60s
	Retries   int                                        // read retries; default 3; negative disables
	MaxBody   int64                                      // default 64 MiB
	Sleep     func(context.Context, time.Duration) error // default: timer honouring ctx

	// The limits on validation requests (bucket.go). Zero values are the production defaults.
	ValidatePerMinute int              // tokens a minute, one for each validation request tailkeeper decides to send (a retry of a request takes none); the bucket holds max(this, 2); default config.DefaultValidatePerMinute (30)
	Now               func() time.Time // the bucket's clock; default time.Now
	ValidateDeadline  time.Duration    // one validate call, all its sends; default 60s
	ValidateInFlight  int              // validate calls at once; default 2
}

type PolicyDetails struct {
	Text     []byte   // the policy as HuJSON, decoded from the base64 acl field; at most guard.MaxPolicyBytes
	ETag     string   // the header verbatim, quotes included; "" when none
	Warnings []string // the server's own warnings for the stored policy: the baseline
	Errors   []string // the stored policy's errors: it no longer parses or resolves
}

type PolicyGet struct {
	Details     bool   // adds ?details=true: a JSON object with the policy, its warnings and errors
	Accept      string // "" sends no Accept header
	IfNoneMatch string // "" sends no If-None-Match header; otherwise the value, verbatim
}

type PolicyStamp struct {
	ETag   string // the header verbatim, quotes included; "" when none
	SHA256 string // lower-case hex of the plain body's bytes
}

type PolicyStatus string

type PolicyTest struct {
	Src             string         `json:"src"`
	Proto           string         `json:"proto,omitempty"`
	SrcPostureAttrs map[string]any `json:"srcPostureAttrs,omitempty"` // string, number or bool values, passed through as the caller gave them
	Accept          []string       `json:"accept,omitempty"`
	Deny            []string       `json:"deny,omitempty"`
}

type PolicyValidation struct {
	Status  PolicyStatus
	HTTP    int
	Message string       // the server's message: untrusted text
	Results []TestResult // entries with their errors and warnings, in order; set for pass and fail only
	Why     string       // for PolicyUnknown: tailkeeper's words, quoting nothing but capped untrusted tokens
	Hint    string       // set by the client's send, never by the reader: the size hint of a rejection that speaks of size
}

type Raw struct {
	Body []byte
	ETag string
}

type RawResponse struct {
	Status int
	ETag   string
	Body   []byte
}

type TestResult struct {
	User     string   `json:"user"`
	Errors   []string `json:"errors"`
	Warnings []string `json:"warnings"`
}

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

type Validation struct {
	Passed  bool         // no test failed
	Results []TestResult // sources with errors or warnings
}