授权插件

警告

此特性是实验性的,可能会发生重大更改。请参阅 Conan 稳定性 部分以获取更多信息。

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

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

远程授权插件

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

该插件位于路径 <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'}

注意

这些插件可以使用 conan config installconan config install-pkg 命令共享和安装

重要: 确保您的插件和配置**不**包含硬编码的秘密或敏感数据。相反,应使用您通过秘密管理器的实现来检索密码。