bascule

type Authenticator interface {
	// Authenticate verifies the given Token.
	Authenticate(Token) error
}

type Authenticators []Authenticator

type Authorizer interface {
	// Authorize verifies that the given Token can access a resource.
	Authorize(resource any, t Token) error
}

type Credentials struct {
	// Scheme is the parsing scheme used for the credential value.
	Scheme Scheme

	// Value is the raw, unparsed credential information.
	Value string
}

type CredentialsParser interface {
	// Parse parses the raw, marshaled version of credentials and
	// returns the Credentials object.
	Parse(raw string) (Credentials, error)
}

type InvalidCredentialsError struct {
	// Cause represents any lower-level error that occurred, if any.
	Cause error

	// Raw represents the raw credentials that couldn't be parsed.
	Raw string
}

type MissingCredentialsError struct {
	// Cause represents the lower-level error that occurred, if any.
	Cause error

	// Reason contains any additional information about the missing credentials.
	Reason string
}

type Scheme string

type Token interface {
	// Credentials returns the raw, unparsed information used to produce this Token.
	Credentials() Credentials

	// Principal is the security subject of this token, e.g. the user name or other
	// user identifier.
	Principal() string
}

type TokenFactory interface {
	// NewToken accepts a raw, serialized set of credentials and turns it
	// into a Token.  This method executes the workflow of:
	//
	// - parsing the serialized credentials into a Credentials
	// - parsing the Credentials into a Token
	// - executing any Authenticator rules against the Token
	NewToken(serialized string) (Token, error)
}

type TokenFactoryOption interface {
	// contains filtered or unexported methods
}

type TokenParser interface {
	// Parse turns a Credentials into a Token.  This method may validate parts
	// of the credential's value, but should not perform any authentication itself.
	Parse(Credentials) (Token, error)
}

type TokenParsers map[Scheme]TokenParser