一个OpenResty里OAuth 2认证的轮子(下)

上篇含全系列链接:传送门

前一篇文章主要实现了OAuth最开始的一步,跳转至平台账号,和一些乱七八糟为了工程化做的准备。这篇文章里会实现OAuth剩下的步骤,包括从认证码到令牌符再到用户信息。

之前的Nginx配置里已经先埋了个坑——在我们OAuth??榈某跏蓟?,已经传了两个目前还没有用到的参数,token_endpointprofile_endpoint,它们就对应着认证码换令牌符和令牌符取用户信息两个API:

  init_by_lua_block {
    require('oauth').init({
      code_endpoint = 'https://github.com/login/oauth/authorize',
      token_endpoint = 'https://github.com/login/oauth/access_token',
      profile_endpoint = 'https://api.github.com/user',
      client_id = 'client_id',
      client_secret = 'client_secret',
      redirect_uri = 'http://test.myoauth.com/auth-cb/github/login',
      scope = 'user',
    })
  }

在OAuth的回调URL里,之前也定义了这么一段:

location /auth-cb/github/login {
  content_by_lua_block {
    return require('oauth').get_profile(ngx.var.arg_code)
  }
}

里面的 ngx.var.arg_code 就是在OAuth平台跳转回来以后的临时认证码。现在可以先把 get_profile 函数改成下面这个样子,函数和对应的数据都被命名得非常直观:

-- in resty/lua/oauth.lua
function M.get_profile(code)
  local token = get_token(code)
  local profile = get_profile(token)
  ngx.say(cjson.encode(profile))
end

注意 M.get_profile 挂在了 oauth.lua 这个??橐┞冻隼吹娜衷砝?,和我们马上要定义的局部函数 get_tokenget_profile 并不产生命名冲突。下面就是取令牌符和取用户令牌的请求逻辑,完全根据GitHub的OAuth流程文档来写,纯属无脑搬砖。

local resp = require('resp')
local requests = require('requests')

local function get_token(code)
  local payload = {
    client_id = _conf.client_id,
    client_secret = _conf.client_secret,
    code = code,
  }
  local status, body, err = requests.jpost(_conf.token_endpoint, cjson.encode(payload))
  if not status then resp.fail(err, _conf.token_endpoint, ngx.HTTP_SERVICE_UNAVAILABLE)
  else
      if status ~= 200 then resp.fail(err, cjson.decode(body), status)
      else return ngx.decode_args(body).access_token end
  end
end

local function get_profile(token)
  local status, body, err = requests.jget(
    _conf.profile_endpoint, '',
    { Authorization = 'token ' .. token })
  if not status then resp.fail(err, _conf.profile_endpoint, ngx.HTTP_SERVICE_UNAVAILABLE)
  else
      if status ~= 200 then resp.fail(err, cjson.decode(body), status)
      else return cjson.decode(body) end
  end
end

里面带了一点简单的错误处理逻辑,在出错的时候会记下对应的请求报文和API路径,全部都是来自以下这个简短的小工具??椋?/p>

-- resty/lua/resp.lua

local cjson = require('cjson.safe')
cjson.encode_empty_table_as_object(false)

local M = {}

function M.fail(msg, detail, status)
  if status then ngx.status = status end
  ngx.say(cjson.encode({ msg = msg, detail = detail }))
  if status then ngx.exit(status) end
end

return M

好了,现在代码的全貌已经出来了。试着跑一下……咦?出错了,返回Unavailable了?看一下日志,有这么一行:

XXXX/XX/XX XX:XX:XX [debug] 33#33: *34 [lua] requests.lua:53: jpost(): "no resolver defined to resolve \"github.com\""

问题出在哪儿呢?问题就在于,Nginx并不会自动做DNS查询,它的所有转发和请求都基于IP。我想这样的设计初衷应该是考虑到DNS解析时间比较不可控,不想让大量这样的请求占太多的网络IO。不过我们这个场景下DNS解析是刚需,没办法写死IP,解决办法就是在http block里加上这么一句 resolver 8.8.8.8;,让Nginx在读到基于域名请求的时候调用Google的DNS服务。

加好DNS resolver之后再试……又双叒叕不行?!再翻日志,这下是这个问题:

XXXX/XX/XX XX:XX:XX [error] 36#36: *36 lua ssl certificate verify error: (20: unable to get local issuer certificate), client: 172.17.0.1, server: , request: "GET /auth-cb/github/login?code=XXXXXXXXXXXXXXXXXXX

这个问题我第一次遇到也是一脸懵逼,放狗问了一下才知道,原来Nginx不但不解析域名,连HTTPS Cert也不会自动检查。解决方法也不麻烦,找到Linux发行版的根证书(必须是PEM格式的——我也不知道还有什么格式),用 lua_ssl_trusted_certificate 引进来,然后用 lua_ssl_verify_depth 定义一下证书查询最多经过几步(默认只查一次我也是醉了)。所以http block里在 init_by_lua_block 之前的配置就长这个样子:

http {
  include /usr/local/openresty/nginx/conf/mime.types;
  lua_package_path '$prefix/lua/?.lua;;';
  lua_code_cache off;
  resolver 8.8.8.8;
  lua_ssl_verify_depth 10;
  lua_ssl_trusted_certificate '/etc/ssl/certs/ca-certificates.crt';

  init_by_lua_block {
    ...
  }

为什么是查询的depth定为10?我瞎定的。为什么根证书的路径是这个?我根据Demo的发行版查的,Alpine放在这里,CentOS和Ubuntu可能都不是这个地方。

好啦,现在访问我们本地服务的OAuth认证URL,浏览器就会先返回302跳转到GitHub的认证页,登录并授权后GitHub就会把临时认证码再通过跳转发给浏览器,浏览器对我们的回调接口发起带临时认证码的请求,我们的服务后台拿到临时认证码后先发一个请求到GitHub去获取令牌符,然后再把令牌符放进Auth Header发起一个请求,GitHub就会告诉我们的服务这个用户到底是谁,有什么profile信息咯。现在拿到用户信息以后我们无脑用JSON丢给浏览器,但根据业务需要做用户的认证啊登记啊什么的,都不麻烦。

到此为止,我们就在OpenResty里实现了一个特别简单的OAuth 2认证流程咯。欢迎大家拍砖留言。

一般人我不告诉他:最近写得有点密集了,过两天会再多加一篇补遗,填上一个第一篇的作业中,阮老师博客里有人回复提到的坑(其实如果你注意到Dockerfile里最后一行装了一个到现在都没有提到过的session第三方库……)

最后编辑于
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,172评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,346评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,788评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,299评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,409评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,467评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,476评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,262评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,699评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,994评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,167评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,827评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,499评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,149评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,387评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,028评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,055评论 2 352

推荐阅读更多精彩内容