README
¶
bulrush-identify
Provide basic user authorization and authentication
var Identify = identify.
New().
AddOptions(identify.FakeURLsOption([]string{`^/api/ignore$`, `^/api/gorm/mock`})).
AddOptions(identify.FakeTokensOption([]string{})).
AddOptions(identify.ModelOption(&identify.RedisModel{
Redis: addition.Redis,
})).
Init(func(iden *identify.Identify) {
iden.AddOptions(
identify.AuthOption(func(ctx *gin.Context) (interface{}, error) {
login := struct {
UserName string `form:"username" json:"username" xml:"username" binding:"required"`
Password string `form:"password" json:"password" xml:"password" binding:"required"`
Type string `form:"type" json:"type" xml:"type"`
}{}
// captcha := ctx.GetString("captcha")
if err := ctx.ShouldBind(&login); err != nil {
return nil, err
}
user := addition.GORMExt.Var("User")
if err := addition.GORMExt.DB.Find(user, map[string]interface{}{"name": login.UserName, "password": login.Password}).Error; err != nil {
return nil, errors.New("user authentication failed")
}
return user, nil
}),
)
})
app.Use(Identify)
ObtainToken
double@double:~/bulrush-template$ curl http://127.0.0.1:3001/api/v1/obtainToken -X POST -d "username=123&password=xxx"
{
"accessToken":"E8V3TZX3XQEWN6E8B0VJTXK26Z8OF6F5",
"refreshToken":"U1MPQIYQZKD86CYGWKDI04O4R5SK4FEW",
"created":1559287003,
"updated":1559287003,
"expired":1559373403
}
RefleshToken
double@double:~/bulrush-template$ curl http://127.0.0.1:3001/api/v1/refleshToken -X POST -d "accessToken=U1MPQIYQZKD86CYGWKDI04O4R5SK4FEW"
{
"accessToken":"0ILMFDM0JILCLJ5987HYMT2J18BYJDXI",
"refreshToken":"U1MPQIYQZKD86CYGWKDI04O4R5SK4FEW",
"created":1559287003,
"updated":1559287592,
"expired":1559373992,
"extra":{
"id":"5ce8ba5e51603f528e568b47","username":"123","roles":[]
}
}
MIT License
Copyright (c) 2018-2020 Double
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation
¶
Index ¶
- Constants
- func RandString(n int) string
- func Some(target interface{}, initValue interface{}) interface{}
- type Identify
- func (iden *Identify) AddOptions(opts ...Option) *Identify
- func (iden *Identify) GetToken(ctx *gin.Context) *Token
- func (iden *Identify) Init(init func(*Identify)) *Identify
- func (iden *Identify) ObtainToken(extra interface{}) (*Token, error)
- func (iden *Identify) Plugin(router *gin.RouterGroup, httpProxy *gin.Engine) *Identify
- func (iden *Identify) SetToken(ctx *gin.Context, token *Token)
- func (iden *Identify) VerifyContext(ctx *gin.Context) bool
- func (iden *Identify) VerifyToken(token string) bool
- type Model
- type Option
- type RedisModel
- type RoutesGroup
- type Token
Constants ¶
const IdenKey = "identify"
IdenKey defined ctx key
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Identify ¶
type Identify struct {
Auth func(c *gin.Context) (interface{}, error)
Iden func(c *gin.Context)
ExpiresIn int64
Routes RoutesGroup
Model Model
FakeURLs *[]string
FakeTokens *[]string
}
Identify authentication interface
func (*Identify) AddOptions ¶
AddOptions defined add option
func (*Identify) ObtainToken ¶
ObtainToken accessToken
func (*Identify) VerifyContext ¶
VerifyContext defined verify
func (*Identify) VerifyToken ¶
VerifyToken defined verify
type Model ¶
type Model interface {
Save(*Token) (*Token, error)
Find(*Token) (*Token, error)
Revoke(*Token) error
}
Model defined
type Option ¶
type Option func(*Identify) interface{}
Option defined implement of option
func AuthOption ¶
AuthOption defined auth
type RedisModel ¶
RedisModel token store
func (*RedisModel) Find ¶
func (model *RedisModel) Find(token *Token) (*Token, error)
Find find a token
func (*RedisModel) Revoke ¶
func (model *RedisModel) Revoke(token *Token) error
Revoke revoke a token
type RoutesGroup ¶
type RoutesGroup struct {
ObtainTokenRoute string
RevokeTokenRoute string
RefleshTokenRoute string
IdenTokenRoute string
}
RoutesGroup iden routes
Source Files