blob: 25f0c7f77246271fe6fe36046295ef63d114ad45 [file] [log] [blame]
Ed Tanous911ac312017-08-15 09:37:42 -07001#pragma once
Ed Tanous3ccb3ad2023-01-13 17:40:03 -08002#include "app.hpp"
3#include "async_resp.hpp"
4#include "dbus_singleton.hpp"
5#include "openbmc_dbus_rest.hpp"
Ed Tanousfaf100f2023-05-25 10:03:14 -07006#include "websocket.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -08007
Ed Tanous911ac312017-08-15 09:37:42 -07008#include <boost/container/flat_map.hpp>
Ed Tanous9b243a42018-08-03 14:33:10 -07009#include <boost/container/flat_set.hpp>
Ed Tanous1abe55e2018-09-05 08:30:59 -070010#include <sdbusplus/bus/match.hpp>
William A. Kennington III0a63b1c2018-10-18 13:37:19 -070011#include <sdbusplus/message/types.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050012
Ed Tanousabf2add2019-01-22 16:40:12 -080013#include <variant>
Ed Tanous9b243a42018-08-03 14:33:10 -070014
Ed Tanous1abe55e2018-09-05 08:30:59 -070015namespace crow
16{
17namespace dbus_monitor
18{
Ed Tanous911ac312017-08-15 09:37:42 -070019
Ed Tanous1abe55e2018-09-05 08:30:59 -070020struct DbusWebsocketSession
21{
Patrick Williams59d494e2022-07-22 19:26:55 -050022 std::vector<std::unique_ptr<sdbusplus::bus::match_t>> matches;
Ed Tanous24b2fe82022-01-06 12:45:54 -080023 boost::container::flat_set<std::string, std::less<>,
24 std::vector<std::string>>
25 interfaces;
Ed Tanous911ac312017-08-15 09:37:42 -070026};
27
Ed Tanouscf9e4172022-12-21 09:30:16 -080028using SessionMap = boost::container::flat_map<crow::websocket::Connection*,
29 DbusWebsocketSession>;
30
31// NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
32static SessionMap sessions;
Ed Tanous911ac312017-08-15 09:37:42 -070033
Ed Tanous9b243a42018-08-03 14:33:10 -070034inline int onPropertyUpdate(sd_bus_message* m, void* userdata,
Ed Tanous81ce6092020-12-17 16:54:55 +000035 sd_bus_error* retError)
Ed Tanous1abe55e2018-09-05 08:30:59 -070036{
Ed Tanouse662eae2022-01-25 10:39:19 -080037 if (retError == nullptr || (sd_bus_error_is_set(retError) != 0))
Ed Tanous1abe55e2018-09-05 08:30:59 -070038 {
Ed Tanous62598e32023-07-17 17:06:25 -070039 BMCWEB_LOG_ERROR("Got sdbus error on match");
Ed Tanous1abe55e2018-09-05 08:30:59 -070040 return 0;
Ed Tanous9b243a42018-08-03 14:33:10 -070041 }
Ed Tanous1abe55e2018-09-05 08:30:59 -070042 crow::websocket::Connection* connection =
43 static_cast<crow::websocket::Connection*>(userdata);
44 auto thisSession = sessions.find(connection);
45 if (thisSession == sessions.end())
46 {
Ed Tanous62598e32023-07-17 17:06:25 -070047 BMCWEB_LOG_ERROR("Couldn't find dbus connection {}",
48 logPtr(connection));
Ed Tanous1abe55e2018-09-05 08:30:59 -070049 return 0;
50 }
Patrick Williams59d494e2022-07-22 19:26:55 -050051 sdbusplus::message_t message(m);
Ed Tanous14766872022-03-15 10:44:42 -070052 nlohmann::json json;
53 json["event"] = message.get_member();
54 json["path"] = message.get_path();
Ed Tanous1abe55e2018-09-05 08:30:59 -070055 if (strcmp(message.get_member(), "PropertiesChanged") == 0)
56 {
Matt Spinler715748a2019-01-30 13:22:28 -060057 nlohmann::json data;
58 int r = openbmc_mapper::convertDBusToJSON("sa{sv}as", message, data);
59 if (r < 0)
60 {
Ed Tanous62598e32023-07-17 17:06:25 -070061 BMCWEB_LOG_ERROR("convertDBusToJSON failed with {}", r);
Matt Spinler715748a2019-01-30 13:22:28 -060062 return 0;
63 }
64 if (!data.is_array())
65 {
Ed Tanous62598e32023-07-17 17:06:25 -070066 BMCWEB_LOG_ERROR("No data in PropertiesChanged signal");
Matt Spinler715748a2019-01-30 13:22:28 -060067 return 0;
68 }
69
70 // data is type sa{sv}as and is an array[3] of string, object, array
Ed Tanous14766872022-03-15 10:44:42 -070071 json["interface"] = data[0];
72 json["properties"] = data[1];
Ed Tanous1abe55e2018-09-05 08:30:59 -070073 }
74 else if (strcmp(message.get_member(), "InterfacesAdded") == 0)
75 {
Matt Spinler715748a2019-01-30 13:22:28 -060076 nlohmann::json data;
77 int r = openbmc_mapper::convertDBusToJSON("oa{sa{sv}}", message, data);
78 if (r < 0)
Ed Tanous1abe55e2018-09-05 08:30:59 -070079 {
Ed Tanous62598e32023-07-17 17:06:25 -070080 BMCWEB_LOG_ERROR("convertDBusToJSON failed with {}", r);
Matt Spinler715748a2019-01-30 13:22:28 -060081 return 0;
82 }
83
84 if (!data.is_array())
85 {
Ed Tanous62598e32023-07-17 17:06:25 -070086 BMCWEB_LOG_ERROR("No data in InterfacesAdded signal");
Matt Spinler715748a2019-01-30 13:22:28 -060087 return 0;
88 }
89
90 // data is type oa{sa{sv}} which is an array[2] of string, object
Patrick Williams62bafc02022-09-08 17:35:35 -050091 for (const auto& entry : data[1].items())
Matt Spinler715748a2019-01-30 13:22:28 -060092 {
93 auto it = thisSession->second.interfaces.find(entry.key());
Ed Tanous1abe55e2018-09-05 08:30:59 -070094 if (it != thisSession->second.interfaces.end())
95 {
Ed Tanous14766872022-03-15 10:44:42 -070096 json["interfaces"][entry.key()] = entry.value();
Ed Tanous1abe55e2018-09-05 08:30:59 -070097 }
98 }
99 }
100 else
101 {
Ed Tanous62598e32023-07-17 17:06:25 -0700102 BMCWEB_LOG_CRITICAL("message {} was unexpected", message.get_member());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700103 return 0;
104 }
Ed Tanous9b243a42018-08-03 14:33:10 -0700105
Ed Tanous71f52d92021-02-19 08:51:17 -0800106 connection->sendText(
Ed Tanous14766872022-03-15 10:44:42 -0700107 json.dump(2, ' ', true, nlohmann::json::error_handler_t::replace));
Ed Tanous1abe55e2018-09-05 08:30:59 -0700108 return 0;
Ed Tanous271584a2019-07-09 16:24:22 -0700109}
Ed Tanous911ac312017-08-15 09:37:42 -0700110
Ed Tanous23a21a12020-07-25 04:45:05 +0000111inline void requestRoutes(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700112{
113 BMCWEB_ROUTE(app, "/subscribe")
Ed Tanous432a8902021-06-14 15:28:56 -0700114 .privileges({{"Login"}})
Ed Tanous1abe55e2018-09-05 08:30:59 -0700115 .websocket()
zhanghch0577726382021-10-21 14:07:57 +0800116 .onopen([&](crow::websocket::Connection& conn) {
Patrick Williams5a39f772023-10-20 11:20:21 -0500117 BMCWEB_LOG_DEBUG("Connection {} opened", logPtr(&conn));
118 sessions.try_emplace(&conn);
119 })
Ed Tanouscb13a392020-07-25 19:02:03 +0000120 .onclose([&](crow::websocket::Connection& conn, const std::string&) {
Patrick Williams5a39f772023-10-20 11:20:21 -0500121 sessions.erase(&conn);
122 })
Ed Tanous62598e32023-07-17 17:06:25 -0700123 .onmessage([&](crow::websocket::Connection& conn,
124 const std::string& data, bool) {
Patrick Williams5a39f772023-10-20 11:20:21 -0500125 const auto sessionPair = sessions.find(&conn);
126 if (sessionPair == sessions.end())
127 {
128 conn.close("Internal error");
129 }
130 DbusWebsocketSession& thisSession = sessionPair->second;
131 BMCWEB_LOG_DEBUG("Connection {} received {}", logPtr(&conn), data);
132 nlohmann::json j = nlohmann::json::parse(data, nullptr, false);
133 if (j.is_discarded())
134 {
135 BMCWEB_LOG_ERROR("Unable to parse json data for monitor");
136 conn.close("Unable to parse json request");
137 return;
138 }
139 nlohmann::json::iterator interfaces = j.find("interfaces");
140 if (interfaces != j.end())
141 {
142 thisSession.interfaces.reserve(interfaces->size());
143 for (auto& interface : *interfaces)
Ed Tanous24b2fe82022-01-06 12:45:54 -0800144 {
Patrick Williams5a39f772023-10-20 11:20:21 -0500145 const std::string* str =
146 interface.get_ptr<const std::string*>();
147 if (str != nullptr)
148 {
149 thisSession.interfaces.insert(*str);
150 }
Ed Tanous62598e32023-07-17 17:06:25 -0700151 }
Patrick Williams5a39f772023-10-20 11:20:21 -0500152 }
153
154 nlohmann::json::iterator paths = j.find("paths");
155 if (paths == j.end())
156 {
157 BMCWEB_LOG_ERROR("Unable to find paths in json data");
158 conn.close("Unable to find paths in json data");
159 return;
160 }
161
162 size_t interfaceCount = thisSession.interfaces.size();
163 if (interfaceCount == 0)
164 {
165 interfaceCount = 1;
166 }
167 // Reserve our matches upfront. For each path there is 1 for
168 // interfacesAdded, and InterfaceCount number for
169 // PropertiesChanged
170 thisSession.matches.reserve(thisSession.matches.size() +
171 paths->size() * (1U + interfaceCount));
172
173 // These regexes derived on the rules here:
174 // https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names
175 static std::regex validPath("^/([A-Za-z0-9_]+/?)*$");
176 static std::regex validInterface(
177 "^[A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)+$");
178
179 for (const auto& thisPath : *paths)
180 {
181 const std::string* thisPathString =
182 thisPath.get_ptr<const std::string*>();
183 if (thisPathString == nullptr)
Ed Tanous62598e32023-07-17 17:06:25 -0700184 {
Patrick Williams5a39f772023-10-20 11:20:21 -0500185 BMCWEB_LOG_ERROR("subscribe path isn't a string?");
186 conn.close();
Ed Tanous62598e32023-07-17 17:06:25 -0700187 return;
188 }
Patrick Williams5a39f772023-10-20 11:20:21 -0500189 if (!std::regex_match(*thisPathString, validPath))
Ed Tanous62598e32023-07-17 17:06:25 -0700190 {
Patrick Williams5a39f772023-10-20 11:20:21 -0500191 BMCWEB_LOG_ERROR("Invalid path name {}", *thisPathString);
192 conn.close();
Ed Tanous9b243a42018-08-03 14:33:10 -0700193 return;
Ed Tanous9b243a42018-08-03 14:33:10 -0700194 }
Patrick Williams5a39f772023-10-20 11:20:21 -0500195 std::string propertiesMatchString =
196 ("type='signal',"
197 "interface='org.freedesktop.DBus.Properties',"
198 "path_namespace='" +
199 *thisPathString +
200 "',"
201 "member='PropertiesChanged'");
202 // If interfaces weren't specified, add a single match for all
203 // interfaces
204 if (thisSession.interfaces.empty())
Ed Tanous002d39b2022-05-31 08:59:27 -0700205 {
Patrick Williams5a39f772023-10-20 11:20:21 -0500206 BMCWEB_LOG_DEBUG("Creating match {}", propertiesMatchString);
Ed Tanous62598e32023-07-17 17:06:25 -0700207
Ed Tanous62598e32023-07-17 17:06:25 -0700208 thisSession.matches.emplace_back(
209 std::make_unique<sdbusplus::bus::match_t>(
Patrick Williams5a39f772023-10-20 11:20:21 -0500210 *crow::connections::systemBus, propertiesMatchString,
Ed Tanous62598e32023-07-17 17:06:25 -0700211 onPropertyUpdate, &conn));
Ed Tanous002d39b2022-05-31 08:59:27 -0700212 }
Patrick Williams5a39f772023-10-20 11:20:21 -0500213 else
214 {
215 // If interfaces were specified, add a match for each
216 // interface
217 for (const std::string& interface : thisSession.interfaces)
218 {
219 if (!std::regex_match(interface, validInterface))
220 {
221 BMCWEB_LOG_ERROR("Invalid interface name {}",
222 interface);
223 conn.close();
224 return;
225 }
226 std::string ifaceMatchString = propertiesMatchString;
227 ifaceMatchString += ",arg0='";
228 ifaceMatchString += interface;
229 ifaceMatchString += "'";
230 BMCWEB_LOG_DEBUG("Creating match {}", ifaceMatchString);
231 thisSession.matches.emplace_back(
232 std::make_unique<sdbusplus::bus::match_t>(
233 *crow::connections::systemBus, ifaceMatchString,
234 onPropertyUpdate, &conn));
235 }
236 }
237 std::string objectManagerMatchString =
238 ("type='signal',"
239 "interface='org.freedesktop.DBus.ObjectManager',"
240 "path_namespace='" +
241 *thisPathString +
242 "',"
243 "member='InterfacesAdded'");
244 BMCWEB_LOG_DEBUG("Creating match {}", objectManagerMatchString);
245 thisSession.matches.emplace_back(
246 std::make_unique<sdbusplus::bus::match_t>(
247 *crow::connections::systemBus, objectManagerMatchString,
248 onPropertyUpdate, &conn));
249 }
250 });
Ed Tanous911ac312017-08-15 09:37:42 -0700251}
Ed Tanous1abe55e2018-09-05 08:30:59 -0700252} // namespace dbus_monitor
253} // namespace crow