auth

Documentation

Index

• Constants
• func AllowReadCharacter(u Auth, c model.Character) bool
• func AllowReadSubject(u Auth, s model.Subject) bool
• type AccessToken
• type Auth
  • func (u Auth) AllowNSFW() bool
  • func (u Auth) RegisteredLongerThan(t time.Duration) bool
• type Permission
• type Repo
  • func NewMysqlRepo(q *query.Query, log *zap.Logger) Repo
• type Service
  • func NewService(repo Repo, u user.Repo, logger *zap.Logger, c cache.RedisCache) Service
• type TokenInfo
• type UserInfo

Constants

const (
	UserGroupAdmin uint8 = iota + 1
	UserGroupBangumiAdmin
	UserGroupWindowAdmin
	UserGroupQuite
	UserGroupBanned

	UserGroupCharacterAdmin
	UserGroupWikiAdmin
	UserGroupNormal
	UserGroupWikiEditor
)

const TokenTypeAccessToken = 1

const TokenTypeOauthToken = 0

Functions

func AllowReadCharacter

func AllowReadCharacter(u Auth, c model.Character) bool

func AllowReadSubject

func AllowReadSubject(u Auth, s model.Subject) bool

Types

type AccessToken

type AccessToken struct {
	ExpiredAt time.Time
	CreatedAt time.Time
	Name      string
	ClientID  string
	ID        uint32
	UserID    model.UserID
}

type Auth

type Auth struct {
	Login      bool
	RegTime    time.Time
	ID         model.UserID // user id
	GroupID    user.GroupID
	Permission Permission `json:"-"` // disable cache for this field.
}

Auth is the basic authorization represent a user.

func (Auth) AllowNSFW

func (u Auth) AllowNSFW() bool

AllowNSFW return if current user is allowed to see NSFW resource.

func (Auth) RegisteredLongerThan

func (u Auth) RegisteredLongerThan(t time.Duration) bool

type Permission

type Permission struct {
	UserList           bool
	ManageUserGroup    bool
	ManageUserPhoto    bool
	ManageTopicState   bool
	ManageReport       bool
	UserBan            bool
	ManageUser         bool
	UserGroup          bool
	UserWikiApply      bool `doc:"申请 wiki 人"`
	UserWikiApprove    bool
	DoujinSubjectErase bool
	DoujinSubjectLock  bool
	SubjectEdit        bool
	SubjectLock        bool
	SubjectRefresh     bool
	SubjectRelated     bool
	SubjectMerge       bool
	SubjectErase       bool
	SubjectCoverLock   bool
	SubjectCoverErase  bool
	MonoEdit           bool
	MonoLock           bool
	MonoMerge          bool
	MonoErase          bool
	BanPost            bool
	EpEdit             bool
	EpMove             bool
	EpMerge            bool
	EpLock             bool
	EpErase            bool
	Report             bool
	ManageApp          bool
	AppErase           bool
}

type Repo

type Repo interface {
	// GetByToken return an authorized user by a valid access token.
	GetByToken(ctx context.Context, token string) (UserInfo, error)
	GetPermission(ctx context.Context, groupID uint8) (Permission, error)

	CreateAccessToken(
		ctx context.Context, userID model.UserID, name string, expiration time.Duration,
	) (token string, err error)

	ListAccessToken(ctx context.Context, userID model.UserID) ([]AccessToken, error)
	DeleteAccessToken(ctx context.Context, tokenID uint32) (bool, error)

	// GetByEmail return (Auth, HashedPassword, error)
	GetByEmail(ctx context.Context, email string) (UserInfo, []byte, error)
	GetTokenByID(ctx context.Context, id uint32) (AccessToken, error)
}

AuthRepo presents an authorization.

func NewMysqlRepo

func NewMysqlRepo(q *query.Query, log *zap.Logger) Repo

type Service

type Service interface {
	GetByToken(ctx context.Context, token string) (Auth, error)
	GetByID(ctx context.Context, userID model.UserID) (Auth, error)

	ComparePassword(hashed []byte, password string) (bool, error)

	Login(ctx context.Context, email, password string) (Auth, bool, error)

	GetTokenByID(ctx context.Context, tokenID uint32) (AccessToken, error)
	CreateAccessToken(
		ctx context.Context, userID model.UserID, name string, expiration time.Duration,
	) (token string, err error)
	ListAccessToken(ctx context.Context, userID model.UserID) ([]AccessToken, error)
	DeleteAccessToken(ctx context.Context, tokenID uint32) (bool, error)
}

func NewService

func NewService(repo Repo, u user.Repo, logger *zap.Logger, c cache.RedisCache) Service

type TokenInfo

type TokenInfo struct {
	CreatedAt time.Time `json:"created_at"`
	Name      string    `json:"name"`
}

type UserInfo

type UserInfo struct {
	RegTime time.Time
	ID      model.UserID
	GroupID user.GroupID
}