Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateConfig ¶
ValidateConfig validates a parsed Config struct against following constraints:
- Both claim policies and route policies must not be nil. Empty map/slices are allowed.
- All ClaimRequirement instances must have a claim named.
- All RoutePolicy instances must have a path configured.
- If a RoutePolicy is flagged with AllowAnonymous, it cannot name any claim policies
- If a RoutePolicy has a claim policy named, that claim policy should be defined in the ClaimPolicies section.
Types ¶
type Authenticator ¶
Authenticator interface
type AuthenticatorImpl ¶
type AuthenticatorImpl struct {
// contains filtered or unexported fields
}
AuthenticatorImpl is a JWT based authentication implementation
func NewAuthenticator ¶
func NewAuthenticator( signingKey []byte, signingAlgorithm string, config models.AuthenticationConfig) (*AuthenticatorImpl, error)
NewAuthenticator creates a new AuthenticatorImpl instance
func (AuthenticatorImpl) Authenticate ¶
func (a AuthenticatorImpl) Authenticate(authHeader string) (map[string]any, error)
Authenticate implements Bearer token authentication
type Authorizer ¶
type Authorizer interface {
Authorize(policyNames []string, claims map[string]any) (failedPolicy string, err error)
IsAnonymousAllowed(matchedPolicies []models.RoutePolicy, method string) bool
}
Authorizer is the claims-based authorization interface
type AuthorizerImpl ¶
type AuthorizerImpl struct {
// contains filtered or unexported fields
}
AuthorizerImpl implements claims base authorization
func NewAuthorizer ¶
func NewAuthorizer(claimPolicies map[string][]models.ClaimRequirement) *AuthorizerImpl
NewAuthorizer creates a new AuthorizerImpl instance
func (AuthorizerImpl) Authorize ¶
func (a AuthorizerImpl) Authorize(policyNames []string, claims map[string]any) (failedClaim string, err error)
Authorize checks claim values and returns the first failed claim
func (AuthorizerImpl) IsAnonymousAllowed ¶
func (a AuthorizerImpl) IsAnonymousAllowed(matchedPolicies []models.RoutePolicy, method string) bool
IsAnonymousAllowed allows anonymous requests if the most specific route that matches the request has AllowAnonymous set to true.
This function expects the matchedPolicies to be sorted by decreasing path length and wildcard specificity.
If more than one route with the same path and wildcard specifity matches the request, first one that also matches the method decides if allowed anonymously.
If no route policy is matched to the request, the default behavior is to authenticate.
type ConfigParser ¶
ConfigParser is the config parsing interface
type RouteMatcher ¶
type RouteMatcher interface {
MatchRoutePolicies(path string, method string) ([]models.RoutePolicy, error)
}
RouteMatcher matches given path and method to configured route policies
type RouteMatcherImpl ¶
type RouteMatcherImpl struct {
// contains filtered or unexported fields
}
RouteMatcherImpl implements glob-based route matching
func NewRouteMatcher ¶
func NewRouteMatcher(routePolicies []models.RoutePolicy) *RouteMatcherImpl
NewRouteMatcher creates a new RouteMatcherImpl instance
func (RouteMatcherImpl) MatchRoutePolicies ¶
func (g RouteMatcherImpl) MatchRoutePolicies(path string, method string) ([]models.RoutePolicy, error)
MatchRoutePolicies matches given the request path-method pair to configured routes Paths are matched using standard wildcard globs If no method is specified in the configuration, that route matches to all methods
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server struct holds references to necessary services
func NewServer ¶
func NewServer( upstream http.Handler, routeMatcher RouteMatcher, authorizer Authorizer, authenticator Authenticator, config models.ServerConfig) *Server
NewServer checks if upstream is set to enable proxy behavior, then returns a new Server instance
type YamlConfigParser ¶
type YamlConfigParser struct{}
YamlConfigParser is the YAML deserialization implementation of ConfigParser
func (YamlConfigParser) ParseConfig ¶
ParseConfig implements config parsing from YAML files
Source Files