api

Documentation

Overview

Package api provides the Cilium useful helpers for the external API

Index

• Constants
• Variables
• func DisableAPIs(paths PathSet, ...)
• func SetDefaultPermissions(socketPath string) error
• type APIError
  • func Error(code int, err error) *APIError
  • func New(code int, msg string, args ...interface{}) *APIError
  • func (a *APIError) Error() string
  • func (a *APIError) GetModel() *models.Error
  • func (a *APIError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type APIPanicHandler
  • func (h *APIPanicHandler) ServeHTTP(wr http.ResponseWriter, req *http.Request)
• type AdminDisableHandler
  • func NewAdminDisableHandler(name string) *AdminDisableHandler
  • func (a *AdminDisableHandler) ServeHTTP(wr http.ResponseWriter, req *http.Request)
• type Endpoint
• type PathSet
  • func AllowedFlagsToDeniedPaths(spec *loads.Document, allowed []string) (PathSet, error)
  • func NewPathSet(spec *loads.Document) PathSet

Constants

const (
	// CiliumGroupName is the cilium's unix group name.
	CiliumGroupName = "cilium"
	// SocketFileMode is the default file mode for the sockets.
	SocketFileMode os.FileMode = 0660
	// ClientTimeout specifies timeout to be used by clients
	ClientTimeout = 90 * time.Second
)

Variables

var (
	ErrUnknownWildcard = fmt.Errorf("Unsupported API wildcard")
	ErrUnknownFlag     = fmt.Errorf("Unknown API flag")
)

Functions

func DisableAPIs

func DisableAPIs(paths PathSet, addMiddleware func(method, path string, builder middleware.Builder))

DisableAPIs configures the API middleware for all of the paths in the provided PathSet such that those APIs will be administratively disabled at runtime.

func SetDefaultPermissions

func SetDefaultPermissions(socketPath string) error

SetDefaultPermissions sets the given socket's group to `CiliumGroupName` and mode to `SocketFileMode`.

Types

type APIError

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

APIError is the error representation for the API.

func Error

func Error(code int, err error) *APIError

Error creates a new API error from the code and error.

func New

func New(code int, msg string, args ...interface{}) *APIError

New creates a API error from the code, msg and extra arguments.

func (*APIError) Error

func (a *APIError) Error() string

Error returns the API error message.

func (*APIError) GetModel

func (a *APIError) GetModel() *models.Error

GetModel returns model error.

func (*APIError) WriteResponse

func (a *APIError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client.

type APIPanicHandler

type APIPanicHandler struct {
	Next http.Handler
}

APIPanicHandler recovers from API panics and logs encountered panics

func (*APIPanicHandler) ServeHTTP

func (h *APIPanicHandler) ServeHTTP(wr http.ResponseWriter, req *http.Request)

ServeHTTP implements the http.Handler interface. It recovers from panics of all next handlers and logs them

type AdminDisableHandler

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

func NewAdminDisableHandler

func NewAdminDisableHandler(name string) *AdminDisableHandler

func (*AdminDisableHandler) ServeHTTP

func (a *AdminDisableHandler) ServeHTTP(wr http.ResponseWriter, req *http.Request)

type Endpoint

type Endpoint struct {
	Method      string
	Path        string
	Description string
}

Endpoint is an API Endpoint for a parsed API specification.

type PathSet

type PathSet map[string]Endpoint

PathSet is a set of APIs in the form of a map of canonical pascalized flag name to MethodPath, for example: "GetEndpointID": {"GET", "/endpoint/{id}"}

func AllowedFlagsToDeniedPaths

func AllowedFlagsToDeniedPaths(spec *loads.Document, allowed []string) (PathSet, error)

AllowedFlagsToDeniedPaths parses the input API specification and the provided commandline flags, and returns the PathSet that should be administratively disabled using a subsequent call to DisableAPIs().

func NewPathSet

func NewPathSet(spec *loads.Document) PathSet