用go封裝一下二級認證功能

秋玻發表於2023-10-02
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

https://github.com/weloe/token-go/blob/9d1a8be2c16559d46460c82b33995b789e6e31c4/enforcer_interface.go#L58

	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
}

測試

https://github.com/weloe/token-go/blob/9d1a8be2c16559d46460c82b33995b789e6e31c4/enforcer_test.go#L478

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

相關文章