auth

Documentation

Index

• Constants
• Variables
• type Auth
  • func NewAuth(guard string, cache cache.Cache, config config.Config, orm orm.Orm) *Auth
  • func (a *Auth) Guard(name string) contractsauth.Auth
  • func (a *Auth) Login(ctx http.Context, user any) (token string, err error)
  • func (a *Auth) LoginUsingID(ctx http.Context, id any) (token string, err error)
  • func (a *Auth) Logout(ctx http.Context) error
  • func (a *Auth) Parse(ctx http.Context, token string) (*contractsauth.Payload, error)
  • func (a *Auth) Refresh(ctx http.Context) (token string, err error)
  • func (a *Auth) User(ctx http.Context, user any) error
• type Claims
• type Guard
• type Guards
• type ServiceProvider
  • func (database *ServiceProvider) Boot(app foundation.Application)
  • func (database *ServiceProvider) Register(app foundation.Application)

Constants

const BindingAuth = "goravel.auth"

const BindingGate = "goravel.gate"

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")
	ErrorInvalidKey          = errors.New("invalid key")
)

Types

type Auth

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

func NewAuth

func NewAuth(guard string, cache cache.Cache, config config.Config, orm orm.Orm) *Auth

func (*Auth) Guard

func (a *Auth) Guard(name string) contractsauth.Auth

func (*Auth) Login

func (a *Auth) Login(ctx http.Context, user any) (token string, err error)

func (*Auth) LoginUsingID

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

func (*Auth) Logout

func (a *Auth) Logout(ctx http.Context) error

func (*Auth) Parse

func (a *Auth) Parse(ctx http.Context, token string) (*contractsauth.Payload, error)

func (*Auth) Refresh

func (a *Auth) Refresh(ctx http.Context) (token string, err error)

Refresh need parse token first.

func (*Auth) User

func (a *Auth) User(ctx http.Context, user any) 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 {
}

func (*ServiceProvider) Boot

func (database *ServiceProvider) Boot(app foundation.Application)

func (*ServiceProvider) Register

func (database *ServiceProvider) Register(app foundation.Application)