Merge lp:~michael.nelson/launchpad/ppa-generate-key-failure into lp:launchpad

[Michael Nelson]

Ensure only byte-strings are passed to gpgme.Context().keylist()

This branch fixes bug 576405 by ensuring that IGPGHandler.localKeys() passes only byte-strings to gpgme.Context().keylist().

To test:
bin/test -vv -m test_gpghandler

Initially I refactored IGPGHandler.generateKey() to make it more testable (ie. to be able to test everything outside of the gpgme.Context().genkey() call), but deleted this in the end in favour of a direct test of the issue.

This will need to be CP'd, so if you review this and I'm not around, please feel free to send it off to land on devel.

[William Grant (wgrant)]

Isn't this going to explode if the first PPA's display name contains non-ASCII characters?

[Michael Nelson (michael.nelson)]

Right - I had understood that we were only using localKeys() with fingerprints and email addresses, but better to be safe.

I couldn't find much documentation for gpgme, and so have just encoded the string in utf-8.

Thanks William.

[Abel Deuring (adeuring)]

review: Approve (code)

=== modified file 'lib/canonical/launchpad/utilities/ftests/test_gpghandler.py'
--- lib/canonical/launchpad/utilities/ftests/test_gpghandler.py	2009-06-25 05:30:52 +0000
+++ lib/canonical/launchpad/utilities/ftests/test_gpghandler.py	2010-05-07 12:26:30 +0000
@@ -6,8 +6,8 @@
 
 from zope.component import getUtility
 
-from canonical.launchpad.ftests import login, ANONYMOUS, logout
-from canonical.launchpad.ftests import keys_for_tests
+from canonical.launchpad.ftests import (
+    ANONYMOUS, keys_for_tests, login, logout)
 from canonical.launchpad.interfaces.gpghandler import IGPGHandler
 from canonical.testing import LaunchpadFunctionalLayer
 
@@ -97,6 +97,28 @@
         [key] = filtered_keys
         self.assertEqual(key.fingerprint, secret_target_fpr)
 
+    def test_unicode_filter(self):
+        """Using a unicode filter works also.
+
+        XXX michaeln 2010-05-07 bug=576405
+        Recent versions of gpgme return unicode fingerprints, but
+        at the same time, gpgme.Context().keylist falls over if
+        it receives a unicode string.
+        """
+        self.populateKeyring()
+
+        target_fpr = u'340CA3BB270E2716C9EE0B768E7EB7086C64A8C5'
+
+        # Finding a key by its unicode fingerprint.
+        filtered_keys = self.gpg_handler.localKeys(target_fpr)
+        [key] = filtered_keys
+        self.assertEqual(key.fingerprint, target_fpr)
+
+    def test_non_ascii_filter(self):
+        """localKeys should not error if passed non-ascii unicode strings."""
+        filtered_keys = self.gpg_handler.localKeys(u'non-ascii \u8463')
+        self.failUnlessRaises(StopIteration, filtered_keys.next)
+
     def testTestkeyrings(self):
         """Do we have the expected test keyring files"""
         self.assertEqual(len(list(keys_for_tests.test_keyrings())), 1)

=== modified file 'lib/canonical/launchpad/utilities/gpghandler.py'
--- lib/canonical/launchpad/utilities/gpghandler.py	2010-04-26 16:00:31 +0000
+++ lib/canonical/launchpad/utilities/gpghandler.py	2010-05-07 12:26:30 +0000
@@ -399,6 +399,13 @@
         already knows about.
         """
         ctx = gpgme.Context()
+
+        # XXX michaeln 2010-05-07 bug=576405
+        # Currently gpgme.Context().keylist fails if passed a unicode
+        # string even though that's what is returned for fingerprints.
+        if type(filter) == unicode:
+            filter = filter.encode('utf-8')
+
         for key in ctx.keylist(filter, secret):
             yield PymeKey.newFromGpgmeKey(key)