http

package

v2.18.0 Latest Latest Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 26 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/plgd-dev/hub

Links

Open Source Insights

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 DeniedClaims
- func (c DeniedClaims) 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 ¶

View Source

const (
	AnyPathSuffixRegex = `\/.*`
)

Variables ¶

This section is empty.

Functions ¶

func CreateAuthMiddleware ¶

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

CreateAuthMiddleware creates middleware for authorization

func CreateLoggingMiddleware ¶ added in v2.2.4

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

func CreateMakeQueryCaseInsensitiveMiddleware ¶ added in v2.3.6

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

func CreateTrailSlashSuffixMiddleware ¶ added in v2.3.6

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

func DefaultCodeToLevel ¶ added in v2.2.4

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 ErrToStatusWithDef ¶

func ErrToStatusWithDef(err error, def int) int

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

func NewDefaultAuthorizationRules ¶ added in v2.13.0

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 ¶ added in v2.4.0

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 ¶ added in v2.2.4

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 DeniedClaims ¶

type DeniedClaims struct {
	jwt.MapClaims
	Err error
}

func (DeniedClaims) Validate ¶ added in v2.16.3

func (c DeniedClaims) 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 ¶ added in v2.2.4

type LogOpt = func(*LogOptions)

func WithLogger ¶ added in v2.2.4

func WithLogger(logger log.Logger) LogOpt

type LogOptions ¶ added in v2.3.6

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

func NewLogOptions ¶ added in v2.3.6

func NewLogOptions() *LogOptions

type OnUnauthorizedAccessFunc ¶

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

type OpenTelemetryCollectorConfig ¶ added in v2.4.0

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

func (*OpenTelemetryCollectorConfig) Validate ¶ added in v2.4.0

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
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
client
server
service

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL