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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROMEOS_ASH_COMPONENTS_TPM_TPM_TOKEN_INFO_GETTER_H_
#define CHROMEOS_ASH_COMPONENTS_TPM_TPM_TOKEN_INFO_GETTER_H_
#include <memory>
#include <optional>
#include <string>
#include "base/component_export.h"
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "chromeos/ash/components/dbus/cryptohome/UserDataAuth.pb.h"
#include "chromeos/ash/components/dbus/userdataauth/cryptohome_pkcs11_client.h"
#include "chromeos/dbus/tpm_manager/tpm_manager.pb.h"
#include "components/account_id/account_id.h"
namespace base {
class TaskRunner;
}
namespace ash {
// Class for getting a user or the system TPM token info from cryptohome during
// TPM token loading.
class COMPONENT_EXPORT(CHROMEOS_ASH_COMPONENTS_TPM) TPMTokenInfoGetter {
public:
using TpmTokenInfoCallback = base::OnceCallback<void(
std::optional<user_data_auth::TpmTokenInfo> token_info)>;
// Factory method for TPMTokenInfoGetter for a user token.
static std::unique_ptr<TPMTokenInfoGetter> CreateForUserToken(
const AccountId& account_id,
CryptohomePkcs11Client* cryptohome_pkcs11_client,
const scoped_refptr<base::TaskRunner>& delayed_task_runner);
// Factory method for TPMTokenGetter for the system token.
static std::unique_ptr<TPMTokenInfoGetter> CreateForSystemToken(
CryptohomePkcs11Client* cryptohome_pkcs11_client,
const scoped_refptr<base::TaskRunner>& delayed_task_runner);
TPMTokenInfoGetter(const TPMTokenInfoGetter&) = delete;
TPMTokenInfoGetter& operator=(const TPMTokenInfoGetter&) = delete;
~TPMTokenInfoGetter();
// Starts getting TPM token info. Should be called at most once.
// |callback| will be called when all the info is fetched.
// The object may get deleted before |callback| is called, which is equivalent
// to cancelling the info getting (in which case |callback| will never get
// called).
void Start(TpmTokenInfoCallback callback);
void set_nss_slots_software_fallback_for_testing(
bool use_nss_slots_software_fallback) {
use_nss_slots_software_fallback_ = use_nss_slots_software_fallback;
}
private:
enum Type { TYPE_SYSTEM, TYPE_USER };
enum State {
STATE_INITIAL,
STATE_STARTED,
STATE_TPM_ENABLED,
STATE_NSS_SLOTS_SOFTWARE_FALLBACK,
STATE_DONE
};
TPMTokenInfoGetter(
Type type,
const AccountId& account_id,
CryptohomePkcs11Client* cryptohome_pkcs11_client,
const scoped_refptr<base::TaskRunner>& delayed_task_runner);
// Continues TPM token info getting procedure by starting the task associated
// with the current TPMTokenInfoGetter state.
void Continue();
// If token initialization step fails (e.g. if tpm token is not yet ready)
// schedules the initialization step retry attempt after a timeout.
void RetryLater();
// Callbacks for TpmManagerClient.
void OnGetTpmStatus(
const ::tpm_manager::GetTpmNonsensitiveStatusReply& reply);
// Cryptohome methods callbacks.
void OnPkcs11GetTpmTokenInfo(
std::optional<user_data_auth::Pkcs11GetTpmTokenInfoReply> token_info);
// The task runner used to run delayed tasks when retrying failed Cryptohome
// calls.
scoped_refptr<base::TaskRunner> delayed_task_runner_;
Type type_;
State state_;
// The account id associated with the TPMTokenInfoGetter. Empty for system
// token.
AccountId account_id_;
TpmTokenInfoCallback callback_;
// If set and the TPM is not owned, TPMTokenInfoGetter will still get the
// token info using cryptohome's Pkcs11GetTpmTokenInfo query. The token info
// is needed for falling back to a software-backed initialization of the
// system token.
bool use_nss_slots_software_fallback_ = false;
// The current request delay before the next attempt to initialize the
// TPM. Will be adapted after each attempt.
base::TimeDelta tpm_request_delay_;
raw_ptr<CryptohomePkcs11Client, LeakedDanglingUntriaged>
cryptohome_pkcs11_client_;
base::WeakPtrFactory<TPMTokenInfoGetter> weak_factory_{this};
};
} // namespace ash
#endif // CHROMEOS_ASH_COMPONENTS_TPM_TPM_TOKEN_INFO_GETTER_H_
|
