go goth封裝第三方認證庫範例詳解

2022-08-12 18:01:32

簡介

當前很多網站直接採用第三方認證登入，例如支付寶/微信/ Github 等。goth封裝了接入第三方認證的方法，並且內建實現了很多第三方認證的實現：

圖中擷取的只是goth支援的一部分，完整列表可在其GitHub 首頁檢視。

快速使用

本文程式碼使用 Go Modules。

建立目錄並初始化：

$ mkdir goth && cd goth
$ go mod init github.com/darjun/go-daily-lib/goth

安裝goth庫：

$ go get -u github.com/markbates/goth

我們設計了兩個頁面，一個登入頁面：

// login.tpl
<a href="/auth/github?provider=github" rel="external nofollow" >Login With GitHub</a>

點選登入連結會請求/auth/github?provider=github。

一個主介面：

// home.tpl
<p><a href="/logout/github" rel="external nofollow" >logout</a></p>
<p>Name: {{.Name}} [{{.LastName}}, {{.FirstName}}]</p>
<p>Email: {{.Email}}</p>
<p>NickName: {{.NickName}}</p>
<p>Location: {{.Location}}</p>
<p>AvatarURL: {{.AvatarURL}} <img src="{{.AvatarURL}}"></p>
<p>Description: {{.Description}}</p>
<p>UserID: {{.UserID}}</p>
<p>AccessToken: {{.AccessToken}}</p>
<p>ExpiresAt: {{.ExpiresAt}}</p>
<p>RefreshToken: {{.RefreshToken}}</p>

顯示使用者的基本資訊。

同樣地，我們使用html/template標準模板庫來載入和管理頁面模板：

var (
  ptTemplate *template.Template
)
func init() {
  ptTemplate = template.Must(template.New("").ParseGlob("tpls/*.tpl"))
}

主頁面處理如下：

func HomeHandler(w http.ResponseWriter, r *http.Request) {
  user, err := gothic.CompleteUserAuth(w, r)
  if err != nil {
    http.Redirect(w, r, "/login/github", http.StatusTemporaryRedirect)
    return
  }
  ptTemplate.ExecuteTemplate(w, "home.tpl", user)
}

如果使用者登入了，gothic.CompleteUserAuth(w, r)會返回一個非空的User物件，該型別有如下欄位：

type User struct {
  RawData           map[string]interface{}
  Provider          string
  Email             string
  Name              string
  FirstName         string
  LastName          string
  NickName          string
  Description       string
  UserID            string
  AvatarURL         string
  Location          string
  AccessToken       string
  AccessTokenSecret string
  RefreshToken      string
  ExpiresAt         time.Time
  IDToken           string
}

如果已登入，顯示主介面資訊。如果未登入，重定向到登入介面：

func LoginHandler(w http.ResponseWriter, r *http.Request) {
  ptTemplate.ExecuteTemplate(w, "login.tpl", nil)
}

點選登入，由AuthHandler處理請求：

func AuthHandler(w http.ResponseWriter, r *http.Request) {
  gothic.BeginAuthHandler(w, r)
}

呼叫gothic.BeginAuthHandler(w, r)開始跳轉到 GitHub 的驗證介面。GitHub 驗證完成後，瀏覽器會重定向到/auth/github/callback處理：

func CallbackHandler(w http.ResponseWriter, r *http.Request) {
  user, err := gothic.CompleteUserAuth(w, r)
  if err != nil {
    fmt.Fprintln(w, err)
    return
  }
  ptTemplate.ExecuteTemplate(w, "home.tpl", user)
}

如果登入成功，在 CallbackHandler 中，我們可以呼叫gothic.CompleteUserAuth(w, r)取出User物件，然後顯示主頁面。最後是訊息路由設定：

r := mux.NewRouter()
r.HandleFunc("/", HomeHandler)
r.HandleFunc("/login/github", LoginHandler)
r.HandleFunc("/logout/github", LogoutHandler)
r.HandleFunc("/auth/github", AuthHandler)
r.HandleFunc("/auth/github/callback", CallbackHandler)
log.Println("listening on localhost:8080")
log.Fatal(http.ListenAndServe(":8080", r))

goth為我們封裝了 GitHub 的驗證過程，但是我們需要在 GitHub 上新增一個 OAuth App，生成 Client ID 和 Client Secret。

首先，登入 GitHub 賬號，在右側頭像下拉框選擇 Settings：

選擇左側 Developer Settings：

左側選擇 OAuth App，右側點選 New OAuth App：

輸入資訊，重點是Authorization callback URL，這是 GitHub 驗證成功之後的回撥：

生成 App 之後，Client ID 會自動生成，但是 Client Secret 需要再點選右側的按鈕Generate a new client token生成：

生成了 Client Secret：

想要在程式中使用 Github，首先要建立一個 GitHub 的 Provider，呼叫github子包的New()方法：

githubProvider := github.New(clientKey, clientSecret, "http://localhost:8080/auth/github/callback")

第一個引數為 Client ID，第二個引數為 Client Secret，這兩個是由上面的 OAuth App 生成的，第三個引數為回撥的連結，這個必須與 OAuth App 建立時設定的一樣。

然後應用這個 Provider：

goth.UseProviders(githubProvider)

準備工作完成，長吁一口氣。現在執行程式：

$ SECRET_KEY="secret" go run main.go

瀏覽器存取localhost:8080，由於沒有登入，重定向到localhost:8080/login/github：

點選Login with GitHub，會重定向到 GitHub 授權頁面：

點選授權，成功之後使用者資訊會儲存在 session
中。跳轉到主頁面，顯示我的資訊：

更換 store

goth底層使用上一篇文章中介紹的gorilla/sessions庫來儲存登入資訊，而預設採用的是 cookie 作為儲存。另外選項預設採用：

如果需要更改儲存方式或選項，我們可以在程式啟動前，設定gothic.Store欄位。例如我們要更換為 redistore：

store, _ = redistore.NewRediStore(10, "tcp", ":6379", "", []byte("redis-key"))
key := ""
maxAge := 86400 * 30  // 30 days
isProd := false
store := sessions.NewCookieStore([]byte(key))
store.MaxAge(maxAge)
store.Options.Path = "/"
store.Options.HttpOnly = true
store.Options.Secure = isProd
gothic.Store = store

總結

大家如果發現好玩、好用的 Go 語言庫，歡迎到 Go 每日一庫 GitHub 上提交 issue

go goth封裝第三方認證庫範例詳解

目錄

簡介

快速使用

更換 store

總結

熱門文章