bascule

type Attributes ¶

type Attributes interface {
	Get(key string) (interface{}, bool)
}

Attributes is the interface that wraps methods which dictate how to interact with a token's attributes. Getter functions return a boolean as second element which indicates that a value of the requested type exists at the given key path.

func NewAttributes(m map[string]interface{}) Attributes

type Authentication ¶

type Authentication struct {
	Authorization Authorization
	Token         Token
	Request       Request
}

Authentication represents the output of a security pipeline.

func FromContext(ctx context.Context) (Authentication, bool)

type Authorization ¶

type Authorization string

Authorization represents the authorization mechanism performed on the token, e.g. "Basic", "Bearer", etc for HTTP security environments.

type BasicAttributes ¶ added in v0.9.0

type BasicAttributes map[string]interface{}

func (a BasicAttributes) Get(key string) (interface{}, bool)

type ClaimsWithLeeway ¶

type ClaimsWithLeeway struct {
	jwt.MapClaims
	Leeway Leeway
}

func (c *ClaimsWithLeeway) GetMap() (map[string]interface{}, error)

func (c *ClaimsWithLeeway) UnmarshalJSON(data []byte) error

func (c *ClaimsWithLeeway) Valid() error

type Error ¶

type Error interface {
	Cause() error
	Reason() string
}

Error is an optional interface to be implemented by security related errors

type Errors ¶

type Errors []error

Errors is a Multierror that also acts as an error, so that a log-friendly string can be returned but each error in the list can also be accessed.

func (e Errors) Error() string

func (e Errors) Errors() []error

type JWTParser ¶

type JWTParser interface {
	ParseJWT(string, jwt.Claims, jwt.Keyfunc) (*jwt.Token, error)
}

JWTParser parses raw Tokens into JWT objects

var DefaultJWTParser JWTParser = defaultJWTParser{}

type Leeway ¶

type Leeway struct {
	EXP int64 `json:"expLeeway" yaml:"expLeeway"`
	NBF int64 `json:"nbfLeeway" yaml:"nbfLeeway"`
	IAT int64 `json:"iatLeeway" yaml:"iatLeeway"`
}

Leeway is the amount of buffer to include with the time, to allow for clock skew.

type MultiError ¶

type MultiError interface {
	Errors() []error
}

MultiError is an interface that provides a list of errors.

type Request ¶

type Request struct {
	URL    *url.URL
	Method string
}

Request holds request information that may be useful for validating the token.

type Token ¶

type Token interface {
	// Type is the custom token type assigned by plugin code
	Type() string

	// Principal is the security principal, e.g. the user name or client id
	Principal() string

	// Attributes are an arbitrary set of name/value pairs associated with the token.
	// Typically, these will be filled with information supplied by the user, e.g. the claims of a JWT.
	Attributes() Attributes
}

Token is the behavior supplied by all secure tokens

func NewToken(tokenType, principal string, attributes Attributes) Token

type Validator ¶

type Validator interface {
	Check(context.Context, Token) error
}

Validator is the rule type that determines if a Token is valid. Each rule should do exactly (1) thing, and then be composed by application-layer code. Validators are invoked for both authentication and authorization. We may need to have different rule types for those two things, but for now this works.

type ValidatorFunc ¶

type ValidatorFunc func(context.Context, Token) error

ValidatorFunc is the Check function that a Validator has.

func (vf ValidatorFunc) Check(ctx context.Context, t Token) error

type Validators ¶

type Validators []Validator

Validators are a list of objects that implement the Validator interface.

func (v Validators) Check(ctx context.Context, t Token) error