auth

README

auth

go get github.com/go-gorf/auth

Documentation

Index

• Variables
• func AuthenticationRequiredMiddleware(ctx *gin.Context)
• func ProtectedApi(ctx *gin.Context)
• func Urls(r *gin.Engine)
• func UserLogin(ctx *gin.Context)
• type CognitoJwks
  • func (c *CognitoJwks) JwksUrl() string
• type JwkRes
  • func NewCognitoJwks() JwkRes
• type JwtAuthMiddleware
  • func NewJwtMiddleware(database gorf.Db, jwkRes JwkRes) *JwtAuthMiddleware
  • func (m *JwtAuthMiddleware) Authenticate(ctx *gin.Context) (*gorf.BaseUser, error)
  • func (m *JwtAuthMiddleware) GetUser(ctx *gin.Context) (*gorf.BaseUser, error)
  • func (m *JwtAuthMiddleware) ParseAuthHeader(ctx *gin.Context) error
  • func (m *JwtAuthMiddleware) ParseJwtToken(ctx *gin.Context) error
• type Middleware

Variables

var App = gorf.BaseApp{
	Title:        "Auth",
	Info:         "Gorf Auth handler app",
	RouteHandler: Urls,
	SetUpHandler: setup,
}

var Settings = authSettings{
	ClientId:       "",
	UserPool:       "",
	Region:         "",
	UserObjId:      "username",
	AuthMiddleware: nil,
	JwkRes:         nil,
}

Functions

func AuthenticationRequiredMiddleware

func AuthenticationRequiredMiddleware(ctx *gin.Context)

func ProtectedApi

func ProtectedApi(ctx *gin.Context)

func Urls

func Urls(r *gin.Engine)

func UserLogin

func UserLogin(ctx *gin.Context)

Types

type CognitoJwks

type CognitoJwks struct{}

func (*CognitoJwks) JwksUrl

func (c *CognitoJwks) JwksUrl() string

type JwkRes

type JwkRes interface {
	JwksUrl() string
}

func NewCognitoJwks

func NewCognitoJwks() JwkRes

type JwtAuthMiddleware

type JwtAuthMiddleware struct {
	DB gorf.Db
	// contains filtered or unexported fields
}

func NewJwtMiddleware

func NewJwtMiddleware(database gorf.Db, jwkRes JwkRes) *JwtAuthMiddleware

func (*JwtAuthMiddleware) Authenticate

func (m *JwtAuthMiddleware) Authenticate(ctx *gin.Context) (*gorf.BaseUser, error)

func (*JwtAuthMiddleware) GetUser

func (m *JwtAuthMiddleware) GetUser(ctx *gin.Context) (*gorf.BaseUser, error)

func (*JwtAuthMiddleware) ParseAuthHeader

func (m *JwtAuthMiddleware) ParseAuthHeader(ctx *gin.Context) error

func (*JwtAuthMiddleware) ParseJwtToken

func (m *JwtAuthMiddleware) ParseJwtToken(ctx *gin.Context) error

type Middleware

type Middleware interface {
	ParseAuthHeader(ctx *gin.Context) error
	ParseJwtToken(ctx *gin.Context) error
	GetUser(ctx *gin.Context) (*gorf.BaseUser, error)
	Authenticate(ctx *gin.Context) (*gorf.BaseUser, error)
}