jwt

package module

v1.2.0 Latest Latest Go to latest Published: Nov 23, 2024 License: MIT Imports: 16 Imported by: 0

README ¶

Gin Cognito JWT Authentication Middleware

Gin

This is a JWT auth Gin middleware to validate JWT token issued by AWS Cognito identity manager. The implementation of this middleware is based on the AWS documentation on how to verify the JWT token

Here is an example of how can this be invoked. It should be attached to all endpoint you would want to authenticate against the user.


package main

import (
	"github.com/gin-gonic/gin"
    "github.com/Digital-Insight-Technologies-Ltd/gin-jwt-cognito"
)

func main() {

	// Creates a gin router with default middleware:
	router := gin.Default()

	// Create Cognito JWT auth middleware and set it  in all authenticated endpoints
	mw, err := jwt.AuthJWTMiddleware("<some_iss>", "<some_userpool_id>", "region")
	if err != nil {
		panic(err)
	}

	router.GET("/someGet", mw.MiddlewareFunc(), func(context *gin.Context) {
		// some implementation
	})
	router.POST("/somePost", mw.MiddlewareFunc(), func(context *gin.Context) {
		// some implementation
	})
	router.PUT("/somePut", mw.MiddlewareFunc(), func(context *gin.Context) {
		// some implementation
	})

	// By default it serves on :8080 unless a
	// PORT environment variable was defined.
	router.Run()
}

License

MIT

Documentation ¶

Index ¶

Constants
Variables
func CognitoClaimsMiddleware(jwtParser *jwt.Parser) gin.HandlerFunc
type AuthError
type AuthMiddleware
- func AuthJWTMiddleware(iss, userPoolID, region string, allowedClientIds []string, tokenLookup string) (*AuthMiddleware, error)
- func (mw *AuthMiddleware) MiddlewareFunc() gin.HandlerFunc
- func (mw *AuthMiddleware) MiddlewareInit()
type JWK
type JWKKey

Examples ¶

AuthMiddleware

Constants ¶

View Source

const (

	// AuthenticateHeader the Gin authenticate header
	AuthenticateHeader = "WWW-Authenticate"

	// AuthorizationHeader the auth header that gets passed to all services
	AuthorizationHeader = "Authorization"
	AuthorizationQuery  = "Authorization"

	// HEADER used by the JWT middle ware
	HEADER = "header"
	QUERY  = "query"

	// IssuerFieldName the issuer field name
	IssuerFieldName = "iss"
)

View Source

const UserClaimsKey = "userClaims"

UserClaimsKey is the key for user claims in our context

Variables ¶

View Source

var AuthHeaderEmptyError = errors.New("HTTP authorization header empty")

View Source

var AuthQueryEmptyError = errors.New("HTTP authorization query empty")

Functions ¶

func CognitoClaimsMiddleware ¶ added in v1.2.0

func CognitoClaimsMiddleware(jwtParser *jwt.Parser) gin.HandlerFunc

CognitoClaimsMiddleware is a middleware for Gin that extracts user claims from AWS Cognito.

Types ¶

type AuthError ¶

type AuthError struct {
	Code    int `json:"code"`
	Message any `json:"message"`
}

AuthError auth error response

type AuthMiddleware ¶

type AuthMiddleware struct {

	// User can define own Unauthorized func.
	Unauthorized func(*gin.Context, int, string)

	Timeout time.Duration

	// TokenLookup the header name of the token
	TokenLookup string

	// TimeFunc
	TimeFunc func() time.Time

	// Realm name to display to the user. Required.
	Realm string

	// to verify issuer
	VerifyIssuer bool

	// Region aws region
	Region string

	// UserPoolID the cognito user pool id
	UserPoolID string

	// The issuer
	Iss string

	// JWK public JSON Web Key (JWK) for your user pool
	JWK map[string]JWKKey

	// Allowed Client Ids
	AllowedClientIds []string
}

AuthMiddleware middleware

Example ¶

package main

import (
	jwt "github.com/Digital-Insight-Technologies-Ltd/gin-jwt-cognito"
	"github.com/gin-gonic/gin"
)

func main() {

	// Creates a gin router with default middleware:
	router := gin.Default()

	// Create Cognito JWT auth middleware and set it  in all authenticated endpoints
	mw, err := jwt.AuthJWTMiddleware("<some_iss>", "<some_userpool_id>", "region", []string{"clientid1", "clientid2"}, "header: "+jwt.AuthorizationHeader)
	if err != nil {
		panic(err)
	}

	router.GET("/someGet", mw.MiddlewareFunc(), func(context *gin.Context) {
		// some implementation
	})
	router.POST("/somePost", mw.MiddlewareFunc(), func(context *gin.Context) {
		// some implementation
	})
	router.PUT("/somePut", mw.MiddlewareFunc(), func(context *gin.Context) {
		// some implementation
	})

	// By default, it serves on :8080 unless a
	// PORT environment variable was defined.
	err = router.Run()
	if err != nil {
		return
	}
}

Output:

func AuthJWTMiddleware ¶

func AuthJWTMiddleware(iss, userPoolID, region string, allowedClientIds []string, tokenLookup string) (*AuthMiddleware, error)

AuthJWTMiddleware create an instance of the middle ware function

func (*AuthMiddleware) MiddlewareFunc ¶

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

MiddlewareFunc implements the Middleware interface.

func (*AuthMiddleware) MiddlewareInit ¶

func (mw *AuthMiddleware) MiddlewareInit()

MiddlewareInit initialize jwt configs.

type JWK ¶

type JWK struct {
	Keys []JWKKey
}

JWK is json data struct for JSON Web Key

type JWKKey ¶

type JWKKey struct {
	Alg string
	E   string
	Kid string
	Kty string
	N   string
	Use string
}

JWKKey is json data struct for cognito jwk key

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
models

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