authstore

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

type AuthRequiredError struct {
	// Identity is "GitHub" or "CircleCI".
	Identity string
	// Cause says what is wrong with the record, without token material.
	Cause string
	// Hint is the command that fixes it.
	Hint string
}

type Config struct {
	// Store is required.
	Store Store
	// Endpoints default to production.
	Endpoints agentcli.Endpoints
	// Clock defaults to the system clock at scale 1.
	Clock agentcli.Clock
	// HTTPClient defaults to one with a timeout.
	HTTPClient *http.Client
	// OpenBrowser opens a URL for the human; nil means the platform's opener.
	OpenBrowser func(url string) error
	// Stderr receives the instructions for the human during login (the
	// verification URL and code), never a token; nil means os.Stderr.
	Stderr io.Writer
}

type FileStore struct {
	Path string
}

type Identity struct {
	// Present is false when the keychain has no record.
	Present bool   `json:"present"`
	Login   string `json:"login,omitempty"`
	// ExpiresAt is absent for a token that does not expire.
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
	Expired   bool       `json:"expired"`
	// Refreshable: the record has a refresh token that has not expired, so a
	// command refreshes the access token itself (GitHub only).
	Refreshable      bool       `json:"refreshable"`
	RefreshExpiresAt *time.Time `json:"refreshExpiresAt,omitempty"`
	Warnings         []string   `json:"warnings"`
}

type KeyringStore struct{}

type Record struct {
	// Login is the account the token acts as, read once at login.
	Login string `json:"login,omitempty"`
	// Token is the access token.
	Token     string    `json:"token"`
	ExpiresAt time.Time `json:"expiresAt"`
	// RefreshToken and RefreshExpiresAt: GitHub only.
	RefreshToken     string    `json:"refreshToken,omitempty"`
	RefreshExpiresAt time.Time `json:"refreshExpiresAt"`
	// ClientID and RedirectURI: CircleCI only, the per-device OAuth client
	// devctl registered and the loopback address it registered.
	ClientID    string `json:"clientId,omitempty"`
	RedirectURI string `json:"redirectUri,omitempty"`
}

type Status struct {
	GitHub   Identity `json:"github"`
	CircleCI Identity `json:"circleci"`
}

type Store interface {
	// Get returns the record of user or ErrNotFound.
	Get(user string) (Record, error)
	Set(user string, record Record) error
	// Delete removes the record; a missing record is not an error.
	Delete(user string) error
}

type Token struct {
	// Value is the token. It goes into a request header and nowhere else.
	Value string
	// Login is the account the token acts as.
	Login string
	// ExpiresAt is zero for a token that does not expire.
	ExpiresAt time.Time
	// Warning is the expiry notice of a CircleCI token within
	// [CircleCIExpiryWarning] of its end, for the envelope; empty otherwise.
	Warning string
}