IPK signing for the gpg_sign module

Implement ipk signing inside the sign_ipk bbclass using the gpg_sign module and configure signing similar to how rpm does it. sign_ipk uses
gpg_sign's detach_sign because its functionality is identical to package
feed signing.

IPK signing process is a bit different from rpm:
- Signatures are stored outside ipk files; opkg connects to a
feed
server and downloads them to verify a package.
- Signatures are of two types (both supported by opkg): binary or
ascii armoured. By default we sign using ascii armoured.
- Public keys are stored on targets to verify ipks using the
opkg-keyrings recipe.

Signed-off-by Ioan-Adrian Ratiu <[email protected]>

---
 meta/classes/package_ipk.bbclass |  5 ++++
 meta/classes/sign_ipk.bbclass    | 52
++++++++++++++++++++++++++++++++++++++++
 meta/lib/oe/gpg_sign.py          | 50 ++++++++++++++++++++++++++++--
--------
 3 files changed, 94 insertions(+), 13 deletions(-)
 create mode 100644 meta/classes/sign_ipk.bbclass

meta/classes/package_ipk.bbclass +5 -0

index 51bee28..f64837a 100644
@@ -246,6 +246,11 @@ python do_package_ipk () {
             bb.utils.unlockfile(lf)
             raise bb.build.FuncFailed("opkg-build execution failed")
 
+        if d.getVar('IPK_SIGN_PACKAGES', True) == '1':
+            ipkver = "%s-%s" % (d.getVar('PKGV'), d.getVar('PKGR'))
+            ipk_to_sign = "%s/%s_%s_%s.ipk" % (pkgoutdir, pkgname,
 ipkver, d.getVar('PACKAGE_ARCH', True))
+            sign_ipk(d, ipk_to_sign)
+
         cleanupcontrol(root)
         bb.utils.unlockfile(lf)

meta/classes/sign_ipk.bbclass new file +5 -0

new file mode 100644
index 0000000..a481f6d
@@ -0,0 +1,52 @@
+# Class for generating signed IPK packages.
+#
+# Configuration variables used by this class:
+# IPK_GPG_PASSPHRASE_FILE
+#           Path to a file containing the passphrase of the signing

key.

meta/classes/sign_ipk.bbclass new file +4 -0

+# IPK_GPG_NAME
+#           Name of the key to sign with.
+# IPK_GPG_BACKEND
+#           Optional variable for specifying the backend to use for

signing.
+# Currently the only available option is 'local', i.e.
local signing

meta/classes/sign_ipk.bbclass new file +3 -0

+#           on the build host.
+# IPK_GPG_SIGNATURE_TYPE
+#           Optional variable for specifying the type of gpg

signatures, can be:

meta/classes/sign_ipk.bbclass new file +4 -0

+#                     1. Ascii armored (ASC), default if not set
+#                     2. Binary (BIN)
+# GPG_BIN
+#           Optional variable for specifying the gpg binary/wrapper

to use for

meta/classes/sign_ipk.bbclass new file +3 -0

+#           signing.
+# GPG_PATH
+#           Optional variable for specifying the gnupg "home"

directory:

meta/classes/sign_ipk.bbclass new file +13 -0

+#
+
+inherit sanity
+
+IPK_SIGN_PACKAGES = '1'
+IPK_GPG_BACKEND ?= 'local'
+IPK_GPG_SIGNATURE_TYPE ?= 'ASC'
+
+python () {
+    # Check configuration
+    for var in ('IPK_GPG_NAME', 'IPK_GPG_PASSPHRASE_FILE'):
+        if not d.getVar(var, True):
+            raise_sanity_error("You need to define %s in the config"

% var, d)

meta/classes/sign_ipk.bbclass new file +4 -0

+
+    sigtype = d.getVar("IPK_GPG_SIGNATURE_TYPE", True)
+    if sigtype.upper() != "ASC" and sigtype.upper() != "BIN":
+        raise_sanity_error("Bad value for IPK_GPG_SIGNATURE_TYPE

(%s), use either ASC or BIN" % sigtype)

meta/classes/sign_ipk.bbclass new file +15 -0

+}
+
+def sign_ipk(d, ipk_to_sign):
+    from oe.gpg_sign import get_signer
+
+    bb.debug(1, 'Signing ipk: %s' % ipk_to_sign)
+
+    signer = get_signer(d, d.getVar('IPK_GPG_BACKEND', True))
+    sig_type = d.getVar('IPK_GPG_SIGNATURE_TYPE', True)
+    is_ascii_sig = (sig_type.upper() != "BIN")
+
+    signer.detach_sign(ipk_to_sign,
+                       d.getVar('IPK_GPG_NAME', True),
+                       d.getVar('IPK_GPG_PASSPHRASE_FILE', True),
+                       armor=is_ascii_sig)

meta/lib/oe/gpg_sign.py +2 -0

index ada1b2f..ef47d1a 100644
@@ -1,5 +1,6 @@
 """Helper module for GPG signing"""
 import os
+import sys
 
 import bb
 import oe.utils

@@ -50,6 +51,7 @@ class LocalSigner(object):
             bb.error('rpmsign failed: %s' % proc.before.strip())
             raise bb.build.FuncFailed("Failed to sign RPM packages")
 
+
     def detach_sign(self, input_file, keyid, passphrase_file,

passphrase=None, armor=True):
"""Create a detached signature of a file""" import subprocess

meta/lib/oe/gpg_sign.py +1 -6

@@ -57,23 +59,45 @@ class LocalSigner(object):
         if passphrase_file and passphrase:
             raise Exception("You should use either passphrase_file
 of passphrase, not both")
 
-        cmd = [self.gpg_bin, '--detach-sign', '--batch', '--no-tty',
 '--yes',
-               '-u', keyid]
-        if passphrase_file:
-            cmd += ['--passphrase-file', passphrase_file]
-        else:
-            cmd += ['--passphrase-fd', '0']
+        cmd = [self.gpg_bin, '--detach-sign', '--batch', '--no-tty',

'--yes', '-u', keyid]

meta/lib/oe/gpg_sign.py +1 -2

+
         if self.gpg_path:
             cmd += ['--homedir', self.gpg_path]
         if armor:
             cmd += ['--armor']
-        cmd.append(input_file)
-        job = subprocess.Popen(cmd, stdin=subprocess.PIPE,

stdout=subprocess.PIPE,

meta/lib/oe/gpg_sign.py +0 -4

-                               stderr=subprocess.PIPE)
-        _, stderr = job.communicate(passphrase)
-        if job.returncode:
-            raise bb.build.FuncFailed("Failed to create signature

for '%s': %s" %

meta/lib/oe/gpg_sign.py +14 -1

-                                      (input_file, stderr))
+
+        try:
+            keypipe = os.pipe()
+
+            if passphrase_file:
+                with open(passphrase_file) as fobj:
+                    os.write(keypipe[1], fobj.readline());
+            else:
+                os.write(keypipe[1], passphrase)
+
+            cmd += ["--passphrase-fd",  str(keypipe[0])]
+            cmd += [input_file]
+
+            job = subprocess.Popen(cmd, stdin=subprocess.PIPE,

stderr=subprocess.PIPE)

meta/lib/oe/gpg_sign.py +3 -0

+
+            if job.returncode:
+                raise bb.build.FuncFailed("GPG exited with code %d:

%s" %

meta/lib/oe/gpg_sign.py +10 -0

+                                          (job.returncode, stderr))
+
+        except IOError as e:
+            bb.error("IO error (%s): %s" % (e.errno, e.strerror))
+            raise Exception("Failed to sign '%s'" % input_file)
+        except OSError as e:
+            bb.error("OS error (%s): %s" % (e.errno, e.strerror))
+            raise Exception("Failed to sign '%s" % input_file)
+        except:
+            bb.error("Unexpected error (%s): %s" %

(sys.exc_info()[0], sys.exc_info()[1]))

meta/lib/oe/gpg_sign.py +2 -0

+            raise Exception("Failed to sign '%s'" % input_file)
+
 
     def verify(self, sig_file):
         """Verify signature"""

Quoted 176 lines · Ioan-Adrian Ratiu

Implement ipk signing inside the sign_ipk bbclass using the gpg_sign module and configure signing similar to how rpm does it. sign_ipk uses
gpg_sign's detach_sign because its functionality is identical to package
feed signing.

IPK signing process is a bit different from rpm:
- Signatures are stored outside ipk files; opkg connects to a
feed
server and downloads them to verify a package.
- Signatures are of two types (both supported by opkg): binary or
ascii armoured. By default we sign using ascii armoured.
- Public keys are stored on targets to verify ipks using the
opkg-keyrings recipe.

Signed-off-by Ioan-Adrian Ratiu <[email protected]>

---
 meta/classes/package_ipk.bbclass |  5 ++++
 meta/classes/sign_ipk.bbclass    | 52
++++++++++++++++++++++++++++++++++++++++
 meta/lib/oe/gpg_sign.py          | 50 ++++++++++++++++++++++++++++--
--------
 3 files changed, 94 insertions(+), 13 deletions(-)
 create mode 100644 meta/classes/sign_ipk.bbclass

meta/classes/package_ipk.bbclass +5 -0

index 51bee28..f64837a 100644
@@ -246,6 +246,11 @@ python do_package_ipk () {
             bb.utils.unlockfile(lf)
             raise bb.build.FuncFailed("opkg-build execution failed")
 
+        if d.getVar('IPK_SIGN_PACKAGES', True) == '1':
+            ipkver = "%s-%s" % (d.getVar('PKGV'), d.getVar('PKGR'))
+            ipk_to_sign = "%s/%s_%s_%s.ipk" % (pkgoutdir, pkgname,
 ipkver, d.getVar('PACKAGE_ARCH', True))
+            sign_ipk(d, ipk_to_sign)
+
         cleanupcontrol(root)
         bb.utils.unlockfile(lf)

meta/classes/sign_ipk.bbclass new file +5 -0

new file mode 100644
index 0000000..a481f6d
@@ -0,0 +1,52 @@
+# Class for generating signed IPK packages.
+#
+# Configuration variables used by this class:
+# IPK_GPG_PASSPHRASE_FILE
+#           Path to a file containing the passphrase of the signing

key.

meta/classes/sign_ipk.bbclass new file +4 -0

+# IPK_GPG_NAME
+#           Name of the key to sign with.
+# IPK_GPG_BACKEND
+#           Optional variable for specifying the backend to use for

signing.
+# Currently the only available option is 'local', i.e.
local signing

meta/classes/sign_ipk.bbclass new file +3 -0

+#           on the build host.
+# IPK_GPG_SIGNATURE_TYPE
+#           Optional variable for specifying the type of gpg

signatures, can be:

meta/classes/sign_ipk.bbclass new file +4 -0

+#                     1. Ascii armored (ASC), default if not set
+#                     2. Binary (BIN)
+# GPG_BIN
+#           Optional variable for specifying the gpg binary/wrapper

to use for

meta/classes/sign_ipk.bbclass new file +3 -0

+#           signing.
+# GPG_PATH
+#           Optional variable for specifying the gnupg "home"

directory:

meta/classes/sign_ipk.bbclass new file +13 -0

+#
+
+inherit sanity
+
+IPK_SIGN_PACKAGES = '1'
+IPK_GPG_BACKEND ?= 'local'
+IPK_GPG_SIGNATURE_TYPE ?= 'ASC'
+
+python () {
+    # Check configuration
+    for var in ('IPK_GPG_NAME', 'IPK_GPG_PASSPHRASE_FILE'):
+        if not d.getVar(var, True):
+            raise_sanity_error("You need to define %s in the config"

% var, d)

meta/classes/sign_ipk.bbclass new file +4 -0

+
+    sigtype = d.getVar("IPK_GPG_SIGNATURE_TYPE", True)
+    if sigtype.upper() != "ASC" and sigtype.upper() != "BIN":
+        raise_sanity_error("Bad value for IPK_GPG_SIGNATURE_TYPE

(%s), use either ASC or BIN" % sigtype)

meta/classes/sign_ipk.bbclass new file +15 -0

+}
+
+def sign_ipk(d, ipk_to_sign):
+    from oe.gpg_sign import get_signer
+
+    bb.debug(1, 'Signing ipk: %s' % ipk_to_sign)
+
+    signer = get_signer(d, d.getVar('IPK_GPG_BACKEND', True))
+    sig_type = d.getVar('IPK_GPG_SIGNATURE_TYPE', True)
+    is_ascii_sig = (sig_type.upper() != "BIN")
+
+    signer.detach_sign(ipk_to_sign,
+                       d.getVar('IPK_GPG_NAME', True),
+                       d.getVar('IPK_GPG_PASSPHRASE_FILE', True),
+                       armor=is_ascii_sig)

meta/lib/oe/gpg_sign.py +2 -0

index ada1b2f..ef47d1a 100644
@@ -1,5 +1,6 @@
 """Helper module for GPG signing"""
 import os
+import sys
 
 import bb
 import oe.utils

@@ -50,6 +51,7 @@ class LocalSigner(object):
             bb.error('rpmsign failed: %s' % proc.before.strip())
             raise bb.build.FuncFailed("Failed to sign RPM packages")
 
+
     def detach_sign(self, input_file, keyid, passphrase_file,

passphrase=None, armor=True):
"""Create a detached signature of a file""" import subprocess

meta/lib/oe/gpg_sign.py +1 -6

@@ -57,23 +59,45 @@ class LocalSigner(object):
         if passphrase_file and passphrase:
             raise Exception("You should use either passphrase_file
 of passphrase, not both")
 
-        cmd = [self.gpg_bin, '--detach-sign', '--batch', '--no-tty',
 '--yes',
-               '-u', keyid]
-        if passphrase_file:
-            cmd += ['--passphrase-file', passphrase_file]
-        else:
-            cmd += ['--passphrase-fd', '0']
+        cmd = [self.gpg_bin, '--detach-sign', '--batch', '--no-tty',

'--yes', '-u', keyid]

meta/lib/oe/gpg_sign.py +1 -2

+
         if self.gpg_path:
             cmd += ['--homedir', self.gpg_path]
         if armor:
             cmd += ['--armor']
-        cmd.append(input_file)
-        job = subprocess.Popen(cmd, stdin=subprocess.PIPE,

stdout=subprocess.PIPE,

meta/lib/oe/gpg_sign.py +0 -4

-                               stderr=subprocess.PIPE)
-        _, stderr = job.communicate(passphrase)
-        if job.returncode:
-            raise bb.build.FuncFailed("Failed to create signature

for '%s': %s" %

meta/lib/oe/gpg_sign.py +14 -1

-                                      (input_file, stderr))
+
+        try:
+            keypipe = os.pipe()
+
+            if passphrase_file:
+                with open(passphrase_file) as fobj:
+                    os.write(keypipe[1], fobj.readline());
+            else:
+                os.write(keypipe[1], passphrase)
+
+            cmd += ["--passphrase-fd",  str(keypipe[0])]
+            cmd += [input_file]
+
+            job = subprocess.Popen(cmd, stdin=subprocess.PIPE,

stderr=subprocess.PIPE)

meta/lib/oe/gpg_sign.py +2 -0

+            (_, stderr) = job.communicate(passphrase)
+

meta/lib/oe/gpg_sign.py class LocalSigner(object): · line 85

Quoted 2 lines

meta/lib/oe/gpg_sign.py +2 -0

+            os.close(keypipe[1])
+            os.close(keypipe[0])  

I still fail to see why you want to complicate the code with os.pipe. Why not ditch pipe and just do something like:
if passphrase_file:
with open(passphrase_file) as fobj:
_, stderr = job.communicate(fobj.readline())

Thanks,
Markus

Quoted 20 lines

meta/lib/oe/gpg_sign.py +3 -0

+
+            if job.returncode:
+                raise bb.build.FuncFailed("GPG exited with code %d:

%s" %

meta/lib/oe/gpg_sign.py +10 -0

+                                          (job.returncode, stderr))
+
+        except IOError as e:
+            bb.error("IO error (%s): %s" % (e.errno, e.strerror))
+            raise Exception("Failed to sign '%s'" % input_file)
+        except OSError as e:
+            bb.error("OS error (%s): %s" % (e.errno, e.strerror))
+            raise Exception("Failed to sign '%s" % input_file)
+        except:
+            bb.error("Unexpected error (%s): %s" %

(sys.exc_info()[0], sys.exc_info()[1]))

meta/lib/oe/gpg_sign.py +2 -0

+            raise Exception("Failed to sign '%s'" % input_file)
+
 
     def verify(self, sig_file):
         """Verify signature"""  

Starting from v2.1 passing passwords directly to gpg does not work anymore [1], instead a loopback interface must be used otherwise gpg >2.1 will error out with:
"gpg: signing failed: Inappropriate ioctl for device"

gpg <2.1 does not work with the new --pinentry-mode arg and gives an invalid option error, so we detect what is the running version of gpg and pass it accordingly.

[1] https://wiki.archlinux.org/index.php/GnuPG#Unattended_passphrase

Signed-off-by Ioan-Adrian Ratiu <[email protected]>

---
 meta/lib/oe/gpg_sign.py | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

meta/lib/oe/gpg_sign.py +1 -0

index ef47d1a..9f6b0f0 100644
@@ -66,6 +66,12 @@ class LocalSigner(object):
         if armor:
             cmd += ['--armor']
 
+        #gpg > 2.1 supports password pipes only through the loopback

interface

try:
keypipe = os.pipe()

meta/lib/oe/gpg_sign.py +9 -0

@@ -99,6 +105,20 @@ class LocalSigner(object):
             raise Exception("Failed to sign '%s'" % input_file)
 
 
+    def get_gpg_version(self):
+        """Return the gpg version"""
+        import subprocess
+
+        job = subprocess.Popen([self.gpg_bin, "--version"],
 stdout=subprocess.PIPE)
+        (stdout, _) = job.communicate()
+
+        if job.returncode:
+            raise bb.build.FuncFailed("Could not get gpg version (is

%s installed?)" %

meta/lib/oe/gpg_sign.py +5 -0

+                                      self.gpg_bin)
+
+        return stdout.split()[2]
+
+
     def verify(self, sig_file):
         """Verify signature"""
         cmd = self.gpg_bin + " --verify "

As far as I can tell get_gpg_version returns a string. However, you compare that with a float. This should give more correct behavior:
+ if gpg_ver > "2.1":

Not sure I'd trust that either, version comparison logic is painful. Something like this might be more resilient to interesting versioning:

dots = versionstring.split('.')
assert len(dots) >2
if int(dots[0]) >= 2 and int(dots[1])>= 1:

Even this doesn't work as e.g. I have gpg version 2.0.24. But, I agree that version comparison is tricky, e.g. "2.10" > "2.2" would return False. 2.1 is a nice version number in that sense ;) I don't know if gpg has had of will ever have any alphabets in its version number.

try:
return subprocess.check_output((self.gpg_bin, "version")).split()[2]
except CalledProcessExceptionOrWhateverThisExceptionIsCalled:
raise bb.build.FuncFailed("Could not get gpg version (%s). Called %s,
output %s" % (e, e.cmd, e.output))

I guess you mean (with double dash before 'version'):
return subprocess.check_output((self.gpg_bin, "--version")).split()[2]

This patch series extends the gpg_sign module to support ipk signing.

v6 implements Markus' feedback. The most notable change is the sign_ipk
and detach_sign merger, as they were almost identical in functionality.
This also meant a refactoring for detach_sign and a bug fix for the STDIN file descriptor introduced in gpg > 2.1.

Technically that STDIN bug is a feature (meh) of gpg >2.1 which breaks
existing behaviour so we have to work around it i.e. check the gpg version and use the loopback interface. This means that gpg-agent to which gpg >2.1 always connects needs to be running permanently.

Ioan-Adrian Ratiu (4):
gpg_sign: add local ipk package signing functionality
gpg_sign: detach_sign: fix gpg > 2.1 STDIN file descriptor
gpg_sign: export_pubkey: add signature type support
package_manager: sign IPK package feeds

 meta/classes/package_ipk.bbclass       |  5 +++
 meta/classes/sign_ipk.bbclass          | 52 ++++++++++++++++++++++++
 meta/classes/sign_package_feed.bbclass | 12 +++++-
 meta/lib/oe/gpg_sign.py                | 74
+++++++++++++++++++++++++++-------
 meta/lib/oe/package_manager.py         | 17 +++++++-
 5 files changed, 143 insertions(+), 17 deletions(-)
 create mode 100644 meta/classes/sign_ipk.bbclass