包签名¶
警告
包签名插件处于预览版。有关更多信息,请参阅Conan 稳定性部分。
此插件必须位于缓存的 extensions/plugins/sign/sign.py
文件中,包含 2 个方法。
sign(ref, artifacts_folder, signature_folder, **kwargs)
对要上传到服务器的每个配方和包执行。ref
是工件的完整引用,可以是配方引用或包引用。artifacts_folder
是包含要上传文件的文件夹,通常是conanfile.py
、conan_package.tgz
、conanmanifest.txt
等。signature_folder
包含应写入生成文件的文件夹。当从服务器安装包时,
verify(ref, artifacts_folder, signature_folder, files, **kwargs)
执行,接收与上述相同的参数,并应用于验证签名的完整性或正确性。files
是一个可迭代的已下载文件,因为当包安装时,此函数可能会被调用两次:首先,安装配方,verify()
将与配方文件一起被调用,即conanfile.py
、conandata.yml
等。此外,当从源代码构建包时,配方导出的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
参数很重要,以避免未来添加新参数而导致插件损坏,请务必将其添加到您的方法中。