oauth-token-cache

Easily obtain and cache OAuth 2.0 JWT tokens from Auth0.

When using external auth providers for obtaining OAuth 2.0 machine-to-machine tokens you may want to share one access token across several instances (e.g. processes, threads, containers, pods ...) of your application in order to avoid having to issue new tokens too often.

oauth-token-cache makes it easy to obtain, refresh and cache OAuth 2.0 tokens. Obtained tokens are stored both in memory and in Redis with a TTL which corresponds to the time to expire of your token.

pip install oauth-token-cache

Quickstart

from oauth_token_cache import OAuthTokenCache

token_provider = OAuthTokenCache(
    client_id="XXX",
    client_secret="XXX",
    token_url="https://example.com/oauth/token"
)

"""
The token will be cached in Redis. A fresh token will automatically be
fetched when calling `token` the next time in case the old token has expired.
"""
my_token = token_provider.token(audience="test")

my_token.access_token
>> eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IlFrVkJOemN6TjBNeFJr...

my_token.audience
>> test

my_token.token_type
>> Bearer

my_token.expires_at
>> 1572169916

my_token.expired
>> False

Configuring Redis

The redis_options argument will be passed on to the redis client. See the documentation of the redis package on how to configure the client.

OAuthTokenCache(
    client_id="XXX",
    client_secret="XXX",
    token_url="https://example.com/oauth/token",
    redis_options={
        "host": "example.com",
        "port": 1234,
    }
)

Using your own Redis client

You can pass your own Redis client at which redis_options will be ignored. Make sure to configure the redis client to automatically decode responses using decode_response=True.

redis_client = redis.Redis(decode_response=True)

OAuthTokenCache(
    client_id="XXX",
    client_secret="XXX",
    token_url="https://example.com/oauth/token",
    redis_client=redis_client,
)

Overwriting the returned token

For CI and testing it is sometimes helpful to overwrite the returned access token and thus bypass the refreshing and caching functionality of OAuthTokenCache.

You can do so by setting the OAUTH_TOKEN environment variable. OAuthTokenCache will then always return the access token given in the environment variable.

Development

1. Install the dependencies:

poetry install

2. Run linters:

make black
make pylint

3. Run pytest:

make pytest