server

Documentation

Overview

Package server contains the policy engine's server handlers.

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended. For newer features and behaviours, such as defaulting to the Rego v1 syntax, use the corresponding components in the github.com/open-policy-agent/opa/v1 package instead. See https://www.openpolicyagent.org/docs/latest/v0-compatibility/ for more information.

Index

• Constants
• type AuthenticationScheme
• type AuthorizationScheme
• type BundleInfo
• type Info
• type Loop
• type Metrics
• type Server
  • func New() *Server
• type TLSConfig

Constants

const (
	AuthenticationOff   = v1.AuthenticationOff
	AuthenticationToken = v1.AuthenticationToken
	AuthenticationTLS   = v1.AuthenticationTLS
)

Set of supported authentication schemes.

const (
	AuthorizationOff   = v1.AuthorizationOff
	AuthorizationBasic = v1.AuthorizationBasic
)

Set of supported authorization schemes.

const (
	PromHandlerV0Data     = v1.PromHandlerV0Data
	PromHandlerV1Data     = v1.PromHandlerV1Data
	PromHandlerV1Query    = v1.PromHandlerV1Query
	PromHandlerV1Policies = v1.PromHandlerV1Policies
	PromHandlerV1Compile  = v1.PromHandlerV1Compile
	PromHandlerV1Config   = v1.PromHandlerV1Config
	PromHandlerV1Status   = v1.PromHandlerV1Status
	PromHandlerIndex      = v1.PromHandlerIndex
	PromHandlerCatch      = v1.PromHandlerCatch
	PromHandlerHealth     = v1.PromHandlerHealth
	PromHandlerAPIAuthz   = v1.PromHandlerAPIAuthz
)

Set of handlers for use in the "handler" dimension of the duration metric.

Types

type AuthenticationScheme

type AuthenticationScheme = v1.AuthenticationScheme

AuthenticationScheme enumerates the supported authentication schemes. The authentication scheme determines how client identities are established.

type AuthorizationScheme

type AuthorizationScheme = v1.AuthorizationScheme

AuthorizationScheme enumerates the supported authorization schemes. The authorization scheme determines how access to OPA is controlled.

type BundleInfo

type BundleInfo = v1.BundleInfo

BundleInfo contains information describing a bundle.

type Info

type Info = v1.Info

Info contains information describing a policy decision.

type Loop

type Loop = v1.Loop

Loop will contain all the calls from the server that we'll be listening on.

type Metrics

type Metrics = v1.Metrics

Metrics defines the interface that the server requires for recording HTTP handler metrics.

type Server

type Server = v1.Server

Server represents an instance of OPA running in server mode.

func New

func New() *Server

New returns a new Server.

type TLSConfig

type TLSConfig = v1.TLSConfig

TLSConfig represents the TLS configuration for the server. This configuration is used to configure file watchers to reload each file as it changes on disk.