authz

Documentation

Index

• Constants
• func Setup(server *Server, ns namespace.Getter) resource.SetupFn
• func SetupLocal(server *Server, ns namespace.Getter) resource.SetupFn
• type API
• type Provider
• type Server
  • func New(ctx resource.Context, ns namespace.Instance) (Server, error)
  • func NewLocal(ctx resource.Context, ns namespace.Instance) (Server, error)
  • func NewLocalOrFail(t framework.TestContext, ns namespace.Instance) Server
  • func NewOrFail(t framework.TestContext, ns namespace.Instance) Server

Constants

const (
	XExtAuthz                         = "X-Ext-Authz"
	XExtAuthzAllow                    = "allow"
	XExtAuthzCheckReceived            = "X-Ext-Authz-Check-Received"
	XExtAuthzAdditionalHeaderOverride = "X-Ext-Authz-Additional-Header-Override"
	GRPCAdditionalHeaderOverrideValue = "grpc-additional-header-override-value"
)

Functions

func Setup

func Setup(server *Server, ns namespace.Getter) resource.SetupFn

Setup is a utility function for configuring a global authz Server.

func SetupLocal

func SetupLocal(server *Server, ns namespace.Getter) resource.SetupFn

SetupLocal is a utility function for setting a global variable for a local Server.

Types

type API

type API string

API used by a Provider. Either HTTP or GRPC.

const (
	HTTP API = "http"
	GRPC API = "grpc"
)

type Provider

type Provider interface {
	Name() string

	// API used by this provider.
	API() API

	// IsProtocolSupported returns true if the given request protocol is supported by this provider.
	IsProtocolSupported(protocol.Instance) bool

	// IsTargetSupported returns true if the given target is supported by this provider.
	IsTargetSupported(target echo.Target) bool

	// MatchSupportedTargets returns a Matcher for filtering unsupported targets.
	MatchSupportedTargets() match.Matcher

	// Check returns an echo.Checker for validating response based on the request information.
	Check(opts echo.CallOptions, expectAllowed bool) echo.Checker
}

Provider for authz requests.

type Server

type Server interface {
	Namespace() namespace.Instance

	// Providers returns the list of Provider instances.
	Providers() []Provider
}

Server for custom authz.

func New

func New(ctx resource.Context, ns namespace.Instance) (Server, error)

New creates a new authz Server.

func NewLocal

func NewLocal(ctx resource.Context, ns namespace.Instance) (Server, error)

NewLocal does not deploy a new server, but instead configures Istio to allow calls to a local authz server running as a sidecar to the echo app.

func NewLocalOrFail

func NewLocalOrFail(t framework.TestContext, ns namespace.Instance) Server

NewLocalOrFail calls NewLocal and fails if an error occurs.

func NewOrFail

func NewOrFail(t framework.TestContext, ns namespace.Instance) Server

NewOrFail calls New and fails if an error occurs.