File: prefs_pin_engine_unittest.cc

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (229 lines) | stat: -rw-r--r-- 9,259 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chromeos/ash/components/osauth/impl/engines/prefs_pin_engine.h"

#include "ash/constants/ash_pref_names.h"
#include "base/memory/raw_ptr.h"
#include "base/test/task_environment.h"
#include "base/test/test_future.h"
#include "chromeos/ash/components/dbus/cryptohome/UserDataAuth.pb.h"
#include "chromeos/ash/components/dbus/userdataauth/mock_userdataauth_client.h"
#include "chromeos/ash/components/login/auth/public/key.h"
#include "chromeos/ash/components/osauth/impl/prefs.h"
#include "chromeos/ash/components/osauth/public/auth_factor_engine.h"
#include "chromeos/ash/components/osauth/public/common_types.h"
#include "chromeos/ash/components/osauth/test_support/engine_test_util.h"
#include "chromeos/ash/components/osauth/test_support/mock_auth_factor_engine.h"
#include "components/account_id/account_id.h"
#include "components/prefs/testing_pref_service.h"
#include "components/user_manager/fake_user_manager.h"
#include "google_apis/gaia/gaia_id.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace ash {
namespace {

using ::base::test::TestFuture;
using ::testing::_;
using ::testing::Eq;
using ::testing::InSequence;
using ::testing::IsFalse;
using ::testing::IsTrue;

class PrefsPinEngineTest : public EngineTestBase {
 protected:
  PrefsPinEngineTest() : engine_impl_(core_, prefs_), engine_(&engine_impl_) {
    RegisterPinStoragePrefs(prefs_.registry());
  }

  // Add a salt+pin to the preferences.
  void AddPinToPrefs(const std::string& pin) {
    const std::string salt("ABCDEFGH");
    prefs_.SetString(prefs::kQuickUnlockPinSalt, salt);
    Key key(pin);
    key.Transform(Key::KEY_TYPE_SALTED_PBKDF2_AES256_1234, salt);
    prefs_.SetString(prefs::kQuickUnlockPinSecret, key.GetSecret());
  }

  // Define basic expectations for StartAuthSession and ListAuthFactors calls.
  // These will create a minimal session and indicate that only pin auth
  // factor support is available.
  void ExpectStartAndList() {
    EXPECT_CALL(mock_udac_, StartAuthSession(_, _))
        .WillOnce([this](auto&&, auto&& callback) {
          user_data_auth::StartAuthSessionReply reply;
          reply.set_user_exists(true);
          reply.set_auth_session_id(kAuthSessionId);
          std::move(callback).Run(reply);
        });
    EXPECT_CALL(mock_udac_, ListAuthFactors(_, _))
        .WillOnce([](auto&&, auto&& callback) {
          user_data_auth::ListAuthFactorsReply reply;
          auto* factor = reply.add_configured_auth_factors();
          factor->set_type(user_data_auth::AUTH_FACTOR_TYPE_PASSWORD);
          factor->set_label("password");
          factor->mutable_password_metadata();
          reply.add_supported_auth_factors(
              user_data_auth::AUTH_FACTOR_TYPE_PASSWORD);
          std::move(callback).Run(reply);
        });
  }

  // The engine under test. The `engine_` pointer variable provides easy access
  // to the public engine API and `engine_impl_` can be used to access the
  // engine-specific functions.
  PrefsPinEngine engine_impl_;
  raw_ptr<AuthFactorEngine> engine_;
  const std::string kAuthSessionId = "31415926535";
};

TEST_F(PrefsPinEngineTest, GetFactor) {
  EXPECT_THAT(engine_->GetFactor(), Eq(AshAuthFactor::kLegacyPin));
}

TEST_F(PrefsPinEngineTest, StandardSuccessfulAuthenticate) {
  AccountId id =
      AccountId::FromUserEmailGaiaId("test@example.com", GaiaId("fakegaia"));
  user_manager_.AddGaiaUser(id, user_manager::UserType::kRegular);
  const std::string pin("12345");
  AddPinToPrefs(pin);

  // Initialize the engine.
  TestFuture<AshAuthFactor> init_common;
  engine_->InitializeCommon(init_common.GetCallback());
  EXPECT_THAT(init_common.Get(), Eq(AshAuthFactor::kLegacyPin));

  // Start the auth flow and enable use of the engine.
  MockAuthFactorEngineObserver observer;
  ExpectStartAndList();
  engine_->StartAuthFlow(id, AuthPurpose::kScreenUnlock, &observer);
  engine_->SetUsageAllowed(AuthFactorEngine::UsageAllowed::kEnabled);

  // Run the attempt, expect success.
  EXPECT_CALL(observer, OnFactorAttempt(AshAuthFactor::kLegacyPin));
  EXPECT_CALL(observer, OnFactorAttemptResult(AshAuthFactor::kLegacyPin, true));
  engine_impl_.PerformPinAttempt(pin);
}

TEST_F(PrefsPinEngineTest, StandardFailedAuthenticate) {
  AccountId id =
      AccountId::FromUserEmailGaiaId("test@example.com", GaiaId("fakegaia"));
  user_manager_.AddGaiaUser(id, user_manager::UserType::kRegular);
  const std::string pin("12345"), wrong_pin("23456");
  AddPinToPrefs(pin);

  // Initialize the engine.
  TestFuture<AshAuthFactor> init_common;
  engine_->InitializeCommon(init_common.GetCallback());
  EXPECT_THAT(init_common.Get(), Eq(AshAuthFactor::kLegacyPin));

  // Start the auth flow and enable use of the engine.
  MockAuthFactorEngineObserver observer;
  ExpectStartAndList();
  engine_->StartAuthFlow(id, AuthPurpose::kScreenUnlock, &observer);
  engine_->SetUsageAllowed(AuthFactorEngine::UsageAllowed::kEnabled);

  // Run the attempt, expect success.
  EXPECT_CALL(observer, OnFactorAttempt(AshAuthFactor::kLegacyPin));
  EXPECT_CALL(observer,
              OnFactorAttemptResult(AshAuthFactor::kLegacyPin, false));
  engine_impl_.PerformPinAttempt(wrong_pin);
}

TEST_F(PrefsPinEngineTest, FailuresLeadingToLockout) {
  AccountId id =
      AccountId::FromUserEmailGaiaId("test@example.com", GaiaId("fakegaia"));
  user_manager_.AddGaiaUser(id, user_manager::UserType::kRegular);
  const std::string pin("12345"), wrong_pin("23456");
  AddPinToPrefs(pin);

  // Initialize the engine.
  TestFuture<AshAuthFactor> init_common;
  engine_->InitializeCommon(init_common.GetCallback());
  EXPECT_THAT(init_common.Get(), Eq(AshAuthFactor::kLegacyPin));

  // Start the auth flow and enable use of the engine.
  MockAuthFactorEngineObserver observer;
  ExpectStartAndList();
  engine_->StartAuthFlow(id, AuthPurpose::kScreenUnlock, &observer);
  engine_->SetUsageAllowed(AuthFactorEngine::UsageAllowed::kEnabled);

  // Set up the expected observations for the attempts.
  {
    InSequence s;
    for (int i = 0; i < PrefsPinEngine::kMaximumUnlockAttempts - 1; ++i) {
      EXPECT_CALL(observer, OnFactorAttempt(AshAuthFactor::kLegacyPin));
      EXPECT_CALL(observer,
                  OnFactorAttemptResult(AshAuthFactor::kLegacyPin, false));
    }
    EXPECT_CALL(observer, OnFactorAttempt(AshAuthFactor::kLegacyPin));
    EXPECT_CALL(observer, OnLockoutChanged(AshAuthFactor::kLegacyPin));
    EXPECT_CALL(observer,
                OnFactorAttemptResult(AshAuthFactor::kLegacyPin, false));
  }

  // Run a series of bad attempts until the PIN locks out, then try one final
  // time to make sure that it doesn't work even with the correct PIN.
  for (int i = 0; i < PrefsPinEngine::kMaximumUnlockAttempts; ++i) {
    EXPECT_THAT(engine_->IsLockedOut(), IsFalse());
    engine_impl_.PerformPinAttempt(wrong_pin);
  }
  EXPECT_THAT(engine_->IsLockedOut(), IsTrue());
  engine_impl_.PerformPinAttempt(pin);
}

TEST_F(PrefsPinEngineTest, LockoutClearedAfterAuth) {
  AccountId id =
      AccountId::FromUserEmailGaiaId("test@example.com", GaiaId("fakegaia"));
  user_manager_.AddGaiaUser(id, user_manager::UserType::kRegular);
  const std::string pin("12345"), wrong_pin("23456");
  AddPinToPrefs(pin);

  // Initialize the engine.
  TestFuture<AshAuthFactor> init_common;
  engine_->InitializeCommon(init_common.GetCallback());
  EXPECT_THAT(init_common.Get(), Eq(AshAuthFactor::kLegacyPin));

  // Start the auth flow and enable use of the engine.
  MockAuthFactorEngineObserver observer;
  ExpectStartAndList();
  engine_->StartAuthFlow(id, AuthPurpose::kScreenUnlock, &observer);
  engine_->SetUsageAllowed(AuthFactorEngine::UsageAllowed::kEnabled);

  // Set up the expected observations for the attempts.
  {
    InSequence s;
    // A bunch of failed PIN attempts, eventually ending in lockout.
    for (int i = 0; i < PrefsPinEngine::kMaximumUnlockAttempts - 1; ++i) {
      EXPECT_CALL(observer, OnFactorAttempt(AshAuthFactor::kLegacyPin));
      EXPECT_CALL(observer,
                  OnFactorAttemptResult(AshAuthFactor::kLegacyPin, false));
    }
    EXPECT_CALL(observer, OnFactorAttempt(AshAuthFactor::kLegacyPin));
    EXPECT_CALL(observer, OnLockoutChanged(AshAuthFactor::kLegacyPin));
    EXPECT_CALL(observer,
                OnFactorAttemptResult(AshAuthFactor::kLegacyPin, false));
    // A successful attempt from after the lockout is cleared.
    EXPECT_CALL(observer, OnFactorAttempt(AshAuthFactor::kLegacyPin));
    EXPECT_CALL(observer,
                OnFactorAttemptResult(AshAuthFactor::kLegacyPin, true));
  }

  // Run a series of bad attempts until the PIN locks out.
  for (int i = 0; i < PrefsPinEngine::kMaximumUnlockAttempts; ++i) {
    EXPECT_THAT(engine_->IsLockedOut(), IsFalse());
    engine_impl_.PerformPinAttempt(wrong_pin);
  }
  EXPECT_THAT(engine_->IsLockedOut(), IsTrue());

  // Signal that a successful auth occurred, which should clear the lockout.
  engine_->OnSuccessfulAuthentiation();
  EXPECT_THAT(engine_->IsLockedOut(), IsFalse());
  engine_impl_.PerformPinAttempt(pin);
}

}  // namespace
}  // namespace ash