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 相关文章推荐
go语言map与string的相互转换的实现
Apr 07 Golang
golang判断key是否在map中的代码
Apr 24 Golang
Golang 使用Map实现去重与set的功能操作
Apr 29 Golang
使用golang编写一个并发工作队列
May 08 Golang
go语言基础 seek光标位置os包的使用
May 09 Golang
Go语言实现Snowflake雪花算法
Jun 08 Golang
再次探讨go实现无限 buffer 的 channel方法
Jun 13 Golang
Golang 语言控制并发 Goroutine的方法
Jun 30 Golang
Go语言基础map用法及示例详解
Nov 17 Golang
Go语言 详解net的tcp服务
Apr 14 Golang
golang用type-switch判断interface的实际存储类型
Apr 14 Golang
Python测试框架pytest核心库pluggy详解
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
PHP游戏编程25个脚本代码
2011/02/08 PHP
php防止用户重复提交表单
2015/11/02 PHP
Yii框架中jquery表单验证插件用法示例
2016/10/18 PHP
PHP 实现公历日期与农历日期的互转换
2017/09/13 PHP
php测试kafka项目示例
2020/02/06 PHP
jQuery响应enter键的实现思路
2014/04/18 Javascript
基于jQuery的图片不完全按比例自动缩小
2014/07/11 Javascript
JavaScript中的对象的extensible属性介绍
2014/12/30 Javascript
javascript实现限制上传文件大小
2015/02/06 Javascript
JS定义网页表单提交(submit)的方法
2015/03/20 Javascript
jQuery实现移动端滑块拖动选择数字效果
2015/12/24 Javascript
原生javascript实现匀速运动动画效果
2016/02/26 Javascript
jQuery+Ajax实现限制查询间隔的方法
2016/06/07 Javascript
简单的JS轮播图代码
2016/07/18 Javascript
js 判断各种数据类型的简单方法(推荐)
2016/08/29 Javascript
Vuejs第八篇之Vuejs组件的定义实例解析
2016/09/05 Javascript
thinkjs 文件上传功能实例代码
2017/11/08 Javascript
vue中echarts3.0自适应的方法
2018/02/26 Javascript
iview中Select 选择器多选校验方法
2018/03/15 Javascript
js贪心算法 钱币找零问题代码实例
2019/09/11 Javascript
三步实现ionic3点击退出app程序
2019/09/17 Javascript
JavaScript 实现同时选取多个时间段的方法
2019/10/17 Javascript
详解React 条件渲染
2020/07/08 Javascript
Vue +WebSocket + WaveSurferJS 实现H5聊天对话交互的实例
2020/11/18 Vue.js
python同时给两个收件人发送邮件的方法
2015/04/30 Python
python3 cvs将数据读取为字典的方法
2018/12/22 Python
python使用Plotly绘图工具绘制柱状图
2019/04/01 Python
django drf框架自带的路由及最简化的视图
2019/09/10 Python
Python生成个性签名图片获取GUI过程解析
2019/12/16 Python
美国一站式电动和手动工具商店:International Tool
2020/11/26 全球购物
上海方立数码笔试题
2013/10/18 面试题
文秘自荐信
2013/10/20 职场文书
师范应届生语文教师求职信
2013/10/29 职场文书
教师自荐信
2013/12/10 职场文书
PyTorch 如何检查模型梯度是否可导
2021/06/05 Python