id

id 是一个用于生成OIDC身份的Python工具。它可以在多个环境中自动检测和生成OIDC凭证，包括GitHub Actions、GitLab管道和Google Cloud。

安装

id 需要 Python 3.8 或更高版本，可以通过 pip 直接安装

python -m pip install id

用法

您可以通过 python -m 将 id 作为Python模块运行

python -m id --help

顶层

usage: id [-h] [-V] [-v] [-d] 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)
  -d, --decode   decode the OIDC token into JSON (default: False)

对于Python API用法，有一个可导入的函数，detect_credential

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

此函数需要一个 audience 参数，该参数用于生成OIDC令牌。这应设置为令牌的目标受众。

如果没有找到支持的环境，则 detect_credential 返回 None。如果找到支持的环境但 detect_credential 无法检索令牌，则引发 AmbientCredentialError。

支持的环境

id 目前支持以下环境中的环境凭证检测

• GitHub Actions
• Google Cloud
  • Cloud Run
  • Google Kubernetes Engine
  • Compute Engine
  • 等等
• Buildkite
• GitLab （见下文 环境变量）
• CircleCI

环境变量中的令牌

GitLab 通过环境变量提供 OIDC 令牌。变量名必须是 <AUD>_ID_TOKEN，其中 <AUD> 是大写的受众参数，其中所有非 ASCII 字母和数字字符都被替换为 "_"。必须也将开头的数字替换为 "_"。

许可

id 采用 Apache 2.0 许可证。

贡献

有关详细信息，请参阅 贡献文档。

SLSA 原因

该项目在其发布时发出 SLSA 原因！这使您能够验证下载的工件的真实性，并确保二进制代码确实来自此源代码。

要这样做，请按照以下说明操作 这里。