cryptohome: Add dbus method and signal name for encryption migration.

chromeos/dbus/cryptohome_client.h

 // Copyright (c) 2012 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.
 
 #ifndef CHROMEOS_DBUS_CRYPTOHOME_CLIENT_H_
 #define CHROMEOS_DBUS_CRYPTOHOME_CLIENT_H_
 
 #include <stdint.h>
 
 #include <string>
@@ skipping 73 matching lines @@
   typedef base::Callback<void(DBusMethodCallStatus call_status,
                               bool result,
                               const std::string& data)> DataMethodCallback;
 
   // A callback for methods which return both a bool and a protobuf as reply.
   typedef base::Callback<
       void(DBusMethodCallStatus call_status,
            bool result,
            const cryptohome::BaseReply& reply)> ProtobufMethodCallback;
 
+  // A callback to handle DircryptoMigrationProgress signals.
+  typedef base::Callback<void(uint64_t current, uint64_t total)>
+      DircryptoMigrationProgessHandler;
+
   ~CryptohomeClient() override;
 
   // Factory function, creates a new instance and returns ownership.
   // For normal usage, access the singleton via DBusThreadManager::Get().
   static CryptohomeClient* Create();
 
   // Returns the sanitized |username| that the stub implementation would return.
   static std::string GetStubSanitizedUsername(
       const cryptohome::Identification& cryptohome_id);
 
   // Sets AsyncCallStatus signal handlers.
   // |handler| is called when results for AsyncXXX methods are returned.
   // Cryptohome service will process the calls in a first-in-first-out manner
   // when they are made in parallel.
   virtual void SetAsyncCallStatusHandlers(
       const AsyncCallStatusHandler& handler,
       const AsyncCallStatusWithDataHandler& data_handler) = 0;
 
   // Resets AsyncCallStatus signal handlers.
   virtual void ResetAsyncCallStatusHandlers() = 0;
 
   // Sets LowDiskSpace signal handler.  |handler| is called when the cryptohome
   // partition is running out of disk space.
   virtual void SetLowDiskSpaceHandler(const LowDiskSpaceHandler& handler) = 0;
 
+  // A callback to handle DircryptoMigrationProgress signals.  |handler| is
+  // called periodicaly during a migration is performed by cryptohomed.

[Daniel Erat, 2017/03/14 15:37:36]

nit: "called periodically while a migration is being performed by cryptohomed."

is it guaranteed to be called once after the migration is done? is there some
other way for chrome to know when it's done?

[kinaba, 2017/03/15 08:17:30]

My intent is that the callback from MigrateToDircrypto fires
only after the migration is finished (by success or failure.)
Adding a comment below as you suggested.

+  virtual void SetDircryptoMigrationProgressHandler(
+      const DircryptoMigrationProgessHandler& handler) = 0;
+
   // Runs the callback as soon as the service becomes available.
   virtual void WaitForServiceToBeAvailable(
       const WaitForServiceToBeAvailableCallback& callback) = 0;
 
   // Calls IsMounted method and returns true when the call succeeds.
   virtual void IsMounted(const BoolDBusMethodCallback& callback) = 0;
 
   // Calls Unmount method and returns true when the call succeeds.
   // This method blocks until the call returns.
   virtual bool Unmount(bool* success) = 0;
@@ skipping 419 matching lines @@
 
   // Asynchronously calls FlushAndSignBootAttributes method. |callback| is
   // called after method call, and with reply protobuf.
   // FlushAndSignBootAttributes makes all pending boot attribute settings
   // available, and have them signed by a special TPM key. This method always
   // fails after any user, publuc, or guest session starts.
   virtual void FlushAndSignBootAttributes(
       const cryptohome::FlushAndSignBootAttributesRequest& request,
       const ProtobufMethodCallback& callback) = 0;
 
+  // Asynchronously calls MigrateToDicrypto method. |callback| is called after
+  // method call, and with reply protobuf.

[Daniel Erat, 2017/03/14 15:37:36]

does the callback get invoked immediately, or only after the migration has
finished? it'd be good to mention that here.

[kinaba, 2017/03/15 08:17:30]

Done.

+  // MigrateToDicrypto attempts to migrate the home dir using given

[Daniel Erat, 2017/03/14 15:37:37]

nit: MigrateToDirCrypto

[kinaba, 2017/03/15 08:17:30]

Done.

+  // authorization, to the new "dicrypto" encryption.

[Daniel Erat, 2017/03/14 15:37:36]

nit: "dircrypto", also remove comma on this line

[kinaba, 2017/03/15 08:17:30]

Done.

+  virtual void MigrateToDircrypto(
+      const cryptohome::Identification& cryptohome_id,
+      const cryptohome::AuthorizationRequest& auth,
+      const ProtobufMethodCallback& callback) = 0;
+
  protected:
   // Create() should be used instead.
   CryptohomeClient();
 
  private:
   DISALLOW_COPY_AND_ASSIGN(CryptohomeClient);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_DBUS_CRYPTOHOME_CLIENT_H_