Documentation
¶
Overview ¶
Package httpauth carries the token-channel primitives shared by the two HTTP surfaces (`tq serve` dashboard, `tq api`): how a bearer token may be presented, and how a presented value is compared to the configured one. The presentation channels are the Authorization header and the `?token=` query parameter (the fallback for clients that cannot set headers — browsers' EventSource, curl one-liners); the dashboard adds a session-cookie channel on top, which stays in internal/webui because it is a browser-only concern (the API never issues or accepts cookies). Comparison is constant-time over SHA-256 digests, so the secret's length never leaks through timing.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AuthorizationToken ¶
AuthorizationToken returns the raw credentials of an `Authorization: Bearer` header, or "" when the header is absent, carries another scheme, or has an empty value. The scheme match is case-insensitive (RFC 9110 §11.6.2: auth-scheme comparison is case-insensitive).
func HashToken ¶
HashToken digests a secret for TokenMatches. Callers hash the CONFIGURED token once at construction and the presented value per request.
func QueryToken ¶
QueryToken returns the `?token=` query parameter, or "" when absent.
func TokenMatches ¶
TokenMatches reports constant-time equality between the expected digest (HashToken of the configured secret) and a presented value: hashing both sides first means the comparison never leaks the secret's length through timing.
Types ¶
type PresentationPolicy ¶
type PresentationPolicy struct {
// AcceptBearerHeader enables the `Authorization: Bearer` channel.
AcceptBearerHeader bool
// AcceptCookie enables the session-cookie channel; CookieName selects
// the cookie. Only the dashboard sets this (the API never issues or
// accepts cookies).
AcceptCookie bool
// CookieName is the cookie carrying the token when AcceptCookie is set.
CookieName string
// AcceptQuery enables the `?token=` query channel (the fallback for
// clients that cannot set headers — browsers' EventSource, curl
// one-liners).
AcceptQuery bool
}
PresentationPolicy is the per-surface knob for which presentation channels a guard accepts, and in which precedence. Precedence is fixed (bearer header, then session cookie, then `?token=` query); a surface that does not accept a channel never consults it, so e.g. the API (no cookie channel) behaves exactly as if the cookie never existed. Both surfaces share this one tested implementation — a channel bug-fix lands on both at once.
func APIPolicy ¶
func APIPolicy() PresentationPolicy
APIPolicy is the presentation policy of the write API (`tq api`): bearer header, then query. No cookie channel — the API never issues or accepts cookies.
func DashboardPolicy ¶
func DashboardPolicy(cookieName string) PresentationPolicy
DashboardPolicy is the presentation policy of the dashboard (`tq serve`): bearer header, then the session cookie named cookieName, then query.
func (PresentationPolicy) Presented ¶
func (p PresentationPolicy) Presented(r *http.Request) (token string, viaCookie bool)
Presented returns the token a client offered under the policy's channel set, or "" when none of the enabled channels carries one. viaCookie reports whether the token came from the policy's cookie channel (callers use it to skip re-issuing the cookie). Comparison against the configured secret stays with the caller via TokenMatches.
Source Files