使用 Ruby 生成 Gmail IMAP 访问的 SASL XOAUTH2 客户端响应

我正在尝试使用 Ruby 中的 XOAUTH2 通过 IMAP 访问我的 Gmail 电子邮件。

我已通过使用 OAuth 2.0 进行身份验证，成功生成了访问令牌（和刷新令牌）oauth2 https://github.com/intridea/oauth2宝石。我要使用gmail_xoauth https://github.com/nfo/gmail_xoauth通过 IMAP 访问 Gmail。所以我现在需要生成 SASL 初始客户端响应，如下所示Gmail XOAuth2 文档 https://developers.google.com/gmail/xoauth2_protocol:

The SASL XOAUTH2 initial client response has the following format:  

    base64("user=" {User} "^Aauth=Bearer " {Access Token} "^A^A")

using the base64 encoding mechanism defined in RFC 4648.
^A represents a Control+A (\001).

我不清楚如何在字符串中表示“Control+A”。我只是简单地使用^A?

key = Base64.encode64("user=#{email}^Aauth=Bearer #{access_token_obj.token}^A^A")

这个Python脚本 http://google-mail-oauth2-tools.googlecode.com/svn/trunk/python/oauth2.py uses \1代替^A。我也尝试过\001。无论我尝试什么，在验证（在 irb 中）时得到的结果是：

>> imap = Net::IMAP.new('imap.gmail.com', 993, usessl=true, certs=nil, verify=false)
>> imap.authenticate('XOAUTH2', email, key)
OpenSSL::SSL::SSLError: SSL_write:: bad write retry

该错误可能完全无关，但我不确定我尝试过的任何选项都是正确的。

终于想通了...我根本不需要做Base64编码步骤！

gmail_xoauth 添加了XOAUTH验证器 https://github.com/nfo/gmail_xoauth/blob/master/lib/gmail_xoauth/imap_xoauth2_authenticator.rb to Net::IMAP http://ruby-doc.org/stdlib-1.9.3/libdoc/net/imap/rdoc/Net/IMAP.html#method-i-authenticate本身。我意识到这只需要未编码的access_token来自 Google，而不是更长的 Base64 编码字符串。

So, if:

email = `[email protected] /cdn-cgi/l/email-protection`
# The result of the OAuth2 dance (as well as a refresh_token):
access_token = 'ya13.AHES6Y3F54_5fAoz_8VuG-7pzQAo3R0_ukt7dhfgRnJh41Q'

那么我就不必对任何内容进行 Base64 编码。我只是做：

imap = Net::IMAP.new('imap.gmail.com', 993, usessl=true, certs=nil, verify=false)
imap.authenticate('XOAUTH2', email, access_token)

我回来了：

#<struct Net::IMAP::TaggedResponse tag="RUBY0001", name="OK", data=#<struct Net::IMAP::ResponseText code=nil, text="[email protected] /cdn-cgi/l/email-protection Fred Bloggs authenticated (Success)">, raw_data="RUBY0001 OK fredbl[email protected] /cdn-cgi/l/email-protection Fred Bloggs authenticated (Success)\r\n">

（作为奖励，这是一个方便的 Ruby 脚本 https://gist.github.com/jotto/2932998为了得到access_token来自 OAuth 舞蹈。）