确定何时使用Python Social Auth刷新OAUTH2令牌

Question

我认为这主要是关于最佳做法的问题。

我有一个OAUTH2提供程序，它会发出与刷新令牌一样长的访问令牌（有效期为10个小时）。

我在这里发现刷新访问令牌非常容易，但是我不明白如何确定何时刷新。

一个简单的答案可能是“何时不再起作用”，这意味着从后端获取HTTP 401时。 该解决方案的问题在于效率不高，而且我只能假定我已经获得了401，因为令牌已过期。

在我的django应用中，我发现user social auth的Extra data字段包含如下内容：

{ "scope": "read write", "expires": 36000, "refresh_token": "xxxxxxxxxxxxx", "access_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "token_type": "Bearer" }

但我不确定如何使用expires字段。

所以我的问题是：我怎么知道访问令牌是否已过期并且需要刷新它？

编辑 ：我刚刚发现此注释似乎相关，但我不明白如何在管道中插入此新功能以便在令牌刷新期间工作。

Answer 1

我最终想通了。 我最初感到困惑的原因是，实际上有两种情况：

1. 当用户来自登录名时，基本上就可以执行管道。
2. 刷新令牌后，调用用户社交身份验证方法refresh_token

解决第一种情况

我为管道创建了一个新函数：

def set_last_update(details, *args, **kwargs):  # pylint: disable=unused-argument
    """
    Pipeline function to add extra information about when the social auth
    profile has been updated.
    Args:
        details (dict): dictionary of informations about the user
    Returns:
        dict: updated details dictionary
    """
    details['updated_at'] = datetime.utcnow().timestamp()
    return details

在设置中，我在load_extra_data之前将其添加到管道中

SOCIAL_AUTH_PIPELINE = (
    'social.pipeline.social_auth.social_details',
    'social.pipeline.social_auth.social_uid',
    'social.pipeline.social_auth.auth_allowed',
    'social.pipeline.social_auth.social_user',
    'social.pipeline.user.get_username',
    'social.pipeline.user.create_user',
    'social.pipeline.social_auth.associate_user',
    # the following custom pipeline func goes before load_extra_data
    'backends.pipeline_api.set_last_update',
    'social.pipeline.social_auth.load_extra_data',
    'social.pipeline.user.user_details',
    'backends.pipeline_api.update_profile_from_edx',
    'backends.pipeline_api.update_from_linkedin',
)

并且，仍然在设置中，我在额外数据中添加了新字段。

SOCIAL_AUTH_EDXORG_EXTRA_DATA = ['updated_at']

对于第二种情况：

我重写了后端的refresh_token方法以添加额外的字段。

def refresh_token(self, token, *args, **kwargs):
    """
    Overridden method to add extra info during refresh token.
    Args:
        token (str): valid refresh token
    Returns:
        dict of information about the user
    """
    response = super(EdxOrgOAuth2, self).refresh_token(token, *args, **kwargs)
    response['updated_at'] = datetime.utcnow().timestamp()
    return response

仍然在后端类中，我添加了一个额外的字段来提取来自服务器的expires_in字段。

EXTRA_DATA = [
    ('refresh_token', 'refresh_token', True),
    ('expires_in', 'expires_in'),
    ('token_type', 'token_type', True),
    ('scope', 'scope'),
]

此时，我具有创建访问令牌的时间戳记（ updated_at ）和它将有效的秒数（ expires_in ）。

注意： updated_at是一个近似值，因为它是在客户端而不是在提供程序服务器上创建的。

现在唯一缺少的是用于检查是否该刷新访问令牌的功能。

def _send_refresh_request(user_social):
    """
    Private function that refresh an user access token
    """
    strategy = load_strategy()
    try:
        user_social.refresh_token(strategy)
    except HTTPError as exc:
        if exc.response.status_code in (400, 401,):
            raise InvalidCredentialStored(
                message='Received a {} status code from the OAUTH server'.format(
                    exc.response.status_code),
                http_status_code=exc.response.status_code
            )
        raise


def refresh_user_token(user_social):
    """
    Utility function to refresh the access token if is (almost) expired
    Args:
        user_social (UserSocialAuth): a user social auth instance
    """
    try:
        last_update = datetime.fromtimestamp(user_social.extra_data.get('updated_at'))
        expires_in = timedelta(seconds=user_social.extra_data.get('expires_in'))
    except TypeError:
        _send_refresh_request(user_social)
        return
    # small error margin of 5 minutes to be safe
    error_margin = timedelta(minutes=5)
    if datetime.utcnow() - last_update >= expires_in - error_margin:
        _send_refresh_request(user_social)

我希望这对其他人有帮助。

Answer 2

当前， extra_data字段现在具有auth_time 。 您可以将其与expires一起使用，从而确定access_token的有效性：

if (social.extra_data['auth_time'] + social.extra_data['expires'] - 10) <= int(time.time()):
    from social_django.utils import load_strategy
    strategy = load_strategy()
    social.refresh_token(strategy)

多余的“ 10”秒用于防止出现争用情况，在这种情况下， access_token可能在执行进一步的代码之前到期。

这个问题给出了更多细节： 如何使用social-auth-app-django刷新令牌？