source_credentials.json

警告

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

当 conanfile.py recipe 使用 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 定义应与 recipe 中的 URL 匹配。如果 recipe 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 recipe 中使用编码了令牌或用户名/密码身份验证的 URL。这些 URL 很容易泄露到日志中，并且在凭据更改时可能更难修复（这对于 Git 仓库 URL 和克隆也同样适用，最好使用其他 Git 身份验证机制，如 SSH 密钥）

另请参阅