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.

Files for feedr.oauth2, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size feedr.oauth2-0.1.3.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View
Filename, size feedr.oauth2-0.1.3-py3-none-any.whl (9.3 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page