Merge lp:~alecu/ubuntu-sso-client/unlock-keyring-when-storing into lp:ubuntu-sso-client

[Alejandro J. Cura]

Make sure the default keyring is unlocked when getting it (LP: #703343).

Make sure the default keyring is unlocked when getting it

[Alejandro J. Cura (alecu)]

To test this:

 * Stop syncdaemon: u1sdtool -q
 * Start "seahorse" and delete the "Ubuntu One" credentials
 * Lock the keyring: right click on the default keyring ("Passwords: login" or "Passwords: default"), and click on "Lock"
 * Start syncdaemon again: u1sdtool -c

Now try to login as your u1 user, and when it previously failed, it should now ask for your keyring password in order to unlock it.

[Natalia Bidart (nataliabidart)]

Approving, works like a charm.

When running the test suite, I've got: http://pastebin.ubuntu.com/555779/
This is a test-intereference issue that I need to address (LP: #704941).

review: Approve

[Roberto Alsina (ralsina)]

Got the same error as natalia, but that doesn't seem to really be a problem with this branch, so +1

review: Approve

=== modified file 'ubuntu_sso/utils/tests/test_txsecrets.py'
--- ubuntu_sso/utils/tests/test_txsecrets.py	2010-11-17 00:30:35 +0000
+++ ubuntu_sso/utils/tests/test_txsecrets.py	2011-01-18 22:01:23 +0000
@@ -36,6 +36,9 @@
 # pylint: disable=E1101
 
 
+ERROR_CREATE_BUT_LOCKED = "Cannot create an item in a locked collection"
+
+
 class SampleMiscException(Exception):
     """An exception that will be turned into a DBus Exception."""
 
@@ -138,6 +141,8 @@
         """
         if self.create_item_fail:
             raise SampleMiscException()
+        if self.locked:
+            raise SampleMiscException(ERROR_CREATE_BUT_LOCKED)
         attributes = properties[txsecrets.ATTRIBUTES_PROPERTY]
         item_label = properties[txsecrets.LABEL_PROPERTY]
         session, parameters, value = secret
@@ -419,10 +424,11 @@
         collection_name = "sample_keyring"
         coll = yield self.create_sample_collection(collection_name)
         mock_collection = self.mock_service.collections[collection_name]
-        mock_collection.locked = True
         attr = {"key-type": "Ubuntu SSO credentials"}
         sample_secret = "secret99!"
         yield coll.create_item("Cucaracha", attr, sample_secret)
+        mock_collection.locked = True
+
         items = yield self.secretservice.search_items(attr)
         self.assertEqual(len(items), 1)
         value = yield items[0].get_value()
@@ -435,11 +441,12 @@
         collection_name = "sample_keyring"
         coll = yield self.create_sample_collection(collection_name)
         mock_collection = self.mock_service.collections[collection_name]
-        mock_collection.locked = True
-        mock_collection.unlock_prompts = True
         attr = {"key-type": "Ubuntu SSO credentials"}
         sample_secret = "secret99!"
         yield coll.create_item("Cucaracha", attr, sample_secret)
+        mock_collection.locked = True
+        mock_collection.unlock_prompts = True
+
         items = yield self.secretservice.search_items(attr)
         self.assertEqual(len(items), 1)
         value = yield items[0].get_value()
@@ -452,12 +459,13 @@
         collection_name = "sample_keyring"
         coll = yield self.create_sample_collection(collection_name)
         mock_collection = self.mock_service.collections[collection_name]
-        mock_collection.locked = True
-        mock_collection.unlock_prompts = True
         self.mock_service.dismissed = True
         attr = {"key-type": "Ubuntu SSO credentials"}
         sample_secret = "secret99!"
         yield coll.create_item("Cucaracha", attr, sample_secret)
+        mock_collection.locked = True
+        mock_collection.unlock_prompts = True
+
         d = self.secretservice.search_items(attr)
         yield self.assertFailure(d, txsecrets.UserCancelled)
 
@@ -470,18 +478,18 @@
         collection_name = "coll1"
         coll = yield self.create_sample_collection(collection_name)
         mock_coll1 = self.mock_service.collections[collection_name]
+        unlocked_secret = "coll 1 secret!"
+        yield coll.create_item("Cucaracha", attr, unlocked_secret)
         mock_coll1.locked = False
         mock_coll1.unlock_prompts = False
-        unlocked_secret = "coll 1 secret!"
-        yield coll.create_item("Cucaracha", attr, unlocked_secret)
 
         collection_name = "coll2"
         coll = yield self.create_sample_collection(collection_name)
         mock_coll2 = self.mock_service.collections[collection_name]
+        locked_secret = "coll 2 secret!"
+        yield coll.create_item("Cucaracha", attr, locked_secret)
         mock_coll2.locked = True
         mock_coll2.unlock_prompts = False
-        locked_secret = "coll 2 secret!"
-        yield coll.create_item("Cucaracha", attr, locked_secret)
 
         result = yield self.secretservice.search_items(attr)
         self.assertEqual(len(result), 2)
@@ -495,26 +503,26 @@
         collection_name = "coll1"
         coll = yield self.create_sample_collection(collection_name)
         mock_coll1 = self.mock_service.collections[collection_name]
+        unlocked_secret = "coll 1 secret!"
+        yield coll.create_item("Cucaracha", attr, unlocked_secret)
         mock_coll1.locked = False
         mock_coll1.unlock_prompts = False
-        unlocked_secret = "coll 1 secret!"
-        yield coll.create_item("Cucaracha", attr, unlocked_secret)
 
         collection_name = "coll2"
         coll = yield self.create_sample_collection(collection_name)
         mock_coll2 = self.mock_service.collections[collection_name]
+        locked_secret = "coll 2 secret!"
+        yield coll.create_item("Cucaracha", attr, locked_secret)
         mock_coll2.locked = True
         mock_coll2.unlock_prompts = False
-        locked_secret = "coll 2 secret!"
-        yield coll.create_item("Cucaracha", attr, locked_secret)
 
         collection_name = "coll3"
         coll = yield self.create_sample_collection(collection_name)
         mock_coll3 = self.mock_service.collections[collection_name]
+        locked_secret = "coll 3 secret!"
+        yield coll.create_item("Cucaracha", attr, locked_secret)
         mock_coll3.locked = True
         mock_coll3.unlock_prompts = True
-        locked_secret = "coll 3 secret!"
-        yield coll.create_item("Cucaracha", attr, locked_secret)
 
         result = yield self.secretservice.search_items(attr)
         self.assertEqual(len(result), 3)
@@ -537,6 +545,22 @@
         yield self.secretservice.get_default_collection()
         self.assertEqual(len(self.mock_service.collections), 1)
 
+    @inlineCallbacks
+    def test_get_default_collection_is_unlocked(self):
+        """The default collection is unlocked before being returned."""
+        yield self.secretservice.open_session()
+        collection_name = "sample_keyring"
+        self.assertEqual(len(self.mock_service.collections), 0)
+        coll = yield self.create_sample_collection(collection_name)
+        self.assertEqual(len(self.mock_service.collections), 1)
+        mock_collection = self.mock_service.collections[collection_name]
+        mock_collection.locked = True
+        yield self.secretservice.get_default_collection()
+        attr = {"key-type": "Ubuntu 242 credentials"}
+        sample_secret = "secret!"
+        yield coll.create_item("Cucaracha", attr, sample_secret)
+        self.assertEqual(len(mock_collection.items), 1)
+
 
 class CollectionTestCase(BaseTestCase):
     """Test the Collection class."""

=== modified file 'ubuntu_sso/utils/txsecrets.py'
--- ubuntu_sso/utils/txsecrets.py	2010-11-30 12:19:43 +0000
+++ ubuntu_sso/utils/txsecrets.py	2011-01-18 22:01:23 +0000
@@ -172,11 +172,30 @@
         """The collection were default items should be created."""
         d = Deferred()
 
+        def prompt_handle(unlocked):
+            """Handle showing a prompt."""
+            collection_path = unlocked[0]
+            return Collection(self, collection_path)
+
+        def unlock_handler(unlocked, prompt):
+            """The objects were unlocked."""
+            if prompt != "/":
+                d2 = self.do_prompt(prompt)
+                d2.addCallback(prompt_handle)
+                d2.chainDeferred(d)
+            else:
+                d.callback(prompt_handle(unlocked))
+
         def propertyget_handler(collection_paths):
             """The list of collection paths was retrieved."""
             if len(collection_paths) > 0:
-                d.callback(Collection(self, DEFAULT_COLLECTION))
+                # The collection was found, make sure it's unlocked
+                objects = dbus.Array([DEFAULT_COLLECTION], signature="o")
+                self.service.Unlock(objects,
+                                    reply_handler=unlock_handler,
+                                    error_handler=d.errback)
             else:
+                # The collection was not found, so create it
                 self.create_collection(DEFAULT_LABEL).chainDeferred(d)
 
         self.properties.Get(SERVICE_IFACE, COLLECTIONS_PROPERTY,