auth

Documentation

Index

• func ComparePassword(hashed string, normal string) error
• func GenerateToken(username string, callbacks ...func(*Claims)) (string, error)
• func HashPassword(s string) string
• func RefreshToken(tknStr string) (string, error)
• type ApiSecurityOptions
• type Claims
  • func ValidateToken(token string) (*Claims, error)
• type CustomClaims
  • func (c *CustomClaims) Validate(ctx context.Context) error
• type LedgerValidator
  • func New(cfg ApiSecurityOptions) LedgerValidator
• type UserInfo
  • func TokenFromContext(ctx context.Context) *UserInfo

Functions

func ComparePassword

func ComparePassword(hashed string, normal string) error

func GenerateToken

func GenerateToken(username string, callbacks ...func(*Claims)) (string, error)

func HashPassword

func HashPassword(s string) string

func RefreshToken

func RefreshToken(tknStr string) (string, error)

Types

type ApiSecurityOptions

type ApiSecurityOptions struct {
	IssuerURL string   `json:"authority"`
	ClientID  string   `json:"client_id"`
	Audience  []string `json:"-"`
}

type Claims

type Claims struct {
	Username string `json:"username"`
	jwt.RegisteredClaims
}

Create a struct that will be encoded to a JWT. We add jwt.RegisteredClaims as an embedded type, to provide fields like expiry time

func ValidateToken

func ValidateToken(token string) (*Claims, error)

type CustomClaims

type CustomClaims struct {
	PreferredUsername string `json:"preferred_username"`
	EmailVerified     bool   `json:"email_verified"`
}

func (*CustomClaims) Validate

func (c *CustomClaims) Validate(ctx context.Context) error

type LedgerValidator

type LedgerValidator interface {
	ValidateToken(authString string) error
	GetJWTMiddleware() gin.HandlerFunc
}

func New

func New(cfg ApiSecurityOptions) LedgerValidator

type UserInfo

type UserInfo struct {
	Username string
}

func TokenFromContext

func TokenFromContext(ctx context.Context) *UserInfo