Skip to main content

Boto3 RefreshableCredentials wrapping oktad system call

Project description

https://travis-ci.org/Automatic/oktadboto.svg?branch=master https://img.shields.io/pypi/v/oktadboto.svg?style=flat-square https://img.shields.io/pypi/pyversions/oktadboto.svg?style=flat-square https://img.shields.io/pypi/implementation/oktadboto.svg?style=flat-square https://img.shields.io/badge/code%20style-black-000000.svg

Installation

The oktadboto project is public and can be installed from pypi with pip for python3 on mac and linux.

pip install oktadboto

Requires

This library makes system call to oktad to get new session credentials oktad

Usage

After activating your credentials for an oktad profile using you username, password and mfa token you should be able to get new AWS session credentials without authenticating for upto 24 hours. AWS Sessions last only one hour though. Use otkadboto to create an AWS Session using RefreshableCredentials that can make a system call to get a fresh session token every hour.

1) Confirm that you can run oktad {PROFILE_NAME} -- env in your shell to get environment variables for AWS_SESSION_TOKEN, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY.

  1. Example code to create a boto3 s3 client resource

from oktadboto import oktadboto_session
refreshing_boto_session = oktadboto_session('{PROFILE_NAME}')
s3_client = refreshing_boto_session.client('s3')
s3_client.download_fileobj(...)
  1. The RefreshableCredentials will work until you need to reauthenticate with Oktad, usually 24 hours.

Development

Git clone the respository:

git clone git@github.com:upserve/otkadboto.git

Pip install the development dependencies in a virtual environment:

pip install -e .[dev]

Run unit tests:

python -m unittest -v

Run flake8:

flake8 .

Run black:

black .

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

oktadboto-0.0.3.tar.gz (3.6 kB view details)

Uploaded Source

File details

Details for the file oktadboto-0.0.3.tar.gz.

File metadata

  • Download URL: oktadboto-0.0.3.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.1

File hashes

Hashes for oktadboto-0.0.3.tar.gz
Algorithm Hash digest
SHA256 390a1ca55b547d4810bf1dd401b9538afd3003b5a4d06e3aa523719cf7e55f10
MD5 c93ab7baccc0d425ebb36378e2a6cfad
BLAKE2b-256 0dae1a41d5064b56fb15f07fc18612f3fdba5e06149f700068b937235687cd0d

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