security

README

security

Starter for using Session Security

Documentation

Index

• func NewMainModule() *application.ModuleBuilder
• func NewTestModule() *application.ModuleBuilder
• type Context
  • func (inst *Context) Flush() error
• type ContextFactory
• type Session
• type SessionGetter
• type SessionLoader
• type SessionManager
• type SessionProvider
• type SessionRegistration
• type SessionRegistry
• type SessionSaver
• type SessionService
• type SessionSetter
• type Token
• type TokenGetter
• type TokenLoader
• type TokenManager
• type TokenSaver
• type TokenSetter

Functions

func NewMainModule

func NewMainModule() *application.ModuleBuilder

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

func NewTestModule

func NewTestModule() *application.ModuleBuilder

NewTestModule 导出模块[github.com/starter-go/security#test]

Types

type Context

type Context struct {
	Parent context.Context

	// token
	DirtyToken   Token // 表示还没有保存的数据集
	Token        Token
	TokenManager TokenManager

	// session
	DirtySession   Session // 表示还没有保存的数据集
	Session        Session
	SessionManager SessionManager
}

Context 包含当前上下文中跟安全问题相关的信息

func (*Context) Flush

func (inst *Context) Flush() error

Flush 保存被标记为 dirty 的数据

type ContextFactory

type ContextFactory interface {
	CreateContext(parent context.Context) (*Context, error)
}

ContextFactory ...

type Session

type Session interface {
	SessionID() rbac.SessionID

	UserID() rbac.UserID

	UUID() lang.UUID

	GetProperties() properties.Table

	SetProperty(name, value string)

	Get() *rbac.SessionDTO

	Set(s *rbac.SessionDTO)

	UserName() rbac.UserName

	Nickname() string

	Avatar() string

	Language() string

	Roles() rbac.RoleNameList

	HasRole(role rbac.RoleName) bool

	Authenticated() bool

	Create() error

	// 提交已修改的内容
	Commit() error
}

Session 代表当前会话

type SessionGetter

type SessionGetter interface {
	Get(ctx *Context) (Session, error)
}

SessionGetter ...

type SessionLoader

type SessionLoader interface {
	Load(ctx *Context) (Session, error)
}

SessionLoader ...

type SessionManager

type SessionManager interface {
	SessionGetter
	SessionSetter
	SessionLoader
	SessionSaver
}

SessionManager ...

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 SessionSaver

type SessionSaver interface {
	Save(ctx *Context, se Session) error
}

SessionSaver ...

type SessionService

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

SessionService 是针对 SessionDTO 的服务

type SessionSetter

type SessionSetter interface {
	Set(ctx *Context, se Session) error
}

SessionSetter ...

type Token

type Token interface {
	Get() *rbac.TokenDTO

	Set(t *rbac.TokenDTO)

	GetProperties() properties.Table

	SetProperty(name, value string)

	SetSessionID(sid rbac.SessionID)

	GetSessionID() rbac.SessionID

	Roles() rbac.RoleNameList

	HasRole(role rbac.RoleName) bool

	// 提交已修改的内容
	Commit() error
}

Token ... 表示一个安全令牌

type TokenGetter

type TokenGetter interface {
	Get(ctx *Context) (Token, error)
}

TokenGetter ...

type TokenLoader

type TokenLoader interface {
	Load(ctx *Context) (Token, error)
}

TokenLoader ...

type TokenManager

type TokenManager interface {
	TokenGetter
	TokenSetter
	TokenLoader
	TokenSaver
}

TokenManager ...

type TokenSaver

type TokenSaver interface {
	Save(ctx *Context, t Token) error
}

TokenSaver ...

type TokenSetter

type TokenSetter interface {
	Set(ctx *Context, t Token) error
}

TokenSetter ...