Skip to main content

Simple OAuth2 client.

Project description

feedr-oauth2

This is a Python library that implements the client side of following OAuth 2.0 flows:

  • Authorization Code
  • Client Credentials
  • Device Code
  • Refresh Token

The implementation follows the OAuth2 standard described in https://oauth.net/2/.

Quickstart

Authorization Code

from feedr.oauth2.authorization_code import Client, PKCE

client = ac.Client(
  auth_uri='https://authorization-server.com/oauth2/authorize',
  token_uri='https://authorization-server.com/oauth2/token',
  client_id='...',
  client_secret='...',
  redirect_uri='...',
  use_pkce=True,
)

# ------------------
# /api/login
# ------------------

request = client.authorization_request(
  scope='read+write',
  redirect_uri=EXTERNAL_URL + '/api/login/collect',
)

persist_state(request.state, request.pkce)

return redirect(request.auth_uri)

# ------------------
# /api/login/collect?code=...&state=...
# ------------------

pkce: PKCE = retrieve_state(state)

response = client.authorization_code(code, pkce)

print(response)  # AccessTokenResponse(access_token='...', token_type='bearer', ...)

Client Credentials

from feedr.oauth2.client_credentials as Client

client = Client(
  token_uri='https://authorization-server.com/oauth2/token',
  client_id='...',
  client_secret='...',
)

token_info = client.get_token()
print(token_info)  # AccessTokenResponse(access_token='...', token_type='bearer', ...)

Device Code

from feedr.oauth2.device_code import Client

client = Client(
  device_code_uri='https://authorization-server.com/device/code',
  token_uri='https://authorization-server.com/oauth2/token',
  client_id='...',
  client_secret='...',
)

request = client.get_device_code()
print(f'Visit {request.verification_url} and enter the code {request.user_code}.')

token_info = client.poll(request)
print(token_info)  # AccessTokenResponse(access_token='...', token_type='bearer', ...)

Refresh Token

The authorization_code.Client class has a refresh_token() method that makes refreshing the access token easy by simply supplying the refresh token.

new_token = client.refresh_token(token_info.refresh_token)

Alternatively, the refresh_token.Client can be used to create a refresh_token request.

client = Client(
  token_uri='https://authorization-server.com/oauth2/token',
  refresh_token='...',
  client_id='...',
  client_secret='...',
)

token_info = client.get_token()
print(token_info)  # AccessTokenResponse(access_token='...', token_type='bearer', ...)

Copyright © 2020 Niklas Rosenstein

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

feedr.oauth2-0.1.1.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

feedr.oauth2-0.1.1-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file feedr.oauth2-0.1.1.tar.gz.

File metadata

  • Download URL: feedr.oauth2-0.1.1.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for feedr.oauth2-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5cadf112012b9e3e57755138ba6c0bfe305e120a85df6480dab90bb25fbe29c6
MD5 61f5bcb6816f9db61a0f74e416e2d427
BLAKE2b-256 a93cbb11e43081abea46d90270770ba6a15d647f72a7fabaf4d4b3cc89df1c3e

See more details on using hashes here.

File details

Details for the file feedr.oauth2-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: feedr.oauth2-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for feedr.oauth2-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 75c3672cf2392570e094a245a3a42d499870e9d2847464476ae8dc858134fe6e
MD5 b1d94c7c988158fc8fc85e35bd491336
BLAKE2b-256 43890bbe63fded0c2aa64e80779ccd967ebb5a62df9d931dab1039078a1e314d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page