Skip to content

tokens

oauthlib.oauth2.rfc6749.tokens ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This module contains methods for adding two types of access tokens to requests.

  • Bearer https://tools.ietf.org/html/rfc6750
  • MAC https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01

BearerToken

Bases: TokenBase

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
class BearerToken(TokenBase):
    __slots__ = (
        'request_validator', 'token_generator',
        'refresh_token_generator', 'expires_in'
    )

    def __init__(self, request_validator=None, token_generator=None,
                 expires_in=None, refresh_token_generator=None):
        self.request_validator = request_validator
        self.token_generator = token_generator or random_token_generator
        self.refresh_token_generator = (
            refresh_token_generator or self.token_generator
        )
        self.expires_in = expires_in or 3600

    def create_token(self, request, refresh_token=False, **kwargs):
        """
        Create a BearerToken, by default without refresh token.

        :param request: OAuthlib request.
        :type request: oauthlib.common.Request
        :param refresh_token:
        """
        if "save_token" in kwargs:
            warnings.warn("`save_token` has been deprecated, it was not called internally."
                          "If you do, call `request_validator.save_token()` instead.",
                          DeprecationWarning)

        if callable(self.expires_in):
            expires_in = self.expires_in(request)
        else:
            expires_in = self.expires_in

        request.expires_in = expires_in

        token = {
            'access_token': self.token_generator(request),
            'expires_in': expires_in,
            'token_type': 'Bearer',
        }

        # If provided, include - this is optional in some cases https://tools.ietf.org/html/rfc6749#section-3.3 but
        # there is currently no mechanism to coordinate issuing a token for only a subset of the requested scopes so
        # all tokens issued are for the entire set of requested scopes.
        if request.scopes is not None:
            token['scope'] = ' '.join(request.scopes)

        if refresh_token:
            if (request.refresh_token and
                    not self.request_validator.rotate_refresh_token(request)):
                token['refresh_token'] = request.refresh_token
            else:
                token['refresh_token'] = self.refresh_token_generator(request)

        token.update(request.extra_credentials or {})
        return OAuth2Token(token)

    def validate_request(self, request):
        """
        :param request: OAuthlib request.
        :type request: oauthlib.common.Request
        """
        token = get_token_from_header(request)
        return self.request_validator.validate_bearer_token(
            token, request.scopes, request)

    def estimate_type(self, request):
        """
        :param request: OAuthlib request.
        :type request: oauthlib.common.Request
        """
        if request.headers.get('Authorization', '').split(' ')[0].lower() == 'bearer':
            return 9
        elif request.access_token is not None:
            return 5
        else:
            return 0

create_token(request, refresh_token=False, **kwargs)

Create a BearerToken, by default without refresh token.

:param request: OAuthlib request. :type request: oauthlib.common.Request :param refresh_token:

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
def create_token(self, request, refresh_token=False, **kwargs):
    """
    Create a BearerToken, by default without refresh token.

    :param request: OAuthlib request.
    :type request: oauthlib.common.Request
    :param refresh_token:
    """
    if "save_token" in kwargs:
        warnings.warn("`save_token` has been deprecated, it was not called internally."
                      "If you do, call `request_validator.save_token()` instead.",
                      DeprecationWarning)

    if callable(self.expires_in):
        expires_in = self.expires_in(request)
    else:
        expires_in = self.expires_in

    request.expires_in = expires_in

    token = {
        'access_token': self.token_generator(request),
        'expires_in': expires_in,
        'token_type': 'Bearer',
    }

    # If provided, include - this is optional in some cases https://tools.ietf.org/html/rfc6749#section-3.3 but
    # there is currently no mechanism to coordinate issuing a token for only a subset of the requested scopes so
    # all tokens issued are for the entire set of requested scopes.
    if request.scopes is not None:
        token['scope'] = ' '.join(request.scopes)

    if refresh_token:
        if (request.refresh_token and
                not self.request_validator.rotate_refresh_token(request)):
            token['refresh_token'] = request.refresh_token
        else:
            token['refresh_token'] = self.refresh_token_generator(request)

    token.update(request.extra_credentials or {})
    return OAuth2Token(token)

estimate_type(request)

:param request: OAuthlib request. :type request: oauthlib.common.Request

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
346
347
348
349
350
351
352
353
354
355
356
def estimate_type(self, request):
    """
    :param request: OAuthlib request.
    :type request: oauthlib.common.Request
    """
    if request.headers.get('Authorization', '').split(' ')[0].lower() == 'bearer':
        return 9
    elif request.access_token is not None:
        return 5
    else:
        return 0

validate_request(request)

:param request: OAuthlib request. :type request: oauthlib.common.Request

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
337
338
339
340
341
342
343
344
def validate_request(self, request):
    """
    :param request: OAuthlib request.
    :type request: oauthlib.common.Request
    """
    token = get_token_from_header(request)
    return self.request_validator.validate_bearer_token(
        token, request.scopes, request)

TokenBase

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
class TokenBase:
    __slots__ = ()

    def __call__(self, request, refresh_token=False):
        raise NotImplementedError('Subclasses must implement this method.')

    def validate_request(self, request):
        """
        :param request: OAuthlib request.
        :type request: oauthlib.common.Request
        """
        raise NotImplementedError('Subclasses must implement this method.')

    def estimate_type(self, request):
        """
        :param request: OAuthlib request.
        :type request: oauthlib.common.Request
        """
        raise NotImplementedError('Subclasses must implement this method.')

estimate_type(request)

:param request: OAuthlib request. :type request: oauthlib.common.Request

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
272
273
274
275
276
277
def estimate_type(self, request):
    """
    :param request: OAuthlib request.
    :type request: oauthlib.common.Request
    """
    raise NotImplementedError('Subclasses must implement this method.')

validate_request(request)

:param request: OAuthlib request. :type request: oauthlib.common.Request

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
265
266
267
268
269
270
def validate_request(self, request):
    """
    :param request: OAuthlib request.
    :type request: oauthlib.common.Request
    """
    raise NotImplementedError('Subclasses must implement this method.')

get_token_from_header(request)

Helper function to extract a token from the request header.

:param request: OAuthlib request. :type request: oauthlib.common.Request :return: Return the token or None if the Authorization header is malformed.

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
def get_token_from_header(request):
    """
    Helper function to extract a token from the request header.

    :param request: OAuthlib request.
    :type request: oauthlib.common.Request
    :return: Return the token or None if the Authorization header is malformed.
    """
    token = None

    if 'Authorization' in request.headers:
        split_header = request.headers.get('Authorization').split()
        if len(split_header) == 2 and split_header[0].lower() == 'bearer':
            token = split_header[1]
    else:
        token = request.access_token

    return token

prepare_bearer_body(token, body='')

Add a Bearer Token_ to the request body.

access_token=h480djs93hd8

.. _Bearer Token: https://tools.ietf.org/html/rfc6750

:param token: :param body:

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
206
207
208
209
210
211
212
213
214
215
216
def prepare_bearer_body(token, body=''):
    """Add a `Bearer Token`_ to the request body.

    access_token=h480djs93hd8

    .. _`Bearer Token`: https://tools.ietf.org/html/rfc6750

    :param token:
    :param body:
    """
    return add_params_to_qs(body, [(('access_token', token))])

prepare_bearer_headers(token, headers=None)

Add a Bearer Token_ to the request URI. Recommended method of passing bearer tokens.

Authorization: Bearer h480djs93hd8

.. _Bearer Token: https://tools.ietf.org/html/rfc6750

:param token: :param headers:

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
190
191
192
193
194
195
196
197
198
199
200
201
202
203
def prepare_bearer_headers(token, headers=None):
    """Add a `Bearer Token`_ to the request URI.
    Recommended method of passing bearer tokens.

    Authorization: Bearer h480djs93hd8

    .. _`Bearer Token`: https://tools.ietf.org/html/rfc6750

    :param token:
    :param headers:
    """
    headers = headers or {}
    headers['Authorization'] = 'Bearer %s' % token
    return headers

prepare_bearer_uri(token, uri)

Add a Bearer Token_ to the request URI. Not recommended, use only if client can't use authorization header or body.

http://www.example.com/path?access_token=h480djs93hd8

.. _Bearer Token: https://tools.ietf.org/html/rfc6750

:param token: :param uri:

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
176
177
178
179
180
181
182
183
184
185
186
187
def prepare_bearer_uri(token, uri):
    """Add a `Bearer Token`_ to the request URI.
    Not recommended, use only if client can't use authorization header or body.

    http://www.example.com/path?access_token=h480djs93hd8

    .. _`Bearer Token`: https://tools.ietf.org/html/rfc6750

    :param token:
    :param uri:
    """
    return add_params_to_uri(uri, [(('access_token', token))])

prepare_mac_header(token, uri, key, http_method, nonce=None, headers=None, body=None, ext='', hash_algorithm='hmac-sha-1', issue_time=None, draft=0)

Add an MAC Access Authentication_ signature to headers.

Unlike OAuth 1, this HMAC signature does not require inclusion of the request payload/body, neither does it use a combination of client_secret and token_secret but rather a mac_key provided together with the access token.

Currently two algorithms are supported, "hmac-sha-1" and "hmac-sha-256", extension algorithms_ are not supported.

Example MAC Authorization header, linebreaks added for clarity

MAC id="h480djs93hd8",

nonce="1336363200:dj83hs9s", mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="

.. MAC Access Authentication: https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01 .. extension algorithms: https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01#section-7.1

:param token: :param uri: Request URI. :param key: MAC given provided by token endpoint. :param http_method: HTTP Request method. :param nonce: :param headers: Request headers as a dictionary. :param body: :param ext: :param hash_algorithm: HMAC algorithm provided by token endpoint. :param issue_time: Time when the MAC credentials were issued (datetime). :param draft: MAC authentication specification version. :return: headers dictionary with the authorization field added.

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def prepare_mac_header(token, uri, key, http_method,
                       nonce=None,
                       headers=None,
                       body=None,
                       ext='',
                       hash_algorithm='hmac-sha-1',
                       issue_time=None,
                       draft=0):
    """Add an `MAC Access Authentication`_ signature to headers.

    Unlike OAuth 1, this HMAC signature does not require inclusion of the
    request payload/body, neither does it use a combination of client_secret
    and token_secret but rather a mac_key provided together with the access
    token.

    Currently two algorithms are supported, "hmac-sha-1" and "hmac-sha-256",
    `extension algorithms`_ are not supported.

    Example MAC Authorization header, linebreaks added for clarity

    Authorization: MAC id="h480djs93hd8",
                       nonce="1336363200:dj83hs9s",
                       mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="

    .. _`MAC Access Authentication`: https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01
    .. _`extension algorithms`: https://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01#section-7.1

    :param token:
    :param uri: Request URI.
    :param key: MAC given provided by token endpoint.
    :param http_method: HTTP Request method.
    :param nonce:
    :param headers: Request headers as a dictionary.
    :param body:
    :param ext:
    :param hash_algorithm: HMAC algorithm provided by token endpoint.
    :param issue_time: Time when the MAC credentials were issued (datetime).
    :param draft: MAC authentication specification version.
    :return: headers dictionary with the authorization field added.
    """
    http_method = http_method.upper()
    host, port = utils.host_from_uri(uri)

    if hash_algorithm.lower() == 'hmac-sha-1':
        h = hashlib.sha1
    elif hash_algorithm.lower() == 'hmac-sha-256':
        h = hashlib.sha256
    else:
        raise ValueError('unknown hash algorithm')

    if draft == 0:
        nonce = nonce or '{}:{}'.format(utils.generate_age(issue_time),
                                          common.generate_nonce())
    else:
        ts = common.generate_timestamp()
        nonce = common.generate_nonce()

    sch, net, path, par, query, fra = urlparse(uri)

    if query:
        request_uri = path + '?' + query
    else:
        request_uri = path

    # Hash the body/payload
    if body is not None and draft == 0:
        body = body.encode('utf-8')
        bodyhash = b2a_base64(h(body).digest())[:-1].decode('utf-8')
    else:
        bodyhash = ''

    # Create the normalized base string
    base = []
    if draft == 0:
        base.append(nonce)
    else:
        base.append(ts)
        base.append(nonce)
    base.append(http_method.upper())
    base.append(request_uri)
    base.append(host)
    base.append(port)
    if draft == 0:
        base.append(bodyhash)
    base.append(ext or '')
    base_string = '\n'.join(base) + '\n'

    # hmac struggles with unicode strings - http://bugs.python.org/issue5285
    if isinstance(key, str):
        key = key.encode('utf-8')
    sign = hmac.new(key, base_string.encode('utf-8'), h)
    sign = b2a_base64(sign.digest())[:-1].decode('utf-8')

    header = []
    header.append('MAC id="%s"' % token)
    if draft != 0:
        header.append('ts="%s"' % ts)
    header.append('nonce="%s"' % nonce)
    if bodyhash:
        header.append('bodyhash="%s"' % bodyhash)
    if ext:
        header.append('ext="%s"' % ext)
    header.append('mac="%s"' % sign)

    headers = headers or {}
    headers['Authorization'] = ', '.join(header)
    return headers

random_token_generator(request, refresh_token=False)

:param request: OAuthlib request. :type request: oauthlib.common.Request :param refresh_token:

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
219
220
221
222
223
224
225
def random_token_generator(request, refresh_token=False):
    """
    :param request: OAuthlib request.
    :type request: oauthlib.common.Request
    :param refresh_token:
    """
    return common.generate_token()

signed_token_generator(private_pem, **kwargs)

:param private_pem:

Source code in server/vendor/oauthlib/oauth2/rfc6749/tokens.py
228
229
230
231
232
233
234
235
236
def signed_token_generator(private_pem, **kwargs):
    """
    :param private_pem:
    """
    def signed_token_generator(request):
        request.claims = kwargs
        return common.generate_signed_token(private_pem, request)

    return signed_token_generator