1 #pragma once 2 #include <app.hpp> 3 #include <async_resp.hpp> 4 #include <boost/container/flat_map.hpp> 5 #include <boost/container/flat_set.hpp> 6 #include <dbus_singleton.hpp> 7 #include <openbmc_dbus_rest.hpp> 8 #include <sdbusplus/bus/match.hpp> 9 #include <sdbusplus/message/types.hpp> 10 #include <websocket.hpp> 11 12 #include <variant> 13 14 namespace crow 15 { 16 namespace dbus_monitor 17 { 18 19 struct DbusWebsocketSession 20 { 21 std::vector<std::unique_ptr<sdbusplus::bus::match::match>> matches; 22 boost::container::flat_set<std::string> interfaces; 23 }; 24 25 static boost::container::flat_map<crow::websocket::Connection*, 26 DbusWebsocketSession> 27 sessions; 28 29 inline int onPropertyUpdate(sd_bus_message* m, void* userdata, 30 sd_bus_error* retError) 31 { 32 if (retError == nullptr || sd_bus_error_is_set(retError)) 33 { 34 BMCWEB_LOG_ERROR << "Got sdbus error on match"; 35 return 0; 36 } 37 crow::websocket::Connection* connection = 38 static_cast<crow::websocket::Connection*>(userdata); 39 auto thisSession = sessions.find(connection); 40 if (thisSession == sessions.end()) 41 { 42 BMCWEB_LOG_ERROR << "Couldn't find dbus connection " << connection; 43 return 0; 44 } 45 sdbusplus::message::message message(m); 46 nlohmann::json j{{"event", message.get_member()}, 47 {"path", message.get_path()}}; 48 if (strcmp(message.get_member(), "PropertiesChanged") == 0) 49 { 50 nlohmann::json data; 51 int r = openbmc_mapper::convertDBusToJSON("sa{sv}as", message, data); 52 if (r < 0) 53 { 54 BMCWEB_LOG_ERROR << "convertDBusToJSON failed with " << r; 55 return 0; 56 } 57 if (!data.is_array()) 58 { 59 BMCWEB_LOG_ERROR << "No data in PropertiesChanged signal"; 60 return 0; 61 } 62 63 // data is type sa{sv}as and is an array[3] of string, object, array 64 j["interface"] = data[0]; 65 j["properties"] = data[1]; 66 } 67 else if (strcmp(message.get_member(), "InterfacesAdded") == 0) 68 { 69 nlohmann::json data; 70 int r = openbmc_mapper::convertDBusToJSON("oa{sa{sv}}", message, data); 71 if (r < 0) 72 { 73 BMCWEB_LOG_ERROR << "convertDBusToJSON failed with " << r; 74 return 0; 75 } 76 77 if (!data.is_array()) 78 { 79 BMCWEB_LOG_ERROR << "No data in InterfacesAdded signal"; 80 return 0; 81 } 82 83 // data is type oa{sa{sv}} which is an array[2] of string, object 84 for (auto& entry : data[1].items()) 85 { 86 auto it = thisSession->second.interfaces.find(entry.key()); 87 if (it != thisSession->second.interfaces.end()) 88 { 89 j["interfaces"][entry.key()] = entry.value(); 90 } 91 } 92 } 93 else 94 { 95 BMCWEB_LOG_CRITICAL << "message " << message.get_member() 96 << " was unexpected"; 97 return 0; 98 } 99 100 connection->sendText( 101 j.dump(2, ' ', true, nlohmann::json::error_handler_t::replace)); 102 return 0; 103 } 104 105 inline void requestRoutes(App& app) 106 { 107 BMCWEB_ROUTE(app, "/subscribe") 108 .privileges({{"Login"}}) 109 .websocket() 110 .onopen([&](crow::websocket::Connection& conn, 111 const std::shared_ptr<bmcweb::AsyncResp>&) { 112 BMCWEB_LOG_DEBUG << "Connection " << &conn << " opened"; 113 sessions[&conn] = DbusWebsocketSession(); 114 }) 115 .onclose([&](crow::websocket::Connection& conn, const std::string&) { 116 sessions.erase(&conn); 117 }) 118 .onmessage([&](crow::websocket::Connection& conn, 119 const std::string& data, bool) { 120 DbusWebsocketSession& thisSession = sessions[&conn]; 121 BMCWEB_LOG_DEBUG << "Connection " << &conn << " received " << data; 122 nlohmann::json j = nlohmann::json::parse(data, nullptr, false); 123 if (j.is_discarded()) 124 { 125 BMCWEB_LOG_ERROR << "Unable to parse json data for monitor"; 126 conn.close("Unable to parse json request"); 127 return; 128 } 129 nlohmann::json::iterator interfaces = j.find("interfaces"); 130 if (interfaces != j.end()) 131 { 132 thisSession.interfaces.reserve(interfaces->size()); 133 for (auto& interface : *interfaces) 134 { 135 const std::string* str = 136 interface.get_ptr<const std::string*>(); 137 if (str != nullptr) 138 { 139 thisSession.interfaces.insert(*str); 140 } 141 } 142 } 143 144 nlohmann::json::iterator paths = j.find("paths"); 145 if (paths == j.end()) 146 { 147 BMCWEB_LOG_ERROR << "Unable to find paths in json data"; 148 conn.close("Unable to find paths in json data"); 149 return; 150 } 151 152 size_t interfaceCount = thisSession.interfaces.size(); 153 if (interfaceCount == 0) 154 { 155 interfaceCount = 1; 156 } 157 // Reserve our matches upfront. For each path there is 1 for 158 // interfacesAdded, and InterfaceCount number for 159 // PropertiesChanged 160 thisSession.matches.reserve(thisSession.matches.size() + 161 paths->size() * (1U + interfaceCount)); 162 std::string objectManagerMatchString; 163 std::string propertiesMatchString; 164 std::string objectManagerInterfacesMatchString; 165 // These regexes derived on the rules here: 166 // https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names 167 std::regex validPath("^/([A-Za-z0-9_]+/?)*$"); 168 std::regex validInterface( 169 "^[A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)+$"); 170 171 for (const auto& thisPath : *paths) 172 { 173 const std::string* thisPathString = 174 thisPath.get_ptr<const std::string*>(); 175 if (thisPathString == nullptr) 176 { 177 BMCWEB_LOG_ERROR << "subscribe path isn't a string?"; 178 conn.close(); 179 return; 180 } 181 if (!std::regex_match(*thisPathString, validPath)) 182 { 183 BMCWEB_LOG_ERROR << "Invalid path name " << *thisPathString; 184 conn.close(); 185 return; 186 } 187 propertiesMatchString = 188 ("type='signal'," 189 "interface='org.freedesktop.DBus.Properties'," 190 "path_namespace='" + 191 *thisPathString + 192 "'," 193 "member='PropertiesChanged'"); 194 // If interfaces weren't specified, add a single match for all 195 // interfaces 196 if (thisSession.interfaces.size() == 0) 197 { 198 BMCWEB_LOG_DEBUG << "Creating match " 199 << propertiesMatchString; 200 201 thisSession.matches.emplace_back( 202 std::make_unique<sdbusplus::bus::match::match>( 203 *crow::connections::systemBus, 204 propertiesMatchString, onPropertyUpdate, &conn)); 205 } 206 else 207 { 208 // If interfaces were specified, add a match for each 209 // interface 210 for (const std::string& interface : thisSession.interfaces) 211 { 212 if (!std::regex_match(interface, validInterface)) 213 { 214 BMCWEB_LOG_ERROR << "Invalid interface name " 215 << interface; 216 conn.close(); 217 return; 218 } 219 std::string ifaceMatchString = propertiesMatchString; 220 ifaceMatchString += ",arg0='"; 221 ifaceMatchString += interface; 222 ifaceMatchString += "'"; 223 BMCWEB_LOG_DEBUG << "Creating match " 224 << ifaceMatchString; 225 thisSession.matches.emplace_back( 226 std::make_unique<sdbusplus::bus::match::match>( 227 *crow::connections::systemBus, ifaceMatchString, 228 onPropertyUpdate, &conn)); 229 } 230 } 231 objectManagerMatchString = 232 ("type='signal'," 233 "interface='org.freedesktop.DBus.ObjectManager'," 234 "path_namespace='" + 235 *thisPathString + 236 "'," 237 "member='InterfacesAdded'"); 238 BMCWEB_LOG_DEBUG << "Creating match " 239 << objectManagerMatchString; 240 thisSession.matches.emplace_back( 241 std::make_unique<sdbusplus::bus::match::match>( 242 *crow::connections::systemBus, objectManagerMatchString, 243 onPropertyUpdate, &conn)); 244 } 245 }); 246 } 247 } // namespace dbus_monitor 248 } // namespace crow 249