gin_authn

README

gin-authn

Documentation

Index

• Variables
• func DenyAll() gin.HandlerFunc
• func OAuth2Aware(config ...Configuration) gin.HandlerFunc
• func ScopesAllowed(allowedScopes ...string) gin.HandlerFunc
• type Configuration
• type CookieExtractor
  • func (e CookieExtractor) Extract(c *gin.Context) (string, error)
• type HeaderExtractor
  • func (e HeaderExtractor) Extract(c *gin.Context) (string, error)
• type PostFormExtractor
  • func (e PostFormExtractor) Extract(c *gin.Context) (string, error)
• type QueryExtractor
  • func (qe QueryExtractor) Extract(c *gin.Context) (string, error)
• type TokenExtractor
  • func CompositeExtractor(extractor ...TokenExtractor) TokenExtractor

Variables

var DefaultAccessTokenExtractor = CompositeExtractor(
	HeaderExtractor("Authorization: Bearer"),
	PostFormExtractor("access_token"),
	QueryExtractor("access_token"))

var DefaultIdTokenExtractor = HeaderExtractor("X-Id-Token")

Functions

func DenyAll

func DenyAll() gin.HandlerFunc

func OAuth2Aware

func OAuth2Aware(config ...Configuration) gin.HandlerFunc

func ScopesAllowed

func ScopesAllowed(allowedScopes ...string) gin.HandlerFunc

Types

type Configuration

type Configuration struct {
	VerifyToken          bool
	DiscoveryUrl         string
	JwksUrl              string
	AccessTokenExtractor TokenExtractor
	IdTokenExtractor     TokenExtractor
}

type CookieExtractor

type CookieExtractor string

func (CookieExtractor) Extract

func (e CookieExtractor) Extract(c *gin.Context) (string, error)

type HeaderExtractor

type HeaderExtractor string

func (HeaderExtractor) Extract

func (e HeaderExtractor) Extract(c *gin.Context) (string, error)

type PostFormExtractor

type PostFormExtractor string

func (PostFormExtractor) Extract

func (e PostFormExtractor) Extract(c *gin.Context) (string, error)

type QueryExtractor

type QueryExtractor string

func (QueryExtractor) Extract

func (qe QueryExtractor) Extract(c *gin.Context) (string, error)

type TokenExtractor

type TokenExtractor interface {
	Extract(c *gin.Context) (string, error)
}

func CompositeExtractor

func CompositeExtractor(extractor ...TokenExtractor) TokenExtractor