新聞中心
上一篇:模式。

創(chuàng)新互聯(lián)建站主營平泉網(wǎng)站建設(shè)的網(wǎng)絡(luò)公司,主營網(wǎng)站建設(shè)方案,App定制開發(fā),平泉h5重慶小程序開發(fā)搭建,平泉網(wǎng)站營銷推廣歡迎平泉等地區(qū)企業(yè)咨詢
在這篇帖子中,我們將會(huì)通過為應(yīng)用添加社交登錄功能進(jìn)入后端開發(fā)。
社交登錄的工作方式十分簡單:用戶點(diǎn)擊鏈接,然后重定向到 GitHub 授權(quán)頁面。當(dāng)用戶授予我們對他的個(gè)人信息的訪問權(quán)限之后,就會(huì)重定向回登錄頁面。下一次嘗試登錄時(shí),系統(tǒng)將不會(huì)再次請求授權(quán),也就是說,我們的應(yīng)用已經(jīng)記住了這個(gè)用戶。這使得整個(gè)登錄流程看起來就和你用鼠標(biāo)單擊一樣快。
如果進(jìn)一步考慮其內(nèi)部實(shí)現(xiàn)的話,過程就會(huì)變得復(fù)雜起來。首先,我們需要注冊一個(gè)新的 GitHub OAuth 應(yīng)用。
這一步中,比較重要的是回調(diào) URL。我們將它設(shè)置為 http://localhost:3000/api/oauth/github/callback。這是因?yàn)?,在開發(fā)過程中,我們總是在本地主機(jī)上工作。一旦你要將應(yīng)用交付生產(chǎn),請使用正確的回調(diào) URL 注冊一個(gè)新的應(yīng)用。
注冊以后,你將會(huì)收到“客戶端 id”和“安全密鑰”。安全起見,請不要與任何人分享他們
順便讓我們開始寫一些代碼吧?,F(xiàn)在,創(chuàng)建一個(gè) main.go 文件:
package mainimport ("database/sql""fmt""log""net/http""net/url""os""strconv""github.com/gorilla/securecookie""github.com/joho/godotenv""github.com/knq/jwt"_ "github.com/lib/pq""github.com/matryer/way""golang.org/x/oauth2""golang.org/x/oauth2/github")var origin *url.URLvar db *sql.DBvar githubOAuthConfig *oauth2.Configvar cookieSigner *securecookie.SecureCookievar jwtSigner jwt.Signerfunc main() {godotenv.Load()port := intEnv("PORT", 3000)originString := env("ORIGIN", fmt.Sprintf("http://localhost:%d/", port))databaseURL := env("DATABASE_URL", "postgresql://root@127.0.0.1:26257/messenger?sslmode=disable")githubClientID := os.Getenv("GITHUB_CLIENT_ID")githubClientSecret := os.Getenv("GITHUB_CLIENT_SECRET")hashKey := env("HASH_KEY", "secret")jwtKey := env("JWT_KEY", "secret")var err errorif origin, err = url.Parse(originString); err != nil || !origin.IsAbs() {log.Fatal("invalid origin")return}if i, err := strconv.Atoi(origin.Port()); err == nil {port = i}if githubClientID == "" || githubClientSecret == "" {log.Fatalf("remember to set both $GITHUB_CLIENT_ID and $GITHUB_CLIENT_SECRET")return}if db, err = sql.Open("postgres", databaseURL); err != nil {log.Fatalf("could not open database connection: %v\n", err)return}defer db.Close()if err = db.Ping(); err != nil {log.Fatalf("could not ping to db: %v\n", err)return}githubRedirectURL := *origingithubRedirectURL.Path = "/api/oauth/github/callback"githubOAuthConfig = &oauth2.Config{ClientID: githubClientID,ClientSecret: githubClientSecret,Endpoint: github.Endpoint,RedirectURL: githubRedirectURL.String(),Scopes: []string{"read:user"},}cookieSigner = securecookie.New([]byte(hashKey), nil).MaxAge(0)jwtSigner, err = jwt.HS256.New([]byte(jwtKey))if err != nil {log.Fatalf("could not create JWT signer: %v\n", err)return}router := way.NewRouter()router.HandleFunc("GET", "/api/oauth/github", githubOAuthStart)router.HandleFunc("GET", "/api/oauth/github/callback", githubOAuthCallback)router.HandleFunc("GET", "/api/auth_user", guard(getAuthUser))log.Printf("accepting connections on port %d\n", port)log.Printf("starting server at %s\n", origin.String())addr := fmt.Sprintf(":%d", port)if err = http.ListenAndServe(addr, router); err != nil {log.Fatalf("could not start server: %v\n", err)}}func env(key, fallbackValue string) string {v, ok := os.LookupEnv(key)if !ok {return fallbackValue}return v}func intEnv(key string, fallbackValue int) int {v, ok := os.LookupEnv(key)if !ok {return fallbackValue}i, err := strconv.Atoi(v)if err != nil {return fallbackValue}return i}
安裝依賴項(xiàng):
go get -u github.com/gorilla/securecookiego get -u github.com/joho/godotenvgo get -u github.com/knq/jwtgo get -u github.com/lib/pqge get -u github.com/matoous/go-nanoidgo get -u github.com/matryer/waygo get -u golang.org/x/oauth2
我們將會(huì)使用 .env 文件來保存密鑰和其他配置。請創(chuàng)建這個(gè)文件,并保證里面至少包含以下內(nèi)容:
GITHUB_CLIENT_ID=your_github_client_idGITHUB_CLIENT_SECRET=your_github_client_secret
我們還要用到的其他環(huán)境變量有:
PORT:服務(wù)器運(yùn)行的端口,默認(rèn)值是3000。ORIGIN:你的域名,默認(rèn)值是http://localhost:3000/。我們也可以在這里指定端口。DATABASE_URL:Cockroach 數(shù)據(jù)庫的地址。默認(rèn)值是postgresql://root@127.0.0.1:26257/messenger?sslmode=disable。HASH_KEY:用于為 cookie 簽名的密鑰。沒錯(cuò),我們會(huì)使用已簽名的 cookie 來確保安全。JWT_KEY:用于簽署 JSON 網(wǎng)絡(luò)令牌Web Token的密鑰。
因?yàn)榇a中已經(jīng)設(shè)定了默認(rèn)值,所以你也不用把它們寫到 .env 文件中。
在讀取配置并連接到數(shù)據(jù)庫之后,我們會(huì)創(chuàng)建一個(gè) OAuth 配置。我們會(huì)使用 ORIGIN 信息來構(gòu)建回調(diào) URL(就和我們在 GitHub 頁面上注冊的一樣)。我們的數(shù)據(jù)范圍設(shè)置為 “read:user”。這會(huì)允許我們讀取公開的用戶信息,這里我們只需要他的用戶名和頭像就夠了。然后我們會(huì)初始化 cookie 和 JWT 簽名器。定義一些端點(diǎn)并啟動(dòng)服務(wù)器。
在實(shí)現(xiàn) HTTP 處理程序之前,讓我們編寫一些函數(shù)來發(fā)送 HTTP 響應(yīng)。
func respond(w http.ResponseWriter, v interface{}, statusCode int) {b, err := json.Marshal(v)if err != nil {respondError(w, fmt.Errorf("could not marshal response: %v", err))return}w.Header().Set("Content-Type", "application/json; charset=utf-8")w.WriteHeader(statusCode)w.Write(b)}func respondError(w http.ResponseWriter, err error) {log.Println(err)http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)}
第一個(gè)函數(shù)用來發(fā)送 JSON,而第二個(gè)將錯(cuò)誤記錄到控制臺(tái)并返回一個(gè) 500 Internal Server Error 錯(cuò)誤信息。
OAuth 開始
所以,用戶點(diǎn)擊寫著 “Access with GitHub” 的鏈接。該鏈接指向 /api/oauth/github,這將會(huì)把用戶重定向到 github。
func githubOAuthStart(w http.ResponseWriter, r *http.Request) {state, err := gonanoid.Nanoid()if err != nil {respondError(w, fmt.Errorf("could not generte state: %v", err))return}stateCookieValue, err := cookieSigner.Encode("state", state)if err != nil {respondError(w, fmt.Errorf("could not encode state cookie: %v", err))return}http.SetCookie(w, &http.Cookie{Name: "state",Value: stateCookieValue,Path: "/api/oauth/github",HttpOnly: true,})http.Redirect(w, r, githubOAuthConfig.AuthCodeURL(state), http.StatusTemporaryRedirect)}
OAuth2 使用一種機(jī)制來防止 CSRF ,因此它需要一個(gè)“狀態(tài)”(state)。我們使用 Nanoid() 來創(chuàng)建一個(gè)隨機(jī)字符串,并用這個(gè)字符串作為狀態(tài)。我們也把它保存為一個(gè) cookie。
OAuth 回調(diào)
一旦用戶授權(quán)我們訪問他的個(gè)人信息,他將會(huì)被重定向到這個(gè)端點(diǎn)。這個(gè) URL 的查詢字符串上將會(huì)包含狀態(tài)(state)和授權(quán)碼(code): /api/oauth/github/callback?state=&code=。
const jwtLifetime = time.Hour * 24 * 14type GithubUser struct {ID int `json:"id"`Login string `json:"login"`AvatarURL *string `json:"avatar_url,omitempty"`}type User struct {ID string `json:"id"`Username string `json:"username"`AvatarURL *string `json:"avatarUrl"`}func githubOAuthCallback(w http.ResponseWriter, r *http.Request) {stateCookie, err := r.Cookie("state")if err != nil {http.Error(w, http.StatusText(http.StatusTeapot), http.StatusTeapot)return}http.SetCookie(w, &http.Cookie{Name: "state",Value: "",MaxAge: -1,HttpOnly: true,})var state stringif err = cookieSigner.Decode("state", stateCookie.Value, &state); err != nil {http.Error(w, http.StatusText(http.StatusTeapot), http.StatusTeapot)return}q := r.URL.Query()if state != q.Get("state") {http.Error(w, http.StatusText(http.StatusTeapot), http.StatusTeapot)return}ctx := r.Context()t, err := githubOAuthConfig.Exchange(ctx, q.Get("code"))if err != nil {respondError(w, fmt.Errorf("could not fetch github token: %v", err))return}client := githubOAuthConfig.Client(ctx, t)resp, err := client.Get("https://api.github.com/user")if err != nil {respondError(w, fmt.Errorf("could not fetch github user: %v", err))return}var githubUser GithubUserif err = json.NewDecoder(resp.Body).Decode(&githubUser); err != nil {respondError(w, fmt.Errorf("could not decode github user: %v", err))return}defer resp.Body.Close()tx, err := db.BeginTx(ctx, nil)if err != nil {respondError(w, fmt.Errorf("could not begin tx: %v", err))return}var user Userif err = tx.QueryRowContext(ctx, `SELECT id, username, avatar_url FROM users WHERE github_id = $1`, githubUser.ID).Scan(&user.ID, &user.Username, &user.AvatarURL); err == sql.ErrNoRows {if err = tx.QueryRowContext(ctx, `INSERT INTO users (username, avatar_url, github_id) VALUES ($1, $2, $3)RETURNING id`, githubUser.Login, githubUser.AvatarURL, githubUser.ID).Scan(&user.ID); err != nil {respondError(w, fmt.Errorf("could not insert user: %v", err))return}user.Username = githubUser.Loginuser.AvatarURL = githubUser.AvatarURL} else if err != nil {respondError(w, fmt.Errorf("could not query user by github ID: %v", err))return}if err = tx.Commit(); err != nil {respondError(w, fmt.Errorf("could not commit to finish github oauth: %v", err))return}exp := time.Now().Add(jwtLifetime)token, err := jwtSigner.Encode(jwt.Claims{Subject: user.ID,Expiration: json.Number(strconv.FormatInt(exp.Unix(), 10)),})if err != nil {respondError(w, fmt.Errorf("could not create token: %v", err))return}expiresAt, _ := exp.MarshalText()data := make(url.Values)data.Set("token", string(token))data.Set("expires_at", string(expiresAt))http.Redirect(w, r, "/callback?"+data.Encode(), http.StatusTemporaryRedirect)}
首先,我們會(huì)嘗試使用之前保存的狀態(tài)對 cookie 進(jìn)行解碼。并將其與查詢字符串中的狀態(tài)進(jìn)行比較。如果它們不匹配,我們會(huì)返回一個(gè) 418 I'm teapot(未知來源)錯(cuò)誤。
接著,我們使用授權(quán)碼生成一個(gè)令牌。這個(gè)令牌被用于創(chuàng)建 HTTP 客戶端來向 GitHub API 發(fā)出請求。所以最終我們會(huì)向 https://api.github.com/user 發(fā)送一個(gè) GET 請求。這個(gè)端點(diǎn)將會(huì)以 JSON 格式向我們提供當(dāng)前經(jīng)過身份驗(yàn)證的用戶信息。我們將會(huì)解碼這些內(nèi)容,一并獲取用戶的 ID、登錄名(用戶名)和頭像 URL。
然后我們將會(huì)嘗試在數(shù)據(jù)庫上找到具有該 GitHub ID 的用戶。如果沒有找到,就使用該數(shù)據(jù)創(chuàng)建一個(gè)新的。
之后,對于新創(chuàng)建的用戶,我們會(huì)發(fā)出一個(gè)將用戶 ID 作為主題(Subject)的 JSON 網(wǎng)絡(luò)令牌,并使用該令牌重定向到前端,查詢字符串中一并包含該令牌的到期日(Expiration)。
這一 Web 應(yīng)用也會(huì)被用在其他帖子,但是重定向的鏈接會(huì)是 /callback?token=&expires_at=。在那里,我們將會(huì)利用 JavaScript 從 URL 中獲取令牌和到期日,并通過 Authorization 標(biāo)頭中的令牌以 Bearer token_here 的形式對 /api/auth_user 進(jìn)行 GET 請求,來獲取已認(rèn)證的身份用戶并將其保存到 localStorage。
Guard 中間件
為了獲取當(dāng)前已經(jīng)過身份驗(yàn)證的用戶,我們設(shè)計(jì)了 Guard 中間件。這是因?yàn)樵诮酉聛淼奈恼轮?,我們?huì)有很多需要進(jìn)行身份認(rèn)證的端點(diǎn),而中間件將會(huì)允許我們共享這一功能。
type ContextKey struct {Name string}var keyAuthUserID = ContextKey{"auth_user_id"}func guard(handler http.HandlerFunc) http.HandlerFunc {return func(w http.ResponseWriter, r *http.Request) {var token stringif a := r.Header.Get("Authorization"); strings.HasPrefix(a, "Bearer ") {token = a[7:]} else if t := r.URL.Query().Get("token"); t != "" {token = t} else {http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)return}var claims jwt.Claimsif err := jwtSigner.Decode([]byte(token), &claims); err != nil {http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)return}ctx := r.Context()ctx = context.WithValue(ctx, keyAuthUserID, claims.Subject)handler(w, r.WithContext(ctx))}}
首先,我們嘗試從 Authorization 標(biāo)頭或者是 URL 查詢字符串中的 token 字段中讀取令牌。如果沒有找到,我們需要返回 401 Unauthorized(未授權(quán))錯(cuò)誤。然后我們將會(huì)對令牌中的申明進(jìn)行解碼,并使用該主題作為當(dāng)前已經(jīng)過身份驗(yàn)證的用戶 ID。
現(xiàn)在,我們可以用這一中間件來封裝任何需要授權(quán)的 http.handlerFunc,并且在處理函數(shù)的上下文中保有已經(jīng)過身份驗(yàn)證的用戶 ID。
var guarded = guard(func(w http.ResponseWriter, r *http.Request) {authUserID := r.Context().Value(keyAuthUserID).(string)})
獲取認(rèn)證用戶
func getAuthUser(w http.ResponseWriter, r *http.Request) {ctx := r.Context()authUserID := ctx.Value(keyAuthUserID).(string)var user Userif err := db.QueryRowContext(ctx, `SELECT username, avatar_url FROM users WHERE id = $1`, authUserID).Scan(&user.Username, &user.AvatarURL); err == sql.ErrNoRows {http.Error(w, http.StatusText(http.StatusTeapot), http.StatusTeapot)return} else if err != nil {respondError(w, fmt.Errorf("could not query auth user: %v", err))return}user.ID = authUserIDrespond(w, user, http.StatusOK)}
我們使用 Guard 中間件來獲取當(dāng)前經(jīng)過身份認(rèn)證的用戶 ID 并查詢數(shù)據(jù)庫。
這一部分涵蓋了后端的 OAuth 流程。在下一篇帖子中,我們將會(huì)看到如何開始與其他用戶的對話。
- 源代碼
分享題目:構(gòu)建一個(gè)即時(shí)消息應(yīng)用(二):OAuth
本文路徑:http://www.dlmjj.cn/article/cdgegsj.html


咨詢
建站咨詢
