summaryrefslogtreecommitdiffstats
path: root/meta/lib/oe/gpg_sign.py
blob: 447c23be292cc7ea7e50b53d947e1d2ea224591d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
"""Helper module for GPG signing"""
import os

import bb
import oe.utils

class LocalSigner(object):
    """Class for handling local (on the build host) signing"""
    def __init__(self, d, keyid, passphrase_file):
        self.keyid = keyid
        self.passphrase_file = passphrase_file
        self.gpg_bin = d.getVar('GPG_BIN', True) or \
                  bb.utils.which(os.getenv('PATH'), 'gpg')
        self.gpg_path = d.getVar('GPG_PATH', True)
        self.rpm_bin = bb.utils.which(os.getenv('PATH'), "rpm")

    def export_pubkey(self, output_file):
        """Export GPG public key to a file"""
        cmd = '%s --batch --yes --export --armor -o %s ' % \
                (self.gpg_bin, output_file)
        if self.gpg_path:
            cmd += "--homedir %s " % self.gpg_path
        cmd += self.keyid
        status, output = oe.utils.getstatusoutput(cmd)
        if status:
            raise bb.build.FuncFailed('Failed to export gpg public key (%s): %s' %
                                      (self.keyid, output))

    def sign_rpms(self, files):
        """Sign RPM files"""
        import pexpect

        cmd = self.rpm_bin + " --addsign --define '_gpg_name %s' " % self.keyid
        if self.gpg_bin:
            cmd += "--define '%%__gpg %s' " % self.gpg_bin
        if self.gpg_path:
            cmd += "--define '_gpg_path %s' " % self.gpg_path
        cmd += ' '.join(files)

        # Need to use pexpect for feeding the passphrase
        proc = pexpect.spawn(cmd)
        try:
            proc.expect_exact('Enter pass phrase:', timeout=15)
            with open(self.passphrase_file) as fobj:
                proc.sendline(fobj.readline().rstrip('\n'))
            proc.expect(pexpect.EOF, timeout=900)
            proc.close()
        except pexpect.TIMEOUT as err:
            bb.error('rpmsign timeout: %s' % err)
            proc.terminate()
        if os.WEXITSTATUS(proc.status) or not os.WIFEXITED(proc.status):
            bb.error('rpmsign failed: %s' % proc.before.strip())
            raise bb.build.FuncFailed("Failed to sign RPM packages")

    def detach_sign(self, input_file):
        """Create a detached signature of a file"""
        cmd = "%s --detach-sign --armor --batch --no-tty --yes " \
                  "--passphrase-file '%s' -u '%s' " % \
                  (self.gpg_bin, self.passphrase_file, self.keyid)
        if self.gpg_path:
            gpg_cmd += "--homedir %s " % self.gpg_path
        cmd += input_file
        status, output = oe.utils.getstatusoutput(cmd)
        if status:
            raise bb.build.FuncFailed("Failed to create signature for '%s': %s" %
                                      (input_file, output))


class ObsSigner(object):
    """Class for handling signing with obs-signd"""
    def __init__(self, d, keyid):
        self.keyid = keyid
        self.rpm_bin = bb.utils.which(os.getenv('PATH'), "rpm")
        self.del_old_sign = d.getVar('OBSSIGN_DELSIGN', True) == "1"

    def export_pubkey(self, output_file):
        """Export GPG public key to a file"""
        cmd = "sign -u '%s' -p" % self.keyid
        status, output = oe.utils.getstatusoutput(cmd)
        if status:
            raise bb.build.FuncFailed('Failed to export gpg public key (%s): %s' %
                                      (self.keyid, output))
        with open(output_file, 'w') as fobj:
            fobj.write(output)
            fobj.write('\n')

    def sign_rpms(self, files):
        """Sign RPM files"""
        import pexpect

        # Remove existing signatures. This is a workaround for a limitation
        # of obs-signd: sign is not able to add additional signatures and fails
        # if existing signatures are found in the RPM package.
        if self.del_old_sign:
            cmd = "%s --delsign %s" % (self.rpm_bin, ' '.join(files))
            status, output = oe.utils.getstatusoutput(cmd)
            if status:
                raise bb.build.FuncFailed("Failed to remove RPM signatures: %s" %
                                          output)
        # Sign packages
        cmd = "sign -u '%s' -r %s" % (self.keyid, ' '.join(files))
        status, output = oe.utils.getstatusoutput(cmd)
        if status or [line for line in output.splitlines() if line.endswith('already signed')]:
            raise bb.build.FuncFailed("Failed to sign RPM packages: %s" %
                                      output)

    def detach_sign(self, input_file):
        """Create a detached signature of a file"""
        cmd = "sign -u '%s' -d %s" % (self.keyid, input_file)
        status, output = oe.utils.getstatusoutput(cmd)
        if status:
            raise bb.build.FuncFailed("Failed to create signature for '%s': %s" %
                                      (input_file, output))


def get_signer(d, backend, keyid, passphrase_file):
    """Get signer object for the specified backend"""
    # Use local signing by default
    if backend == 'local':
        return LocalSigner(d, keyid, passphrase_file)
    elif backend == 'obssign':
        if passphrase_file:
            bb.note("GPG passphrase file setting not used when 'obssign' "
                    "backend is used.")
        return ObsSigner(d, keyid)
    else:
        bb.fatal("Unsupported signing backend '%s'" % backend)