Add support for the Pkcs11GetTpmTokenInfoForUser cryptohome call.

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 <string>
 #include <vector>
 
@@ skipping 17 matching lines @@
                               bool return_status,
                               int return_code)>
       AsyncCallStatusHandler;
   // A callback to handle AsyncCallStatusWithData signals.
   typedef base::Callback<void(int async_id,
                               bool return_status,
                               const std::string& data)>
       AsyncCallStatusWithDataHandler;
   // A callback to handle responses of AsyncXXX methods.
   typedef base::Callback<void(int async_id)> AsyncMethodCallback;
-  // A callback to handle responses of Pkcs11GetTpmTokenInfo method.
+  // A callback to handle responses of Pkcs11GetTpmTokenInfo method.  The result
+  // of the D-Bus call is in |call_status|.  On success, |label| holds the
+  // PKCS #11 token label.  This is not useful in practice to identify a token
+  // but may be meaningful to a user.  The |user_pin| can be used with the
+  // C_Login PKCS #11 function but is not necessary because tokens are logged in
+  // for the duration of a signed-in session.  The |slot| corresponds to a
+  // CK_SLOT_ID for the PKCS #11 API and reliably identifies the token for the
+  // duration of the signed-in session.

[satorux1, 2013/10/08 23:46:31]

thank you for adding this! we need more of these comments!

   typedef base::Callback<void(
       DBusMethodCallStatus call_status,
       const std::string& label,
-      const std::string& user_pin)> Pkcs11GetTpmTokenInfoCallback;
+      const std::string& user_pin,
+      int slot)> Pkcs11GetTpmTokenInfoCallback;
   // A callback for methods which return both a bool result and data.
   typedef base::Callback<void(DBusMethodCallStatus call_status,
                               bool result,
                               const std::string& data)> DataMethodCallback;
 
   virtual ~CryptohomeClient();
 
   // Factory function, creates a new instance and returns ownership.
   // For normal usage, access the singleton via DBusThreadManager::Get().
   static CryptohomeClient* Create(DBusClientImplementationType type);
@@ skipping 126 matching lines @@
 
   // Calls TpmClearStoredPassword method and returns true when the call
   // succeeds.  This method blocks until the call returns.
   // TODO(hashimoto): Remove this method. crbug.com/141010
   virtual bool CallTpmClearStoredPasswordAndBlock() = 0;
 
   // Calls Pkcs11IsTpmTokenReady method.
   virtual void Pkcs11IsTpmTokenReady(
       const BoolDBusMethodCallback& callback) = 0;
 
-  // Calls Pkcs11GetTpmTokenInfo method.
+  // Calls Pkcs11GetTpmTokenInfo method.  This method is deprecated, you should
+  // use Pkcs11GetTpmTokenInfoForUser instead.  On success |callback| will
+  // receive PKCS #11 token information for the token associated with the user
+  // who originally signed in (i.e. PKCS #11 slot 0).
   virtual void Pkcs11GetTpmTokenInfo(
       const Pkcs11GetTpmTokenInfoCallback& callback) = 0;
 
+  // Calls Pkcs11GetTpmTokenInfoForUser method.  On success |callback| will
+  // receive PKCS #11 token information for the user identified by the canonical
+  // |username|.
+  virtual void Pkcs11GetTpmTokenInfoForUser(
+      const std::string& username,

[mattm, 2013/10/08 23:10:25]

Is username the "u-<long hex string>" value like in the home dir path?

[Darren Krahn, 2013/10/08 23:29:38]

No, it's a canonical email address as returned by chromeos::User::email().  At
least, that is my intention.  Let me know if this is inconvenient for any
reason.

[satorux1, 2013/10/08 23:46:31]

I think it's a good explanation about |username| parameter. Please add it as a
comment.

+      const Pkcs11GetTpmTokenInfoCallback& callback) = 0;
+
   // Calls InstallAttributesGet method and returns true when the call succeeds.
   // This method blocks until the call returns.
   // The original content of |value| is lost.
   virtual bool InstallAttributesGet(const std::string& name,
                                     std::vector<uint8>* value,
                                     bool* successful) = 0;
 
   // Calls InstallAttributesSet method and returns true when the call succeeds.
   // This method blocks until the call returns.
   virtual bool InstallAttributesSet(const std::string& name,
@@ skipping 154 matching lines @@
   // Create() should be used instead.
   CryptohomeClient();
 
  private:
   DISALLOW_COPY_AND_ASSIGN(CryptohomeClient);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_DBUS_CRYPTOHOME_CLIENT_H_