本文是區塊鏈瀏覽器系列的第四篇。 在[上一篇文章](https://mengbin.top/2023-08-13-blockBrowser/)介紹如何解析區塊數據時,使用`session`對客戶端上傳的pb文件進行區分,到期後自動刪除。 在這片文章中,會著重介紹下認證系統的實現,主要分為三部分: - ...
本文是區塊鏈瀏覽器系列的第四篇。
在上一篇文章介紹如何解析區塊數據時,使用session
對客戶端上傳的pb文件進行區分,到期後自動刪除。
在這片文章中,會著重介紹下認證系統的實現,主要分為三部分:
- 添加資料庫,存儲用戶信息
- 實現用戶認證中間件
- 修改路由
1. 用戶信息存儲
我這裡使用MySQL來存儲數據,使用gorm來實現與資料庫的交換。
首先需要創建用戶表:
CREATE TABLE `users` (
`id` bigint unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(100) NOT NULL,
`password` varchar(100) DEFAULT NULL,
`salt` longtext,
`created_at` datetime(3) DEFAULT NULL,
`updated_at` datetime(3) DEFAULT NULL,
`deleted_at` datetime(3) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=9 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
創建MySQL鏈接句柄:
func InitDB(source string) (*gorm.DB, error) {
dblog := logger.New(
log.New(os.Stdout, "\r\n", log.LstdFlags),
logger.Config{
LogLevel: logger.Error,
IgnoreRecordNotFoundError: true,
Colorful: true,
SlowThreshold: time.Second,
},
)
return gorm.Open(mysql.Open(source), &gorm.Config{
SkipDefaultTransaction: true,
AllowGlobalUpdate: false,
DisableForeignKeyConstraintWhenMigrating: true,
Logger: dblog,
})
}
表結構比較簡單,實現兩個查詢介面:
func GetUserByName(name string) (*User, error) {
var user User
db.Get().First(&user, "name = ?", name)
if user.ID == 0 {
return nil, fmt.Errorf("user with name: %s is not found", name)
}
return &user, nil
}
func GetUserByID(id uint) (*User, error) {
var user User
db.Get().First(&user, "id = ?", id)
if user.ID == 0 {
return nil, fmt.Errorf("user with id: %d is not found", id)
}
return &user, nil
}
除了查詢介面外,還需要提供用戶註冊,這裡直接使用Save()
介面進行資料庫寫入操作:
func RegisterUser(name, password string) (*LoginResponse, error) {
salt := genSalt()
u := &User{
Name: name,
Password: utils.CalcPassword(password, salt),
Salt: salt,
}
if err := db.Get().Save(u).Error; err != nil {
return nil, errors.Wrap(err, "RegisterUser error")
}
now := time.Now()
claims := &jwtv5.RegisteredClaims{
ExpiresAt: jwtv5.NewNumericDate(now.Add(30 * time.Minute)),
Issuer: "browser",
Subject: fmt.Sprintf("%d", u.ID),
}
token := jwtv5.NewWithClaims(jwtv5.SigningMethodHS256, claims)
tokenString, err := token.SignedString(securityKey)
if err != nil {
return nil, errors.Wrap(err, "create token error")
}
return &LoginResponse{
Token: tokenString,
Expire: now.Add(30 * time.Minute).Unix(),
ID: u.ID,
Username: u.Name,
}, nil
}
用戶認證採用的JWT(JSON Web Token),實現方法在JWT介紹有介紹,所以還需要提供兩個介面:Login實現token獲取,RefreshToken刷新token:
func Login(name, password string) (*LoginResponse, error) {
user, err := GetUserByName(name)
if err != nil {
return nil, errors.Wrap(err, "GetUserByName error")
}
if utils.CalcPassword(password, user.Salt) != user.Password {
return nil, errors.New("user name or password is incorrect")
}
now := time.Now()
claims := &jwtv5.RegisteredClaims{
ExpiresAt: jwtv5.NewNumericDate(now.Add(30 * time.Minute)),
Issuer: "browser",
Subject: fmt.Sprintf("%d", user.ID),
}
token := jwtv5.NewWithClaims(jwtv5.SigningMethodHS256, claims)
tokenString, err := token.SignedString(securityKey)
if err != nil {
return nil, errors.Wrap(err, "create token error")
}
return &LoginResponse{
Token: tokenString,
Expire: now.Add(30 * time.Minute).Unix(),
ID: user.ID,
Username: user.Name,
}, nil
}
func RefreshToken(id uint) (*LoginResponse, error) {
user, err := GetUserByID(id)
if err != nil {
return nil, errors.Wrap(err, "GetUserByName error")
}
now := time.Now()
claims := &jwtv5.RegisteredClaims{
ExpiresAt: jwtv5.NewNumericDate(now.Add(30 * time.Minute)),
Issuer: "browser",
Subject: fmt.Sprintf("%d", user.ID),
}
token := jwtv5.NewWithClaims(jwtv5.SigningMethodHS256, claims)
tokenString, err := token.SignedString(securityKey)
if err != nil {
return nil, errors.Wrap(err, "create token error")
}
return &LoginResponse{
Token: tokenString,
Expire: now.Add(30 * time.Minute).Unix(),
ID: user.ID,
Username: user.Name,
}, nil
}
2. 用戶認證中間件
關於Gin中間件的開發,可以參照gin中間件開發,這裡增加三種認證方式:noAuth,不使用認證;basicAuth,用戶名密碼方式認證;tokenAuth,使用token進行認證:
func noAuth(ctx *gin.Context) {
ctx.Next()
}
func basicAuth(ctx *gin.Context) {
name, pwd, ok := ctx.Request.BasicAuth()
if !ok {
srvLogger.Error("basic auth failed")
ctx.JSON(http.StatusForbidden, gin.H{"code": http.StatusForbidden, "msg": "basic auth failed"})
ctx.Abort()
return
}
user, err := data.GetUserByName(name)
if err != nil {
srvLogger.Errorf("GetUserByName error: %s", err.Error())
ctx.JSON(http.StatusForbidden, gin.H{"code": http.StatusForbidden, "msg": err.Error()})
ctx.Abort()
return
}
if utils.CalcPassword(pwd, user.Salt) != user.Password {
srvLogger.Error("user name or password is incorrect")
ctx.JSON(http.StatusForbidden, gin.H{"code": http.StatusForbidden, "msg": "user name or password is incorrect"})
ctx.Abort()
return
}
ctx.Next()
}
func tokenAuth(ctx *gin.Context) {
if err := data.ParseJWT(strings.Split(ctx.Request.Header.Get("Authorization"), " ")[1]); err != nil {
srvLogger.Errorf("tokenAuth error: %s", err.Error())
ctx.JSON(http.StatusForbidden, gin.H{"code": http.StatusForbidden, "msg": "token auth failed"})
ctx.Abort()
return
}
ctx.Next()
}
3. 註冊路由
在上篇中,註冊的路由是這樣的:
engine.POST("/login", login)
engine.GET("/hi/:name", sayHi)
engine.POST("/block/upload", upload)
engine.GET("/block/parse/:msgType", parse)
engine.POST("/block/update/:channel", updateConfig)
現在需要對/block/upload
、/block/parse/:msgType
、/block/update/:channel
介面增加認證,這就需要用到我們上面實現的三個中間件。
由於中間件會按照它們的註冊順利來執行,所以需要認證中間件需要在相應的處理介面前執行,針對noAuth的情況,上面的代碼並不需要進行修改,但對於basicAuth、tokenAuth,上面的代碼就需要修改了:
engine.POST("/block/upload", basicAuth, upload)
engine.GET("/block/parse/:msgType", basicAuth, parse)
engine.POST("/block/update/:channel", basicAuth, updateConfig)
或
engine.POST("/block/upload", tokenAuth, upload)
engine.GET("/block/parse/:msgType", tokenAuth, parse)
engine.POST("/block/update/:channel", tokenAuth, updateConfig)
當然我們也可以使用Handle(httpMethod, relativePath string, handlers ...HandlerFunc)
來進行路由註冊:
for _, router := range server.Routers() {
var handlers []gin.HandlerFunc
if router.AuthType == 0 {
router.AuthType = conf.AuthType
}
switch router.AuthType {
case config.Server_BASICAUTH:
handlers = append(handlers, basicAuth)
case config.Server_TOKENAUTH:
handlers = append(handlers, tokenAuth)
default:
handlers = append(handlers, noAuth)
}
handlers = append(handlers, router.Handler)
engine.Handle(router.Method, router.Path, handlers...)
}
項目完整代碼可以從Github上查看。
聲明:本作品採用署名-非商業性使用-相同方式共用 4.0 國際 (CC BY-NC-SA 4.0)進行許可,使用時請註明出處。
Author: mengbin
blog: mengbin
Github: mengbin92
cnblogs: 戀水無意