security

README

security

Starter for using Session Security

Documentation

Index

• func ModuleT() *application.ModuleBuilder
• type Session
• type SessionProvider
• type SessionRegistration
• type SessionRegistry
• type SessionService
• type Subject
  • func GetSubject(c context.Context) (Subject, error)
  • func SetupSubject(c context.Context, ss SessionService) (Subject, error)

Functions

func ModuleT

func ModuleT() *application.ModuleBuilder

ModuleT 导出模块[github.com/starter-go/security]

Types

type Session

type Session interface {
	Get() *rbac.SessionDTO

	Set(s *rbac.SessionDTO)

	UserID() rbac.UserID

	UserName() rbac.UserName

	Nickname() string

	Avatar() string

	Roles() rbac.RoleNameList

	Authenticated() bool
}

Session 代表当前会话

type SessionProvider

type SessionProvider interface {
	Support(c context.Context) bool
	Current(c context.Context) (Session, error)
}

SessionProvider 会话的实现方案

type SessionRegistration

type SessionRegistration struct {
	Name     string
	Enabled  bool
	Priority int
	Provider SessionProvider
}

SessionRegistration 会话方案的注册信息

type SessionRegistry

type SessionRegistry interface {
	Registration() *SessionRegistration
}

SessionRegistry 会话方案的注册接口

type SessionService

type SessionService interface {
	GetCurrent(c context.Context) (Session, error)
}

SessionService 是针对 SessionDTO 的服务

type Subject

type Subject interface {
	GetSession(create bool) Session

	HasRole(role rbac.RoleName) bool
}

Subject 代表当前主体

func GetSubject

func GetSubject(c context.Context) (Subject, error)

GetSubject 从上下文中提取当前主体

func SetupSubject

func SetupSubject(c context.Context, ss SessionService) (Subject, error)

SetupSubject 把主体绑定到上下文中