credentials.json

警告

此功能为实验性功能，可能会有重大变更。请参阅 Conan 稳定性 部分以获取更多信息。

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

  • 交互式命令行，当某些服务器启动未经授权的错误时，Conan 客户端将交互式地询问用户名/密码并重试。

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

  • 使用环境变量 CONAN_LOGIN_USERNAME （适用于所有远端仓库）(CONAN_LOGIN_USERNAME_{REMOTE} 适用于单个远端仓库) 和 CONAN_PASSWORD (CONAN_PASSWORD_{REMOTE} 适用于单个远端仓库)，Conan 将不会在必要时在命令行中交互式请求，而是从环境变量中获取值，就像用户提供的一样。

  • 将 credentials.json 文件放在 Conan 缓存中。

  • 使用自定义的 auth 插件。

本节介绍 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 导入进行 jinja 渲染，因此它允许使用 jinja 语法。例如，它可以执行以下操作以从环境变量中获取凭据

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

另请参阅