AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 1 | /* |
| 2 | // Copyright (c) 2020 Intel Corporation |
| 3 | // |
| 4 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | // you may not use this file except in compliance with the License. |
| 6 | // You may obtain a copy of the License at |
| 7 | // |
| 8 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | // |
| 10 | // Unless required by applicable law or agreed to in writing, software |
| 11 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | // See the License for the specific language governing permissions and |
| 14 | // limitations under the License. |
| 15 | */ |
| 16 | #pragma once |
Ed Tanous | 3ccb3ad | 2023-01-13 17:40:03 -0800 | [diff] [blame] | 17 | #include "app.hpp" |
AppaRao Puli | b52664e | 2020-04-09 21:36:51 +0530 | [diff] [blame] | 18 | #include "event_service_manager.hpp" |
Ed Tanous | 3ccb3ad | 2023-01-13 17:40:03 -0800 | [diff] [blame] | 19 | #include "http/utility.hpp" |
| 20 | #include "logging.hpp" |
| 21 | #include "query.hpp" |
| 22 | #include "registries/privilege_registry.hpp" |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 23 | #include "snmp_trap_event_clients.hpp" |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 24 | |
Ed Tanous | 601c71a | 2021-09-08 16:40:12 -0700 | [diff] [blame] | 25 | #include <boost/beast/http/fields.hpp> |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 26 | #include <boost/system/error_code.hpp> |
Ed Tanous | a716aa7 | 2023-08-01 11:35:53 -0700 | [diff] [blame] | 27 | #include <boost/url/parse.hpp> |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 28 | #include <sdbusplus/unpack_properties.hpp> |
| 29 | #include <utils/dbus_utils.hpp> |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 30 | |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 31 | #include <charconv> |
| 32 | #include <memory> |
Ed Tanous | 3544d2a | 2023-08-06 18:12:20 -0700 | [diff] [blame] | 33 | #include <ranges> |
Patrick Williams | 1e270c5 | 2021-12-04 06:06:56 -0600 | [diff] [blame] | 34 | #include <span> |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 35 | #include <string> |
Patrick Williams | 1e270c5 | 2021-12-04 06:06:56 -0600 | [diff] [blame] | 36 | |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 37 | namespace redfish |
| 38 | { |
| 39 | |
AppaRao Puli | 156d6b0 | 2020-04-25 06:04:05 +0530 | [diff] [blame] | 40 | static constexpr const std::array<const char*, 2> supportedEvtFormatTypes = { |
| 41 | eventFormatType, metricReportFormatType}; |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 42 | static constexpr const std::array<const char*, 3> supportedRegPrefixes = { |
P Dheeraj Srujan Kumar | b304bd7 | 2021-01-29 17:46:35 +0530 | [diff] [blame] | 43 | "Base", "OpenBMC", "TaskEvent"}; |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 44 | static constexpr const std::array<const char*, 3> supportedRetryPolicies = { |
| 45 | "TerminateAfterRetries", "SuspendRetries", "RetryForever"}; |
| 46 | |
Sunitha Harish | e56f254 | 2020-07-22 02:38:59 -0500 | [diff] [blame] | 47 | static constexpr const std::array<const char*, 1> supportedResourceTypes = { |
| 48 | "Task"}; |
Sunitha Harish | e56f254 | 2020-07-22 02:38:59 -0500 | [diff] [blame] | 49 | |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 50 | inline void requestRoutesEventService(App& app) |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 51 | { |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 52 | BMCWEB_ROUTE(app, "/redfish/v1/EventService/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 53 | .privileges(redfish::privileges::getEventService) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 54 | .methods(boost::beast::http::verb::get)( |
| 55 | [&app](const crow::Request& req, |
| 56 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
Carson Labrado | 3ba0007 | 2022-06-06 19:40:56 +0000 | [diff] [blame] | 57 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 58 | { |
| 59 | return; |
| 60 | } |
Ed Tanous | 1476687 | 2022-03-15 10:44:42 -0700 | [diff] [blame] | 61 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 62 | asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/EventService"; |
| 63 | asyncResp->res.jsonValue["@odata.type"] = |
| 64 | "#EventService.v1_5_0.EventService"; |
| 65 | asyncResp->res.jsonValue["Id"] = "EventService"; |
| 66 | asyncResp->res.jsonValue["Name"] = "Event Service"; |
AppaRao Puli | 5e44e3d | 2021-03-16 15:37:24 +0000 | [diff] [blame] | 67 | asyncResp->res.jsonValue["ServerSentEventUri"] = |
| 68 | "/redfish/v1/EventService/SSE"; |
| 69 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 70 | asyncResp->res.jsonValue["Subscriptions"]["@odata.id"] = |
| 71 | "/redfish/v1/EventService/Subscriptions"; |
| 72 | asyncResp->res |
| 73 | .jsonValue["Actions"]["#EventService.SubmitTestEvent"]["target"] = |
| 74 | "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent"; |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 75 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 76 | const persistent_data::EventServiceConfig eventServiceConfig = |
| 77 | persistent_data::EventServiceStore::getInstance() |
| 78 | .getEventServiceConfig(); |
zhanghch05 | 8d1b46d | 2021-04-01 11:18:24 +0800 | [diff] [blame] | 79 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 80 | asyncResp->res.jsonValue["Status"]["State"] = |
| 81 | (eventServiceConfig.enabled ? "Enabled" : "Disabled"); |
| 82 | asyncResp->res.jsonValue["ServiceEnabled"] = eventServiceConfig.enabled; |
| 83 | asyncResp->res.jsonValue["DeliveryRetryAttempts"] = |
| 84 | eventServiceConfig.retryAttempts; |
| 85 | asyncResp->res.jsonValue["DeliveryRetryIntervalSeconds"] = |
| 86 | eventServiceConfig.retryTimeoutInterval; |
| 87 | asyncResp->res.jsonValue["EventFormatTypes"] = supportedEvtFormatTypes; |
| 88 | asyncResp->res.jsonValue["RegistryPrefixes"] = supportedRegPrefixes; |
| 89 | asyncResp->res.jsonValue["ResourceTypes"] = supportedResourceTypes; |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 90 | |
Ed Tanous | 613dabe | 2022-07-09 11:17:36 -0700 | [diff] [blame] | 91 | nlohmann::json::object_t supportedSSEFilters; |
| 92 | supportedSSEFilters["EventFormatType"] = true; |
| 93 | supportedSSEFilters["MessageId"] = true; |
| 94 | supportedSSEFilters["MetricReportDefinition"] = true; |
| 95 | supportedSSEFilters["RegistryPrefix"] = true; |
| 96 | supportedSSEFilters["OriginResource"] = false; |
| 97 | supportedSSEFilters["ResourceType"] = false; |
AppaRao Puli | 7d1cc38 | 2020-05-16 02:42:22 +0530 | [diff] [blame] | 98 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 99 | asyncResp->res.jsonValue["SSEFilterPropertiesSupported"] = |
Ed Tanous | 613dabe | 2022-07-09 11:17:36 -0700 | [diff] [blame] | 100 | std::move(supportedSSEFilters); |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 101 | }); |
Ayushi Smriti | 07941a8 | 2020-05-21 15:55:34 +0530 | [diff] [blame] | 102 | |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 103 | BMCWEB_ROUTE(app, "/redfish/v1/EventService/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 104 | .privileges(redfish::privileges::patchEventService) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 105 | .methods(boost::beast::http::verb::patch)( |
Ed Tanous | 45ca1b8 | 2022-03-25 13:07:27 -0700 | [diff] [blame] | 106 | [&app](const crow::Request& req, |
| 107 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
Carson Labrado | 3ba0007 | 2022-06-06 19:40:56 +0000 | [diff] [blame] | 108 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 109 | { |
| 110 | return; |
| 111 | } |
| 112 | std::optional<bool> serviceEnabled; |
| 113 | std::optional<uint32_t> retryAttemps; |
| 114 | std::optional<uint32_t> retryInterval; |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 115 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 116 | if (!json_util::readJsonPatch( |
| 117 | req, asyncResp->res, "ServiceEnabled", serviceEnabled, |
| 118 | "DeliveryRetryAttempts", retryAttemps, |
| 119 | "DeliveryRetryIntervalSeconds", retryInterval)) |
| 120 | { |
| 121 | return; |
| 122 | } |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 123 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 124 | persistent_data::EventServiceConfig eventServiceConfig = |
| 125 | persistent_data::EventServiceStore::getInstance() |
| 126 | .getEventServiceConfig(); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 127 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 128 | if (serviceEnabled) |
| 129 | { |
| 130 | eventServiceConfig.enabled = *serviceEnabled; |
| 131 | } |
Sunitha Harish | e56f254 | 2020-07-22 02:38:59 -0500 | [diff] [blame] | 132 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 133 | if (retryAttemps) |
| 134 | { |
| 135 | // Supported range [1-3] |
| 136 | if ((*retryAttemps < 1) || (*retryAttemps > 3)) |
| 137 | { |
| 138 | messages::queryParameterOutOfRange( |
| 139 | asyncResp->res, std::to_string(*retryAttemps), |
| 140 | "DeliveryRetryAttempts", "[1-3]"); |
| 141 | } |
| 142 | else |
| 143 | { |
| 144 | eventServiceConfig.retryAttempts = *retryAttemps; |
| 145 | } |
| 146 | } |
P Dheeraj Srujan Kumar | b304bd7 | 2021-01-29 17:46:35 +0530 | [diff] [blame] | 147 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 148 | if (retryInterval) |
| 149 | { |
Gunnar Mills | 33a32b3 | 2022-11-17 14:29:07 -0600 | [diff] [blame] | 150 | // Supported range [5 - 180] |
| 151 | if ((*retryInterval < 5) || (*retryInterval > 180)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 152 | { |
| 153 | messages::queryParameterOutOfRange( |
| 154 | asyncResp->res, std::to_string(*retryInterval), |
Gunnar Mills | 33a32b3 | 2022-11-17 14:29:07 -0600 | [diff] [blame] | 155 | "DeliveryRetryIntervalSeconds", "[5-180]"); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 156 | } |
| 157 | else |
| 158 | { |
| 159 | eventServiceConfig.retryTimeoutInterval = *retryInterval; |
| 160 | } |
| 161 | } |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 162 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 163 | EventServiceManager::getInstance().setEventServiceConfig( |
| 164 | eventServiceConfig); |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 165 | }); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | inline void requestRoutesSubmitTestEvent(App& app) |
| 169 | { |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 170 | BMCWEB_ROUTE( |
| 171 | app, "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 172 | .privileges(redfish::privileges::postEventService) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 173 | .methods(boost::beast::http::verb::post)( |
Ed Tanous | 45ca1b8 | 2022-03-25 13:07:27 -0700 | [diff] [blame] | 174 | [&app](const crow::Request& req, |
| 175 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
Carson Labrado | 3ba0007 | 2022-06-06 19:40:56 +0000 | [diff] [blame] | 176 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 177 | { |
| 178 | return; |
| 179 | } |
| 180 | if (!EventServiceManager::getInstance().sendTestEventLog()) |
| 181 | { |
| 182 | messages::serviceDisabled(asyncResp->res, |
| 183 | "/redfish/v1/EventService/"); |
| 184 | return; |
| 185 | } |
| 186 | asyncResp->res.result(boost::beast::http::status::no_content); |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 187 | }); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 188 | } |
| 189 | |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 190 | inline void doSubscriptionCollection( |
Ed Tanous | e81de51 | 2023-06-27 17:07:00 -0700 | [diff] [blame] | 191 | const boost::system::error_code& ec, |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 192 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 193 | const dbus::utility::ManagedObjectType& resp) |
| 194 | { |
| 195 | if (ec) |
| 196 | { |
Ed Tanous | 1306101 | 2023-07-25 11:12:19 -0700 | [diff] [blame] | 197 | if (ec.value() == EBADR || ec.value() == EHOSTUNREACH) |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 198 | { |
| 199 | // This is an optional process so just return if it isn't there |
| 200 | return; |
| 201 | } |
| 202 | |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 203 | BMCWEB_LOG_ERROR("D-Bus response error on GetManagedObjects {}", ec); |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 204 | messages::internalError(asyncResp->res); |
| 205 | return; |
| 206 | } |
| 207 | nlohmann::json& memberArray = asyncResp->res.jsonValue["Members"]; |
| 208 | for (const auto& objpath : resp) |
| 209 | { |
| 210 | sdbusplus::message::object_path path(objpath.first); |
| 211 | const std::string snmpId = path.filename(); |
| 212 | if (snmpId.empty()) |
| 213 | { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 214 | BMCWEB_LOG_ERROR("The SNMP client ID is wrong"); |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 215 | messages::internalError(asyncResp->res); |
| 216 | return; |
| 217 | } |
| 218 | |
| 219 | getSnmpSubscriptionList(asyncResp, snmpId, memberArray); |
| 220 | } |
| 221 | } |
| 222 | |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 223 | inline void requestRoutesEventDestinationCollection(App& app) |
| 224 | { |
Gayathri Leburu | 1ebe3e4 | 2022-02-09 10:45:19 +0000 | [diff] [blame] | 225 | BMCWEB_ROUTE(app, "/redfish/v1/EventService/Subscriptions/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 226 | .privileges(redfish::privileges::getEventDestinationCollection) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 227 | .methods(boost::beast::http::verb::get)( |
Ed Tanous | 45ca1b8 | 2022-03-25 13:07:27 -0700 | [diff] [blame] | 228 | [&app](const crow::Request& req, |
| 229 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
Carson Labrado | 3ba0007 | 2022-06-06 19:40:56 +0000 | [diff] [blame] | 230 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 231 | { |
| 232 | return; |
| 233 | } |
| 234 | asyncResp->res.jsonValue["@odata.type"] = |
| 235 | "#EventDestinationCollection.EventDestinationCollection"; |
| 236 | asyncResp->res.jsonValue["@odata.id"] = |
| 237 | "/redfish/v1/EventService/Subscriptions"; |
| 238 | asyncResp->res.jsonValue["Name"] = "Event Destination Collections"; |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 239 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 240 | nlohmann::json& memberArray = asyncResp->res.jsonValue["Members"]; |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 241 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 242 | std::vector<std::string> subscripIds = |
| 243 | EventServiceManager::getInstance().getAllIDs(); |
| 244 | memberArray = nlohmann::json::array(); |
| 245 | asyncResp->res.jsonValue["Members@odata.count"] = subscripIds.size(); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 246 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 247 | for (const std::string& id : subscripIds) |
| 248 | { |
| 249 | nlohmann::json::object_t member; |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 250 | member["@odata.id"] = boost::urls::format( |
| 251 | "/redfish/v1/EventService/Subscriptions/{}" + id); |
Patrick Williams | b2ba307 | 2023-05-12 10:27:39 -0500 | [diff] [blame] | 252 | memberArray.emplace_back(std::move(member)); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 253 | } |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 254 | crow::connections::systemBus->async_method_call( |
Ed Tanous | e81de51 | 2023-06-27 17:07:00 -0700 | [diff] [blame] | 255 | [asyncResp](const boost::system::error_code& ec, |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 256 | const dbus::utility::ManagedObjectType& resp) { |
| 257 | doSubscriptionCollection(ec, asyncResp, resp); |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 258 | }, |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 259 | "xyz.openbmc_project.Network.SNMP", |
| 260 | "/xyz/openbmc_project/network/snmp/manager", |
| 261 | "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 262 | }); |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 263 | |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 264 | BMCWEB_ROUTE(app, "/redfish/v1/EventService/Subscriptions/") |
Abhishek Patel | 7eeafa7 | 2021-07-28 10:59:16 -0500 | [diff] [blame] | 265 | .privileges(redfish::privileges::postEventDestinationCollection) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 266 | .methods(boost::beast::http::verb::post)( |
| 267 | [&app](const crow::Request& req, |
| 268 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
Carson Labrado | 3ba0007 | 2022-06-06 19:40:56 +0000 | [diff] [blame] | 269 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 270 | { |
| 271 | return; |
| 272 | } |
| 273 | if (EventServiceManager::getInstance().getNumberOfSubscriptions() >= |
| 274 | maxNoOfSubscriptions) |
| 275 | { |
| 276 | messages::eventSubscriptionLimitExceeded(asyncResp->res); |
| 277 | return; |
| 278 | } |
| 279 | std::string destUrl; |
| 280 | std::string protocol; |
| 281 | std::optional<std::string> context; |
| 282 | std::optional<std::string> subscriptionType; |
| 283 | std::optional<std::string> eventFormatType2; |
| 284 | std::optional<std::string> retryPolicy; |
| 285 | std::optional<std::vector<std::string>> msgIds; |
| 286 | std::optional<std::vector<std::string>> regPrefixes; |
| 287 | std::optional<std::vector<std::string>> resTypes; |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 288 | std::optional<std::vector<nlohmann::json::object_t>> headers; |
| 289 | std::optional<std::vector<nlohmann::json::object_t>> mrdJsonArray; |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 290 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 291 | if (!json_util::readJsonPatch( |
| 292 | req, asyncResp->res, "Destination", destUrl, "Context", context, |
| 293 | "Protocol", protocol, "SubscriptionType", subscriptionType, |
| 294 | "EventFormatType", eventFormatType2, "HttpHeaders", headers, |
| 295 | "RegistryPrefixes", regPrefixes, "MessageIds", msgIds, |
| 296 | "DeliveryRetryPolicy", retryPolicy, "MetricReportDefinitions", |
| 297 | mrdJsonArray, "ResourceTypes", resTypes)) |
| 298 | { |
| 299 | return; |
| 300 | } |
| 301 | |
AppaRao Puli | 600af5f | 2021-10-06 21:51:16 +0000 | [diff] [blame] | 302 | // https://stackoverflow.com/questions/417142/what-is-the-maximum-length-of-a-url-in-different-browsers |
| 303 | static constexpr const uint16_t maxDestinationSize = 2000; |
| 304 | if (destUrl.size() > maxDestinationSize) |
| 305 | { |
| 306 | messages::stringValueTooLong(asyncResp->res, "Destination", |
| 307 | maxDestinationSize); |
| 308 | return; |
| 309 | } |
| 310 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 311 | if (regPrefixes && msgIds) |
| 312 | { |
| 313 | if (!regPrefixes->empty() && !msgIds->empty()) |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 314 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 315 | messages::propertyValueConflict(asyncResp->res, "MessageIds", |
| 316 | "RegistryPrefixes"); |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 317 | return; |
| 318 | } |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 319 | } |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 320 | |
Ed Tanous | 6fd2955 | 2023-10-04 09:40:14 -0700 | [diff] [blame] | 321 | boost::system::result<boost::urls::url> url = |
Ed Tanous | a716aa7 | 2023-08-01 11:35:53 -0700 | [diff] [blame] | 322 | boost::urls::parse_absolute_uri(destUrl); |
| 323 | if (!url) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 324 | { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 325 | BMCWEB_LOG_WARNING("Failed to validate and split destination url"); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 326 | messages::propertyValueFormatError(asyncResp->res, destUrl, |
| 327 | "Destination"); |
| 328 | return; |
| 329 | } |
Ed Tanous | a716aa7 | 2023-08-01 11:35:53 -0700 | [diff] [blame] | 330 | url->normalize(); |
| 331 | crow::utility::setProtocolDefaults(*url, protocol); |
| 332 | crow::utility::setPortDefaults(*url); |
| 333 | |
| 334 | if (url->path().empty()) |
| 335 | { |
| 336 | url->set_path("/"); |
| 337 | } |
| 338 | |
| 339 | if (url->has_userinfo()) |
| 340 | { |
| 341 | messages::propertyValueFormatError(asyncResp->res, destUrl, |
| 342 | "Destination"); |
| 343 | return; |
| 344 | } |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 345 | |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 346 | if (protocol == "SNMPv2c") |
| 347 | { |
| 348 | if (context) |
| 349 | { |
| 350 | messages::propertyValueConflict(asyncResp->res, "Context", |
| 351 | "Protocol"); |
| 352 | return; |
| 353 | } |
| 354 | if (eventFormatType2) |
| 355 | { |
| 356 | messages::propertyValueConflict(asyncResp->res, |
| 357 | "EventFormatType", "Protocol"); |
| 358 | return; |
| 359 | } |
| 360 | if (retryPolicy) |
| 361 | { |
| 362 | messages::propertyValueConflict(asyncResp->res, "RetryPolicy", |
| 363 | "Protocol"); |
| 364 | return; |
| 365 | } |
| 366 | if (msgIds) |
| 367 | { |
| 368 | messages::propertyValueConflict(asyncResp->res, "MessageIds", |
| 369 | "Protocol"); |
| 370 | return; |
| 371 | } |
| 372 | if (regPrefixes) |
| 373 | { |
| 374 | messages::propertyValueConflict(asyncResp->res, |
| 375 | "RegistryPrefixes", "Protocol"); |
| 376 | return; |
| 377 | } |
| 378 | if (resTypes) |
| 379 | { |
| 380 | messages::propertyValueConflict(asyncResp->res, "ResourceTypes", |
| 381 | "Protocol"); |
| 382 | return; |
| 383 | } |
| 384 | if (headers) |
| 385 | { |
| 386 | messages::propertyValueConflict(asyncResp->res, "HttpHeaders", |
| 387 | "Protocol"); |
| 388 | return; |
| 389 | } |
| 390 | if (mrdJsonArray) |
| 391 | { |
| 392 | messages::propertyValueConflict( |
| 393 | asyncResp->res, "MetricReportDefinitions", "Protocol"); |
| 394 | return; |
| 395 | } |
Ed Tanous | a716aa7 | 2023-08-01 11:35:53 -0700 | [diff] [blame] | 396 | if (url->scheme() != "snmp") |
| 397 | { |
| 398 | messages::propertyValueConflict(asyncResp->res, "Destination", |
| 399 | "Protocol"); |
| 400 | return; |
| 401 | } |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 402 | |
Ed Tanous | a716aa7 | 2023-08-01 11:35:53 -0700 | [diff] [blame] | 403 | addSnmpTrapClient(asyncResp, url->host_address(), |
| 404 | url->port_number()); |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 405 | return; |
| 406 | } |
| 407 | |
Ed Tanous | a716aa7 | 2023-08-01 11:35:53 -0700 | [diff] [blame] | 408 | std::shared_ptr<Subscription> subValue = |
| 409 | std::make_shared<Subscription>(*url, app.ioContext()); |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 410 | |
Ed Tanous | a716aa7 | 2023-08-01 11:35:53 -0700 | [diff] [blame] | 411 | subValue->destinationUrl = std::move(*url); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 412 | |
| 413 | if (subscriptionType) |
| 414 | { |
| 415 | if (*subscriptionType != "RedfishEvent") |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 416 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 417 | messages::propertyValueNotInList( |
| 418 | asyncResp->res, *subscriptionType, "SubscriptionType"); |
| 419 | return; |
| 420 | } |
| 421 | subValue->subscriptionType = *subscriptionType; |
| 422 | } |
| 423 | else |
| 424 | { |
| 425 | subValue->subscriptionType = "RedfishEvent"; // Default |
| 426 | } |
| 427 | |
| 428 | if (protocol != "Redfish") |
| 429 | { |
| 430 | messages::propertyValueNotInList(asyncResp->res, protocol, |
| 431 | "Protocol"); |
| 432 | return; |
| 433 | } |
| 434 | subValue->protocol = protocol; |
| 435 | |
| 436 | if (eventFormatType2) |
| 437 | { |
Ed Tanous | 3544d2a | 2023-08-06 18:12:20 -0700 | [diff] [blame] | 438 | if (std::ranges::find(supportedEvtFormatTypes, *eventFormatType2) == |
| 439 | supportedEvtFormatTypes.end()) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 440 | { |
| 441 | messages::propertyValueNotInList( |
| 442 | asyncResp->res, *eventFormatType2, "EventFormatType"); |
| 443 | return; |
| 444 | } |
| 445 | subValue->eventFormatType = *eventFormatType2; |
| 446 | } |
| 447 | else |
| 448 | { |
| 449 | // If not specified, use default "Event" |
| 450 | subValue->eventFormatType = "Event"; |
| 451 | } |
| 452 | |
| 453 | if (context) |
| 454 | { |
Ed Tanous | 8ece0e4 | 2024-01-02 13:16:50 -0800 | [diff] [blame] | 455 | // This value is selected arbitrarily. |
AppaRao Puli | 600af5f | 2021-10-06 21:51:16 +0000 | [diff] [blame] | 456 | constexpr const size_t maxContextSize = 256; |
| 457 | if (context->size() > maxContextSize) |
| 458 | { |
| 459 | messages::stringValueTooLong(asyncResp->res, "Context", |
| 460 | maxContextSize); |
| 461 | return; |
| 462 | } |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 463 | subValue->customText = *context; |
| 464 | } |
| 465 | |
| 466 | if (headers) |
| 467 | { |
AppaRao Puli | 600af5f | 2021-10-06 21:51:16 +0000 | [diff] [blame] | 468 | size_t cumulativeLen = 0; |
| 469 | |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 470 | for (const nlohmann::json::object_t& headerChunk : *headers) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 471 | { |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 472 | for (const auto& item : headerChunk) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 473 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 474 | const std::string* value = |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 475 | item.second.get_ptr<const std::string*>(); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 476 | if (value == nullptr) |
| 477 | { |
| 478 | messages::propertyValueFormatError( |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 479 | asyncResp->res, item.second, |
| 480 | "HttpHeaders/" + item.first); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 481 | return; |
| 482 | } |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 483 | // Adding a new json value is the size of the key, + |
| 484 | // the size of the value + 2 * 2 quotes for each, + |
| 485 | // the colon and space between. example: |
| 486 | // "key": "value" |
| 487 | cumulativeLen += item.first.size() + value->size() + 6; |
| 488 | // This value is selected to mirror http_connection.hpp |
| 489 | constexpr const uint16_t maxHeaderSizeED = 8096; |
| 490 | if (cumulativeLen > maxHeaderSizeED) |
| 491 | { |
| 492 | messages::arraySizeTooLong( |
| 493 | asyncResp->res, "HttpHeaders", maxHeaderSizeED); |
| 494 | return; |
| 495 | } |
| 496 | subValue->httpHeaders.set(item.first, *value); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 497 | } |
| 498 | } |
| 499 | } |
| 500 | |
| 501 | if (regPrefixes) |
| 502 | { |
| 503 | for (const std::string& it : *regPrefixes) |
| 504 | { |
Ed Tanous | 3544d2a | 2023-08-06 18:12:20 -0700 | [diff] [blame] | 505 | if (std::ranges::find(supportedRegPrefixes, it) == |
| 506 | supportedRegPrefixes.end()) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 507 | { |
| 508 | messages::propertyValueNotInList(asyncResp->res, it, |
| 509 | "RegistryPrefixes"); |
P Dheeraj Srujan Kumar | b304bd7 | 2021-01-29 17:46:35 +0530 | [diff] [blame] | 510 | return; |
| 511 | } |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 512 | } |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 513 | subValue->registryPrefixes = *regPrefixes; |
| 514 | } |
P Dheeraj Srujan Kumar | b304bd7 | 2021-01-29 17:46:35 +0530 | [diff] [blame] | 515 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 516 | if (resTypes) |
| 517 | { |
| 518 | for (const std::string& it : *resTypes) |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 519 | { |
Ed Tanous | 3544d2a | 2023-08-06 18:12:20 -0700 | [diff] [blame] | 520 | if (std::ranges::find(supportedResourceTypes, it) == |
| 521 | supportedResourceTypes.end()) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 522 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 523 | messages::propertyValueNotInList(asyncResp->res, it, |
| 524 | "ResourceTypes"); |
AppaRao Puli | 144b631 | 2020-08-03 22:23:12 +0530 | [diff] [blame] | 525 | return; |
| 526 | } |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 527 | } |
| 528 | subValue->resourceTypes = *resTypes; |
| 529 | } |
| 530 | |
| 531 | if (msgIds) |
| 532 | { |
| 533 | std::vector<std::string> registryPrefix; |
| 534 | |
| 535 | // If no registry prefixes are mentioned, consider all |
| 536 | // supported prefixes |
| 537 | if (subValue->registryPrefixes.empty()) |
| 538 | { |
| 539 | registryPrefix.assign(supportedRegPrefixes.begin(), |
| 540 | supportedRegPrefixes.end()); |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 541 | } |
| 542 | else |
| 543 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 544 | registryPrefix = subValue->registryPrefixes; |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 545 | } |
AppaRao Puli | 156d6b0 | 2020-04-25 06:04:05 +0530 | [diff] [blame] | 546 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 547 | for (const std::string& id : *msgIds) |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 548 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 549 | bool validId = false; |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 550 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 551 | // Check for Message ID in each of the selected Registry |
| 552 | for (const std::string& it : registryPrefix) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 553 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 554 | const std::span<const redfish::registries::MessageEntry> |
| 555 | registry = |
| 556 | redfish::registries::getRegistryFromPrefix(it); |
| 557 | |
Ed Tanous | 3544d2a | 2023-08-06 18:12:20 -0700 | [diff] [blame] | 558 | if (std::ranges::any_of( |
| 559 | registry, |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 560 | [&id](const redfish::registries::MessageEntry& |
| 561 | messageEntry) { |
| 562 | return id == messageEntry.first; |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 563 | })) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 564 | { |
| 565 | validId = true; |
| 566 | break; |
| 567 | } |
| 568 | } |
| 569 | |
| 570 | if (!validId) |
| 571 | { |
| 572 | messages::propertyValueNotInList(asyncResp->res, id, |
| 573 | "MessageIds"); |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 574 | return; |
| 575 | } |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 576 | } |
| 577 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 578 | subValue->registryMsgIds = *msgIds; |
| 579 | } |
| 580 | |
| 581 | if (retryPolicy) |
| 582 | { |
Ed Tanous | 3544d2a | 2023-08-06 18:12:20 -0700 | [diff] [blame] | 583 | if (std::ranges::find(supportedRetryPolicies, *retryPolicy) == |
| 584 | supportedRetryPolicies.end()) |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 585 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 586 | messages::propertyValueNotInList(asyncResp->res, *retryPolicy, |
| 587 | "DeliveryRetryPolicy"); |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 588 | return; |
| 589 | } |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 590 | subValue->retryPolicy = *retryPolicy; |
| 591 | } |
| 592 | else |
| 593 | { |
| 594 | // Default "TerminateAfterRetries" |
| 595 | subValue->retryPolicy = "TerminateAfterRetries"; |
| 596 | } |
Ed Tanous | fffb8c1 | 2022-02-07 23:53:03 -0800 | [diff] [blame] | 597 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 598 | if (mrdJsonArray) |
| 599 | { |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 600 | for (nlohmann::json::object_t& mrdObj : *mrdJsonArray) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 601 | { |
| 602 | std::string mrdUri; |
| 603 | |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 604 | if (!json_util::readJsonObject(mrdObj, asyncResp->res, |
| 605 | "@odata.id", mrdUri)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 606 | |
| 607 | { |
| 608 | return; |
| 609 | } |
| 610 | subValue->metricReportDefinitions.emplace_back(mrdUri); |
| 611 | } |
| 612 | } |
| 613 | |
| 614 | std::string id = |
| 615 | EventServiceManager::getInstance().addSubscription(subValue); |
| 616 | if (id.empty()) |
| 617 | { |
| 618 | messages::internalError(asyncResp->res); |
| 619 | return; |
| 620 | } |
| 621 | |
| 622 | messages::created(asyncResp->res); |
| 623 | asyncResp->res.addHeader( |
| 624 | "Location", "/redfish/v1/EventService/Subscriptions/" + id); |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 625 | }); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 626 | } |
| 627 | |
| 628 | inline void requestRoutesEventDestination(App& app) |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 629 | { |
Ravi Teja | 9d41aec | 2021-07-23 01:57:01 -0500 | [diff] [blame] | 630 | BMCWEB_ROUTE(app, "/redfish/v1/EventService/Subscriptions/<str>/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 631 | .privileges(redfish::privileges::getEventDestination) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 632 | .methods(boost::beast::http::verb::get)( |
Ed Tanous | 45ca1b8 | 2022-03-25 13:07:27 -0700 | [diff] [blame] | 633 | [&app](const crow::Request& req, |
| 634 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 635 | const std::string& param) { |
Carson Labrado | 3ba0007 | 2022-06-06 19:40:56 +0000 | [diff] [blame] | 636 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 637 | { |
| 638 | return; |
| 639 | } |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 640 | |
| 641 | if (param.starts_with("snmp")) |
| 642 | { |
| 643 | getSnmpTrapClient(asyncResp, param); |
| 644 | return; |
| 645 | } |
| 646 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 647 | std::shared_ptr<Subscription> subValue = |
| 648 | EventServiceManager::getInstance().getSubscription(param); |
| 649 | if (subValue == nullptr) |
| 650 | { |
| 651 | asyncResp->res.result(boost::beast::http::status::not_found); |
| 652 | return; |
| 653 | } |
| 654 | const std::string& id = param; |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 655 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 656 | asyncResp->res.jsonValue["@odata.type"] = |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 657 | "#EventDestination.v1_8_0.EventDestination"; |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 658 | asyncResp->res.jsonValue["Protocol"] = "Redfish"; |
Ed Tanous | 3b32780 | 2023-08-14 09:23:43 -0700 | [diff] [blame] | 659 | asyncResp->res.jsonValue["@odata.id"] = boost::urls::format( |
| 660 | "/redfish/v1/EventService/Subscriptions/{}", id); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 661 | asyncResp->res.jsonValue["Id"] = id; |
| 662 | asyncResp->res.jsonValue["Name"] = "Event Destination " + id; |
| 663 | asyncResp->res.jsonValue["Destination"] = subValue->destinationUrl; |
| 664 | asyncResp->res.jsonValue["Context"] = subValue->customText; |
| 665 | asyncResp->res.jsonValue["SubscriptionType"] = |
| 666 | subValue->subscriptionType; |
| 667 | asyncResp->res.jsonValue["HttpHeaders"] = nlohmann::json::array(); |
| 668 | asyncResp->res.jsonValue["EventFormatType"] = subValue->eventFormatType; |
| 669 | asyncResp->res.jsonValue["RegistryPrefixes"] = |
| 670 | subValue->registryPrefixes; |
| 671 | asyncResp->res.jsonValue["ResourceTypes"] = subValue->resourceTypes; |
zhanghch05 | 8d1b46d | 2021-04-01 11:18:24 +0800 | [diff] [blame] | 672 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 673 | asyncResp->res.jsonValue["MessageIds"] = subValue->registryMsgIds; |
| 674 | asyncResp->res.jsonValue["DeliveryRetryPolicy"] = subValue->retryPolicy; |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 675 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 676 | nlohmann::json::array_t mrdJsonArray; |
| 677 | for (const auto& mdrUri : subValue->metricReportDefinitions) |
| 678 | { |
| 679 | nlohmann::json::object_t mdr; |
| 680 | mdr["@odata.id"] = mdrUri; |
| 681 | mrdJsonArray.emplace_back(std::move(mdr)); |
| 682 | } |
| 683 | asyncResp->res.jsonValue["MetricReportDefinitions"] = mrdJsonArray; |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 684 | }); |
Ravi Teja | 9d41aec | 2021-07-23 01:57:01 -0500 | [diff] [blame] | 685 | BMCWEB_ROUTE(app, "/redfish/v1/EventService/Subscriptions/<str>/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 686 | // The below privilege is wrong, it should be ConfigureManager OR |
| 687 | // ConfigureSelf |
Abhishek Patel | 7eeafa7 | 2021-07-28 10:59:16 -0500 | [diff] [blame] | 688 | // https://github.com/openbmc/bmcweb/issues/220 |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 689 | //.privileges(redfish::privileges::patchEventDestination) |
Ed Tanous | 432a890 | 2021-06-14 15:28:56 -0700 | [diff] [blame] | 690 | .privileges({{"ConfigureManager"}}) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 691 | .methods(boost::beast::http::verb::patch)( |
Ed Tanous | 45ca1b8 | 2022-03-25 13:07:27 -0700 | [diff] [blame] | 692 | [&app](const crow::Request& req, |
| 693 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 694 | const std::string& param) { |
Carson Labrado | 3ba0007 | 2022-06-06 19:40:56 +0000 | [diff] [blame] | 695 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 696 | { |
| 697 | return; |
| 698 | } |
| 699 | std::shared_ptr<Subscription> subValue = |
| 700 | EventServiceManager::getInstance().getSubscription(param); |
| 701 | if (subValue == nullptr) |
| 702 | { |
| 703 | asyncResp->res.result(boost::beast::http::status::not_found); |
| 704 | return; |
| 705 | } |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 706 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 707 | std::optional<std::string> context; |
| 708 | std::optional<std::string> retryPolicy; |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 709 | std::optional<std::vector<nlohmann::json::object_t>> headers; |
Sunitha Harish | e56f254 | 2020-07-22 02:38:59 -0500 | [diff] [blame] | 710 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 711 | if (!json_util::readJsonPatch(req, asyncResp->res, "Context", context, |
| 712 | "DeliveryRetryPolicy", retryPolicy, |
| 713 | "HttpHeaders", headers)) |
| 714 | { |
| 715 | return; |
| 716 | } |
AppaRao Puli | 144b631 | 2020-08-03 22:23:12 +0530 | [diff] [blame] | 717 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 718 | if (context) |
| 719 | { |
| 720 | subValue->customText = *context; |
| 721 | } |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 722 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 723 | if (headers) |
| 724 | { |
| 725 | boost::beast::http::fields fields; |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 726 | for (const nlohmann::json::object_t& headerChunk : *headers) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 727 | { |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 728 | for (const auto& it : headerChunk) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 729 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 730 | const std::string* value = |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 731 | it.second.get_ptr<const std::string*>(); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 732 | if (value == nullptr) |
Ed Tanous | 601c71a | 2021-09-08 16:40:12 -0700 | [diff] [blame] | 733 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 734 | messages::propertyValueFormatError( |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 735 | asyncResp->res, it.second, |
| 736 | "HttpHeaders/" + it.first); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 737 | return; |
| 738 | } |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 739 | fields.set(it.first, *value); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 740 | } |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 741 | } |
Ed Tanous | 78d4ec4 | 2024-03-06 17:36:33 -0800 | [diff] [blame] | 742 | subValue->httpHeaders = std::move(fields); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 743 | } |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 744 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 745 | if (retryPolicy) |
| 746 | { |
Ed Tanous | 3544d2a | 2023-08-06 18:12:20 -0700 | [diff] [blame] | 747 | if (std::ranges::find(supportedRetryPolicies, *retryPolicy) == |
| 748 | supportedRetryPolicies.end()) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 749 | { |
| 750 | messages::propertyValueNotInList(asyncResp->res, *retryPolicy, |
| 751 | "DeliveryRetryPolicy"); |
| 752 | return; |
| 753 | } |
| 754 | subValue->retryPolicy = *retryPolicy; |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 755 | } |
| 756 | |
| 757 | EventServiceManager::getInstance().updateSubscriptionData(); |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 758 | }); |
Ravi Teja | 9d41aec | 2021-07-23 01:57:01 -0500 | [diff] [blame] | 759 | BMCWEB_ROUTE(app, "/redfish/v1/EventService/Subscriptions/<str>/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 760 | // The below privilege is wrong, it should be ConfigureManager OR |
| 761 | // ConfigureSelf |
Abhishek Patel | 7eeafa7 | 2021-07-28 10:59:16 -0500 | [diff] [blame] | 762 | // https://github.com/openbmc/bmcweb/issues/220 |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 763 | //.privileges(redfish::privileges::deleteEventDestination) |
Ed Tanous | 432a890 | 2021-06-14 15:28:56 -0700 | [diff] [blame] | 764 | .privileges({{"ConfigureManager"}}) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 765 | .methods(boost::beast::http::verb::delete_)( |
Ed Tanous | 45ca1b8 | 2022-03-25 13:07:27 -0700 | [diff] [blame] | 766 | [&app](const crow::Request& req, |
| 767 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 768 | const std::string& param) { |
Carson Labrado | 3ba0007 | 2022-06-06 19:40:56 +0000 | [diff] [blame] | 769 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 770 | { |
| 771 | return; |
| 772 | } |
Chicago Duan | 3d30708 | 2020-11-26 14:12:12 +0800 | [diff] [blame] | 773 | |
| 774 | if (param.starts_with("snmp")) |
| 775 | { |
| 776 | deleteSnmpTrapClient(asyncResp, param); |
| 777 | EventServiceManager::getInstance().deleteSubscription(param); |
| 778 | return; |
| 779 | } |
| 780 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 781 | if (!EventServiceManager::getInstance().isSubscriptionExist(param)) |
| 782 | { |
| 783 | asyncResp->res.result(boost::beast::http::status::not_found); |
| 784 | return; |
| 785 | } |
| 786 | EventServiceManager::getInstance().deleteSubscription(param); |
Patrick Williams | 5a39f77 | 2023-10-20 11:20:21 -0500 | [diff] [blame] | 787 | }); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 788 | } |
AppaRao Puli | e5aaf04 | 2020-03-20 01:05:52 +0530 | [diff] [blame] | 789 | |
| 790 | } // namespace redfish |