keycloak_middleware

README

Acknowledgements

• Keycloak SSO
• Go Cloak

Installation

Install using go module in your project

  go get github.com/wirnat/go-keycloak-middleware

Overview

• Simple middleware for validating role from keycloak claims

• Support for Echo handler

• Support for Gin handler

• Validate user using keycloak realm access

• Validate user using keycloak resource access

Usage/Examples

//1.INIT Middleware instance
middleware := keycloak_middleware.NewKeyCloakMiddleware(keycloak_middleware.KeyCloakConfig{
	KeyCloakIP:   "localhost:8080",
	Realm:        "my-erp",
	ClientID:     "your client id",
	ClientSecret: "your client secret",
})

//2. Build a permission role
adminAccess := middleware.RealmAccess("admin_access").ResourceAccess("login").EchoGuard()

e := echo.New()

//3. implement it to your route
e.POST("login", func(c echo.Context) error {
	panic("something")
}, adminAccess)

e.Start(":8181")

Documentation

Index

• func NewKeyCloakMiddleware(config KeyCloakConfig, options ...func(cloak *gocloak.GoCloak)) *keyCloakMiddleware
• type EchoHook
• type GinHook
• type KeyCloakConfig
• type Middleware

Functions

func NewKeyCloakMiddleware

func NewKeyCloakMiddleware(config KeyCloakConfig, options ...func(cloak *gocloak.GoCloak)) *keyCloakMiddleware

Types

type EchoHook

type EchoHook func(ctx echo.Context, claims *jwt.MapClaims) error

type GinHook

type GinHook func(ctx *gin.Context, claims *jwt.MapClaims) error

type KeyCloakConfig

type KeyCloakConfig struct {
	KeyCloakIP         string `mapstructure:"key_cloak_ip" json:"key_cloak_ip" yaml:"key_cloak_ip"`
	Realm              string `mapstructure:"realm" json:"realm" yaml:"realm"`
	ClientID           string `mapstructure:"client_id" json:"client_id" yaml:"client_id"`
	ClientSecret       string `mapstructure:"client_secret" json:"client_secret" yaml:"client_secret"`
	RetrospectingToken bool   `json:"retrospecting_token"`
}

type Middleware

type Middleware interface {
	GetClaim(ctx context.Context, accessToken string) (claim *jwt.MapClaims, err error)
	ResourceAccess(args ...string) (r keyCloakMiddleware)
	RealmAccess(args ...string) (r keyCloakMiddleware)
	GinGuard(hook ...GinHook) gin.HandlerFunc
	EchoGuard(hook ...EchoHook) echo.MiddlewareFunc
	ValidateRealmAccess(claims jwt.MapClaims) (err error)
	ValidateResourceAccess(claims jwt.MapClaims) error
	ReturnGoCloak() *gocloak.GoCloak
}