auth

Documentation

Index

• Variables
• func GetAuth(guard string) auth.Auth
• func Logout(ctx *frame.Context)
• func NewAuth(guard string) contractauth.Auth
• func NewSession(guard string) contractauth.Auth
• type Application
• type Auth
  • func (app *Auth) Guard(name string) contractauth.Auth
  • func (app *Auth) Login(ctx *frame.Context, user contractauth.User) (token string, err error)
  • func (app *Auth) LoginUsingID(ctx *frame.Context, id any) (token string, err error)
  • func (app *Auth) Logout(ctx *frame.Context) error
  • func (app *Auth) Parse(ctx *frame.Context, token string) error
  • func (app *Auth) Refresh(ctx *frame.Context) (token string, err error)
  • func (app *Auth) User(ctx *frame.Context, user contractauth.User) error
• type Claims
• type Guard
• type Guards
• type ServiceProvider
  • func (database *ServiceProvider) Boot()
  • func (database *ServiceProvider) Register()
• type Session
  • func (app *Session) Guard(name string) contractauth.Auth
  • func (app *Session) Login(ctx *frame.Context, user contractauth.User) (token string, err error)
  • func (app *Session) LoginUsingID(ctx *frame.Context, id any) (token string, err error)
  • func (app *Session) Logout(ctx *frame.Context) error
  • func (app *Session) Parse(ctx *frame.Context, token string) error
  • func (app *Session) Refresh(ctx *frame.Context) (token string, err error)
  • func (app *Session) User(ctx *frame.Context, user contractauth.User) error

Variables

var (
	ErrorRefreshTimeExceeded = errors.New("refresh time exceeded")
	ErrorTokenExpired        = errors.New("token expired")
	ErrorNoPrimaryKeyField   = errors.New("the primaryKey field was not found in the model, set primaryKey like orm.Model")
	ErrorEmptySecret         = errors.New("secret is required")
	ErrorTokenDisabled       = errors.New("token is disabled")
	ErrorParseTokenFirst     = errors.New("parse token first")
	ErrorInvalidClaims       = errors.New("invalid claims")
	ErrorInvalidToken        = errors.New("invalid token")
)

var Drivers *drivers

Functions

func GetAuth

func GetAuth(guard string) auth.Auth

func Logout

func Logout(ctx *frame.Context)

func NewAuth

func NewAuth(guard string) contractauth.Auth

func NewSession

func NewSession(guard string) contractauth.Auth

Types

type Application

type Application struct {
	// contains filtered or unexported fields
}

type Auth

type Auth struct {
	// contains filtered or unexported fields
}

func (*Auth) Guard

func (app *Auth) Guard(name string) contractauth.Auth

func (*Auth) Login

func (app *Auth) Login(ctx *frame.Context, user contractauth.User) (token string, err error)

func (*Auth) LoginUsingID

func (app *Auth) LoginUsingID(ctx *frame.Context, id any) (token string, err error)

func (*Auth) Logout

func (app *Auth) Logout(ctx *frame.Context) error

func (*Auth) Parse

func (app *Auth) Parse(ctx *frame.Context, token string) error

func (*Auth) Refresh

func (app *Auth) Refresh(ctx *frame.Context) (token string, err error)

Refresh need parse token first.

func (*Auth) User

func (app *Auth) User(ctx *frame.Context, user contractauth.User) error

User need parse token first.

type Claims

type Claims struct {
	Key string `json:"key"`
	jwt.RegisteredClaims
}

type Guard

type Guard struct {
	Claims *Claims
	Token  string
}

type Guards

type Guards map[string]*Guard

type ServiceProvider

type ServiceProvider struct {
	Auth auth.Auth
}

func (*ServiceProvider) Boot

func (database *ServiceProvider) Boot()

func (*ServiceProvider) Register

func (database *ServiceProvider) Register()

type Session

type Session struct {
	// contains filtered or unexported fields
}

func (*Session) Guard

func (app *Session) Guard(name string) contractauth.Auth

func (*Session) Login

func (app *Session) Login(ctx *frame.Context, user contractauth.User) (token string, err error)

func (*Session) LoginUsingID

func (app *Session) LoginUsingID(ctx *frame.Context, id any) (token string, err error)

func (*Session) Logout

func (app *Session) Logout(ctx *frame.Context) error

func (*Session) Parse

func (app *Session) Parse(ctx *frame.Context, token string) error

func (*Session) Refresh

func (app *Session) Refresh(ctx *frame.Context) (token string, err error)

Refresh need parse token first.

func (*Session) User

func (app *Session) User(ctx *frame.Context, user contractauth.User) error

User need parse token first.