Skip to main content

API for managing stored OAuth credentials.

Project description

Python Library for storing OAuth credentials in many locations

What's this for?

By their very nature, OAuth credentials are valuable and dangerous, and have to be stored securely. As a result, the same tasks to store these tokens in a simple and secure fashion have to be written each time, or copied and pasted around - leading to potential issues as problems are found and not fixed in all places.

This library will store OAuth tokens in any of the following places:

  1. Secret Manager
  2. Firestore
  3. Google Cloud Storage files
  4. A local json file

Other storage locations can be added at will simply by forking this library and extending the appropriate abstract classes.

Samples

Fetching a token from storage

from auth.credentials_helpers import encode_key
from auth.secret_manager import SecretManager

manager = SecretManager(project='<gcp project name>')
key = manager.get_document(encode_key('<token id>'))

Note the use of encode_key. This is because many of the storage systems supported do not allow special characters, and the most convenient identifier for most OAuth tokens is the email address of the user. encode_key is a base64 encoder - and no decoding is necessary.

The example given uses Secret Manager (part of Google Cloud). To use (say) GCS, the code would change like this:

from auth.credentials_helpers import encode_key
from auth.gcs_datastore import GCSDatastore

manager = GCSDatastore(project='<gcp project name>', bucket='<gcs bucket>')
key = manager.get_document(encode_key('<token id>'))

All that changes is where the datastore is!

Storing a token in Secret Manager

from auth.secret_manager import SecretManager
manager = SecretManager(project='<gcp project name>')

manager.update_document(id=encode_key('<token_id>'), new_data=<token string>)

This will implicitly create a secret if there was not one already, or simply update an existing secret with a new 'live' version of the secret.

Listing all the available secrets

from auth.secret_manager import SecretManager
manager = SecretManager(project='<gcp project name>')

manager.list_documents()

Removing a secret

from auth.secret_manager import SecretManager
manager = SecretManager(project='<gcp project name>')

manager.delete_document(id=encode_key('<token_id>'))

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

python-oauth-token-manager-0.1.1.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

python_oauth_token_manager-0.1.1-py3-none-any.whl (25.6 kB view details)

Uploaded Python 3

File details

Details for the file python-oauth-token-manager-0.1.1.tar.gz.

File metadata

File hashes

Hashes for python-oauth-token-manager-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c7bf6e75d2cfe191188efe103096868158c63cf7e3f71fdc979fed7c537954bf
MD5 549755d273dcaa88a7513da7652e5931
BLAKE2b-256 d580e5f6464887ea70df566e82e3efb54df61e150be47e82f09844e891a449ff

See more details on using hashes here.

File details

Details for the file python_oauth_token_manager-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for python_oauth_token_manager-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0be608ace415944cebd1d0d832fac463db027c1d049899fe64c28e36b7fedbf0
MD5 8b79f49815862e2b11e80c22eaad1380
BLAKE2b-256 afb002f6eb6cf4caf2692c452e61d697736a215b0f2660eb3d00e68b2668a281

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