middleware

README

Auth0 Scopes

Consume Auth0 Scopes in Go A Go middleware for gin.

Check out Examples - for an idea on how to use this with Gin

Installation

# Go package install
go get github.com/colwill/go-auth0-scopes/

Basic Usage

import (
    middleware "github.com/colwill/go-auth0-scopes"
)

var router = gin.Default()

func main() {

    router.Use(middleware.ScopeUnwrap())
    router.GET("/protected", middleware.Authorise("read:protected"), func(c *gin.Context) {
        c.IndentedJSON(http.StatusOK, gin.H{"message": "this is a protected route!"})
    })

    err = router.Run()
	if err != nil {
		return
	}
}

Documentation

Index

• func Authorise(scope string) gin.HandlerFunc
• func ScopeUnwrap() gin.HandlerFunc
• type CustomAuthClaims
  • func (c CustomAuthClaims) Validate(ctx context.Context) error

Functions

func Authorise

func Authorise(scope string) gin.HandlerFunc

func ScopeUnwrap

func ScopeUnwrap() gin.HandlerFunc

Types

type CustomAuthClaims

type CustomAuthClaims struct {
	Scope string `json:"scope"`
}

func (CustomAuthClaims) Validate

func (c CustomAuthClaims) Validate(ctx context.Context) error