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
|
// Copyright 2019 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_DBUS_KERBEROS_KERBEROS_CLIENT_H_
#define CHROMEOS_ASH_COMPONENTS_DBUS_KERBEROS_KERBEROS_CLIENT_H_
#include "base/callback_list.h"
#include "base/component_export.h"
#include "base/functional/callback.h"
#include "chromeos/ash/components/dbus/kerberos/kerberos_service.pb.h"
#include "dbus/object_proxy.h"
namespace dbus {
class Bus;
}
namespace ash {
// KerberosClient is used to communicate with the org.chromium.Kerberos
// service. All method should be called from the origin thread (UI thread) which
// initializes the DBusThreadManager instance.
class COMPONENT_EXPORT(KERBEROS) KerberosClient {
public:
using AddAccountCallback =
base::OnceCallback<void(const kerberos::AddAccountResponse& response)>;
using RemoveAccountCallback =
base::OnceCallback<void(const kerberos::RemoveAccountResponse& response)>;
using ClearAccountsCallback =
base::OnceCallback<void(const kerberos::ClearAccountsResponse& response)>;
using ListAccountsCallback =
base::OnceCallback<void(const kerberos::ListAccountsResponse& response)>;
using SetConfigCallback =
base::OnceCallback<void(const kerberos::SetConfigResponse& response)>;
using ValidateConfigCallback = base::OnceCallback<void(
const kerberos::ValidateConfigResponse& response)>;
using AcquireKerberosTgtCallback = base::OnceCallback<void(
const kerberos::AcquireKerberosTgtResponse& response)>;
using GetKerberosFilesCallback = base::OnceCallback<void(
const kerberos::GetKerberosFilesResponse& response)>;
using PrincipalNameFunc = void(const std::string& principal_name);
using KerberosFilesChangedCallback =
base::RepeatingCallback<PrincipalNameFunc>;
using KerberosTicketExpiringCallback =
base::RepeatingCallback<PrincipalNameFunc>;
// Interface with testing functionality. Accessed through GetTestInterface(),
// only implemented in the fake implementation.
class TestInterface {
public:
// Sets the artificial delay for asynchronous function calls.
// Should be set to 0 for tests.
virtual void SetTaskDelay(base::TimeDelta delay) = 0;
// Starts recording which functions are called.
virtual void StartRecordingFunctionCalls() = 0;
// Stops recording which functions are called and returns calls as a
// comma separated list, e.g. "AddAccount,ListAccounts".
virtual std::string StopRecordingAndGetRecordedFunctionCalls() = 0;
// Returns the number of accounts currently saved.
virtual std::size_t GetNumberOfAccounts() const = 0;
// Sets the simulated number of network failures for |AcquireKerberosTgt()|.
// The default value is zero. This value should be set when testing the
// exponential backoff retry for adding managed accounts.
virtual void SetSimulatedNumberOfNetworkFailures(
int number_of_failures) = 0;
protected:
virtual ~TestInterface() = default;
};
// Creates and initializes the global instance. |bus| must not be null.
static void Initialize(dbus::Bus* bus);
// Creates and initializes a fake global instance if not already created.
static void InitializeFake();
// Destroys the global instance.
static void Shutdown();
// Returns the global instance which may be null if not initialized.
static KerberosClient* Get();
KerberosClient(const KerberosClient&) = delete;
KerberosClient& operator=(const KerberosClient&) = delete;
// Kerberos daemon D-Bus method calls. See org.chromium.Kerberos.xml and
// kerberos_service.proto in Chromium OS code for the documentation of the
// methods and request/response messages.
virtual void AddAccount(const kerberos::AddAccountRequest& request,
AddAccountCallback callback) = 0;
virtual void RemoveAccount(const kerberos::RemoveAccountRequest& request,
RemoveAccountCallback callback) = 0;
virtual void ClearAccounts(const kerberos::ClearAccountsRequest& request,
ClearAccountsCallback callback) = 0;
virtual void ListAccounts(const kerberos::ListAccountsRequest& request,
ListAccountsCallback callback) = 0;
virtual void SetConfig(const kerberos::SetConfigRequest& request,
SetConfigCallback callback) = 0;
virtual void ValidateConfig(const kerberos::ValidateConfigRequest& request,
ValidateConfigCallback callback) = 0;
virtual void AcquireKerberosTgt(
const kerberos::AcquireKerberosTgtRequest& request,
int password_fd,
AcquireKerberosTgtCallback callback) = 0;
virtual void GetKerberosFiles(
const kerberos::GetKerberosFilesRequest& request,
GetKerberosFilesCallback callback) = 0;
virtual base::CallbackListSubscription SubscribeToKerberosFileChangedSignal(
KerberosFilesChangedCallback callback) = 0;
virtual base::CallbackListSubscription
SubscribeToKerberosTicketExpiringSignal(
KerberosTicketExpiringCallback callback) = 0;
// Returns an interface for testing (fake only), or returns nullptr.
virtual TestInterface* GetTestInterface() = 0;
protected:
// Initialize/Shutdown should be used instead.
KerberosClient();
virtual ~KerberosClient();
};
} // namespace ash
#endif // CHROMEOS_ASH_COMPONENTS_DBUS_KERBEROS_KERBEROS_CLIENT_H_
|
