Save previously used transport type for WebAuthn UI

Use Chromium pref as a persistant key-value storage to save previously
used transport type. This will enable us to skip "Welcome" dialog if we
know that the user has already used certain transport type before.

Bug: 868212
Change-Id: Iff732f2d990291cfe1465107fc01d08b3cf3e019
Reviewed-on: https://chromium-review.googlesource.com/1152559
Commit-Queue: Jun Choi <hongjunchoi@chromium.org>
Reviewed-by: Jochen Eisinger <jochen@chromium.org>
Reviewed-by: Kim Paulhamus <kpaulhamus@chromium.org>
Cr-Commit-Position: refs/heads/master@{#580028}

chrome/browser/webauthn/chrome_authenticator_request_delegate.cc

@@ -32,7 +32,6 @@
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/web_contents.h"
-#include "device/fido/fido_transport_protocol.h"
 
 #if defined(OS_MACOSX)
 #include "device/fido/mac/credential_metadata.h"
@@ -64,6 +63,26 @@ bool IsWebAuthnUiEnabled() {
       switches::kWebAuthenticationUI);
 }
 
+#if !defined(OS_ANDROID)
+void SetInitialUiModelBasedOnPreviouslyUsedTransport(
+    AuthenticatorRequestDialogModel* model,
+    base::Optional<device::FidoTransportProtocol> previous_transport) {
+  if (!previous_transport)
+    return;
+
+  // TODO(hongjunchoi): Add UI component for defaulting to BLE, Cable and Mac
+  // TouchID transports.
+  switch (*previous_transport) {
+    case device::FidoTransportProtocol::kUsbHumanInterfaceDevice:
+      model->SetCurrentStep(AuthenticatorRequestDialogModel::Step::
+                                kUsbInsertAndActivateOnRegister);
+      break;
+    default:
+      return;
+  }
+}
+#endif
+
 }  // namespace
 
 #if defined(OS_MACOSX)
@@ -71,6 +90,9 @@ static const char kWebAuthnTouchIdMetadataSecretPrefName[] =
     "webauthn.touchid.metadata_secret";
 #endif
 
+static const char kWebAuthnLastTransportUsedPrefName[] =
+    "webauthn.last_transport_used";
+
 // static
 void ChromeAuthenticatorRequestDelegate::RegisterProfilePrefs(
     user_prefs::PrefRegistrySyncable* registry) {
@@ -78,6 +100,9 @@ void ChromeAuthenticatorRequestDelegate::RegisterProfilePrefs(
   registry->RegisterStringPref(kWebAuthnTouchIdMetadataSecretPrefName,
                                std::string());
 #endif
+
+  registry->RegisterStringPref(kWebAuthnLastTransportUsedPrefName,
+                               std::string());
 }
 
 ChromeAuthenticatorRequestDelegate::ChromeAuthenticatorRequestDelegate(
@@ -116,7 +141,10 @@ void ChromeAuthenticatorRequestDelegate::DidStartRequest() {
 
   auto dialog_model = std::make_unique<AuthenticatorRequestDialogModel>();
   weak_dialog_model_ = dialog_model.get();
+  SetInitialUiModelBasedOnPreviouslyUsedTransport(weak_dialog_model_,
+                                                  GetLastTransportUsed());
   weak_dialog_model_->AddObserver(this);
+
   ShowAuthenticatorRequestDialog(
       content::WebContents::FromRenderFrameHost(render_frame_host()),
       std::move(dialog_model));
@@ -220,6 +248,14 @@ ChromeAuthenticatorRequestDelegate::GetTouchIdAuthenticatorConfig() const {
 }
 #endif
 
+base::Optional<device::FidoTransportProtocol>
+ChromeAuthenticatorRequestDelegate::GetLastTransportUsed() const {
+  PrefService* prefs =
+      Profile::FromBrowserContext(browser_context())->GetPrefs();
+  return device::ConvertToFidoTransportProtocol(
+      prefs->GetString(kWebAuthnLastTransportUsedPrefName));
+}
+
 void ChromeAuthenticatorRequestDelegate::BluetoothAdapterIsAvailable() {
   if (!IsWebAuthnUiEnabled())
     return;
@@ -268,6 +304,14 @@ void ChromeAuthenticatorRequestDelegate::FidoAuthenticatorRemoved(
       saved_authenticators.end());
 }
 
+void ChromeAuthenticatorRequestDelegate::UpdateLastTransportUsed(
+    device::FidoTransportProtocol transport) {
+  PrefService* prefs =
+      Profile::FromBrowserContext(browser_context())->GetPrefs();
+  prefs->SetString(kWebAuthnLastTransportUsedPrefName,
+                   device::ToString(transport));
+}
+
 void ChromeAuthenticatorRequestDelegate::OnModelDestroyed() {
   DCHECK(weak_dialog_model_);
   weak_dialog_model_ = nullptr;

chrome/browser/webauthn/chrome_authenticator_request_delegate.h

@@ -7,12 +7,15 @@
 
 #include <string>
 
+#include "base/gtest_prod_util.h"
 #include "base/memory/weak_ptr.h"
+#include "base/optional.h"
 #include "base/strings/string_piece.h"
 #include "build/build_config.h"
 #include "chrome/browser/webauthn/authenticator_request_dialog_model.h"
 #include "content/public/browser/authenticator_request_client_delegate.h"
 #include "device/fido/fido_request_handler_base.h"
+#include "device/fido/fido_transport_protocol.h"
 
 class Profile;
 
@@ -49,6 +52,7 @@ class ChromeAuthenticatorRequestDelegate
       const override;
 #endif  // defined(OS_MACOSX)
 
+  base::Optional<device::FidoTransportProtocol> GetLastTransportUsed() const;
   base::WeakPtr<ChromeAuthenticatorRequestDelegate> AsWeakPtr();
 
  private:
@@ -69,6 +73,8 @@ class ChromeAuthenticatorRequestDelegate
   void FidoAuthenticatorAdded(
       const device::FidoAuthenticator& authenticator) override;
   void FidoAuthenticatorRemoved(base::StringPiece device_id) override;
+  void UpdateLastTransportUsed(
+      device::FidoTransportProtocol transport) override;
 
   // AuthenticatorRequestDialogModel::Observer:
   void OnModelDestroyed() override;

chrome/browser/webauthn/chrome_authenticator_request_delegate_unittest.cc

@@ -10,16 +10,21 @@
 #include "content/public/test/web_contents_tester.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
-namespace content {
 namespace {
 
 class ChromeAuthenticatorRequestDelegateTest
     : public ChromeRenderViewHostTestHarness {};
 
+TEST_F(ChromeAuthenticatorRequestDelegateTest, TestDefaultTransportPrefType) {
+  ChromeAuthenticatorRequestDelegate delegate(main_rfh());
+  EXPECT_FALSE(delegate.GetLastTransportUsed());
+}
+
 #if defined(OS_MACOSX)
 std::string TouchIdMetadataSecret(
     const ChromeAuthenticatorRequestDelegate& delegate) {
-  base::Optional<AuthenticatorRequestClientDelegate::TouchIdAuthenticatorConfig>
+  base::Optional<
+      content::AuthenticatorRequestClientDelegate::TouchIdAuthenticatorConfig>
       config = delegate.GetTouchIdAuthenticatorConfig();
   return config->metadata_secret;
 }
@@ -45,8 +50,8 @@ TEST_F(ChromeAuthenticatorRequestDelegateTest,
   // Different profiles have different secrets. (No way to reset
   // browser_context(), so we have to create our own.)
   auto browser_context = base::WrapUnique(CreateBrowserContext());
-  auto web_contents =
-      WebContentsTester::CreateTestWebContents(browser_context.get(), nullptr);
+  auto web_contents = content::WebContentsTester::CreateTestWebContents(
+      browser_context.get(), nullptr);
   EXPECT_NE(
       TouchIdMetadataSecret(ChromeAuthenticatorRequestDelegate(main_rfh())),
       TouchIdMetadataSecret(
@@ -59,4 +64,3 @@ TEST_F(ChromeAuthenticatorRequestDelegateTest,
 #endif
 
 }  // namespace
-}  // namespace content

content/public/browser/authenticator_request_client_delegate.cc

@@ -48,4 +48,7 @@ void AuthenticatorRequestClientDelegate::FidoAuthenticatorAdded(
 void AuthenticatorRequestClientDelegate::FidoAuthenticatorRemoved(
     base::StringPiece device_id) {}
 
+void AuthenticatorRequestClientDelegate::UpdateLastTransportUsed(
+    device::FidoTransportProtocol transport) {}
+
 }  // namespace content

content/public/browser/authenticator_request_client_delegate.h

@@ -13,6 +13,7 @@
 #include "build/build_config.h"
 #include "content/common/content_export.h"
 #include "device/fido/fido_request_handler_base.h"
+#include "device/fido/fido_transport_protocol.h"
 
 namespace device {
 class FidoAuthenticator;
@@ -82,6 +83,10 @@ class CONTENT_EXPORT AuthenticatorRequestClientDelegate
   GetTouchIdAuthenticatorConfig() const;
 #endif
 
+  // Saves transport type the user used during WebAuthN API so that the
+  // WebAuthN UI will default to the same transport type during next API call.
+  virtual void UpdateLastTransportUsed(device::FidoTransportProtocol transport);
+
   // device::FidoRequestHandlerBase::AuthenticatorMapObserver:
   void BluetoothAdapterIsAvailable() override;
   void FidoAuthenticatorAdded(

device/fido/BUILD.gn

@@ -75,6 +75,7 @@ component("fido") {
     "fido_request_handler_base.h",
     "fido_task.cc",
     "fido_task.h",
+    "fido_transport_protocol.cc",
     "fido_transport_protocol.h",
     "get_assertion_request_handler.cc",
     "get_assertion_request_handler.h",

device/fido/fido_transport_protocol.cc

+// Copyright 2018 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 "device/fido/fido_transport_protocol.h"
+
+namespace device {
+
+const char kUsbHumanInterfaceDevice[] = "hid";
+const char kNearFieldCommunication[] = "nfc";
+const char kBluetoothLowEnergy[] = "ble";
+const char kCloudAssistedBluetoothLowEnergy[] = "cable";
+const char kInternal[] = "internal";
+
+base::Optional<FidoTransportProtocol> ConvertToFidoTransportProtocol(
+    base::StringPiece protocol) {
+  if (protocol == kUsbHumanInterfaceDevice)
+    return FidoTransportProtocol::kUsbHumanInterfaceDevice;
+  else if (protocol == kNearFieldCommunication)
+    return FidoTransportProtocol::kNearFieldCommunication;
+  else if (protocol == kBluetoothLowEnergy)
+    return FidoTransportProtocol::kBluetoothLowEnergy;
+  else if (protocol == kCloudAssistedBluetoothLowEnergy)
+    return FidoTransportProtocol::kCloudAssistedBluetoothLowEnergy;
+  else if (protocol == kInternal)
+    return FidoTransportProtocol::kInternal;
+  else
+    return base::nullopt;
+}
+
+COMPONENT_EXPORT(DEVICE_FIDO)
+std::string ToString(FidoTransportProtocol protocol) {
+  switch (protocol) {
+    case FidoTransportProtocol::kUsbHumanInterfaceDevice:
+      return kUsbHumanInterfaceDevice;
+    case FidoTransportProtocol::kNearFieldCommunication:
+      return kNearFieldCommunication;
+    case FidoTransportProtocol::kBluetoothLowEnergy:
+      return kBluetoothLowEnergy;
+    case FidoTransportProtocol::kCloudAssistedBluetoothLowEnergy:
+      return kCloudAssistedBluetoothLowEnergy;
+    case FidoTransportProtocol::kInternal:
+      return kInternal;
+  }
+  NOTREACHED();
+  return "";
+}
+
+}  // namespace device

device/fido/fido_transport_protocol.h

@@ -5,11 +5,17 @@
 #ifndef DEVICE_FIDO_FIDO_TRANSPORT_PROTOCOL_H_
 #define DEVICE_FIDO_FIDO_TRANSPORT_PROTOCOL_H_
 
+#include <string>
+
+#include "base/component_export.h"
+#include "base/optional.h"
+#include "base/strings/string_piece.h"
+
 namespace device {
 
 // This enum represents the transport protocols over which Fido WebAuthN API is
 // currently supported.
-enum class FidoTransportProtocol {
+enum class FidoTransportProtocol : uint8_t {
   kUsbHumanInterfaceDevice,
   kNearFieldCommunication,
   kBluetoothLowEnergy,
@@ -17,6 +23,20 @@ enum class FidoTransportProtocol {
   kInternal,
 };
 
+// String representation of above FidoTransportProtocol enum.
+extern const char kUsbHumanInterfaceDevice[];
+extern const char kNearFieldCommunication[];
+extern const char kBluetoothLowEnergy[];
+extern const char kCloudAssistedBluetoothLowEnergy[];
+extern const char kInternal[];
+
+COMPONENT_EXPORT(DEVICE_FIDO)
+base::Optional<FidoTransportProtocol> ConvertToFidoTransportProtocol(
+    base::StringPiece protocol);
+
+COMPONENT_EXPORT(DEVICE_FIDO)
+std::string ToString(FidoTransportProtocol protocol);
+
 }  // namespace device
 
 #endif  // DEVICE_FIDO_FIDO_TRANSPORT_PROTOCOL_H_