Skip to main content

A tool for generating OIDC identities

Project description

id

CI PyPI version OpenSSF Scorecard SLSA

id is a Python tool for generating OIDC identities. It can automatically detect and produce OIDC credentials on an number of environments, including GitHub Actions and Google Cloud.

Installation

id requires Python 3.7 or newer, and can be installed directly via pip:

python -m pip install id

Usage

You can run id as a Python module via python -m:

python -m id --help

Top-level:

usage: id [-h] [-V] [-v] audience

a tool for generating OIDC identities

positional arguments:
  audience       the OIDC audience to use

optional arguments:
  -h, --help     show this help message and exit
  -V, --version  show program's version number and exit
  -v, --verbose  run with additional debug logging; supply multiple times to
                 increase verbosity (default: 0)

For Python API usage, there is a single importable function, detect_credential:

>>> from id import detect_credential
>>> detect_credential(audience='something')
'<OIDC token>'

This function requires an audience parameter, which is used when generating the OIDC token. This should be set to the intended audience for the token.

Supported environments

id currently supports ambient credential detection in the following environments:

Licensing

id is licensed under the Apache 2.0 License.

Contributing

See the contributing docs for details.

SLSA Provenance

This project emits a SLSA provenance on its release! This enables you to verify the integrity of the downloaded artifacts and ensured that the binary's code really comes from this source code.

To do so, please follow the instructions here.

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

id-1.0.0a2.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

id-1.0.0a2-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file id-1.0.0a2.tar.gz.

File metadata

  • Download URL: id-1.0.0a2.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for id-1.0.0a2.tar.gz
Algorithm Hash digest
SHA256 968ba9403f7a897484751fefe54f5155237ab78ace87b91c394d7f7f52c941ac
MD5 63ae7f6acf10610d1b8a7873ce673bb6
BLAKE2b-256 27b2fd8bbd2106af0b954c93c5125615f00abaad9ad5f37c9df976907bf39852

See more details on using hashes here.

Provenance

File details

Details for the file id-1.0.0a2-py3-none-any.whl.

File metadata

  • Download URL: id-1.0.0a2-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for id-1.0.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 60df734019ac249a709f71847f4511b2816c7c3dc084b2fba4f228857cd599ff
MD5 3d24e207c30e1bab76885d0470358b41
BLAKE2b-256 139fc09181b4b0858b361b08eac233f0d1d658f0cf7baba3fc43dafcb1a618b9

See more details on using hashes here.

Provenance

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