1# 2# Copyright OpenEmbedded Contributors 3# 4# SPDX-License-Identifier: MIT 5# 6 7from oeqa.selftest.case import OESelftestTestCase 8from oeqa.utils.commands import runCmd, bitbake, get_bb_var, get_bb_vars, create_temp_layer 9import os 10import oe 11import glob 12import re 13import shutil 14import tempfile 15from contextlib import contextmanager 16from oeqa.utils.ftools import write_file 17 18 19class Signing(OESelftestTestCase): 20 21 gpg_dir = "" 22 pub_key_path = "" 23 secret_key_path = "" 24 25 def setup_gpg(self): 26 bitbake('gnupg-native -c addto_recipe_sysroot') 27 28 self.gpg_dir = tempfile.mkdtemp(prefix="oeqa-signing-") 29 self.track_for_cleanup(self.gpg_dir) 30 31 self.pub_key_path = os.path.join(self.testlayer_path, 'files', 'signing', "key.pub") 32 self.secret_key_path = os.path.join(self.testlayer_path, 'files', 'signing', "key.secret") 33 34 nsysroot = get_bb_var("RECIPE_SYSROOT_NATIVE", "gnupg-native") 35 36 runCmd('gpg --agent-program=`which gpg-agent`\|--auto-expand-secmem --batch --homedir %s --import %s %s' % (self.gpg_dir, self.pub_key_path, self.secret_key_path), native_sysroot=nsysroot) 37 return nsysroot + get_bb_var("bindir_native") 38 39 40 @contextmanager 41 def create_new_builddir(self, builddir, newbuilddir): 42 bb.utils.mkdirhier(newbuilddir) 43 oe.path.copytree(builddir + "/conf", newbuilddir + "/conf") 44 oe.path.copytree(builddir + "/cache", newbuilddir + "/cache") 45 46 origenv = os.environ.copy() 47 48 for e in os.environ: 49 if builddir + "/" in os.environ[e]: 50 os.environ[e] = os.environ[e].replace(builddir + "/", newbuilddir + "/") 51 if os.environ[e].endswith(builddir): 52 os.environ[e] = os.environ[e].replace(builddir, newbuilddir) 53 54 os.chdir(newbuilddir) 55 try: 56 yield 57 finally: 58 for e in origenv: 59 os.environ[e] = origenv[e] 60 os.chdir(builddir) 61 62 def test_signing_packages(self): 63 """ 64 Summary: Test that packages can be signed in the package feed 65 Expected: Package should be signed with the correct key 66 Expected: Images can be created from signed packages 67 Product: oe-core 68 Author: Daniel Istrate <daniel.alexandrux.istrate@intel.com> 69 Author: Alexander Kanavin <alex.kanavin@gmail.com> 70 AutomatedBy: Daniel Istrate <daniel.alexandrux.istrate@intel.com> 71 """ 72 import oe.packagedata 73 74 self.setup_gpg() 75 76 package_classes = get_bb_var('PACKAGE_CLASSES') 77 if 'package_rpm' not in package_classes: 78 self.skipTest('This test requires RPM Packaging.') 79 80 test_recipe = 'ed' 81 82 feature = 'INHERIT += "sign_rpm"\n' 83 feature += 'RPM_GPG_PASSPHRASE = "test123"\n' 84 feature += 'RPM_GPG_NAME = "testuser"\n' 85 feature += 'GPG_PATH = "%s"\n' % self.gpg_dir 86 feature += 'PACKAGECONFIG:append:pn-rpm-native = " sequoia"\n' 87 feature += 'PACKAGECONFIG:append:pn-rpm = " sequoia"\n' 88 89 self.write_config(feature) 90 91 bitbake('-c clean %s' % test_recipe) 92 bitbake('-f -c package_write_rpm %s' % test_recipe) 93 94 self.add_command_to_tearDown('bitbake -c clean %s' % test_recipe) 95 96 needed_vars = ['PKGDATA_DIR', 'DEPLOY_DIR_RPM', 'PACKAGE_ARCH', 'STAGING_BINDIR_NATIVE'] 97 bb_vars = get_bb_vars(needed_vars, test_recipe) 98 pkgdatadir = bb_vars['PKGDATA_DIR'] 99 pkgdata = oe.packagedata.read_pkgdatafile(pkgdatadir + "/runtime/ed") 100 if 'PKGE' in pkgdata: 101 pf = pkgdata['PN'] + "-" + pkgdata['PKGE'] + pkgdata['PKGV'] + '-' + pkgdata['PKGR'] 102 else: 103 pf = pkgdata['PN'] + "-" + pkgdata['PKGV'] + '-' + pkgdata['PKGR'] 104 deploy_dir_rpm = bb_vars['DEPLOY_DIR_RPM'] 105 package_arch = bb_vars['PACKAGE_ARCH'].replace('-', '_') 106 staging_bindir_native = bb_vars['STAGING_BINDIR_NATIVE'] 107 108 pkg_deploy = os.path.join(deploy_dir_rpm, package_arch, '.'.join((pf, package_arch, 'rpm'))) 109 110 # Use a temporary rpmdb 111 rpmdb = tempfile.mkdtemp(prefix='oeqa-rpmdb') 112 113 runCmd('%s/rpmkeys --define "_dbpath %s" --import %s' % 114 (staging_bindir_native, rpmdb, self.pub_key_path)) 115 116 ret = runCmd('%s/rpmkeys --define "_dbpath %s" --checksig %s' % 117 (staging_bindir_native, rpmdb, pkg_deploy)) 118 # tmp/deploy/rpm/i586/ed-1.9-r0.i586.rpm: rsa sha1 md5 OK 119 self.assertIn('digests signatures OK', ret.output, 'Package signed incorrectly.') 120 shutil.rmtree(rpmdb) 121 122 #Check that an image can be built from signed packages 123 self.add_command_to_tearDown('bitbake -c clean core-image-minimal') 124 bitbake('-c clean core-image-minimal') 125 bitbake('core-image-minimal') 126 127 128 def test_signing_sstate_archive(self): 129 """ 130 Summary: Test that sstate archives can be signed 131 Expected: Package should be signed with the correct key 132 Product: oe-core 133 Author: Daniel Istrate <daniel.alexandrux.istrate@intel.com> 134 AutomatedBy: Daniel Istrate <daniel.alexandrux.istrate@intel.com> 135 """ 136 137 test_recipe = 'ed' 138 139 # Since we need gpg but we can't use gpg-native for sstate signatures, we 140 # build gpg-native in our original builddir then run the tests in a second one. 141 builddir = os.environ.get('BUILDDIR') + "-testsign" 142 sstatedir = os.path.join(builddir, 'test-sstate') 143 144 nsysroot = self.setup_gpg() 145 146 feature = 'SSTATE_SIG_KEY ?= "testuser"\n' 147 feature += 'SSTATE_SIG_PASSPHRASE ?= "test123"\n' 148 feature += 'SSTATE_VERIFY_SIG ?= "1"\n' 149 feature += 'GPG_PATH = "%s"\n' % self.gpg_dir 150 feature += 'SSTATE_DIR = "%s"\n' % sstatedir 151 # Any mirror might have partial sstate without .sig files, triggering failures 152 feature += 'SSTATE_MIRRORS:forcevariable = ""\n' 153 154 self.write_config(feature) 155 156 with self.create_new_builddir(os.environ['BUILDDIR'], builddir): 157 158 os.environ["PATH"] = nsysroot + ":" + os.environ["PATH"] 159 self.add_command_to_tearDown('bitbake -c clean %s' % test_recipe) 160 self.add_command_to_tearDown('rm -rf %s' % sstatedir) 161 self.add_command_to_tearDown('rm -rf %s' % builddir) 162 163 bitbake('-c clean %s' % test_recipe) 164 bitbake('-c populate_lic %s' % test_recipe) 165 166 recipe_sig = glob.glob(sstatedir + '/*/*/*:ed:*_populate_lic.tar.zst.sig') 167 recipe_archive = glob.glob(sstatedir + '/*/*/*:ed:*_populate_lic.tar.zst') 168 169 self.assertEqual(len(recipe_sig), 1, 'Failed to find .sig file.') 170 self.assertEqual(len(recipe_archive), 1, 'Failed to find .tar.zst file.') 171 172 ret = runCmd('gpg --homedir %s --verify %s %s' % (self.gpg_dir, recipe_sig[0], recipe_archive[0])) 173 # gpg: Signature made Thu 22 Oct 2015 01:45:09 PM EEST using RSA key ID 61EEFB30 174 # gpg: Good signature from "testuser (nocomment) <testuser@email.com>" 175 self.assertIn('gpg: Good signature from', ret.output, 'Package signed incorrectly.') 176 177 178class LockedSignatures(OESelftestTestCase): 179 180 def test_locked_signatures(self): 181 """ 182 Summary: Test locked signature mechanism 183 Expected: Locked signatures will prevent task to run 184 Product: oe-core 185 Author: Daniel Istrate <daniel.alexandrux.istrate@intel.com> 186 AutomatedBy: Daniel Istrate <daniel.alexandrux.istrate@intel.com> 187 """ 188 189 import uuid 190 191 test_recipe = 'ed' 192 locked_sigs_file = 'locked-sigs.inc' 193 194 bitbake(test_recipe) 195 # Generate locked sigs include file 196 bitbake('-S lockedsigs %s' % test_recipe) 197 198 feature = 'require %s\n' % locked_sigs_file 199 feature += 'SIGGEN_LOCKEDSIGS_TASKSIG_CHECK = "warn"\n' 200 self.write_config(feature) 201 202 # Build a locked recipe 203 bitbake(test_recipe) 204 205 templayerdir = tempfile.mkdtemp(prefix='signingqa') 206 create_temp_layer(templayerdir, 'selftestsigning') 207 runCmd('bitbake-layers add-layer %s' % templayerdir) 208 209 # Make a change that should cause the locked task signature to change 210 # Use uuid so hash equivalance server isn't triggered 211 recipe_append_file = test_recipe + '_' + get_bb_var('PV', test_recipe) + '.bbappend' 212 recipe_append_path = os.path.join(templayerdir, 'recipes-test', test_recipe, recipe_append_file) 213 feature = 'SUMMARY:${PN} = "test locked signature%s"\n' % uuid.uuid4() 214 215 os.mkdir(os.path.join(templayerdir, 'recipes-test')) 216 os.mkdir(os.path.join(templayerdir, 'recipes-test', test_recipe)) 217 write_file(recipe_append_path, feature) 218 219 self.add_command_to_tearDown('bitbake-layers remove-layer %s' % templayerdir) 220 self.add_command_to_tearDown('rm -f %s' % os.path.join(self.builddir, locked_sigs_file)) 221 self.add_command_to_tearDown('rm -rf %s' % templayerdir) 222 223 # Build the recipe again 224 ret = bitbake(test_recipe) 225 226 # Verify you get the warning and that the real task *isn't* run (i.e. the locked signature has worked) 227 patt = r'The %s:do_package sig is computed to be \S+, but the sig is locked to \S+ in SIGGEN_LOCKEDSIGS\S+' % test_recipe 228 found_warn = re.search(patt, ret.output) 229 230 self.assertIsNotNone(found_warn, "Didn't find the expected warning message. Output: %s" % ret.output) 231