http

Documentation

Index

• Constants
• func CanonicalHref(href string) string
• func CreateAuthMiddleware(authInterceptor Interceptor, onUnauthorizedAccessFunc OnUnauthorizedAccessFunc) func(next http.Handler) http.Handler
• func CreateLoggingMiddleware(opts ...LogOpt) func(next http.Handler) http.Handler
• func CreateMakeQueryCaseInsensitiveMiddleware(queryCaseInsensitive map[string]string, opts ...LogOpt) func(next http.Handler) http.Handler
• func CreateTrailSlashSuffixMiddleware(opts ...LogOpt) func(next http.Handler) http.Handler
• func DefaultCodeToLevel(code int, logger log.Logger) func(args ...interface{})
• func ErrToStatus(err error) int
• func ErrToStatusWithDef(err error, def int) int
• func NewDefaultAuthorizationRules(apiPath string) map[string][]AuthArgs
• func OpenTelemetryNewHandler(handler http.Handler, serviceName string, tracerProvider trace.TracerProvider) http.Handler
• func ParseToken(auth string) (string, error)
• func ToURLString(scheme string, host string, path string) string
• func WantToLog(code int, logger log.Logger) bool
• type AuthArgs
• type ClaimsFunc
  • func MakeClaimsFunc(methods map[string][]AuthArgs) ClaimsFunc
• type DeniedClaimsError
  • func (c DeniedClaimsError) Error() string
  • func (c DeniedClaimsError) Unwrap() error
  • func (c DeniedClaimsError) Validate() error
• type Interceptor
  • func NewInterceptorWithValidator(validator Validator, auths map[string][]AuthArgs, whiteList ...RequestMatcher) Interceptor
• type LogOpt
  • func WithLogger(logger log.Logger) LogOpt
• type LogOptions
  • func NewLogOptions() *LogOptions
• type OnUnauthorizedAccessFunc
• type OpenTelemetryCollectorConfig
  • func (c *OpenTelemetryCollectorConfig) Validate() error
• type RequestMatcher
• type Validator

Constants

const (
	ApplicationProtoJsonContentType = "application/protojson"

	CorrelationIDHeaderKey      = "Correlation-Id"
	ContentLengthHeaderKey      = "Content-Length"
	ContentTypeHeaderKey        = "Content-Type"
	ContentTypeOptionsHeaderKey = "X-Content-Type-Options"
	AcceptHeaderKey             = "Accept"
	ETagHeaderKey               = "ETag"
)

const (
	AnyPathSuffixRegex = `\/.*`
)

Functions

func CanonicalHref

func CanonicalHref(href string) string

CanonicalHref always lead by "/"

func CreateAuthMiddleware

func CreateAuthMiddleware(authInterceptor Interceptor, onUnauthorizedAccessFunc OnUnauthorizedAccessFunc) func(next http.Handler) http.Handler

CreateAuthMiddleware creates middleware for authorization

func CreateLoggingMiddleware

func CreateLoggingMiddleware(opts ...LogOpt) func(next http.Handler) http.Handler

func CreateMakeQueryCaseInsensitiveMiddleware

func CreateMakeQueryCaseInsensitiveMiddleware(queryCaseInsensitive map[string]string, opts ...LogOpt) func(next http.Handler) http.Handler

func CreateTrailSlashSuffixMiddleware

func CreateTrailSlashSuffixMiddleware(opts ...LogOpt) func(next http.Handler) http.Handler

func DefaultCodeToLevel

func DefaultCodeToLevel(code int, logger log.Logger) func(args ...interface{})

DefaultCodeToLevel is the default implementation of gRPC return codes and interceptor log level for server side.

func ErrToStatus

func ErrToStatus(err error) int

ErrToStatus converts err to http.Status.

func ErrToStatusWithDef

func ErrToStatusWithDef(err error, def int) int

ErrToStatusWithDef converts err with default http.Status(for unknown conversion) to http.Status.

func NewDefaultAuthorizationRules

func NewDefaultAuthorizationRules(apiPath string) map[string][]AuthArgs

NewDefaultAuthorizationRules returns a map of HTTP methods to a slice of AuthArgs. The AuthArgs contain a URI field that is a regular expression matching the given apiPath with any path suffix. This function is used to create default authorization rules for HTTP methods GET, POST, DELETE, and PUT.

func OpenTelemetryNewHandler

func OpenTelemetryNewHandler(handler http.Handler, serviceName string, tracerProvider trace.TracerProvider) http.Handler

func ParseToken

func ParseToken(auth string) (string, error)

func ToURLString

func ToURLString(scheme string, host string, path string) string

ToURLString convert scheme, host, path to escaped url.

func WantToLog

func WantToLog(code int, logger log.Logger) bool

DefaultCodeToLevel is the default implementation of gRPC return codes and interceptor log level for server side.

Types

type AuthArgs

type AuthArgs struct {
	URI    *regexp.Regexp
	Scopes []*regexp.Regexp
}

type ClaimsFunc

type ClaimsFunc = func(ctx context.Context, method, uri string) jwt.ClaimsValidator

func MakeClaimsFunc

func MakeClaimsFunc(methods map[string][]AuthArgs) ClaimsFunc

type DeniedClaimsError

type DeniedClaimsError struct {
	jwt.MapClaims
	Err error
}

func (DeniedClaimsError) Error

func (c DeniedClaimsError) Error() string

func (DeniedClaimsError) Unwrap

func (c DeniedClaimsError) Unwrap() error

func (DeniedClaimsError) Validate

func (c DeniedClaimsError) Validate() error

type Interceptor

type Interceptor = func(ctx context.Context, method, uri string) (context.Context, error)

func NewInterceptorWithValidator

func NewInterceptorWithValidator(validator Validator, auths map[string][]AuthArgs, whiteList ...RequestMatcher) Interceptor

NewInterceptor authorizes HTTP request with validator.

type LogOpt

type LogOpt = func(*LogOptions)

func WithLogger

func WithLogger(logger log.Logger) LogOpt

type LogOptions

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

func NewLogOptions

func NewLogOptions() *LogOptions

type OnUnauthorizedAccessFunc

type OnUnauthorizedAccessFunc = func(ctx context.Context, w http.ResponseWriter, r *http.Request, err error)

type OpenTelemetryCollectorConfig

type OpenTelemetryCollectorConfig struct {
	otelClient.Config `yaml:",inline"`
}

func (*OpenTelemetryCollectorConfig) Validate

func (c *OpenTelemetryCollectorConfig) Validate() error

type RequestMatcher

type RequestMatcher struct {
	Method string
	URI    *regexp.Regexp
}

RequestMatcher allows request without token validation.

type Validator

type Validator interface {
	ParseWithClaims(token string, claims jwt.Claims) error
}