cros: Added a new function to quick unlock api for checking unfinished pins.

chrome/browser/chromeos/extensions/quick_unlock_private/quick_unlock_private_api.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 "chrome/browser/chromeos/extensions/quick_unlock_private/quick_unlock_private_api.h"
 
 #include "chrome/browser/chromeos/login/quick_unlock/pin_storage.h"
 #include "chrome/browser/chromeos/login/quick_unlock/pin_storage_factory.h"
 #include "chrome/browser/chromeos/profiles/profile_helper.h"
+#include "chrome/common/pref_names.h"
 #include "chromeos/login/auth/extended_authenticator.h"
 #include "chromeos/login/auth/user_context.h"
+#include "components/prefs/pref_service.h"
 #include "extensions/browser/event_router.h"
 
 namespace extensions {
 
 namespace quick_unlock_private = api::quick_unlock_private;
 namespace SetModes = quick_unlock_private::SetModes;
 namespace GetActiveModes = quick_unlock_private::GetActiveModes;
+namespace CheckCredential = quick_unlock_private::CheckCredential;
 namespace GetAvailableModes = quick_unlock_private::GetAvailableModes;
 namespace OnActiveModesChanged = quick_unlock_private::OnActiveModesChanged;
+using CredentialProblem = quick_unlock_private::CredentialProblem;
+using CredentialCheck = quick_unlock_private::CredentialCheck;
 using QuickUnlockMode = quick_unlock_private::QuickUnlockMode;
 using QuickUnlockModeList = std::vector<QuickUnlockMode>;
 
 namespace {
 
 const char kModesAndCredentialsLengthMismatch[] =
     "|modes| and |credentials| must have the same number of elements";
 const char kMultipleModesNotSupported[] =
     "At most one quick unlock mode can be active.";
+// PINs greater in length than |kMinLengthForWeakPin| will be checked for
+// weakness.
+const int kMinLengthForWeakPin = 2;
+// A list of the top-10 most commmonly used PINs. This list is taken from
+// www.datagenetics.com/blog/september32012/.
+const char* kMostCommonPins[] = {"1234", "1111", "0000", "1212", "7777",
+                                 "1004", "2000", "4444", "2222", "6969"};
 
 // Returns the active set of quick unlock modes.
 QuickUnlockModeList ComputeActiveModes(Profile* profile) {
   QuickUnlockModeList modes;
 
   chromeos::PinStorage* pin_storage =
       chromeos::PinStorageFactory::GetForProfile(profile);
   if (pin_storage && pin_storage->IsPinSet())
     modes.push_back(quick_unlock_private::QUICK_UNLOCK_MODE_PIN);
 
   return modes;
 }
 
 // Returns true if |a| and |b| contain the same elements. The elements do not
 // need to be in the same order.
 bool AreModesEqual(const QuickUnlockModeList& a, const QuickUnlockModeList& b) {
   if (a.size() != b.size())
     return false;
 
   // This is a slow comparison algorithm, but the number of entries in |a| and
   // |b| will always be very low (0-3 items) so it doesn't matter.
   for (size_t i = 0; i < a.size(); ++i) {
     if (std::find(b.begin(), b.end(), a[i]) == b.end())
       return false;
   }
 
   return true;
 }
 
+std::vector<CredentialProblem> IsPinNumeric(const std::string& pin) {
+  std::vector<CredentialProblem> problems;
+  if (!std::all_of(pin.begin(), pin.end(), ::isdigit))
+    problems.push_back(CredentialProblem::CREDENTIAL_PROBLEM_CONTAINS_NONDIGIT);
+  return problems;
+}
+
+// Returns a list of length related problems (if any) for a given |pin|
+// given the PIN min/max policies in |profile|. If |out_min_length| and/or
+// |out_max_length| are valid pointers, return the profile min/max length as
+// well.
+std::vector<CredentialProblem> IsPinLengthValid(const std::string& pin,
+                                                Profile* profile,

[Devlin, 2016/11/23 18:22:49]

Maybe just pass in prefs here, rather than the full profile?

[sammiequon, 2016/11/29 19:22:44]

Done.

+                                                int* out_min_length,
+                                                int* out_max_length) {
+  PrefService* pref_service = profile->GetPrefs();
+  int min_length = pref_service->GetInteger(prefs::kPinUnlockMinimumLength);
+  int max_length = pref_service->GetInteger(prefs::kPinUnlockMaximumLength);
+
+  // Sanitize the policy input.
+  if (min_length < 1)
+    min_length = 1;
+  if (max_length < 0)
+    max_length = 0;
+
+  // If the maximum length is nonzero and shorter than the minimum length, the
+  // maximum length is the minimum length.
+  if (max_length != 0 && max_length < min_length)
+    max_length = min_length;
+
+  if (out_min_length)
+    *out_min_length = min_length;
+  if (out_max_length)
+    *out_max_length = max_length;
+
+  std::vector<CredentialProblem> problems;
+
+  // Check if the PIN is shorter than the minimum specified length.
+  if (int{pin.size()} < min_length)

[Devlin, 2016/11/23 18:22:49]

prefer static_cast<int> here (here and below)

[jdufault, 2016/11/28 15:49:40]

The style guide says that int{} style casts are preferred when casting
arithmetic types (https://google.github.io/styleguide/cppguide.html#Casting).

[sammiequon, 2016/11/29 19:22:44]

Done.

+    problems.push_back(CredentialProblem::CREDENTIAL_PROBLEM_TOO_SHORT);
+
+  // If the maximum specified length is zero, there is no maximum length.
+  // Otherwise check if the PIN is longer than the maximum specified length.
+  if (max_length != 0 && int{pin.size()} > max_length)
+    problems.push_back(CredentialProblem::CREDENTIAL_PROBLEM_TOO_LONG);
+
+  return problems;
+}
+
+// Returns a list of problems regarding the difficulty of the PIN (if any) for
+// a given |pin|.
+std::vector<CredentialProblem> IsPinDifficultEnough(const std::string& pin) {
+  std::vector<CredentialProblem> problems;
+  // If the pin length is |kMinLengthForWeakPin| or less, there is no need to
+  // check for same character and increasing pin.
+  if (int{pin.size()} <= kMinLengthForWeakPin)
+    return problems;
+
+  // Check if it is on the list of most common PINs.
+  const char** end = std::end(kMostCommonPins);
+  bool is_common = std::find(kMostCommonPins, end, pin) != end;

[Devlin, 2016/11/23 18:22:48]

just inline std::end() here.

[sammiequon, 2016/11/29 19:22:44]

Done.

+
+  // Check for same digits, increasing PIN simutaneously.
+  bool is_same = true;
+  bool is_increasing = true;
+  bool is_decreasing = true;
+  for (int i = 1; i < int{pin.length()}; ++i) {
+    const char previous = pin[i - 1];
+    const char current = pin[i];
+
+    is_same = is_same && (current == previous);
+    is_increasing = is_increasing && (current == previous + 1);
+    is_decreasing = is_decreasing && (current == previous - 1);

[Devlin, 2016/11/23 18:22:48]

do we have any kind of data for this?  It strikes me as a little weird that
23456789 isn't allowed but 124 is.

[sammiequon, 2016/11/29 19:22:44]

I agree. Let me check with the PM if we should hold up on the increase/decrease
if the pin is sufficiently long.

+  }
+
+  // PIN is considered weak if any of these conditions is met.
+  if (is_same || is_increasing || is_decreasing || is_common)
+    problems.push_back(CredentialProblem::CREDENTIAL_PROBLEM_TOO_WEAK);
+
+  return problems;
+}
+
+void AppendToProblemList(std::vector<CredentialProblem>& dest,
+                         const std::vector<CredentialProblem>& src) {
+  dest.insert(dest.end(), src.begin(), src.end());
+}
+
 }  // namespace
 
 // quickUnlockPrivate.getAvailableModes
 
 QuickUnlockPrivateGetAvailableModesFunction::
     QuickUnlockPrivateGetAvailableModesFunction()
     : chrome_details_(this) {}
 
 QuickUnlockPrivateGetAvailableModesFunction::
     ~QuickUnlockPrivateGetAvailableModesFunction() {}
@@ skipping 17 matching lines @@
 QuickUnlockPrivateGetActiveModesFunction::
     ~QuickUnlockPrivateGetActiveModesFunction() {}
 
 ExtensionFunction::ResponseAction
 QuickUnlockPrivateGetActiveModesFunction::Run() {
   const QuickUnlockModeList modes =
       ComputeActiveModes(chrome_details_.GetProfile());
   return RespondNow(ArgumentList(GetActiveModes::Results::Create(modes)));
 }
 
+// quickUnlockPrivate.checkCredential
+
+QuickUnlockPrivateCheckCredentialFunction::
+    QuickUnlockPrivateCheckCredentialFunction()
+    : chrome_details_(this) {}
+
+QuickUnlockPrivateCheckCredentialFunction::
+    ~QuickUnlockPrivateCheckCredentialFunction() {}
+
+ExtensionFunction::ResponseAction
+QuickUnlockPrivateCheckCredentialFunction::Run() {
+  params_ = CheckCredential::Params::Create(*args_);
+  EXTENSION_FUNCTION_VALIDATE(params_.get());
+
+  auto result = base::MakeUnique<CredentialCheck>();
+
+  // Only handles pins for now.
+  if (params_->mode != QuickUnlockMode::QUICK_UNLOCK_MODE_PIN)
+    return RespondNow(ArgumentList(CheckCredential::Results::Create(*result)));
+
+  std::string credential = params_->credential;
+
+  Profile* profile = chrome_details_.GetProfile();

[Devlin, 2016/11/23 18:22:49]

Prefer to just use Profile::FromBrowserContext(browser_context()).

[sammiequon, 2016/11/29 19:22:44]

Done.

+  PrefService* pref_service = profile->GetPrefs();
+  bool allow_weak = pref_service->GetBoolean(prefs::kPinUnlockAllowWeakPins);
+
+  // Check and return the problems.
+  std::vector<CredentialProblem> validity_problems = IsPinNumeric(credential);

[Devlin, 2016/11/23 18:22:49]

This seems overly complex.  Each of these only returns a single problem, and all
except pin length return a constant problem.  Maybe:
if (!IsPinNumeric())
  problems.push_back(not numeric);
CredentialProblem length_problem;
if (!IsPinLengthValid(&length_problem))
  problems.push_back(length_problem);
if (!IsPinDifficultEnough())
  problems.push_back(too easy);

Then we get rid of AppendToProblemList, returning vectors in all cases, etc.

[sammiequon, 2016/11/29 19:22:44]

Done. This is a lot cleaner. Thanks!

+  // Note: This function call writes values to |result->min_length| and
+  // |result->max_length|.
+  std::vector<CredentialProblem> length_problems = IsPinLengthValid(
+      credential, profile, &result->min_length, &result->max_length);
+  std::vector<CredentialProblem> weak_problems =
+      IsPinDifficultEnough(credential);
+
+  // Append the results from various checks to the appropriate list in |result|.
+  // |validity_problems| and |length_problems| are always errors, while
+  // |weak_problems| are errors or warnings depending on the policy.
+  AppendToProblemList(result->errors, validity_problems);
+  AppendToProblemList(result->errors, length_problems);
+  AppendToProblemList(allow_weak ? result->warnings : result->errors,
+                      weak_problems);
+
+  return RespondNow(ArgumentList(CheckCredential::Results::Create(*result)));
+}
+
 // quickUnlockPrivate.setModes
 
 QuickUnlockPrivateSetModesFunction::QuickUnlockPrivateSetModesFunction()
     : chrome_details_(this) {}
 
 QuickUnlockPrivateSetModesFunction::~QuickUnlockPrivateSetModesFunction() {}
 
 void QuickUnlockPrivateSetModesFunction::SetAuthenticatorAllocatorForTesting(
     const QuickUnlockPrivateSetModesFunction::AuthenticatorAllocator&
         allocator) {
   authenticator_allocator_ = allocator;
 }
 
 void QuickUnlockPrivateSetModesFunction::SetModesChangedEventHandlerForTesting(
     const ModesChangedEventHandler& handler) {
   modes_changed_handler_ = handler;
 }
 
 ExtensionFunction::ResponseAction QuickUnlockPrivateSetModesFunction::Run() {
   params_ = SetModes::Params::Create(*args_);
   EXTENSION_FUNCTION_VALIDATE(params_.get());
 
   if (params_->modes.size() != params_->credentials.size())
     return RespondNow(Error(kModesAndCredentialsLengthMismatch));
 
   if (params_->modes.size() > 1)
     return RespondNow(Error(kMultipleModesNotSupported));
 
-  // Verify every credential is numeric.
-  for (const std::string& credential : params_->credentials) {
-    if (!std::all_of(credential.begin(), credential.end(), ::isdigit))
-      return RespondNow(ArgumentList(SetModes::Results::Create(false)));
+  // Verify every credential is valid based on policies.
+  bool allow_weak = chrome_details_.GetProfile()->GetPrefs()->GetBoolean(
+      prefs::kPinUnlockAllowWeakPins);
+  for (size_t j = 0; j < params_->modes.size(); ++j) {

[Devlin, 2016/11/23 18:22:48]

range-based for loop?

[sammiequon, 2016/11/29 19:22:44]

params->modes & params->credentials are always the same size and i am using both
of their elements inside the for loop.

+    if (params_->credentials[j].empty())
+      continue;
+
+    if (params_->modes[j] == QuickUnlockMode::QUICK_UNLOCK_MODE_PIN) {
+      if (!IsPinNumeric(params_->credentials[j]).empty())
+        return RespondNow(ArgumentList(SetModes::Results::Create(false)));
+
+      if (!IsPinLengthValid(params_->credentials[j],
+                            chrome_details_.GetProfile(), nullptr, nullptr)
+               .empty()) {
+        return RespondNow(ArgumentList(SetModes::Results::Create(false)));
+      }
+      if (!allow_weak &&
+          !IsPinDifficultEnough(params_->credentials[j]).empty()) {
+        return RespondNow(ArgumentList(SetModes::Results::Create(false)));
+      }
+    }
   }
 
   user_manager::User* user = chromeos::ProfileHelper::Get()->GetUserByProfile(
       chrome_details_.GetProfile());
   chromeos::UserContext user_context(user->GetAccountId());
   user_context.SetKey(chromeos::Key(params_->account_password));
 
   // Lazily allocate the authenticator. We do this here, instead of in the ctor,
   // so that tests can install a fake.
   if (authenticator_allocator_.is_null())
@@ skipping 85 matching lines @@
   }
 
   std::unique_ptr<base::ListValue> args = OnActiveModesChanged::Create(modes);
   std::unique_ptr<Event> event(
       new Event(events::QUICK_UNLOCK_PRIVATE_ON_ACTIVE_MODES_CHANGED,
                 OnActiveModesChanged::kEventName, std::move(args)));
   EventRouter::Get(browser_context())->BroadcastEvent(std::move(event));
 }
 
 }  // namespace extensions