source_credentials.json

警告

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

当 conanfile.py 配方使用 download() 或 get() 助手从其他服务器下载某些源代码时，例如

def source(self):
    # Immutable source .zip
    download(self, f"https://server/that/need/credentials/files/tarballname-{self.version}.zip", "downloaded.zip")
    # Also the ``get()`` function, as it internally calls ``download()``

这些下载通常对于互联网上的开源第三方库是匿名的，但私有组织或供应商提供的某些专有代码也可能需要某种身份验证。

为此，可以在 Conan 缓存中提供 source_credentials.json 文件。此文件具有以下格式，其中每个 credentials 条目都应具有一个 url，用于定义应与配方 URL 匹配的 URL。如果配方 URL 以凭据文件中的给定 URL 开头，则将注入凭据。如果文件为多个 URL 提供多个凭据，则将按顺序评估它们，直到发生第一次匹配。如果未找到匹配项，则不会注入任何凭据。自定义 身份验证插件 也可用于直接从您自己的机密管理器中检索凭据。

需要注意的是，source_credentials 仅适用于使用 tools.files download() 和 get() 助手下载的文件，但在其他情况下不会使用它。要为 Conan 存储库提供凭据，应改用 credentials.json 文件，请参阅 credentials.json。

{
    "credentials": [
        {
            "url": "https://server/that/need/credentials",
            "token": "mytoken"
        }
    ]
}

使用 token 字段将添加一个 Authorization = Bearer {token} 标头。这将是首选的身份验证方式，因为它通常比使用用户名/密码更安全。

如果出于某种原因需要使用用户名/密码进行 HTTP 基本身份验证，则可以使用 user 和 password 字段提供。

{
    "credentials": [
        {
            "url": "https://server/that/need/credentials",
            "user": "myuser",
            "password": "mypassword"
        }
    ]
}

作为一般规则，强烈建议不要在文件中硬编码密码等机密信息。为了避免这种情况，source_credentials.json 文件始终呈现为 jinja 模板，因此它可以执行获取环境变量 os.getenv() 等操作，允许在系统或 CI 级别配置机密信息。

{% set mytk = os.getenv('mytoken') %}
{
    "credentials": [
        {
            "url": "https://server/that/need/credentials",
            "token": "{{mytk}}"
        }
    ]
}

注意

最佳实践

• 避免在 conanfile.py 配方中使用编码令牌或用户名/密码身份验证的 URL。这些 URL 很容易泄漏到日志中，并且在凭据更改的情况下更难以修复（这对于 Git 存储库 URL 和克隆也适用，最好使用其他 Git 身份验证机制，例如 ssh 密钥）。

另请参阅

• 如何为源服务器登录使用您自己的机密管理器.