auth

type Config struct {
	// AuthType is the type of auth
	AuthType Type `yaml:"auth_type"`
	// Path is the path to the config file for auth
	Path string `yaml:"path"`
}

type SecurityClient interface {
	// GetToken returns the token needed by internal component
	// for communication
	GetToken() Token
}

type SecurityManager interface {
	// Authenticate with the token provided,
	// return User if authentication succeeds
	Authenticate(token Token) (User, error)
	// RedactToken redact token passed in by
	// removing sensitive info, so the info would
	// not be leaked into other components and get
	// leaked/logged accidentally.
	// It would be called after auth is done, before
	// passing the token to other components
	RedactToken(token Token)
}

type Token interface {
	Get(k string) (string, bool)
	Del(k string)
	// Items returns all of the items in the token.
	// The returned map should not be modified, it is
	// the caller's responsibility to copy before write.
	Items() map[string]string
}

type Type string

type User interface {
	// IsPermitted returns whether user can
	// access the specified procedure
	IsPermitted(procedure string) bool
}