auth

package

v1.0.0 Latest Latest Go to latest Published: Apr 7, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitee.com/sparrow614/sparrow_cloud_go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func AuthMiddlewareFunc(af AuthFunc) iris.Handler
func LoginRequire(ctx iris.Context)
type AuthFunc
type IModel
type User

Constants ¶

View Source

const (
	// DefaultAuthKey is the default key for the token in the request header.
	DefaultAuthKey        = "X-Jwt-Payload"
	DefaultAuthPayloadKey = "AUTH_PAYLOAD"
)

Variables ¶

View Source

var ErrNotSupported = errors.New("not supported")

Functions ¶

func AuthMiddlewareFunc ¶

func AuthMiddlewareFunc(af AuthFunc) iris.Handler

如果授权函数返回有效的用户, 则设置到ctx.User()中如果授权还是没提供或者没有返回有效用户, 则设置一个空的用户到ctx.User()中空的User默认为未授权状态

func LoginRequire ¶

func LoginRequire(ctx iris.Context)

登录请求中间件

Types ¶

type AuthFunc ¶

type AuthFunc = func(ctx iris.Context) *User

type IModel ¶

type IModel interface {
	GetID() string
}

数据库model, 用来存储动态数据

type User ¶

type User struct {
	UserModel    IModel `json:"user_model,omitempty"` // User Model
	Id           string `json:"id"`
	Username     string `json:"username"`
	Phone        string `json:"phone"`
	IsAuthorized bool   `json:"is_authorized"`
}

实现 iris 的 User 接口: https://github.com/kataras/iris/blob/master/context/context_user.go

func GetUser ¶

func GetUser(ctx iris.Context) *User

* 获取系统用户

func NewUser ¶

func NewUser(id string, phone string, username string, isAuthorized bool, um IModel) *User

新建用户

func UserIDAuth ¶

func UserIDAuth(ctx iris.Context) *User

默认提供授权函数

func (*User) GetAuthorization ¶

func (u *User) GetAuthorization() (string, error)

GetAuthorization should return the authorization method, e.g. Basic Authentication.

func (*User) GetAuthorizedAt ¶

func (u *User) GetAuthorizedAt() (time.Time, error)

func (*User) GetEmail ¶

func (u *User) GetEmail() (string, error)

func (*User) GetField ¶

func (u *User) GetField(key string) (interface{}, error)

func (*User) GetID ¶

func (u *User) GetID() (string, error)

func (*User) GetModel ¶

func (u *User) GetModel() IModel

获取 UserModel

func (*User) GetPassword ¶

func (u *User) GetPassword() (string, error)

func (*User) GetRaw ¶

func (u *User) GetRaw() (interface{}, error)

GetRaw should return the raw instance of the user, if supported.

func (*User) GetRoles ¶

func (u *User) GetRoles() ([]string, error)

func (*User) GetToken ¶

func (u *User) GetToken() ([]byte, error)

func (*User) GetUsername ¶

func (u *User) GetUsername() (string, error)

func (*User) SetModel ¶

func (u *User) SetModel(au IModel)

设置用户 UserModel

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL