blob: 1e06cb565a8dfac221381bb1a3182b3bd16b5a09 [file] [log] [blame]
Garrick Evans08843932019-09-17 14:41:08 +09001// Copyright 2019 The Chromium OS Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Jason Jeremy Imanadffbcb2020-08-31 13:21:36 +09005#ifndef PATCHPANEL_DBUS_CLIENT_H_
6#define PATCHPANEL_DBUS_CLIENT_H_
Garrick Evans08843932019-09-17 14:41:08 +09007
8#include <memory>
Jason Jeremy Imanadffbcb2020-08-31 13:21:36 +09009#include <set>
Jason Jeremy Iman6f1f3e72020-07-06 13:04:03 +090010#include <string>
Garrick Evans08843932019-09-17 14:41:08 +090011#include <utility>
12#include <vector>
13
Hugo Benichicc6850f2020-01-17 13:26:06 +090014#include "base/files/scoped_file.h"
Garrick Evans08843932019-09-17 14:41:08 +090015#include <brillo/brillo_export.h>
16#include <dbus/bus.h>
17#include <dbus/object_proxy.h>
Hugo Benichi8135e562019-12-12 15:56:36 +090018#include <patchpanel/proto_bindings/patchpanel_service.pb.h>
Garrick Evans08843932019-09-17 14:41:08 +090019
20namespace patchpanel {
21
Hugo Benichi51ff71b2020-08-19 00:55:15 +090022// Simple wrapper around patchpanel DBus API. All public functions are blocking
Jie Jiang0a70acf2020-10-02 11:57:32 +090023// DBus calls to patchpaneld (asynchronous calls are mentioned explicitly). The
24// method names and protobuf schema used by patchpanel DBus API are defined in
25// platform2/system_api/dbus/patchpanel. Access control for clients is defined
26// in platform2/patchpanel/dbus.
Garrick Evans08843932019-09-17 14:41:08 +090027class BRILLO_EXPORT Client {
28 public:
Jie Jiang0a70acf2020-10-02 11:57:32 +090029 using GetTrafficCountersCallback =
30 base::OnceCallback<void(const std::vector<TrafficCounter>&)>;
Jie Jiang25c1b972020-11-12 15:42:53 +090031 using NeighborReachabilityEventHandler =
32 base::RepeatingCallback<void(const NeighborReachabilityEventSignal&)>;
Jie Jiang0a70acf2020-10-02 11:57:32 +090033
Garrick Evans08843932019-09-17 14:41:08 +090034 static std::unique_ptr<Client> New();
35
Jie Jiang81c84db2020-09-29 17:40:16 +090036 // Only used in tests.
37 static std::unique_ptr<Client> New(const scoped_refptr<dbus::Bus>& bus,
38 dbus::ObjectProxy* proxy);
Garrick Evans08843932019-09-17 14:41:08 +090039
Jie Jiang81c84db2020-09-29 17:40:16 +090040 virtual ~Client() = default;
Garrick Evans27b74032019-11-19 13:33:47 +090041
Jie Jiang81c84db2020-09-29 17:40:16 +090042 virtual bool NotifyArcStartup(pid_t pid) = 0;
43 virtual bool NotifyArcShutdown() = 0;
Garrick Evans08843932019-09-17 14:41:08 +090044
Jie Jiang81c84db2020-09-29 17:40:16 +090045 virtual std::vector<NetworkDevice> NotifyArcVmStartup(uint32_t cid) = 0;
46 virtual bool NotifyArcVmShutdown(uint32_t cid) = 0;
Garrick Evans27b74032019-11-19 13:33:47 +090047
Jie Jiang81c84db2020-09-29 17:40:16 +090048 virtual bool NotifyTerminaVmStartup(uint32_t cid,
49 NetworkDevice* device,
50 IPv4Subnet* container_subnet) = 0;
51 virtual bool NotifyTerminaVmShutdown(uint32_t cid) = 0;
52
53 virtual bool NotifyPluginVmStartup(uint64_t vm_id,
54 int subnet_index,
55 NetworkDevice* device) = 0;
56 virtual bool NotifyPluginVmShutdown(uint64_t vm_id) = 0;
Garrick Evans376f0672020-01-07 15:31:50 +090057
Hugo Benichi7d9d8db2020-03-30 15:56:56 +090058 // Reset the VPN routing intent mark on a socket to the default policy for
59 // the current uid. This is in general incorrect to call this method for
60 // a socket that is already connected.
Jie Jiang81c84db2020-09-29 17:40:16 +090061 virtual bool DefaultVpnRouting(int socket) = 0;
Hugo Benichi7d9d8db2020-03-30 15:56:56 +090062
63 // Mark a socket to be always routed through a VPN if there is one.
64 // Must be called before the socket is connected.
Jie Jiang81c84db2020-09-29 17:40:16 +090065 virtual bool RouteOnVpn(int socket) = 0;
Hugo Benichi7d9d8db2020-03-30 15:56:56 +090066
67 // Mark a socket to be always routed through the physical network.
68 // Must be called before the socket is connected.
Jie Jiang81c84db2020-09-29 17:40:16 +090069 virtual bool BypassVpn(int socket) = 0;
Hugo Benichi7d9d8db2020-03-30 15:56:56 +090070
Hugo Benichicc6850f2020-01-17 13:26:06 +090071 // Sends a ConnectNamespaceRequest for the given namespace pid. Returns a
72 // pair with a valid ScopedFD and the ConnectNamespaceResponse proto message
73 // received if the request succeeded. Closing the ScopedFD will teardown the
74 // veth and routing setup and free the allocated IPv4 subnet.
Jie Jiang81c84db2020-09-29 17:40:16 +090075 virtual std::pair<base::ScopedFD, patchpanel::ConnectNamespaceResponse>
Hugo Benichicc6850f2020-01-17 13:26:06 +090076 ConnectNamespace(pid_t pid,
77 const std::string& outbound_ifname,
Jie Jiang81c84db2020-09-29 17:40:16 +090078 bool forward_user_traffic) = 0;
Hugo Benichicc6850f2020-01-17 13:26:06 +090079
Jie Jiang0a70acf2020-10-02 11:57:32 +090080 // Gets the traffic counters kept by patchpanel asynchronously, |callback|
81 // will be called with the counters once they are ready, or with an empty
82 // vector when an error happen. |devices| is the set of interfaces (shill
83 // devices) for which counters should be returned, any unknown interfaces will
84 // be ignored. If |devices| is empty, counters for all known interfaces will
85 // be returned.
Jie Jiang81c84db2020-09-29 17:40:16 +090086 virtual void GetTrafficCounters(const std::set<std::string>& devices,
87 GetTrafficCountersCallback callback) = 0;
Jie Jiange02d1202020-07-27 16:57:04 +090088
Jason Jeremy Iman6f1f3e72020-07-06 13:04:03 +090089 // Sends a ModifyPortRuleRequest to modify iptables ingress rules.
90 // This should only be called by permission_broker's 'devbroker'.
Jie Jiang81c84db2020-09-29 17:40:16 +090091 virtual bool ModifyPortRule(patchpanel::ModifyPortRuleRequest::Operation op,
92 patchpanel::ModifyPortRuleRequest::RuleType type,
93 patchpanel::ModifyPortRuleRequest::Protocol proto,
94 const std::string& input_ifname,
95 const std::string& input_dst_ip,
96 uint32_t input_dst_port,
97 const std::string& dst_ip,
98 uint32_t dst_port) = 0;
Jason Jeremy Iman6f1f3e72020-07-06 13:04:03 +090099
Garrick Evans9e637982020-11-30 11:59:27 +0900100 // Obtains a list of NetworkDevices currently managed by patchpanel.
101 virtual std::vector<NetworkDevice> GetDevices() = 0;
102
Jie Jiang25c1b972020-11-12 15:42:53 +0900103 // Registers a handler that will be called on receiving a neighbor
104 // reachability event. Currently these events are generated only for WiFi
Jie Jiange2e4c0b2020-09-16 18:48:43 +0900105 // devices. The handler is registered for as long as this patchpanel::Client
106 // instance is alive.
Jie Jiang25c1b972020-11-12 15:42:53 +0900107 virtual void RegisterNeighborReachabilityEventHandler(
108 NeighborReachabilityEventHandler handler) = 0;
Jie Jiange2e4c0b2020-09-16 18:48:43 +0900109
Jie Jiang81c84db2020-09-29 17:40:16 +0900110 protected:
111 Client() = default;
Garrick Evans08843932019-09-17 14:41:08 +0900112};
113
114} // namespace patchpanel
115
Jason Jeremy Imanadffbcb2020-08-31 13:21:36 +0900116#endif // PATCHPANEL_DBUS_CLIENT_H_