server

Documentation

Index

• Variables
• func AddDefaultAccess(a *knox.Access)
• func AddHeader(k, v string) func(http.HandlerFunc) http.HandlerFunc
• func AddPrincipalValidator(validator knox.PrincipalValidator)
• func Authentication(providers []auth.Provider) func(http.HandlerFunc) http.HandlerFunc
• func GetParams(r *http.Request) map[string]string
• func GetPrincipal(r *http.Request) knox.Principal
• func GetRouteID(r *http.Request) string
• func GetRouter(cryptor keydb.Cryptor, db keydb.DB, ...) (*mux.Router, error)
• func Logger(logger *log.Logger) func(http.HandlerFunc) http.HandlerFunc
• type HTTPError
  • func GetAPIError(r *http.Request) *HTTPError
• type KeyManager
  • func NewKeyManager(c keydb.Cryptor, db keydb.DB) KeyManager
• type Parameter
• type PostParameter
  • func (p PostParameter) Get(r *http.Request) (string, bool)
  • func (p PostParameter) Name() string
• type QueryParameter
  • func (p QueryParameter) Get(r *http.Request) (string, bool)
  • func (p QueryParameter) Name() string
• type RawQueryParameter
  • func (p RawQueryParameter) Get(r *http.Request) (string, bool)
  • func (p RawQueryParameter) Name() string
• type Route
  • func (r Route) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type UrlParameter
  • func (p UrlParameter) Get(r *http.Request) (string, bool)
  • func (p UrlParameter) Name() string

Variables

var HTTPErrMap = map[int]*httpErrResp{
	knox.NoKeyIDCode:                   {http.StatusBadRequest, "Missing Key ID"},
	knox.InternalServerErrorCode:       {http.StatusInternalServerError, "Internal Server Error"},
	knox.KeyIdentifierExistsCode:       {http.StatusBadRequest, "Key identifer exists"},
	knox.KeyVersionDoesNotExistCode:    {http.StatusNotFound, "Key version does not exist"},
	knox.KeyIdentifierDoesNotExistCode: {http.StatusNotFound, "Key identifer does not exist"},
	knox.UnauthenticatedCode:           {http.StatusUnauthorized, "User or machine is not authenticated"},
	knox.UnauthorizedCode:              {http.StatusForbidden, "User or machine not authorized"},
	knox.NotYetImplementedCode:         {http.StatusNotImplemented, "Not yet implemented"},
	knox.NotFoundCode:                  {http.StatusNotFound, "Route not found"},
	knox.NoKeyDataCode:                 {http.StatusBadRequest, "Missing Key Data"},
	knox.BadRequestDataCode:            {http.StatusBadRequest, "Bad request format"},
	knox.BadKeyFormatCode:              {http.StatusBadRequest, "Key ID contains unsupported characters"},
	knox.BadPrincipalIdentifier:        {http.StatusBadRequest, "Invalid principal identifier"},
}

HTTPErrMap is a mapping from err subcodes to the http err response that will be returned.

Functions

func AddDefaultAccess

func AddDefaultAccess(a *knox.Access)

AddDefaultAccess adds an access to every created key.

func AddHeader

func AddHeader(k, v string) func(http.HandlerFunc) http.HandlerFunc

AddHeader adds a HTTP header to the response

func AddPrincipalValidator

func AddPrincipalValidator(validator knox.PrincipalValidator)

AddPrincipalValidator applies additional, custom validation on principals submitted to Knox for adding into ACLs. Can be used to set custom business logic for e.g. what kind of machine or service prefixes are acceptable.

func Authentication

func Authentication(providers []auth.Provider) func(http.HandlerFunc) http.HandlerFunc

Authentication sets the principal or returns an error if the principal cannot be authenticated.

func GetParams

func GetParams(r *http.Request) map[string]string

GetParams gets the parameters for the request through the parameters context.

func GetPrincipal

func GetPrincipal(r *http.Request) knox.Principal

GetPrincipal gets the principal authenticated through the authentication decorator

func GetRouteID

func GetRouteID(r *http.Request) string

GetRouteID gets the short form function name for the route being called. Used for logging/metrics.

func GetRouter

func GetRouter(
	cryptor keydb.Cryptor,
	db keydb.DB,
	decorators [](func(http.HandlerFunc) http.HandlerFunc),
	additionalRoutes []Route) (*mux.Router, error)

GetRouter creates the mux router that serves knox routes. All routes are declared in this file. Each handler itself takes in the db and auth provider interfaces and returns a handler that the is processed through the API Middleware.

func Logger

func Logger(logger *log.Logger) func(http.HandlerFunc) http.HandlerFunc

Logger logs the request and response information in json format to the logger given.

Types

type HTTPError

type HTTPError struct {
	Subcode int
	Message string
}

HTTPError is the error type with knox err subcode and message for logging purposes

func GetAPIError

func GetAPIError(r *http.Request) *HTTPError

GetAPIError gets the HTTP error that will be returned from the server.

type KeyManager

type KeyManager interface {
	GetAllKeyIDs() ([]string, error)
	GetUpdatedKeyIDs(map[string]string) ([]string, error)
	GetKey(id string, status knox.VersionStatus) (*knox.Key, error)
	AddNewKey(*knox.Key) error
	DeleteKey(id string) error
	UpdateAccess(string, ...knox.Access) error
	AddVersion(string, *knox.KeyVersion) error
	UpdateVersion(keyID string, versionID uint64, s knox.VersionStatus) error
}

KeyManager is the interface for logic related to managing keys.

func NewKeyManager

func NewKeyManager(c keydb.Cryptor, db keydb.DB) KeyManager

NewKeyManager builds a struct for interfacing with the keydb.

type Parameter

type Parameter interface {
	Name() string
	Get(r *http.Request) (string, bool)
}

Parameter is an interface through which route-specific Knox API Parameters can be specified

type PostParameter

type PostParameter string

PostParameter is an implementation of the Parameter interface that extracts values embedded in the web form transmitted in the request body

func (PostParameter) Get

func (p PostParameter) Get(r *http.Request) (string, bool)

Get returns the value of the appropriate parameter from the request body

func (PostParameter) Name

func (p PostParameter) Name() string

Name represents the key corresponding to this parameter in the request form

type QueryParameter

type QueryParameter string

QueryParameter is an implementation of the Parameter interface that extracts specific parameter values from the query string of the request URL as referenced in section 3.4 of RFC2396.

func (QueryParameter) Get

func (p QueryParameter) Get(r *http.Request) (string, bool)

Get returns the value of the query string parameter

func (QueryParameter) Name

func (p QueryParameter) Name() string

Name defines the URL-embedded key that this parameter maps to

type RawQueryParameter

type RawQueryParameter string

RawQueryParameter is an implementation of the Parameter interface that extracts the complete query string from the request URL as referenced in section 3.4 of RFC2396.

func (RawQueryParameter) Get

func (p RawQueryParameter) Get(r *http.Request) (string, bool)

Get returns the value of the entire query string

func (RawQueryParameter) Name

func (p RawQueryParameter) Name() string

Name represents the key-name that will be set for the raw query string in the `parameters` map of the route handler function.

type Route

type Route struct {
	// Handler represents the handler function that is responsible for serving
	// this route
	Handler func(db KeyManager, principal knox.Principal, parameters map[string]string) (interface{}, *HTTPError)

	// Id represents A unique string identifier that represents this specific
	// route
	Id string

	// Path represents the relative HTTP path (or prefix) that must be specified
	//  in order to invoke this route
	Path string

	// Method represents the HTTP method that must be specified in order to
	// invoke this route
	Method string

	// Parameters is an array that represents the route-specific parameters
	// that will be passed to the handler function
	Parameters []Parameter
}

Route is a struct that defines a path and method-specific HTTP route on the Knox server

func (Route) ServeHTTP

func (r Route) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP runs API middleware and calls the underlying handler function.

type UrlParameter

type UrlParameter string

UrlParameter is an implementation of the Parameter interface that extracts parameter values from the URL as referenced in section 3.3 of RFC2396.

func (UrlParameter) Get

func (p UrlParameter) Get(r *http.Request) (string, bool)

Get returns the value of the URL parameter

func (UrlParameter) Name

func (p UrlParameter) Name() string

Name defines the URL-embedded key that this parameter maps to