credentials.json

警告

此功能是实验性的，可能会发生重大更改。有关更多信息，请参阅 Conan 稳定性 部分。

Conan 可以通过以下方式对 Conan 远程服务器进行身份验证：

  • 交互式命令行，当某个服务器抛出未经授权的错误时，Conan 客户端会交互式地请求用户/密码并重试。

  • 使用 conan remote login 命令，可以通过传递参数或交互式方式进行身份验证。

  • 使用环境变量 CONAN_LOGIN_USERNAME（适用于所有远程）或 CONAN_LOGIN_USERNAME_{REMOTE}（适用于特定远程）以及 CONAN_PASSWORD（适用于所有远程）或 CONAN_PASSWORD_{REMOTE}（适用于特定远程），Conan 在必要时将不会在命令行中进行交互式请求，而是像用户提供那样，使用环境变量中的值。

  • 使用位于 Conan 缓存中的 credentials.json 文件。

  • 使用自定义的 认证插件。

本节介绍 credentials.json 文件的用法。

该文件具有以下格式，其中每个 credentials 条目都应包含一个 remote 名称，该名称必须与 conan remote list 中定义的名称匹配。然后是 user 和 password 字段。

{
    "credentials": [
        {
            "remote": "default",
            "user": "admin",
            "password": "password"
        }
    ]
}

Conan 在必要时并经服务器请求时，能够自动从此文件中提取凭据。

注意

Conan 不会预先使用凭据在每次 Conan 命令中为每个定义的远程服务器自动强制登录。默认情况下，Conan 使用先前存储的令牌或匿名使用，直到执行显式的 conan remote login 命令，或者直到远程服务器抛出身份验证错误。发生这种情况时，将使用 credentials.json 文件、环境变量或用户的交互式输入来对该服务器进行身份验证。

凭据来源的优先级如下：

  • 如果 credentials.json 文件存在，则优先级更高，如果存在该远程的条目，则将使用它。如果不起作用，则会报错。

  • 如果在 credentials.json 中不存在该远程的条目，它将查找定义的环境变量。

  • 如果环境变量不存在，它将交互式地请求凭据。如果设置了 core:non_interactive=True，则会报错。

credentials.json 文件会使用注入的 platform 和 os imports 进行 Jinja 渲染，因此允许使用 Jinja 语法。例如，可以使用类似以下方式从环境变量中获取凭据：

{% set myuser = os.getenv('myuser') %}
{% set mytk = os.getenv('mytoken') %}
{
    "credentials": [
        {
            "remote": "myremote",
            "user": "{{myuser}}"
            "password": "{{mytk}}"
        }
    ]
}

另请参阅