File: compute_engine_service_client.h

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 (92 lines) | stat: -rw-r--r-- 3,287 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 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef REMOTING_BASE_COMPUTE_ENGINE_SERVICE_CLIENT_H_
#define REMOTING_BASE_COMPUTE_ENGINE_SERVICE_CLIENT_H_

#include <memory>
#include <optional>
#include <string>
#include <string_view>

#include "base/functional/callback_forward.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/threading/thread_checker.h"
#include "base/values.h"
#include "net/http/http_status_code.h"
#include "remoting/base/http_status.h"

namespace net {
struct NetworkTrafficAnnotationTag;
}  // namespace net

namespace network {
class SimpleURLLoader;
class SharedURLLoaderFactory;
}  // namespace network

namespace remoting {

// A service client that communicates with the Compute Engine API. Note that the
// methods must be called from code running within a GCE VM Instance as the API
// does not exist in other contexts.
class ComputeEngineServiceClient {
 public:
  using ResponseCallback = base::OnceCallback<void(const HttpStatus&)>;

  explicit ComputeEngineServiceClient(
      scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory);

  ComputeEngineServiceClient(const ComputeEngineServiceClient&) = delete;
  ComputeEngineServiceClient& operator=(const ComputeEngineServiceClient&) =
      delete;

  ~ComputeEngineServiceClient();

  // Must be called from code running within a Compute Engine Instance.
  // Uses the default service account associated with the Instance.
  // More information on this request can be found at:
  // https://cloud.google.com/compute/docs/instances/verifying-instance-identity
  void GetInstanceIdentityToken(std::string_view audience,
                                ResponseCallback callback);

  // Must be called from code running within a Compute Engine Instance.
  // Retrieves an OAuth access token for the default service account associated
  // with the Compute Engine Instance.
  void GetServiceAccountAccessToken(ResponseCallback callback);

  // Must be called from code running within a Compute Engine Instance.
  // Retrieves the set of OAuth scopes present in access tokens generated for
  // the default service account associated with the Compute Engine Instance.
  void GetServiceAccountScopes(ResponseCallback callback);

  void CancelPendingRequests();

 private:
  void ExecuteRequest(
      std::string_view url,
      const net::NetworkTrafficAnnotationTag& network_annotation,
      ResponseCallback callback);

  void OnRequestComplete(ResponseCallback callback,
                         std::optional<std::string> response_body);

  // The URL used to fetch information from the metadata server. The default
  // hostname and port can be overridden by setting the GCE_METADATA_HOST
  // environment variable.
  std::string metadata_server_base_url_;

  // |url_loader_| is non-null when a request is in-flight.
  std::unique_ptr<network::SimpleURLLoader> url_loader_;
  scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory_;

  THREAD_CHECKER(thread_checker_);

  base::WeakPtrFactory<ComputeEngineServiceClient> weak_ptr_factory_{this};
};

}  // namespace remoting

#endif  // REMOTING_BASE_COMPUTE_ENGINE_SERVICE_CLIENT_H_