go goth封装第三方认证库示例详解


Posted in Golang onAugust 14, 2022

简介

当前很多网站直接采用第三方认证登录,例如支付宝/微信/ Github 等。goth封装了接入第三方认证的方法,并且内置实现了很多第三方认证的实现:

go 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:

go goth封装第三方认证库示例详解

选择左侧 Developer Settings:

go goth封装第三方认证库示例详解

左侧选择 OAuth App,右侧点击 New OAuth App:

go goth封装第三方认证库示例详解

输入信息,重点是Authorization callback URL,这是 GitHub 验证成功之后的回调:

go goth封装第三方认证库示例详解

生成 App 之后,Client ID 会自动生成,但是 Client Secret 需要再点击右侧的按钮Generate a new client token生成:

go goth封装第三方认证库示例详解

生成了 Client Secret:

go goth封装第三方认证库示例详解

想要在程序中使用 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

go goth封装第三方认证库示例详解

点击Login with GitHub,会重定向到 GitHub 授权页面:

go goth封装第三方认证库示例详解

点击授权,成功之后用户信息会保存在 session
中。跳转到主页面,显示我的信息:

go goth封装第三方认证库示例详解

更换 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?

参考

goth GitHub:https://github.com/markbates/goth

Go 每日一库 GitHub:https://github.com/darjun/go-daily-lib

以上就是go goth封装第三方认证库示例详解的详细内容,更多关于go goth第三方认证库的资料请关注三水点靠木其它相关文章!

Golang 相关文章推荐
golang正则之命名分组方式
Apr 25 Golang
Go语言中break label与goto label的区别
Apr 28 Golang
基于Go Int转string几种方式性能测试
Apr 28 Golang
Golang中interface{}转为数组的操作
Apr 30 Golang
golang 比较浮点数的大小方式
May 02 Golang
关于golang高并发的实现与注意事项说明
May 08 Golang
go语言基础 seek光标位置os包的使用
May 09 Golang
golang中的struct操作
Nov 11 Golang
Go语言实现一个简单的并发聊天室的项目实战
Mar 18 Golang
Golang实现可重入锁的示例代码
May 25 Golang
GoFrame框架数据校验之校验结果Error接口对象
Jun 21 Golang
在ubuntu下安装go开发环境的全过程
Aug 05 Golang
基于Python实现西西成语接龙小助手
Aug 05 #Golang
Python测试框架pytest核心库pluggy详解
Aug 05 #Golang
Go结合Gin导出Mysql数据到Excel表格
Aug 05 #Golang
GO中sync包自由控制并发示例详解
Aug 05 #Golang
Go语言编译原理之源码调试
Aug 05 #Golang
Go语言编译原理之变量捕获
Aug 05 #Golang
在ubuntu下安装go开发环境的全过程
Aug 05 #Golang
You might like
双料怀旧--SHARP GF515的维护、修理和简单调试
2021/03/02 无线电
PHP编程获取音频文件时长的方法【基于getid3类】
2017/04/20 PHP
Laravel配置全局公共函数的方法步骤
2019/05/09 PHP
laravel请求参数校验方法
2019/10/10 PHP
javascript 学习笔记(八)javascript对象
2011/04/12 Javascript
js函数中onmousedown和onclick的区别和联系探讨
2013/05/19 Javascript
Node.js异步I/O学习笔记
2014/11/04 Javascript
通过实例理解javascript中没有函数重载的概念
2015/06/03 Javascript
基于jquery实现在线选座订座之影院篇
2015/08/24 Javascript
JS实现仿Windows7风格的网页右键菜单效果代码
2015/09/11 Javascript
解决jquery插件:TypeError:$.browser is undefined报错的方法
2015/11/21 Javascript
Bootstrap 布局组件(全)
2016/07/18 Javascript
简单实现js浮动框
2016/12/13 Javascript
利用Bootstrap实现表格复选框checkbox全选
2016/12/21 Javascript
js删除数组中的元素delete和splice的区别详解
2018/02/03 Javascript
js实现下拉框二级联动
2018/12/04 Javascript
JS开发自己的类库实例分析
2019/08/28 Javascript
vue中用 async/await 来处理异步操作
2020/07/18 Javascript
微信小程序淘宝首页双排图片布局排版代码(推荐)
2020/10/29 Javascript
微信小程序实现首页弹出广告
2020/12/03 Javascript
Python的print用法示例
2014/02/11 Python
Python中的匿名函数使用简介
2015/04/27 Python
python 中pyqt5 树节点点击实现多窗口切换问题
2019/07/04 Python
python读取Excel表格文件的方法
2019/09/02 Python
pyinstaller 3.6版本通过pip安装失败的解决办法(推荐)
2020/01/18 Python
python实现俄罗斯方块小游戏
2020/04/24 Python
python中re模块知识点总结
2021/01/17 Python
日本运动品牌美津浓官方购物网站:MIZUNO SHOP
2016/08/21 全球购物
医生实习工作总结的自我评价
2013/09/27 职场文书
学雷锋树新风演讲稿
2014/05/10 职场文书
团组织推优材料
2014/12/29 职场文书
学生犯错保证书
2015/05/09 职场文书
寻衅滋事罪辩护词
2015/05/21 职场文书
会计专业自荐信范文
2019/05/22 职场文书
Python基础之常用库常用方法整理
2021/04/30 Python
Java处理延时任务的常用几种解决方案
2022/06/01 Java/Android