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