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
87        self.write_config(feature)
88
89        bitbake('-c clean %s' % test_recipe)
90        bitbake('-f -c package_write_rpm %s' % test_recipe)
91
92        self.add_command_to_tearDown('bitbake -c clean %s' % test_recipe)
93
94        needed_vars = ['PKGDATA_DIR', 'DEPLOY_DIR_RPM', 'PACKAGE_ARCH', 'STAGING_BINDIR_NATIVE']
95        bb_vars = get_bb_vars(needed_vars, test_recipe)
96        pkgdatadir = bb_vars['PKGDATA_DIR']
97        pkgdata = oe.packagedata.read_pkgdatafile(pkgdatadir + "/runtime/ed")
98        if 'PKGE' in pkgdata:
99            pf = pkgdata['PN'] + "-" + pkgdata['PKGE'] + pkgdata['PKGV'] + '-' + pkgdata['PKGR']
100        else:
101            pf = pkgdata['PN'] + "-" + pkgdata['PKGV'] + '-' + pkgdata['PKGR']
102        deploy_dir_rpm = bb_vars['DEPLOY_DIR_RPM']
103        package_arch = bb_vars['PACKAGE_ARCH'].replace('-', '_')
104        staging_bindir_native = bb_vars['STAGING_BINDIR_NATIVE']
105
106        pkg_deploy = os.path.join(deploy_dir_rpm, package_arch, '.'.join((pf, package_arch, 'rpm')))
107
108        # Use a temporary rpmdb
109        rpmdb = tempfile.mkdtemp(prefix='oeqa-rpmdb')
110
111        runCmd('%s/rpmkeys --define "_dbpath %s" --import %s' %
112               (staging_bindir_native, rpmdb, self.pub_key_path))
113
114        ret = runCmd('%s/rpmkeys --define "_dbpath %s" --checksig %s' %
115                     (staging_bindir_native, rpmdb, pkg_deploy))
116        # tmp/deploy/rpm/i586/ed-1.9-r0.i586.rpm: rsa sha1 md5 OK
117        self.assertIn('digests signatures OK', ret.output, 'Package signed incorrectly.')
118        shutil.rmtree(rpmdb)
119
120        #Check that an image can be built from signed packages
121        self.add_command_to_tearDown('bitbake -c clean core-image-minimal')
122        bitbake('-c clean core-image-minimal')
123        bitbake('core-image-minimal')
124
125
126    def test_signing_sstate_archive(self):
127        """
128        Summary:     Test that sstate archives can be signed
129        Expected:    Package should be signed with the correct key
130        Product:     oe-core
131        Author:      Daniel Istrate <daniel.alexandrux.istrate@intel.com>
132        AutomatedBy: Daniel Istrate <daniel.alexandrux.istrate@intel.com>
133        """
134
135        test_recipe = 'ed'
136
137        # Since we need gpg but we can't use gpg-native for sstate signatures, we
138        # build gpg-native in our original builddir then run the tests in a second one.
139        builddir = os.environ.get('BUILDDIR') + "-testsign"
140        sstatedir = os.path.join(builddir, 'test-sstate')
141
142        nsysroot = self.setup_gpg()
143
144        feature = 'SSTATE_SIG_KEY ?= "testuser"\n'
145        feature += 'SSTATE_SIG_PASSPHRASE ?= "test123"\n'
146        feature += 'SSTATE_VERIFY_SIG ?= "1"\n'
147        feature += 'GPG_PATH = "%s"\n' % self.gpg_dir
148        feature += 'SSTATE_DIR = "%s"\n' % sstatedir
149        # Any mirror might have partial sstate without .sig files, triggering failures
150        feature += 'SSTATE_MIRRORS:forcevariable = ""\n'
151
152        self.write_config(feature)
153
154        with self.create_new_builddir(os.environ['BUILDDIR'], builddir):
155
156            os.environ["PATH"] = nsysroot + ":" + os.environ["PATH"]
157            self.add_command_to_tearDown('bitbake -c clean %s' % test_recipe)
158            self.add_command_to_tearDown('rm -rf %s' % sstatedir)
159            self.add_command_to_tearDown('rm -rf %s' % builddir)
160
161            bitbake('-c clean %s' % test_recipe)
162            bitbake('-c populate_lic %s' % test_recipe)
163
164            recipe_sig = glob.glob(sstatedir + '/*/*/*:ed:*_populate_lic.tar.zst.sig')
165            recipe_archive = glob.glob(sstatedir + '/*/*/*:ed:*_populate_lic.tar.zst')
166
167            self.assertEqual(len(recipe_sig), 1, 'Failed to find .sig file.')
168            self.assertEqual(len(recipe_archive), 1, 'Failed to find .tar.zst file.')
169
170            ret = runCmd('gpg --homedir %s --verify %s %s' % (self.gpg_dir, recipe_sig[0], recipe_archive[0]))
171            # gpg: Signature made Thu 22 Oct 2015 01:45:09 PM EEST using RSA key ID 61EEFB30
172            # gpg: Good signature from "testuser (nocomment) <testuser@email.com>"
173            self.assertIn('gpg: Good signature from', ret.output, 'Package signed incorrectly.')
174
175
176class LockedSignatures(OESelftestTestCase):
177
178    def test_locked_signatures(self):
179        """
180        Summary:     Test locked signature mechanism
181        Expected:    Locked signatures will prevent task to run
182        Product:     oe-core
183        Author:      Daniel Istrate <daniel.alexandrux.istrate@intel.com>
184        AutomatedBy: Daniel Istrate <daniel.alexandrux.istrate@intel.com>
185        """
186
187        import uuid
188
189        test_recipe = 'ed'
190        locked_sigs_file = 'locked-sigs.inc'
191
192        bitbake(test_recipe)
193        # Generate locked sigs include file
194        bitbake('-S lockedsigs %s' % test_recipe)
195
196        feature = 'require %s\n' % locked_sigs_file
197        feature += 'SIGGEN_LOCKEDSIGS_TASKSIG_CHECK = "warn"\n'
198        self.write_config(feature)
199
200        # Build a locked recipe
201        bitbake(test_recipe)
202
203        templayerdir = tempfile.mkdtemp(prefix='signingqa')
204        create_temp_layer(templayerdir, 'selftestsigning')
205        runCmd('bitbake-layers add-layer %s' % templayerdir)
206
207        # Make a change that should cause the locked task signature to change
208        # Use uuid so hash equivalance server isn't triggered
209        recipe_append_file = test_recipe + '_' + get_bb_var('PV', test_recipe) + '.bbappend'
210        recipe_append_path = os.path.join(templayerdir, 'recipes-test', test_recipe, recipe_append_file)
211        feature = 'SUMMARY:${PN} = "test locked signature%s"\n' % uuid.uuid4()
212
213        os.mkdir(os.path.join(templayerdir, 'recipes-test'))
214        os.mkdir(os.path.join(templayerdir, 'recipes-test', test_recipe))
215        write_file(recipe_append_path, feature)
216
217        self.add_command_to_tearDown('bitbake-layers remove-layer %s' % templayerdir)
218        self.add_command_to_tearDown('rm -f %s' % os.path.join(self.builddir, locked_sigs_file))
219        self.add_command_to_tearDown('rm -rf %s' % templayerdir)
220
221        # Build the recipe again
222        ret = bitbake(test_recipe)
223
224        # Verify you get the warning and that the real task *isn't* run (i.e. the locked signature has worked)
225        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
226        found_warn = re.search(patt, ret.output)
227
228        self.assertIsNotNone(found_warn, "Didn't find the expected warning message. Output: %s" % ret.output)
229