用go封装一下二级认证功能
用go封装一下二级认证
本篇为用go设计开发一个自己的轻量级登录库/框架吧 - 秋玻 - 博客园 (cnblogs.com)的二级认证业务篇,会讲讲二级认证业务的实现,给库/框架增加新的功能。
源码:https://github.com/weloe/token-go
在一个系统中,为了保证账号安全性,我们除了登录之外可能还会进行二次校验,例如游戏中的交易密码认证,博客园登录的两步验证等等。因此,我打算为token-go封装下二级认证的功能。
实现思路
对于二级认证我们的认证对象是token也就是一个登录对象,为了兼容各种业务还要加上service业务,最后就是这个认证生效的时间time,毕竟总不能一次认证过了以后就再也不用认证了,那这个二级认证的功能也就没有意义了。
在业务上我们往往需要的四个方法,执行认证,判断是否认证,查看认证生效的剩余时间,取消认证(让认证失效)。
从代码实现上看
认证需要存储token-service信息
判断是否认证有效(是否在认证时间内)就是去判断这个token-service信息是否存在了
查看认证生效的剩余时间就是获取一下token-service的剩余存储时间
取消认证(让认证失效)也就是手动去删除这个token-service信息了,一般来说在退出登录的时候需要取消认证信息。
而存储删除等持久化操作则使用Adapter
OpenSafe(token string, service string, time int64) error
IsSafe(token string, service string) bool
GetSafeTime(token string, service string) int64
CloseSafe(token string, service string) error
代码实现
有了思路后代码实现其实就很简单了,无非就是存储信息,判断信息是否存在和删除信息了。
执行认证
https://github.com/weloe/token-go/blob/9d1a8be2c16559d46460c82b33995b789e6e31c4/enforcer.go#L646
首先校验参数,在执行认证前需要判断一下是否登录,不然怎么说是二级认证?存储token和service信息,调用logger,最后调用watcher提供扩展点。
func (e *Enforcer) OpenSafe(token string, service string, time int64) error {
if time == 0 {
return nil
}
// 判断是否登录
err := e.CheckLoginByToken(token)
if err != nil {
return err
}
err = e.adapter.SetStr(e.spliceSecSafeKey(token, service), constant.DefaultSecondAuthValue, time)
if err != nil {
return err
}
if e.watcher != nil {
e.watcher.OpenSafe(e.loginType, token, service, time)
}
return nil
}
判断是否认证
https://github.com/weloe/token-go/blob/ac8674dc3ebbd4bcb213328b43f4c11678191919/enforcer.go#L665
判断是否认证即是判断token-service信息是否存在。
func (e *Enforcer) IsSafe(token string, service string) bool {
if token == "" {
return false
}
str := e.adapter.GetStr(e.spliceSecSafeKey(token, service))
return str != ""
}
查看认证生效的剩余时间
https://github.com/weloe/token-go/blob/ac8674dc3ebbd4bcb213328b43f4c11678191919/enforcer.go#L673
func (e *Enforcer) GetSafeTime(token string, service string) int64 {
if token == "" {
return 0
}
timeout := e.adapter.GetTimeout(e.spliceSecSafeKey(token, service))
return timeout
}
取消认证
https://github.com/weloe/token-go/blob/ac8674dc3ebbd4bcb213328b43f4c11678191919/enforcer.go#L681
取消就是使用adapter删除token-service的信息
func (e *Enforcer) CloseSafe(token string, service string) error {
if token == "" {
return nil
}
err := e.adapter.DeleteStr(e.spliceSecSafeKey(token, service))
if err != nil {
return err
}
if e.watcher != nil {
e.watcher.CloseSafe(e.loginType, token, service)
}
return nil
}
测试
func TestEnforcer_SecSafe(t *testing.T) {
err, enforcer, _ := NewTestEnforcer(t)
if err != nil {
t.Fatalf("NewTestEnforcer() failed: %v", err)
}
tokenValue, err := enforcer.LoginById("1")
if err != nil {
t.Fatalf("LoginById() failed: %v", err)
}
service := "default_service"
err = enforcer.OpenSafe(tokenValue, service, 600000)
if err != nil {
t.Fatalf("OpenSafe() failed: %v", err)
}
isSafe := enforcer.IsSafe(tokenValue, service)
if !isSafe {
t.Fatalf("IsSafe() failed, unexpected return value: %v", isSafe)
}
time := enforcer.GetSafeTime(tokenValue, service)
t.Logf("safe time is %v", time)
err = enforcer.CloseSafe(tokenValue, service)
if err != nil {
t.Fatalf("CloseSafe() failed: %v", err)
}
time = enforcer.GetSafeTime(tokenValue, service)
if time != constant.NotValueExpire {
t.Fatalf("error safe time: %v", time)
}
isSafe = enforcer.IsSafe(tokenValue, service)
if isSafe {
t.Fatalf("IsSafe() failed, unexpected return value: %v", isSafe)
}
}
=== RUN TestEnforcer_SecSafe
2023/10/02 20:56:00 timer period = 30, timer start
enforcer_test.go:497: safe time is 600000
--- PASS: TestEnforcer_SecSafe (0.01s)
PASS