包签名

警告

包签名插件处于预览状态。请参阅 Conan 稳定性 部分以获取更多信息。

此插件必须位于缓存的 extensions/plugins/sign/sign.py 文件中,它包含 2 个方法

  • sign(ref, artifacts_folder, signature_folder, **kwargs) 在每个要上传到服务器的配方和包上执行。ref 是构件的完整引用,它可以是配方引用或包引用。artifacts_folder 是包含要上传的文件的文件夹,通常是 conanfile.pyconan_package.tgzconanmanifest.txt 等。signature_folder 包含应在其中写入生成文件的文件夹。

  • verify(ref, artifacts_folder, signature_folder, files, **kwargs) 在从服务器安装包时执行,接收与上面相同的参数,并应用于验证签名的完整性或正确性。files 是下载文件的可迭代对象,因为当安装包时此函数可以被调用两次:首先,安装配方,并且将使用配方文件(即 conanfile.pyconandata.yml 等)调用 verify()。此外,当从源构建包时,可能会下载配方导出的 conan_sources.tgz 文件,并且将再次调用 verify() 函数,这次 files 参数仅包含 conan_sources.tgz

以下是一个包签名器的示例,它在上传包时将构件文件名放入名为 signature.asc 的文件中,并断言下载的构件位于下载的 signature.asc

import os

def sign(ref, artifacts_folder, signature_folder, **kwargs):
    print("Signing ref: ", ref)
    print("Signing folder: ", artifacts_folder)
    files = []
    for f in sorted(os.listdir(artifacts_folder)):
        if os.path.isfile(os.path.join(artifacts_folder, f)):
            files.append(f)
    signature = os.path.join(signature_folder, "signature.asc")
    open(signature, "w").write("\n".join(files))

def verify(ref, artifacts_folder, signature_folder, files, **kwargs):
    print("Verifying ref: ", ref)
    print("Verifying folder: ", artifacts_folder)
    signature = os.path.join(signature_folder, "signature.asc")
    contents = open(signature).read()
    print("verifying contents", contents)
    for f in files:
        print("VERIFYING ", f)
        if os.path.isfile(os.path.join(artifacts_folder, f)):
            assert f in contents

请注意,**kwargs 参数对于避免未来添加新参数而导致插件中断非常重要,请确保将其添加到您的方法中。