Migrate Libsecret for OSCrypt to a new schema

components/os_crypt/os_crypt_util_linux_unittest.cc

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include <string>
 
 #include "base/macros.h"
 #include "components/os_crypt/key_storage_libsecret.h"
 #include "components/os_crypt/libsecret_util_linux.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 
 // Mock functions use MockSecretValue, where SecretValue would appear, and are
 // cast to the correct signature. We can reduce SecretValue to an std::string,
 // because we don't use anything else from it.
 using MockSecretValue = std::string;
 
+const SecretSchema kDeprecatedSchema = {

[Lei Zhang, 2016/08/26 21:33:57]

Ditto re: naming.

[cfroussios, 2016/08/29 09:58:42]

Done.

+    "chrome_libsecret_os_crypt_password",
+    SECRET_SCHEMA_NONE,
+    {
+        {nullptr, SECRET_SCHEMA_ATTRIBUTE_STRING},
+    }};
+
+const SecretSchema kSchema = {
+    "chrome_libsecret_keyring_os_crypt_password",
+    SECRET_SCHEMA_DONT_MATCH_NAME,
+    {
+        {"application", SECRET_SCHEMA_ATTRIBUTE_STRING},
+        {nullptr, SECRET_SCHEMA_ATTRIBUTE_STRING},
+    }};
+
 // Replaces some of LibsecretLoader's methods with mocked ones.
 class MockLibsecretLoader : public LibsecretLoader {
  public:
   // Sets up the minimum mock implementation necessary for OSCrypt to work
   // with Libsecret. Also resets the state to mock a clean database.
   static bool ResetForOSCrypt();
 
   // Sets OSCrypt's password in the libsecret mock to a specific value
   static void SetOSCryptPassword(const char*);
 
   // Releases memory and restores LibsecretLoader to an uninitialized state.
   static void TearDown();
 
+  // Set whether there is an old password that needs to be migrated from the
+  // deprecated schema. Null means no such password. See crbug/639298
+  static void SetDeprecatedOSCryptPassword(const char* value);
+
  private:
   // These methods are used to redirect calls through LibsecretLoader
   static const gchar* mock_secret_value_get_text(MockSecretValue* value);
 
   static gboolean mock_secret_password_store_sync(const SecretSchema* schema,
                                                   const gchar* collection,
                                                   const gchar* label,
                                                   const gchar* password,
                                                   GCancellable* cancellable,
                                                   GError** error,
                                                   ...);
 
   static MockSecretValue* mock_secret_service_lookup_sync(
       SecretService* service,
       const SecretSchema* schema,
       GHashTable* attributes,
       GCancellable* cancellable,
       GError** error);
 
   static void mock_secret_value_unref(gpointer value);
 
   static GList* mock_secret_service_search_sync(SecretService* service,
                                                 const SecretSchema* schema,
                                                 GHashTable* attributes,
                                                 SecretSearchFlags flags,
                                                 GCancellable* cancellable,
                                                 GError** error);
 
-  // MockLibsecretLoader owns this object.
+  static gboolean mock_secret_password_clear_sync(const SecretSchema* schema,
+                                                  GCancellable* cancellable,
+                                                  GError** error,
+                                                  ...);
+
+  // MockLibsecretLoader owns these objects.
   static MockSecretValue* stored_password_mock_ptr_;
+  static MockSecretValue* deprecated_password_mock_ptr_;
 };
 
 MockSecretValue* MockLibsecretLoader::stored_password_mock_ptr_ = nullptr;
+MockSecretValue* MockLibsecretLoader::deprecated_password_mock_ptr_ = nullptr;
 
 const gchar* MockLibsecretLoader::mock_secret_value_get_text(
     MockSecretValue* value) {
   return value->c_str();
 }
 
 // static
 gboolean MockLibsecretLoader::mock_secret_password_store_sync(
     const SecretSchema* schema,
     const gchar* collection,
     const gchar* label,
     const gchar* password,
     GCancellable* cancellable,
     GError** error,
     ...) {
+  EXPECT_STREQ(kSchema.name, schema->name);
   delete stored_password_mock_ptr_;
   stored_password_mock_ptr_ = new MockSecretValue(password);
   return true;
 }
 
 // static
 MockSecretValue* MockLibsecretLoader::mock_secret_service_lookup_sync(
     SecretService* service,
     const SecretSchema* schema,
     GHashTable* attributes,
     GCancellable* cancellable,
     GError** error) {
-  return stored_password_mock_ptr_;
+  bool is_known_schema = strcmp(schema->name, kSchema.name) == 0 ||
+                         strcmp(schema->name, kDeprecatedSchema.name) == 0;
+  EXPECT_TRUE(is_known_schema);
+
+  if (strcmp(schema->name, kSchema.name) == 0)
+    return stored_password_mock_ptr_;
+  else if (strcmp(schema->name, kDeprecatedSchema.name) == 0)
+    return deprecated_password_mock_ptr_;
+
+  NOTREACHED();
+  return nullptr;
 }
 
 // static
 void MockLibsecretLoader::mock_secret_value_unref(gpointer value) {}
 
 // static
 GList* MockLibsecretLoader::mock_secret_service_search_sync(
     SecretService* service,
     const SecretSchema* schema,
     GHashTable* attributes,
     SecretSearchFlags flags,
     GCancellable* cancellable,
     GError** error) {
   *error = nullptr;
   return nullptr;
 }
 
 // static
+gboolean MockLibsecretLoader::mock_secret_password_clear_sync(
+    const SecretSchema* schema,
+    GCancellable* cancellable,
+    GError** error,
+    ...) {
+  EXPECT_STREQ(kDeprecatedSchema.name, schema->name);
+  delete deprecated_password_mock_ptr_;
+  deprecated_password_mock_ptr_ = nullptr;
+  return true;
+}
+
+// static
 bool MockLibsecretLoader::ResetForOSCrypt() {
-  // 4 methods used by KeyStorageLibsecret::GetKey()
+  // 4 methods used by KeyStorageLibsecret
   secret_password_store_sync =
       &MockLibsecretLoader::mock_secret_password_store_sync;
   secret_value_get_text = (decltype(&::secret_value_get_text)) &
                           MockLibsecretLoader::mock_secret_value_get_text;
   secret_value_unref = &MockLibsecretLoader::mock_secret_value_unref;
   secret_service_lookup_sync =
       (decltype(&::secret_service_lookup_sync)) &
       MockLibsecretLoader::mock_secret_service_lookup_sync;
+  // Used by Migrate()
+  secret_password_clear_sync =
+      &MockLibsecretLoader::mock_secret_password_clear_sync;
   // 1 method used by LibsecretLoader::EnsureLibsecretLoaded()
   secret_service_search_sync =
       &MockLibsecretLoader::mock_secret_service_search_sync;
 
   delete stored_password_mock_ptr_;
   stored_password_mock_ptr_ = nullptr;
   libsecret_loaded_ = true;
 
   return true;
 }
 
 // static
 void MockLibsecretLoader::SetOSCryptPassword(const char* value) {
   delete stored_password_mock_ptr_;
   stored_password_mock_ptr_ = new MockSecretValue(value);
 }
 
 // static
+void MockLibsecretLoader::SetDeprecatedOSCryptPassword(const char* value) {
+  delete deprecated_password_mock_ptr_;
+  deprecated_password_mock_ptr_ = new MockSecretValue(value);
+}
+
+// static
 void MockLibsecretLoader::TearDown() {
   delete stored_password_mock_ptr_;
   stored_password_mock_ptr_ = nullptr;
   libsecret_loaded_ =
       false;  // Function pointers will be restored when loading.
 }
 
 class LibsecretTest : public testing::Test {
  public:
   LibsecretTest() = default;
@@ skipping 18 matching lines @@
 
 TEST_F(LibsecretTest, LibsecretCreatesRandomised) {
   KeyStorageLibsecret libsecret;
   MockLibsecretLoader::ResetForOSCrypt();
   std::string password = libsecret.GetKey();
   MockLibsecretLoader::ResetForOSCrypt();
   std::string password_new = libsecret.GetKey();
   EXPECT_NE(password, password_new);
 }
 
+TEST_F(LibsecretTest, LibsecretMigratesFromDeprecatedSchema) {
+  KeyStorageLibsecret libsecret;
+  MockLibsecretLoader::ResetForOSCrypt();
+  MockLibsecretLoader::SetDeprecatedOSCryptPassword("swallow");
+  std::string password = libsecret.GetKey();
+  EXPECT_EQ(password, "swallow");

[Lei Zhang, 2016/08/26 21:33:57]

expected value on the left

[cfroussios, 2016/08/29 09:58:42]

Done.

+}
+
 }  // namespace