使用Flask-OAuthlib實現QQ OAuth2登陸

本文介紹如何經過Flask-OAuthlib擴展實現QQ OAuth2登陸。

Flask-OAuthlib是OAuthlib的Flask擴展實現，主要特性：

• 支持OAuth 1.0a, 1.0, 1.1, OAuth2客戶端
• 友好的API（和Flask-OAuth同樣）
• 與Flask直接整合
• 等等……

Flask-OAuthlib提供了多個開放平臺的示例代碼，好比Google, Facebook, Twiter, Github, Dropbox, 豆瓣, 微博等，只是暫時沒有QQ登陸的示例代碼。

QQ OAuth登陸示例

下面是QQ登陸的代碼：

pythonimport os
import json
from flask import Flask, redirect, url_for, session, request, jsonify, Markup
from flask_oauthlib.client import OAuth

QQ_APP_ID = os.getenv('QQ_APP_ID', '101187283')
QQ_APP_KEY = os.getenv('QQ_APP_KEY', '993983549da49e384d03adfead8b2489')

app = Flask(__name__)
app.debug = True
app.secret_key = 'development'
oauth = OAuth(app)

qq = oauth.remote_app(
    'qq',
    consumer_key=QQ_APP_ID,
    consumer_secret=QQ_APP_KEY,
    base_url='https://graph.qq.com',
    request_token_url=None,
    request_token_params={'scope': 'get_user_info'},
    access_token_url='/oauth2.0/token',
    authorize_url='/oauth2.0/authorize',
)


def json_to_dict(x):
    '''OAuthResponse class can't not parse the JSON data with content-type
    text/html, so we need reload the JSON data manually'''
    if x.find('callback') > -1:
        pos_lb = x.find('{')
        pos_rb = x.find('}')
        x = x[pos_lb:pos_rb + 1]
    try:
        return json.loads(x, encoding='utf-8')
    except:
        return x


def update_qq_api_request_data(data={}):
    '''Update some required parameters for OAuth2.0 API calls'''
    defaults = {
        'openid': session.get('qq_openid'),
        'access_token': session.get('qq_token')[0],
        'oauth_consumer_key': QQ_APP_ID,
    }
    defaults.update(data)
    return defaults


@app.route('/')
def index():
    '''just for verify website owner here.'''
    return Markup('''<meta property="qc:admins" '''
                  '''content="226526754150631611006375" />''')


@app.route('/user_info')
def get_user_info():
    if 'qq_token' in session:
        data = update_qq_api_request_data()
        resp = qq.get('/user/get_user_info', data=data)
        return jsonify(status=resp.status, data=resp.data)
    return redirect(url_for('login'))


@app.route('/login')
def login():
    return qq.authorize(callback=url_for('authorized', _external=True))


@app.route('/logout')
def logout():
    session.pop('qq_token', None)
    return redirect(url_for('get_user_info'))


@app.route('/login/authorized')
def authorized():
    resp = qq.authorized_response()
    if resp is None:
        return 'Access denied: reason=%s error=%s' % (
            request.args['error_reason'],
            request.args['error_description']
        )
    session['qq_token'] = (resp['access_token'], '')

    # Get openid via access_token, openid and access_token are needed for API calls
    resp = qq.get('/oauth2.0/me', {'access_token': session['qq_token'][0]})
    resp = json_to_dict(resp.data)
    if isinstance(resp, dict):
        session['qq_openid'] = resp.get('openid')

    return redirect(url_for('get_user_info'))


@qq.tokengetter
def get_qq_oauth_token():
    return session.get('qq_token')


if __name__ == '__main__':
    app.run()

主要流程：

1. 訪問QQ互聯網站 http://connect.qq.com/ 註冊成爲開發者，並申請應用，申請應用時須要驗證網站全部權；
2. 應用申請好以後，把QQ_APP_ID和QQ_APP_KEY替換爲你的應用的；
3. 訪問/login，而後會跳轉到QQ的受權驗證網頁；
4. QQ驗證經過以後，會跳轉回到/login/authorized，並獲取access_token；
5. 獲得access_token以後，經過access_token獲取openid，access_token和openid是後期調用其它API的必要參數；
6. 跳轉到/user_info，獲取並顯示登陸用戶的基本信息。

更多信息請參閱Flask-OAuthlib文檔和QQ互聯文檔：

• https://flask-oauthlib.readthedocs.org/
• http://wiki.connect.qq.com/

關於SAE平臺的特別說明

在SAE平臺上，受權過程沒有任何問題，當獲取到access_token以後，調用API時，會在請求時（好比get, put）附加相似以下的請求頭：

pythonheaders = {u'Authorization': u'Bearer 83F40E96FB6882686F4DF1E17105D04E'}

這個請求頭會引起HTTPError: HTTP Error 400: Bad request，形成請求失敗。解決的辦法是把鍵名轉換成str類型，Hack代碼以下：

pythondef convert_keys_to_string(dictionary):
    """Recursively converts dictionary keys to strings."""
    if not isinstance(dictionary, dict):
        return dictionary
    return dict((str(k), convert_keys_to_string(v))
        for k, v in dictionary.items())

def change_qq_header(uri, headers, body):
    headers = convert_keys_to_string(headers)
    return uri, headers, body

qq.pre_request = change_qq_header

當項目部署在SAE平臺時，將這段代碼放在if __name__ == '__main__'語句以前便可。

小結

OAuth2登陸驗證仍是比較容易的，絕大多數的平臺都支持標準的協議，使用通用的庫能夠簡化開發流程。另外，QQ登陸的代碼已經提交到Flask-OAuthlib代碼庫了。

---

原文：http://flask123.sinaapp.com/article/59/