paramtoken

Documentation

Index

• type Authenticator
  • func New(param string, auth authenticator.Token, removeParam bool) *Authenticator
  • func (a *Authenticator) AuthenticateRequest(req *http.Request) (*authenticator.Response, bool, error)

Types

type Authenticator

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

Authenticator provides a way to authenticate tokens provided as a parameter This only exists to allow websocket connections to use an API token, since they cannot set an Authorize header For this authenticator to work, tokens will be part of the request URL, and are more likely to be logged or otherwise exposed. Every effort should be made to filter tokens from being logged when using this authenticator.

func New

func New(param string, auth authenticator.Token, removeParam bool) *Authenticator

func (*Authenticator) AuthenticateRequest

func (a *Authenticator) AuthenticateRequest(req *http.Request) (*authenticator.Response, bool, error)