chain

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

type Chain struct {
	MiddlewareList     []SecurityChainMiddleware
	IgnorePatterns     []*regexp.Regexp
	IgnoredHTTPMethods []string
}

type MiddlewareBuilder func() SecurityChainMiddleware

type SecurityChain interface {

	// AddMiddleware adds new SecurityChainMiddleware to the end of the security chain.
	AddMiddleware(middleware SecurityChainMiddleware) SecurityChain

	// AddMiddlewareType adds a middleware to the end of the chain. The actual SecurityChainMiddleware
	// is build by calling the MiddlewareBuilder for the specific registered type of middleware.
	// See NewSecurity function for registering MiddlewareBuilder for a specific security middleware.
	AddMiddlewareType(middlewareType string) (SecurityChain, error)

	// Execute executes the security chain.
	// It takes context.Context http.ResponseWriter and a pointer to http.Request as arguments.
	// After executing all SecurityChainMiddleware in the chain, it returns the resulting context.Context,
	// http.ResponseWriter and *http.Request. This may be different from the parameters passed to the function.
	// If an error occurred during executing the chain, and error is returned.
	Execute(ctx context.Context, rw http.ResponseWriter, req *http.Request) (context.Context, http.ResponseWriter, *http.Request, error)

	// AddIgnorePattern adds a pattern for the request path that will be ignored by this chain.
	// The request path will be matched against the ignore patterns and if match is found, then
	// the chain will not be executed and the request processing will be passed through.
	// This is useful for public resources for which we don't check the auth.
	// If the pattern is invalid, an error will be returned and the pattern is not added to the
	// list of ignore patterns.
	AddIgnorePattern(pattern string) error

	// IgnoreHTTPMethod add an HTTP method that will be ignored. Every HTTP request with this method (verb) shall
	// be passed through and ignored by the security chain.
	IgnoreHTTPMethod(method string)
}

type SecurityChainMiddleware func(context.Context, http.ResponseWriter, *http.Request) (context.Context, http.ResponseWriter, error)

type SecurityMiddlewareBuilders map[string]MiddlewareBuilder