授权插件¶

警告

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

关于授权，我们有两个插件：一个专注于远程 Conan 服务器授权，auth_remote.py，另一个专注于源文件服务器的授权，auth_source.py。

这些插件的目的是创建与每个用户密钥管理器的自定义集成。

远程授权插件¶

第一个插件是一个 Python 脚本，它接收一个 Remote 对象和一个可选参数：user。如果提供了用户，则期望的输出是使用该用户名的凭据。输出应该是一个元组，包含要用于该远程的用户名，或者 None，如果未为该远程指定凭据，并且希望 Conan 遵循正常的登录流程。

该插件位于路径 <CONAN_HOME>/extensions/plugins/auth_remote.py，必须手动创建，名称为 auth_remote.py，包含一个名为 auth_remote_plugin(remote, user=None, **kwargs) 的函数。

检索凭据的顺序如下

首先，尝试从 auth_remote_plugin 获取凭据。
如果不存在或返回 None，下一步是检查 credentials.json。
之后，搜索环境变量。
最后，通过交互式提示获取凭据。

这里我们可以看到一个插件实现的示例。

def auth_remote_plugin(remote, user=None, **kwargs):
    if remote.url.startswith("https://artifactory.my-org/"):
        return "admin", "password"

源授权插件¶

这是一个 Python 脚本，它接收一个 url 作为参数，并输出一个包含凭据或访问令牌的字典。它也可以返回 None，以指示 Conan 应该继续其正常的登录流程。

该插件位于路径 <CONAN_HOME>/extensions/plugins/auth_source.py，必须手动创建，名称为 auth_source.py，包含一个名为 auth_source_plugin(url, **kwargs) 的函数。

检索凭据的顺序如下

首先，尝试从 auth_source_plugin 获取凭据。
如果不存在或返回 None，则尝试从 source_credentials.json 检索它们。

这里我们可以看到一个插件实现的示例。

def auth_source_plugin(url, **kwargs):
    if url.startswith("https://my-sources-user-password.my-org/"):
        return {'user': 'my-user', 'password': 'my-password'}
    elif url.startswith("https://my-private-token-sources.my-org/"):
        return {'token': 'my-secure-token'}

此外，返回一个 headers 字典会将内容作为 HTTP 标头添加到源请求中，因为某些服务器可能需要一些特定的自定义标头。

def auth_source_plugin(url, **kwargs):
    if url.startswith("https://my-private-token-sources-with-headers.my-org/"):
        return {'token': 'my-secure-token', 'headers': {'my-header-1': 'my-value-1'}}

注意

这些插件可以使用 conan config install 或 conan config install-pkg 进行共享和安装。

重要提示： 确保您的插件和配置不包含硬编码的密钥或敏感数据。相反，密码应使用您的实现与密钥管理器检索。