router

Documentation

Index

• Constants
• func ExtractToken(headerValue string) (string, error)
• func RegisterAuthErrCode(scenario AuthErrorScenario, errCode string)
• func RegisterAuthMsgID(scenario AuthErrorScenario, msgID int)
• func RegisterMiddlewareErrCode(scenario MiddlewareErrorScenario, errCode string)
• func RegisterMiddlewareMsgID(scenario MiddlewareErrorScenario, msgID int)
• func RequestLoggerMiddleware(logger logger.Logger) gin.HandlerFunc
• func SetDefaultErrCode(errCode string)
• func SetDefaultMsgID(msgID int)
• func SetupRouter(useOIDCAuth bool, l logger.Logger, authMiddleware *AuthMiddleware) (*gin.Engine, error)
• func TimeoutMiddleware(timeout time.Duration) gin.HandlerFunc
• type AuthErrorScenario
• type AuthMiddleware
  • func LoadAuthMiddleware(clientID string, providerURL string, cache TokenCache, l logger.Logger) (*AuthMiddleware, error)
  • func NewAuthMiddleware(clientID string, provider *oidc.Provider, cache TokenCache, ...) (*AuthMiddleware, error)
  • func (a *AuthMiddleware) MiddlewareFunc() gin.HandlerFunc
• type GinContext
  • func (gc *GinContext) Bind(obj any) error
  • func (gc *GinContext) BindJSON(obj any) error
  • func (gc *GinContext) JSON(code int, obj any)
  • func (gc *GinContext) Request() *http.Request
• type GinRouter
  • func NewGinRouter() *GinRouter
  • func (gr *GinRouter) Serve(address string) error
• type MiddlewareErrorScenario
• type RedisTokenCache
  • func (r *RedisTokenCache) Get(token string) (bool, error)
  • func (r *RedisTokenCache) Set(token string) error
• type TokenCache
  • func NewRedisTokenCache(addr string, password string, db int, expiration time.Duration) TokenCache

Constants

const DefaultExpiration = 30 * time.Second

Functions

func ExtractToken

func ExtractToken(headerValue string) (string, error)

ExtractToken extracts the token from the Authorization header.

func RegisterAuthErrCode

func RegisterAuthErrCode(scenario AuthErrorScenario, errCode string)

RegisterAuthErrCode allows the registration of an error code for a specific AuthErrorScenario.

func RegisterAuthMsgID

func RegisterAuthMsgID(scenario AuthErrorScenario, msgID int)

RegisterAuthMsgID allows the registration of a message ID for a specific AuthErrorScenario.

func RegisterMiddlewareErrCode

func RegisterMiddlewareErrCode(scenario MiddlewareErrorScenario, errCode string)

func RegisterMiddlewareMsgID

func RegisterMiddlewareMsgID(scenario MiddlewareErrorScenario, msgID int)

func RequestLoggerMiddleware

func RequestLoggerMiddleware(logger logger.Logger) gin.HandlerFunc

func SetDefaultErrCode

func SetDefaultErrCode(errCode string)

SetDefaultErrCode allows external code to set a custom default error code.

func SetDefaultMsgID

func SetDefaultMsgID(msgID int)

SetDefaultMsgID allows external code to set a custom default message ID.

func SetupRouter

func SetupRouter(useOIDCAuth bool, l logger.Logger, authMiddleware *AuthMiddleware) (*gin.Engine, error)

func TimeoutMiddleware

func TimeoutMiddleware(timeout time.Duration) gin.HandlerFunc

Types

type AuthErrorScenario

type AuthErrorScenario string

AuthErrorScenario defines a set of constants representing different error scenarios that can occur within the AuthMiddleware. These scenarios are used to map specific error conditions to message IDs and error codes.

const (
	// TokenMissing indicates an error scenario where the expected authentication token is missing from the request.
	TokenMissing AuthErrorScenario = "TokenMissing"
	// TokenCacheFailed indicates an error scenario where an operation related to caching the token fails.
	TokenCacheFailed AuthErrorScenario = "TokenCacheFailed"
	// TokenVerificationFailed indicates an error scenario where the authentication token fails verification.
	TokenVerificationFailed AuthErrorScenario = "TokenVerificationFailed"
)

type AuthMiddleware

type AuthMiddleware struct {
	Verifier *oidc.IDTokenVerifier
	Cache    TokenCache
	Logger   logger.Logger
}

func LoadAuthMiddleware

func LoadAuthMiddleware(clientID string, providerURL string, cache TokenCache, l logger.Logger) (*AuthMiddleware, error)

func NewAuthMiddleware

func NewAuthMiddleware(clientID string, provider *oidc.Provider, cache TokenCache, logger logger.Logger) (*AuthMiddleware, error)

func (*AuthMiddleware) MiddlewareFunc

func (a *AuthMiddleware) MiddlewareFunc() gin.HandlerFunc

MiddlewareFunc returns a gin.HandlerFunc (middleware) that checks for a valid token.

type GinContext

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

GinContext is an adapter that implements the Context interface for Gin.

func (*GinContext) Bind

func (gc *GinContext) Bind(obj any) error

Bind binds the request body to obj.

func (*GinContext) BindJSON

func (gc *GinContext) BindJSON(obj any) error

BindJSON binds the JSON request body into obj.

func (*GinContext) JSON

func (gc *GinContext) JSON(code int, obj any)

JSON sends a JSON response.

func (*GinContext) Request

func (gc *GinContext) Request() *http.Request

Request returns the underlying http.Request.

type GinRouter

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

GinRouter implements the Router interface for Gin framework.

func NewGinRouter

func NewGinRouter() *GinRouter

NewGinRouter is a constructor for GinRouter.

func (*GinRouter) Serve

func (gr *GinRouter) Serve(address string) error

Serve starts the HTTP server at the specified address.

type MiddlewareErrorScenario

type MiddlewareErrorScenario string

const (
	RequestTimeout MiddlewareErrorScenario = "RequestTimeout"
)

type RedisTokenCache

type RedisTokenCache struct {
	Client     *redis.Client
	Ctx        context.Context
	Expiration time.Duration
}

RedisTokenCache is a Redis implementation of TokenCache.

func (*RedisTokenCache) Get

func (r *RedisTokenCache) Get(token string) (bool, error)

Get gets a token from the cache.

func (*RedisTokenCache) Set

func (r *RedisTokenCache) Set(token string) error

Set sets a token in the cache.

type TokenCache

type TokenCache interface {
	Get(token string) (bool, error)
	Set(token string) error
}

TokenCache is an interface for caching tokens.

func NewRedisTokenCache

func NewRedisTokenCache(addr string, password string, db int, expiration time.Duration) TokenCache