File: directory_service_client.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; 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 (287 lines) | stat: -rw-r--r-- 11,423 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
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "remoting/base/directory_service_client.h"

#include "base/functional/bind.h"
#include "base/strings/stringize_macros.h"
#include "base/system/sys_info.h"
#include "remoting/base/fqdn.h"
#include "remoting/base/protobuf_http_request.h"
#include "remoting/base/protobuf_http_request_config.h"
#include "remoting/base/service_urls.h"
#include "remoting/proto/remoting/v1/directory_messages.pb.h"
#include "remoting/proto/remoting/v1/remote_support_host_messages.pb.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"

namespace {
constexpr net::NetworkTrafficAnnotationTag kDeleteHostTrafficAnnotation =
    net::DefineNetworkTrafficAnnotation("remoting_directory_delete_host",
                                        R"(
        semantics {
          sender: "Chrome Remote Desktop"
          description:
            "Deletes a Chrome Remote Desktop host from the user's account."
          trigger:
            "User deletes a Chrome Remote Desktop host from the host list."
          data:
            "User's Chrome Remote Desktop credentials and the Chrome Remote "
            "Desktop host ID that identifies the host."
          destination: GOOGLE_OWNED_SERVICE
        }
        policy {
          cookies_allowed: NO
          setting:
            "This request cannot be stopped in settings, but will not be sent "
            "if the user does not use Chrome Remote Desktop."
          policy_exception_justification:
            "Not implemented."
        })");

constexpr net::NetworkTrafficAnnotationTag kGetHostListTrafficAnnotation =
    net::DefineNetworkTrafficAnnotation("remoting_directory_get_host_list",
                                        R"(
        semantics {
          sender: "Chrome Remote Desktop"
          description:
            "Retrieves information about Chrome Remote Desktop hosts that are "
            "registered under the user's account."
          trigger:
            "User opens the Chrome Remote Desktop app."
          data:
            "User's Chrome Remote Desktop credentials."
          destination: GOOGLE_OWNED_SERVICE
        }
        policy {
          cookies_allowed: NO
          setting:
            "This request cannot be stopped in settings, but will not be sent "
            "if the user does not use Chrome Remote Desktop."
          policy_exception_justification:
            "Not implemented."
        })");

constexpr net::NetworkTrafficAnnotationTag kLegacyHeartbeatTrafficAnnotation =
    net::DefineNetworkTrafficAnnotation("remoting_directory_legacy_heartbeat",
                                        R"(
        semantics {
          sender: "Chrome Remote Desktop"
          description:
            "Sends updated information about the Chrome Remote Desktop host."
          trigger:
            "Sent when host is initially set up or restarted."
          data:
            "Includes an internal UUID to identify the remote access host "
            "instance, the name and version of the operating system, the "
            "version of the CRD package installed, and a set of signaling ids "
            "which the CRD client can use to send the host messages."
          destination: GOOGLE_OWNED_SERVICE
        }
        policy {
          cookies_allowed: NO
          setting:
            "This request cannot be stopped in settings, but will not be sent "
            "if the user does not use Chrome Remote Desktop."
          policy_exception_justification:
            "Not implemented."
        })");

constexpr net::NetworkTrafficAnnotationTag kRegisterHostTrafficAnnotation =
    net::DefineNetworkTrafficAnnotation("remoting_directory_register_host",
                                        R"(
        semantics {
          sender: "Chrome Remote Desktop"
          description:
            "Registers a new Chrome Remote Desktop host under the user's "
            "account."
          trigger:
            "User runs the remoting_start_host command by typing it on the "
            "terminal. Third party administrators might implement scripts to "
            "run this automatically, but the Chrome Remote Desktop product "
            "does not come with such scripts."
          data:
            "User's Chrome Remote Desktop credentials and information about "
            "the new Chrome Remote Desktop host such as host ID and host name."
          destination: GOOGLE_OWNED_SERVICE
        }
        policy {
          cookies_allowed: NO
          setting:
            "This request cannot be stopped in settings, but will not be sent "
            "if the user does not use Chrome Remote Desktop."
          policy_exception_justification:
            "Not implemented."
        })");

constexpr net::NetworkTrafficAnnotationTag kSendHeartbeatTrafficAnnotation =
    net::DefineNetworkTrafficAnnotation("remoting_directory_send_heartbeat",
                                        R"(
        semantics {
          sender: "Chrome Remote Desktop"
          description:
            "A lightweight heartbeat message that can be used to identify "
            "the last time the Chrome Remote Desktop host was online."
          trigger:
            "Sent periodically from the host to indicate that it is alive."
          data:
            "Includes an internal UUID to identify the remote access host."
          destination: GOOGLE_OWNED_SERVICE
        }
        policy {
          cookies_allowed: NO
          setting:
            "This request cannot be stopped in settings, but will not be sent "
            "if the user does not use Chrome Remote Desktop."
          policy_exception_justification:
            "Not implemented."
        })");

}  // namespace

namespace remoting {

DirectoryServiceClient::DirectoryServiceClient(
    OAuthTokenGetter* token_getter,
    scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory)
    : http_client_(ServiceUrls::GetInstance()->remoting_server_endpoint(),
                   token_getter,
                   url_loader_factory) {}

DirectoryServiceClient::~DirectoryServiceClient() = default;

void DirectoryServiceClient::DeleteHost(const std::string& host_id,
                                        DeleteHostCallback callback) {
  constexpr char path[] = "/v1/directory:deletehost";

  auto delete_host_request = std::make_unique<apis::v1::DeleteHostRequest>();
  delete_host_request->set_host_id(host_id);
  ExecuteRequest(kDeleteHostTrafficAnnotation, path,
                 /*enable_retries=*/true, std::move(delete_host_request),
                 std::move(callback));
}

void DirectoryServiceClient::GetHostList(GetHostListCallback callback) {
  constexpr char path[] = "/v1/directory:gethostlist";

  ExecuteRequest(kGetHostListTrafficAnnotation, path,
                 /*enable_retries=*/true,
                 std::make_unique<apis::v1::GetHostListRequest>(),
                 std::move(callback));
}

void DirectoryServiceClient::GetManagedChromeOsHost(
    const std::string& support_id,
    GetManagedChromeOsHostCallback callback) {
  constexpr char path[] = "/v1/remotesupport:getManagedChromeOsHost";

  auto request = std::make_unique<apis::v1::GetManagedChromeOsHostRequest>();
  request->set_support_id(support_id);
  request->set_client_os_version(STRINGIZE(VERSION));

  // TODO: joedow - Fix the traffic annotation.
  ExecuteRequest(kGetHostListTrafficAnnotation, path,
                 /*enable_retries=*/true, std::move(request),
                 std::move(callback));
}

void DirectoryServiceClient::LegacyHeartbeat(
    const std::string& directory_id,
    std::optional<std::string> signaling_id,
    std::optional<std::string> offline_reason,
    bool is_initial_heartbeat,
    bool set_fqdn,
    const std::string& os_name,
    const std::string& os_version,
    LegacyHeartbeatCallback callback) {
  constexpr char path[] = "/v1/directory:heartbeat";

  auto request = std::make_unique<apis::v1::HeartbeatRequest>();
  request->set_host_id(directory_id);
  if (signaling_id) {
    request->set_tachyon_id(*signaling_id);
  }
  if (offline_reason) {
    request->set_host_offline_reason(*offline_reason);
  }
  request->set_host_version(STRINGIZE(VERSION));
  request->set_host_os_name(os_name);
  request->set_host_os_version(os_version);
  request->set_host_cpu_type(base::SysInfo::OperatingSystemArchitecture());
  request->set_is_initial_heartbeat(is_initial_heartbeat);

  if (set_fqdn) {
    std::string fqdn = GetFqdn();
    if (!fqdn.empty()) {
      request->set_hostname(fqdn);
    }
  }

  // HeartbeatSender has its own retry logic, so we disable it here.
  ExecuteRequest(kLegacyHeartbeatTrafficAnnotation, path,
                 /*enable_retries=*/false, std::move(request),
                 std::move(callback));
}

void DirectoryServiceClient::RegisterHost(const std::string& host_id,
                                          const std::string& host_name,
                                          const std::string& public_key,
                                          const std::string& host_client_id,
                                          RegisterHostCallback callback) {
  constexpr char path[] = "/v1/directory:registerhost";

  auto register_host_request =
      std::make_unique<apis::v1::RegisterHostRequest>();
  if (!host_id.empty()) {
    register_host_request->set_host_id(host_id);
  }
  register_host_request->set_host_name(host_name);
  register_host_request->set_public_key(public_key);
  register_host_request->set_host_client_id(host_client_id);

  // RegisterHost is non-idempotent (potentially multiple host records will be
  // created), so retries may not be safe.
  ExecuteRequest(kRegisterHostTrafficAnnotation, path, /*enable_retries=*/false,
                 std::move(register_host_request), std::move(callback));
}

void DirectoryServiceClient::SendHeartbeat(const std::string& directory_id,
                                           SendHeartbeatCallback callback) {
  constexpr char path[] = "/v1/directory:sendheartbeat";

  auto request = std::make_unique<apis::v1::SendHeartbeatRequest>();
  request->set_host_id(directory_id);

  // HeartbeatSender has its own retry logic, so we disable it here.
  ExecuteRequest(kSendHeartbeatTrafficAnnotation, path,
                 /*enable_retries=*/false, std::move(request),
                 std::move(callback));
}

void DirectoryServiceClient::CancelPendingRequests() {
  http_client_.CancelPendingRequests();
}

template <typename CallbackType>
void DirectoryServiceClient::ExecuteRequest(
    const net::NetworkTrafficAnnotationTag& traffic_annotation,
    const std::string& path,
    bool enable_retries,
    std::unique_ptr<google::protobuf::MessageLite> request_message,
    CallbackType callback) {
  auto request_config =
      std::make_unique<ProtobufHttpRequestConfig>(traffic_annotation);
  request_config->path = path;
  request_config->request_message = std::move(request_message);
  if (enable_retries) {
    request_config->UseSimpleRetryPolicy();
  }

  auto request =
      std::make_unique<ProtobufHttpRequest>(std::move(request_config));
  request->SetTimeoutDuration(base::Seconds(30));
  request->SetResponseCallback(std::move(callback));
  http_client_.ExecuteRequest(std::move(request));
}

}  // namespace remoting