webutil

README

webutil

Web-related utilities for Go microservices.

Documentation

Index

• func ConfigureGinCORS(router *gin.Engine, allowedOrigins []string, allowMethods []string, ...)
• func CreateAuth0JWTValidationGinMiddleware(auth0Domain string, audiences []string, algorithm validator.SignatureAlgorithm, ...) func(c *gin.Context)
• func GetAccessToken(auth0Domain, m2mClientID, m2mClientSecret, apiAudience string) (string, error)
• func GetClaims(ctx context.Context) *validator.ValidatedClaims
• func GinAccessLogMiddleware(c *gin.Context)
• func GraphErrorPresenter(ctx context.Context, e error) *gqlerror.Error
• func GraphPanicRecoverer(_ context.Context, p interface{}) error
• func HasScope(scopes, expectedScope string) bool
• func InitGinPackage(devMode bool)
• func NewGin() *gin.Engine
• type CORSConfig
  • func (c *CORSConfig) Configure(router *gin.Engine)
• type GraphUserError
  • func (e *GraphUserError) Error() string
  • func (e *GraphUserError) Is(err error) bool
  • func (e *GraphUserError) Unwrap() error
• type HTTPConfig

Functions

func ConfigureGinCORS

func ConfigureGinCORS(
	router *gin.Engine,
	allowedOrigins []string,
	allowMethods []string,
	allowHeaders []string,
	exposeHeaders []string,
	maxAge time.Duration,
	disableCredentials bool)

func CreateAuth0JWTValidationGinMiddleware

func CreateAuth0JWTValidationGinMiddleware(
	auth0Domain string,
	audiences []string,
	algorithm validator.SignatureAlgorithm,
	customClaimsFunc func() validator.CustomClaims,
	tokenExtractors ...jwtmiddleware.TokenExtractor) func(c *gin.Context)

func GetAccessToken

func GetAccessToken(auth0Domain, m2mClientID, m2mClientSecret, apiAudience string) (string, error)

func GetClaims

func GetClaims(ctx context.Context) *validator.ValidatedClaims

func GinAccessLogMiddleware

func GinAccessLogMiddleware(c *gin.Context)

func GraphErrorPresenter

func GraphErrorPresenter(ctx context.Context, e error) *gqlerror.Error

func GraphPanicRecoverer

func GraphPanicRecoverer(_ context.Context, p interface{}) error

func HasScope

func HasScope(scopes, expectedScope string) bool

func InitGinPackage

func InitGinPackage(devMode bool)

func NewGin

func NewGin() *gin.Engine

Types

type CORSConfig

type CORSConfig struct {
	AllowedOrigins     []string      `` /* 241-byte string literal not displayed */
	AllowMethods       []string      `` /* 219-byte string literal not displayed */
	AllowHeaders       []string      `` /* 258-byte string literal not displayed */
	DisableCredentials bool          `` /* 216-byte string literal not displayed */
	ExposeHeaders      []string      `` /* 215-byte string literal not displayed */
	MaxAge             time.Duration `` /* 215-byte string literal not displayed */
}

func (*CORSConfig) Configure

func (c *CORSConfig) Configure(router *gin.Engine)

type GraphUserError

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

func (*GraphUserError) Error

func (e *GraphUserError) Error() string

func (*GraphUserError) Is

func (e *GraphUserError) Is(err error) bool

func (*GraphUserError) Unwrap

func (e *GraphUserError) Unwrap() error

type HTTPConfig

type HTTPConfig struct {
	Port int        `env:"PORT" value-name:"PORT" long:"port" description:"Port to listen on" default:"8000"`
	CORS CORSConfig `group:"cors" namespace:"cors" env-namespace:"CORS"`
}