使用Lua编写Nginx服务器的认证模块的方法
过去两天里，我解决了一个非常有趣的问题。我用一个nginx服务器作为代理，需要能够向其中添加一个认证层，使其能够使用外部的认证源（比如某个web应用）来进行验证，如果用户在外部认证源有账号，就可以在代理里认证通过。
需求一览
我考虑了几种解决方案，罗列如下：
- 用一个简单的python/flask模块来做代理和验证。
- 一个使用subrequests做验证的nginx模块（nginx目前可以做到这一点）
- 使用lua编写一个nginxren认证模块
很显然，给整个系统添加额外请求将执行的不是很好，因为这将会增加延迟(特别是给每一个页面文件都增加一个请求是很让人烦恼的).这就意味着我们把subrequest模块排除在外了。python/flash解决方案好像对nginx支持的也并不好，所以咱也把它排除了。就剩lua了，当然nginx对原生化支持得不错的。
因为我不想再扩展的服务器上对每一个请求都做认证，所以我决定生成一些令牌，这样人们就可以将它保存起来，并把它呈现给服务器，然后服务器就让请求通过。然而，因为lua模块没有一种保持状态的方式(我已经发现)，所以我们不能将令牌随处存储。当你没有更多的内存时，怎样来验证用户所说的话呢？
解决问题
加密签名的方式可是咱的救星！我们可以拿用户的用户名和过期时间数据来给用户添加签名的cookies，这样就能很容易的验证每个用户是谁了，同时我们就不用令牌了。
在nginx中，我们要做的就是直接在指定位置配置access_by_lua_file /our/file.lua，这样这个指定位置就可以保护我们的脚本了。现在，让我们一起来写代码：
local cookie = ngx.var.cookie_mytoken
local hmac = ""
local timestamp = ""
local timestamp_time = 0
-- check that the cookie exists.
if cookie == nil or cookie:find(":") == nil then
-- internally rewrite the url so that we serve
-- /auth/ if there's no cookie.
ngx.exec("/auth/")
else
-- if there's a cookie, split off the hmac signature
-- and timestamp.
local divider = cookie:find(":")
hmac = cookie:sub(divider+1)
timestamp = cookie:sub(0, divider-1)
end
-- verify that the signature is valid.
if hmac_sha1("some very secret string", timestamp) ~= hmac or tonumber(timestamp) < os.time() then
-- if invalid, send to /auth/ again.
ngx.exec("/auth/")
end
上面的代码可以直接运行。我们用一些明文来签名(这种情况下用的是一个时间戳，当然你可以用任何你想用的),之后我们用密文生成hmac(哈希信息认证码)，然后一个签名就生成了，这样用户就不能篡改为无效信息了。
当用户试图载入一个资源的时候，我们会检查cookie里面的签名是否有效，如果是，就通过他的请求。反之，我们会把他们重定向到一个发行口令的服务器，这个服务器会验证并且在没有的情况下给予他们一个签名的口令。
明锐的你可能会发现，上面的代码存在时间上的漏洞。如果你没有发现，别难过。嗯，也许会有点难过。
这里是一段lua的代码，用来比较两个字符串在恒定时间上的等值关系（因而能够阻止任何时间上的攻击，除非我忽视了什么，这极为可能）：
-- constant-time string comparison function.
local same = true
for i = 1, #str1 do
-- if the two strings' lengths are different, sub()
-- will just return nil for the remaining length.
c1 = str1:sub(i,i)
c2 = str2:sub(i,i)
if c1 ~= c2 then
same = false
end
end
return same
end
我已经在函数上应用了时间来区分，如我所知，这是一个在恒定时间下的等值字符串。不同长度的字符串会稍稍改变时间，也许是因为子过程sub应用了一个不同的分支而导致的。而且，c1~=c2分支显然不是恒定时间的，但是在实际中，它相当接近恒定，所以于我们的例子不会有影响。我更倾向于使用xor操作，从而确定两个字符串的xor结果是否为0, 不过lua似乎不包括二进制位的xor操作。如果我在这个判断上有误，对于任何纠正我都很感激。
口令发行服务器
现在，我们已经写了一些很棒的口令检查代码，所有需要做的，只是写一个服务器来真正的发行这些口令。我本可以用python以及flask来写这个服务器，不过我还是想用go做一个尝试，因为我是一个计算机语言潮人而且go看上去“酷”。使用python大概会快一些，不过我乐意用go。
这个服务器会弹出一个http基础验证的表单，检查你输入的帐户，如果正确，它会给你一个签名的口令，适合于一个小时的代理服务器访问。这样，你只需要验证外部服务一次，而随后的身份验证的检查将在nginx层面，而且会相当的快。
请求处理器
写一个处理器，来弹出一个基本的验证窗体不是很难，但是go没有完美的文档，所以我必须自己一点点寻猎。其实非常简单，最终，这里就是http基本验证的go代码：
if username := checkauth(r); username == "" {
w.header().set("www-authenticate", `basic realm="the kingdom of stavros"`)
w.writeheader(401)
w.write([]byte("401 unauthorized\n"))
} else {
fmt.printf("authenticated user %v.\n", username)
token := gettoken()
settokencookie(w, token)
fmt.fprintf(w, "<html><head><script>location.reload()</script></head></html>")
}
}
设置口令和cookie
一旦我们验证了一个用户之后，我们需要给他们的口令设置一个cookie。我门只需要做我们用lua做过的同样的事情，如上，只是更加简单，因为go在标准库里面就包括一个真加密包。这个代码一样很直接明了，即使没有完全文档化：
expiration := int(time.now().unix()) + 3600
mac := hmac.new(sha1.new, []byte("some very secret string"))
mac.write([]byte(fmt.sprintf("%v", expiration)))
expectedmac := fmt.sprintf("%x", mac.sum(nil))
return fmt.sprintf("%v:%s", expiration, expectedmac)
}
func settokencookie(w http.responsewriter, token string) {
rawcookie := fmt.sprintf("mytoken=%s", token)
expire := time.now().add(time.hour)
cookie := http.cookie{"mytoken",
token,
"/",
".example.com",
expire,
expire.format(time.unixdate),
3600,
false,
true,
rawcookie,
[]string{rawcookie}}
http.setcookie(w, &cookie)
}
尝试把他们放在一起
来完成我们这一大段美妙的组合，我们只需要一个函数，用来检查由用户提供的验证信息，而且我们做到了！这里是我从一些库里面汲取出来的代码，当前它只是检查一个特定的用户名／密码的组合，所以和第三方的服务的集成就做为留给读者的作业吧：
s := strings.splitn(r.header.get("authorization"), " ", 2)
if len(s) != 2 || s[0] != "basic" {
return ""
}
b, err := base64.stdencoding.decodestring(s[1])
if err != nil {
return ""
}
pair := strings.splitn(string(b), ":", 2)
if len(pair) != 2 {
return ""
}
if pair[0] != "username" || pair[1] != "password" {
return ""
}
return pair[0]
}
结论
我到目前对于nginx的lua模块还是有着相当的喜欢。它允许你在web服务器的请求／响应周期里面做一些简单的操作，而且对于某些操作，比如为代理服务器做验证的检查，是很有意义的。这些事情对于一个不可编程的web服务器，一直很难，因此我们极可能需要写自己的http代理服务。
上面的代码相当的简短，而且优雅，所以我对于上面的所有都感到高兴。我不能确定，这对于响应添加了多少额外的时间，不过，做一个验证是有好处的，我想这将值得去做（而且应该足够快，所以不是一个问题）。
另一个好处就是，你可以仅使用一个在nginxlocationblock里面的单独的directive来开启它，所以没有需要跟踪的配置项。我发现，总体而言，这是一个非常优雅的解决方案，而且我很高兴的了解到nginx可以让我去做这样的事情，可能是将来我需要去做的。