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原生库的中bytes.Buffer用法
Apr 25 Golang
golang中的并发和并行
May 08 Golang
Golang 获取文件md5校验的方法以及效率对比
May 08 Golang
Go中的条件语句Switch示例详解
Aug 23 Golang
Go语言实现一个简单的并发聊天室的项目实战
Mar 18 Golang
victoriaMetrics库布隆过滤器初始化及使用详解
Apr 05 Golang
Go并发4种方法简明讲解
Apr 06 Golang
Golang日志包的使用
Apr 20 Golang
实现GO语言对数组切片去重
Apr 20 Golang
Golang 入门 之url 包
May 04 Golang
Golang入门之计时器
May 04 Golang
Go中使用gjson来操作JSON数据的实现
Aug 14 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中计算中文字符串长度、截取中文字符串的函数代码
2011/08/09 PHP
php代码收集表单内容并写入文件的代码
2012/01/29 PHP
php获取远程图片体积大小的实例
2013/11/12 PHP
PHP和Shell实现检查SAMBA与NFS Server是否存在
2015/01/07 PHP
php实现遍历目录并删除指定文件中指定内容
2015/01/21 PHP
PHP读取、解析eml文件及生成网页的方法示例
2017/09/04 PHP
phpStudy配置多站点多域名方法及遇到的403错误解决方法
2017/10/19 PHP
PHP PDOStatement::getAttribute讲解
2019/02/01 PHP
firefox下对ajax的onreadystatechange的支持情况分析
2009/12/14 Javascript
基于jquery实现的上传图片及图片大小验证、图片预览效果代码
2011/04/12 Javascript
JQuery的Ajax跨域请求原理概述及实例
2013/04/26 Javascript
JS调用页面表格导出excel示例代码
2014/03/18 Javascript
用JavaScript实现使用鼠标画线的示例代码
2014/08/19 Javascript
JavaScript插件化开发教程 (四)
2015/01/27 Javascript
javascript实现控制的多级下拉菜单
2015/07/05 Javascript
JavaScript获取当前cpu使用率的方法
2015/12/15 Javascript
jQuery实现可移动选项的左右下拉列表示例
2016/12/26 Javascript
Vue使用枚举类型实现HTML下拉框步骤详解
2018/02/05 Javascript
Vue 中使用富文本编译器wangEditor3的方法
2019/09/26 Javascript
Python使用修饰器执行函数的参数检查功能示例
2017/09/26 Python
Python中那些 Pythonic的写法详解
2019/07/02 Python
如何基于Python爬取隐秘的角落评论
2020/07/02 Python
scrapy框架携带cookie访问淘宝购物车功能的实现代码
2020/07/07 Python
Python操作Elasticsearch处理timeout超时
2020/07/17 Python
Python发送邮件实现基础解析
2020/08/14 Python
印尼最大的在线购物网站:MatahariMall.com
2016/08/26 全球购物
巴西服装和鞋子购物网站:Marisa
2018/10/25 全球购物
学校感恩教育活动总结
2014/07/07 职场文书
学校工作推荐信范文
2014/07/11 职场文书
垃圾分类的活动方案
2014/08/15 职场文书
2014年党的群众路线整改措施思想汇报
2014/10/12 职场文书
草房子读书笔记
2015/06/29 职场文书
2016年学校“6﹒26国际禁毒日”宣传活动总结
2016/04/05 职场文书
React如何创建组件
2021/06/27 Javascript
PYTHON使用Matplotlib去实现各种条形图的绘制
2022/03/22 Python
Java实现经典游戏泡泡堂的示例代码
2022/04/04 Java/Android