1 /*
2 // Copyright (c) 2018 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
17 
18 #include "app.hpp"
19 #include "dbus_utility.hpp"
20 #include "error_messages.hpp"
21 #include "openbmc_dbus_rest.hpp"
22 #include "query.hpp"
23 #include "redfish_util.hpp"
24 #include "registries/privilege_registry.hpp"
25 #include "utils/json_utils.hpp"
26 #include "utils/stl_utils.hpp"
27 
28 #include <boost/system/error_code.hpp>
29 #include <sdbusplus/asio/property.hpp>
30 
31 #include <array>
32 #include <optional>
33 #include <string_view>
34 #include <variant>
35 
36 namespace redfish
37 {
38 
39 void getNTPProtocolEnabled(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp);
40 std::string getHostName();
41 
42 static constexpr std::string_view sshServiceName = "dropbear";
43 static constexpr std::string_view httpsServiceName = "bmcweb";
44 static constexpr std::string_view ipmiServiceName = "phosphor-ipmi-net";
45 
46 // Mapping from Redfish NetworkProtocol key name to backend service that hosts
47 // that protocol.
48 static constexpr std::array<std::pair<std::string_view, std::string_view>, 3>
49     networkProtocolToDbus = {{{"SSH", sshServiceName},
50                               {"HTTPS", httpsServiceName},
51                               {"IPMI", ipmiServiceName}}};
52 
53 inline void extractNTPServersAndDomainNamesData(
54     const dbus::utility::ManagedObjectType& dbusData,
55     std::vector<std::string>& ntpData, std::vector<std::string>& dnData)
56 {
57     for (const auto& obj : dbusData)
58     {
59         for (const auto& ifacePair : obj.second)
60         {
61             if (ifacePair.first !=
62                 "xyz.openbmc_project.Network.EthernetInterface")
63             {
64                 continue;
65             }
66 
67             for (const auto& propertyPair : ifacePair.second)
68             {
69                 if (propertyPair.first == "StaticNTPServers")
70                 {
71                     const std::vector<std::string>* ntpServers =
72                         std::get_if<std::vector<std::string>>(
73                             &propertyPair.second);
74                     if (ntpServers != nullptr)
75                     {
76                         ntpData.insert(ntpData.end(), ntpServers->begin(),
77                                        ntpServers->end());
78                     }
79                 }
80                 else if (propertyPair.first == "DomainName")
81                 {
82                     const std::vector<std::string>* domainNames =
83                         std::get_if<std::vector<std::string>>(
84                             &propertyPair.second);
85                     if (domainNames != nullptr)
86                     {
87                         dnData.insert(dnData.end(), domainNames->begin(),
88                                       domainNames->end());
89                     }
90                 }
91             }
92         }
93     }
94     stl_utils::removeDuplicate(ntpData);
95     stl_utils::removeDuplicate(dnData);
96 }
97 
98 template <typename CallbackFunc>
99 void getEthernetIfaceData(CallbackFunc&& callback)
100 {
101     sdbusplus::message::object_path path("/xyz/openbmc_project/network");
102     dbus::utility::getManagedObjects(
103         "xyz.openbmc_project.Network", path,
104         [callback = std::forward<CallbackFunc>(callback)](
105             const boost::system::error_code& ec,
106             const dbus::utility::ManagedObjectType& dbusData) {
107         std::vector<std::string> ntpServers;
108         std::vector<std::string> domainNames;
109 
110         if (ec)
111         {
112             callback(false, ntpServers, domainNames);
113             return;
114         }
115 
116         extractNTPServersAndDomainNamesData(dbusData, ntpServers, domainNames);
117 
118         callback(true, ntpServers, domainNames);
119     });
120 }
121 
122 inline void afterNetworkPortRequest(
123     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
124     const boost::system::error_code& ec,
125     const std::vector<std::tuple<std::string, std::string, bool>>& socketData)
126 {
127     if (ec)
128     {
129         messages::internalError(asyncResp->res);
130         return;
131     }
132     for (const auto& data : socketData)
133     {
134         const std::string& socketPath = get<0>(data);
135         const std::string& protocolName = get<1>(data);
136         bool isProtocolEnabled = get<2>(data);
137 
138         asyncResp->res.jsonValue[protocolName]["ProtocolEnabled"] =
139             isProtocolEnabled;
140         asyncResp->res.jsonValue[protocolName]["Port"] = nullptr;
141         getPortNumber(socketPath, [asyncResp, protocolName](
142                                       const boost::system::error_code& ec2,
143                                       int portNumber) {
144             if (ec2)
145             {
146                 messages::internalError(asyncResp->res);
147                 return;
148             }
149             asyncResp->res.jsonValue[protocolName]["Port"] = portNumber;
150         });
151     }
152 }
153 
154 inline void getNetworkData(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
155                            const crow::Request& req)
156 {
157     if (req.session == nullptr)
158     {
159         messages::internalError(asyncResp->res);
160         return;
161     }
162 
163     asyncResp->res.addHeader(
164         boost::beast::http::field::link,
165         "</redfish/v1/JsonSchemas/ManagerNetworkProtocol/NetworkProtocol.json>; rel=describedby");
166     asyncResp->res.jsonValue["@odata.type"] =
167         "#ManagerNetworkProtocol.v1_5_0.ManagerNetworkProtocol";
168     asyncResp->res.jsonValue["@odata.id"] =
169         "/redfish/v1/Managers/bmc/NetworkProtocol";
170     asyncResp->res.jsonValue["Id"] = "NetworkProtocol";
171     asyncResp->res.jsonValue["Name"] = "Manager Network Protocol";
172     asyncResp->res.jsonValue["Description"] = "Manager Network Service";
173     asyncResp->res.jsonValue["Status"]["Health"] = "OK";
174     asyncResp->res.jsonValue["Status"]["HealthRollup"] = "OK";
175     asyncResp->res.jsonValue["Status"]["State"] = "Enabled";
176 
177     // HTTP is Mandatory attribute as per OCP Baseline Profile - v1.0.0,
178     // but from security perspective it is not recommended to use.
179     // Hence using protocolEnabled as false to make it OCP and security-wise
180     // compliant
181     asyncResp->res.jsonValue["HTTP"]["Port"] = nullptr;
182     asyncResp->res.jsonValue["HTTP"]["ProtocolEnabled"] = false;
183 
184     // The ProtocolEnabled of the following protocols is determined by
185     // inspecting the state of associated systemd sockets. If these protocols
186     // have been disabled, then the systemd socket unit files will not be found
187     // and the protocols will not be returned in this Redfish query. Set some
188     // defaults to ensure something is always returned.
189     for (const auto& nwkProtocol : networkProtocolToDbus)
190     {
191         asyncResp->res.jsonValue[nwkProtocol.first]["Port"] = nullptr;
192         asyncResp->res.jsonValue[nwkProtocol.first]["ProtocolEnabled"] = false;
193     }
194 
195     std::string hostName = getHostName();
196 
197     asyncResp->res.jsonValue["HostName"] = hostName;
198 
199     getNTPProtocolEnabled(asyncResp);
200 
201     getEthernetIfaceData(
202         [hostName, asyncResp](const bool& success,
203                               const std::vector<std::string>& ntpServers,
204                               const std::vector<std::string>& domainNames) {
205         if (!success)
206         {
207             messages::resourceNotFound(asyncResp->res, "ManagerNetworkProtocol",
208                                        "NetworkProtocol");
209             return;
210         }
211         asyncResp->res.jsonValue["NTP"]["NTPServers"] = ntpServers;
212         if (!hostName.empty())
213         {
214             std::string fqdn = hostName;
215             if (!domainNames.empty())
216             {
217                 fqdn += ".";
218                 fqdn += domainNames[0];
219             }
220             asyncResp->res.jsonValue["FQDN"] = std::move(fqdn);
221         }
222     });
223 
224     Privileges effectiveUserPrivileges =
225         redfish::getUserPrivileges(*req.session);
226 
227     // /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates is
228     // something only ConfigureManager can access then only display when
229     // the user has permissions ConfigureManager
230     if (isOperationAllowedWithPrivileges({{"ConfigureManager"}},
231                                          effectiveUserPrivileges))
232     {
233         asyncResp->res.jsonValue["HTTPS"]["Certificates"]["@odata.id"] =
234             "/redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates";
235     }
236 
237     getPortStatusAndPath(std::span(networkProtocolToDbus),
238                          std::bind_front(afterNetworkPortRequest, asyncResp));
239 } // namespace redfish
240 
241 inline void afterSetNTP(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
242                         const boost::system::error_code& ec)
243 {
244     if (ec)
245     {
246         BMCWEB_LOG_DEBUG("Failed to set elapsed time. DBUS response error {}",
247                          ec);
248         messages::internalError(asyncResp->res);
249         return;
250     }
251     asyncResp->res.result(boost::beast::http::status::no_content);
252 }
253 
254 inline void handleNTPProtocolEnabled(
255     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, bool ntpEnabled)
256 {
257     bool interactive = false;
258     auto callback = [asyncResp](const boost::system::error_code& ec) {
259         afterSetNTP(asyncResp, ec);
260     };
261     crow::connections::systemBus->async_method_call(
262         std::move(callback), "org.freedesktop.timedate1",
263         "/org/freedesktop/timedate1", "org.freedesktop.timedate1", "SetNTP",
264         ntpEnabled, interactive);
265 }
266 
267 // Redfish states that ip addresses can be
268 // string, to set a value
269 // null, to delete the value
270 // object_t, empty json object, to ignore the value
271 using IpAddress =
272     std::variant<std::string, nlohmann::json::object_t, std::nullptr_t>;
273 
274 inline void
275     handleNTPServersPatch(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
276                           const std::vector<IpAddress>& ntpServerObjects,
277                           std::vector<std::string> currentNtpServers)
278 {
279     std::vector<std::string>::iterator currentNtpServer =
280         currentNtpServers.begin();
281     for (size_t index = 0; index < ntpServerObjects.size(); index++)
282     {
283         const IpAddress& ntpServer = ntpServerObjects[index];
284         if (std::holds_alternative<std::nullptr_t>(ntpServer))
285         {
286             // Can't delete an item that doesn't exist
287             if (currentNtpServer == currentNtpServers.end())
288             {
289                 messages::propertyValueNotInList(asyncResp->res, "null",
290                                                  "NTP/NTPServers/" +
291                                                      std::to_string(index));
292 
293                 return;
294             }
295             currentNtpServer = currentNtpServers.erase(currentNtpServer);
296             continue;
297         }
298         const nlohmann::json::object_t* ntpServerObject =
299             std::get_if<nlohmann::json::object_t>(&ntpServer);
300         if (ntpServerObject != nullptr)
301         {
302             if (!ntpServerObject->empty())
303             {
304                 messages::propertyValueNotInList(
305                     asyncResp->res, *ntpServerObject,
306                     "NTP/NTPServers/" + std::to_string(index));
307                 return;
308             }
309             // Can't retain an item that doesn't exist
310             if (currentNtpServer == currentNtpServers.end())
311             {
312                 messages::propertyValueOutOfRange(
313                     asyncResp->res, *ntpServerObject,
314                     "NTP/NTPServers/" + std::to_string(index));
315 
316                 return;
317             }
318             // empty objects should leave the NtpServer unmodified
319             currentNtpServer++;
320             continue;
321         }
322 
323         const std::string* ntpServerStr = std::get_if<std::string>(&ntpServer);
324         if (ntpServerStr == nullptr)
325         {
326             messages::internalError(asyncResp->res);
327             return;
328         }
329         if (currentNtpServer == currentNtpServers.end())
330         {
331             // if we're at the end of the list, append to the end
332             currentNtpServers.push_back(*ntpServerStr);
333             currentNtpServer = currentNtpServers.end();
334             continue;
335         }
336         *currentNtpServer = *ntpServerStr;
337         currentNtpServer++;
338     }
339 
340     // Any remaining array elements should be removed
341     currentNtpServers.erase(currentNtpServer, currentNtpServers.end());
342 
343     constexpr std::array<std::string_view, 1> ethInterfaces = {
344         "xyz.openbmc_project.Network.EthernetInterface"};
345     dbus::utility::getSubTree(
346         "/xyz/openbmc_project", 0, ethInterfaces,
347         [asyncResp, currentNtpServers](
348             const boost::system::error_code& ec,
349             const dbus::utility::MapperGetSubTreeResponse& subtree) {
350         if (ec)
351         {
352             BMCWEB_LOG_WARNING("D-Bus error: {}, {}", ec, ec.message());
353             messages::internalError(asyncResp->res);
354             return;
355         }
356 
357         for (const auto& [objectPath, serviceMap] : subtree)
358         {
359             for (const auto& [service, interfaces] : serviceMap)
360             {
361                 for (const auto& interface : interfaces)
362                 {
363                     if (interface !=
364                         "xyz.openbmc_project.Network.EthernetInterface")
365                     {
366                         continue;
367                     }
368 
369                     setDbusProperty(asyncResp, service, objectPath, interface,
370                                     "StaticNTPServers", "NTP/NTPServers/",
371                                     currentNtpServers);
372                 }
373             }
374         }
375     });
376 }
377 
378 inline void
379     handleProtocolEnabled(const bool protocolEnabled,
380                           const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
381                           const std::string& netBasePath)
382 {
383     constexpr std::array<std::string_view, 1> interfaces = {
384         "xyz.openbmc_project.Control.Service.Attributes"};
385     dbus::utility::getSubTree(
386         "/xyz/openbmc_project/control/service", 0, interfaces,
387         [protocolEnabled, asyncResp,
388          netBasePath](const boost::system::error_code& ec,
389                       const dbus::utility::MapperGetSubTreeResponse& subtree) {
390         if (ec)
391         {
392             messages::internalError(asyncResp->res);
393             return;
394         }
395 
396         for (const auto& entry : subtree)
397         {
398             if (entry.first.starts_with(netBasePath))
399             {
400                 setDbusProperty(
401                     asyncResp, entry.second.begin()->first, entry.first,
402                     "xyz.openbmc_project.Control.Service.Attributes", "Running",
403                     "IPMI/ProtocolEnabled", protocolEnabled);
404                 setDbusProperty(
405                     asyncResp, entry.second.begin()->first, entry.first,
406                     "xyz.openbmc_project.Control.Service.Attributes", "Enabled",
407                     "IPMI/ProtocolEnabled", protocolEnabled);
408             }
409         }
410     });
411 }
412 
413 inline std::string getHostName()
414 {
415     std::string hostName;
416 
417     std::array<char, HOST_NAME_MAX> hostNameCStr{};
418     if (gethostname(hostNameCStr.data(), hostNameCStr.size()) == 0)
419     {
420         hostName = hostNameCStr.data();
421     }
422     return hostName;
423 }
424 
425 inline void
426     getNTPProtocolEnabled(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
427 {
428     sdbusplus::asio::getProperty<bool>(
429         *crow::connections::systemBus, "org.freedesktop.timedate1",
430         "/org/freedesktop/timedate1", "org.freedesktop.timedate1", "NTP",
431         [asyncResp](const boost::system::error_code& ec, bool enabled) {
432         if (ec)
433         {
434             BMCWEB_LOG_WARNING(
435                 "Failed to get NTP status, assuming not supported");
436             return;
437         }
438 
439         asyncResp->res.jsonValue["NTP"]["ProtocolEnabled"] = enabled;
440     });
441 }
442 
443 inline std::string encodeServiceObjectPath(std::string_view serviceName)
444 {
445     sdbusplus::message::object_path objPath(
446         "/xyz/openbmc_project/control/service");
447     objPath /= serviceName;
448     return objPath.str;
449 }
450 
451 inline void handleBmcNetworkProtocolHead(
452     crow::App& app, const crow::Request& req,
453     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
454 {
455     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
456     {
457         return;
458     }
459     asyncResp->res.addHeader(
460         boost::beast::http::field::link,
461         "</redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json>; rel=describedby");
462 }
463 
464 inline void handleManagersNetworkProtocolPatch(
465     App& app, const crow::Request& req,
466     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
467 {
468     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
469     {
470         return;
471     }
472     std::optional<std::string> newHostName;
473 
474     std::optional<std::vector<IpAddress>> ntpServerObjects;
475     std::optional<bool> ntpEnabled;
476     std::optional<bool> ipmiEnabled;
477     std::optional<bool> sshEnabled;
478 
479     // clang-format off
480         if (!json_util::readJsonPatch(
481                 req, asyncResp->res,
482                 "HostName", newHostName,
483                 "NTP/NTPServers", ntpServerObjects,
484                 "NTP/ProtocolEnabled", ntpEnabled,
485                 "IPMI/ProtocolEnabled", ipmiEnabled,
486                 "SSH/ProtocolEnabled", sshEnabled))
487         {
488             return;
489         }
490     // clang-format on
491 
492     asyncResp->res.result(boost::beast::http::status::no_content);
493     if (newHostName)
494     {
495         messages::propertyNotWritable(asyncResp->res, "HostName");
496         return;
497     }
498 
499     if (ntpEnabled)
500     {
501         handleNTPProtocolEnabled(asyncResp, *ntpEnabled);
502     }
503     if (ntpServerObjects)
504     {
505         getEthernetIfaceData(
506             [asyncResp, ntpServerObjects](
507                 const bool success, std::vector<std::string>& currentNtpServers,
508                 const std::vector<std::string>& /*domainNames*/) {
509             if (!success)
510             {
511                 messages::internalError(asyncResp->res);
512                 return;
513             }
514             handleNTPServersPatch(asyncResp, *ntpServerObjects,
515                                   std::move(currentNtpServers));
516         });
517     }
518 
519     if (ipmiEnabled)
520     {
521         handleProtocolEnabled(
522             *ipmiEnabled, asyncResp,
523             encodeServiceObjectPath(std::string(ipmiServiceName) + '@'));
524     }
525 
526     if (sshEnabled)
527     {
528         handleProtocolEnabled(*sshEnabled, asyncResp,
529                               encodeServiceObjectPath(sshServiceName));
530     }
531 }
532 
533 inline void handleManagersNetworkProtocolHead(
534     App& app, const crow::Request& req,
535     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
536 {
537     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
538     {
539         return;
540     }
541     asyncResp->res.addHeader(
542         boost::beast::http::field::link,
543         "</redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json>; rel=describedby");
544 }
545 
546 inline void handleManagersNetworkProtocolGet(
547     App& app, const crow::Request& req,
548     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
549 {
550     handleManagersNetworkProtocolHead(app, req, asyncResp);
551     getNetworkData(asyncResp, req);
552 }
553 
554 inline void requestRoutesNetworkProtocol(App& app)
555 {
556     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/NetworkProtocol/")
557         .privileges(redfish::privileges::patchManagerNetworkProtocol)
558         .methods(boost::beast::http::verb::patch)(
559             std::bind_front(handleManagersNetworkProtocolPatch, std::ref(app)));
560 
561     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/NetworkProtocol/")
562         .privileges(redfish::privileges::headManagerNetworkProtocol)
563         .methods(boost::beast::http::verb::head)(
564             std::bind_front(handleManagersNetworkProtocolHead, std::ref(app)));
565 
566     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/NetworkProtocol/")
567         .privileges(redfish::privileges::getManagerNetworkProtocol)
568         .methods(boost::beast::http::verb::get)(
569             std::bind_front(handleManagersNetworkProtocolGet, std::ref(app)));
570 }
571 
572 } // namespace redfish
573