File: kcer_rollback_helper.h

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (92 lines) | stat: -rw-r--r-- 3,411 bytes parent folder | download | duplicates (3)
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
// 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.

#ifndef CHROME_BROWSER_ASH_KCER_NSSDB_MIGRATION_KCER_ROLLBACK_HELPER_H_
#define CHROME_BROWSER_ASH_KCER_NSSDB_MIGRATION_KCER_ROLLBACK_HELPER_H_

#include "base/memory/raw_ptr.h"
#include "chromeos/ash/components/kcer/chaps/high_level_chaps_client.h"
#include "chromeos/ash/components/tpm/tpm_token_info_getter.h"
#include "components/prefs/pref_service.h"

namespace kcer::internal {

inline constexpr char kNssDbClientCertsRollback[] =
    "Ash.KcerRollbackHelper.Events";

// This enum should be kept in sync with the `NssDbClientCertsRollbackEvent`
// in tools/metrics/histograms/metadata/ash/enums.xml.
enum class NssDbClientCertsRollbackEvent {
  kRollbackScheduled = 0,
  kRollbackStarted = 1,
  kRollbackSuccessful = 2,
  kFailedNotAllObjectsDeleted = 3,
  kRollbackFlagPresent = 4,
  kRollbackFlagNotPresent = 5,
  kRollbackListSize0 = 6,
  kRollbackListSize1 = 7,
  kRollbackListSize2 = 8,
  kRollbackListSize3 = 9,
  kRollbackListSizeAbove3 = 10,
  kFailedNoSlotInfoFound = 11,
  kFailedNoUserAccountId = 12,
  kFailedFlagResetNotSuccessful = 13,
  kCertCacheResetSuccessful = 14,
  kCertCacheResetFailed = 15,
  kMaxValue = kCertCacheResetFailed,
};

// Helper class for scheduling and executing rollback from usage of software
// backed chaps client to software NSS DB.
class KcerRollbackHelper final {
 public:
  explicit KcerRollbackHelper(HighLevelChapsClient* high_level_chaps_client,
                              PrefService* prefs_service);
  ~KcerRollbackHelper();

  // Checks experiment status and presence of the rollback flag in
  // users preferences `prefs_service`.
  static bool IsChapsRollbackRequired(PrefService* prefs_service);

  // Schedules rollback execution.
  void PerformRollback() const;

 private:
  // Finds users token information and calls FindUserSlotId().
  void FindUserToken() const;

  // Extracts users slot id from `user_token_info` and pass it to
  // SelectAndDeleteDoubleWrittenObjects() .
  void FindUserSlotId(
      std::unique_ptr<ash::TPMTokenInfoGetter> scoped_user_token_info_getter,
      std::optional<user_data_auth::TpmTokenInfo> user_token_info) const;

  // Selects PKCS11 objects which have special attribute
  // 'kCkaChromeOsMigratedFromNss' from `slot_id` and calls
  // DestroyObjectsInSlot() on them.
  void SelectAndDeleteDoubleWrittenObjects(
      SessionChapsClient::SlotId slot_id) const;

  // Destroys objects from `slot_id` included into `handles` with retry.
  // Calls to callback function with `result` as parameter.
  void DestroyObjectsInSlot(
      SessionChapsClient::SlotId slot_id,
      std::vector<SessionChapsClient::ObjectHandle> handles,
      uint32_t result) const;

  // Resets flag in users preferences if rollback finished successfully based
  // on `result_code`.
  void ResetCacheAndRollbackFlag(SessionChapsClient::SlotId slot_id,
                                 uint32_t result_code) const;

  // This should outlives KcerRollbackHelper.
  raw_ptr<kcer::HighLevelChapsClient> high_level_chaps_client_;
  // This should outlives KcerRollbackHelper.
  raw_ptr<PrefService> prefs_service_;
  base::WeakPtrFactory<KcerRollbackHelper> weak_factory_{this};
};

}  // namespace kcer::internal

#endif  // CHROME_BROWSER_ASH_KCER_NSSDB_MIGRATION_KCER_ROLLBACK_HELPER_H_