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 handleNTPProtocolEnabled(
242     const bool& ntpEnabled, const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
243 {
244     std::string timeSyncMethod;
245     if (ntpEnabled)
246     {
247         timeSyncMethod = "xyz.openbmc_project.Time.Synchronization.Method.NTP";
248     }
249     else
250     {
251         timeSyncMethod =
252             "xyz.openbmc_project.Time.Synchronization.Method.Manual";
253     }
254 
255     sdbusplus::asio::setProperty(
256         *crow::connections::systemBus, "xyz.openbmc_project.Settings",
257         "/xyz/openbmc_project/time/sync_method",
258         "xyz.openbmc_project.Time.Synchronization", "TimeSyncMethod",
259         timeSyncMethod, [asyncResp](const boost::system::error_code& ec) {
260         if (ec)
261         {
262             messages::internalError(asyncResp->res);
263         }
264     });
265 }
266 
267 inline void
268     handleNTPServersPatch(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
269                           const std::vector<nlohmann::json>& ntpServerObjects,
270                           std::vector<std::string> currentNtpServers)
271 {
272     std::vector<std::string>::iterator currentNtpServer =
273         currentNtpServers.begin();
274     for (size_t index = 0; index < ntpServerObjects.size(); index++)
275     {
276         const nlohmann::json& ntpServer = ntpServerObjects[index];
277         if (ntpServer.is_null())
278         {
279             // Can't delete an item that doesn't exist
280             if (currentNtpServer == currentNtpServers.end())
281             {
282                 messages::propertyValueNotInList(asyncResp->res, "null",
283                                                  "NTP/NTPServers/" +
284                                                      std::to_string(index));
285 
286                 return;
287             }
288             currentNtpServer = currentNtpServers.erase(currentNtpServer);
289             continue;
290         }
291         const nlohmann::json::object_t* ntpServerObject =
292             ntpServer.get_ptr<const nlohmann::json::object_t*>();
293         if (ntpServerObject != nullptr)
294         {
295             if (!ntpServerObject->empty())
296             {
297                 messages::propertyValueNotInList(
298                     asyncResp->res,
299                     ntpServer.dump(2, ' ', true,
300                                    nlohmann::json::error_handler_t::replace),
301                     "NTP/NTPServers/" + std::to_string(index));
302                 return;
303             }
304             // Can't retain an item that doesn't exist
305             if (currentNtpServer == currentNtpServers.end())
306             {
307                 messages::propertyValueOutOfRange(
308                     asyncResp->res,
309                     ntpServer.dump(2, ' ', true,
310                                    nlohmann::json::error_handler_t::replace),
311                     "NTP/NTPServers/" + std::to_string(index));
312 
313                 return;
314             }
315             // empty objects should leave the NtpServer unmodified
316             currentNtpServer++;
317             continue;
318         }
319 
320         const std::string* ntpServerStr =
321             ntpServer.get_ptr<const std::string*>();
322         if (ntpServerStr == nullptr)
323         {
324             messages::propertyValueTypeError(
325                 asyncResp->res,
326                 ntpServer.dump(2, ' ', true,
327                                nlohmann::json::error_handler_t::replace),
328                 "NTP/NTPServers/" + std::to_string(index));
329             return;
330         }
331         if (currentNtpServer == currentNtpServers.end())
332         {
333             // if we're at the end of the list, append to the end
334             currentNtpServers.push_back(*ntpServerStr);
335             currentNtpServer = currentNtpServers.end();
336             continue;
337         }
338         *currentNtpServer = *ntpServerStr;
339         currentNtpServer++;
340     }
341 
342     // Any remaining array elements should be removed
343     currentNtpServers.erase(currentNtpServer, currentNtpServers.end());
344 
345     constexpr std::array<std::string_view, 1> ethInterfaces = {
346         "xyz.openbmc_project.Network.EthernetInterface"};
347     dbus::utility::getSubTree(
348         "/xyz/openbmc_project", 0, ethInterfaces,
349         [asyncResp, currentNtpServers](
350             const boost::system::error_code& ec,
351             const dbus::utility::MapperGetSubTreeResponse& subtree) {
352         if (ec)
353         {
354             BMCWEB_LOG_WARNING("D-Bus error: {}, {}", ec, ec.message());
355             messages::internalError(asyncResp->res);
356             return;
357         }
358 
359         for (const auto& [objectPath, serviceMap] : subtree)
360         {
361             for (const auto& [service, interfaces] : serviceMap)
362             {
363                 for (const auto& interface : interfaces)
364                 {
365                     if (interface !=
366                         "xyz.openbmc_project.Network.EthernetInterface")
367                     {
368                         continue;
369                     }
370 
371                     sdbusplus::asio::setProperty(
372                         *crow::connections::systemBus, service, objectPath,
373                         interface, "StaticNTPServers", currentNtpServers,
374                         [asyncResp](const boost::system::error_code& ec2) {
375                         if (ec2)
376                         {
377                             messages::internalError(asyncResp->res);
378                             return;
379                         }
380                     });
381                 }
382             }
383         }
384     });
385 }
386 
387 inline void
388     handleProtocolEnabled(const bool protocolEnabled,
389                           const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
390                           const std::string& netBasePath)
391 {
392     constexpr std::array<std::string_view, 1> interfaces = {
393         "xyz.openbmc_project.Control.Service.Attributes"};
394     dbus::utility::getSubTree(
395         "/xyz/openbmc_project/control/service", 0, interfaces,
396         [protocolEnabled, asyncResp,
397          netBasePath](const boost::system::error_code& ec,
398                       const dbus::utility::MapperGetSubTreeResponse& subtree) {
399         if (ec)
400         {
401             messages::internalError(asyncResp->res);
402             return;
403         }
404 
405         for (const auto& entry : subtree)
406         {
407             if (boost::algorithm::starts_with(entry.first, netBasePath))
408             {
409                 sdbusplus::asio::setProperty(
410                     *crow::connections::systemBus, entry.second.begin()->first,
411                     entry.first,
412                     "xyz.openbmc_project.Control.Service.Attributes", "Running",
413                     protocolEnabled,
414                     [asyncResp](const boost::system::error_code& ec2) {
415                     if (ec2)
416                     {
417                         messages::internalError(asyncResp->res);
418                         return;
419                     }
420                 });
421                 sdbusplus::asio::setProperty(
422                     *crow::connections::systemBus, entry.second.begin()->first,
423                     entry.first,
424                     "xyz.openbmc_project.Control.Service.Attributes", "Enabled",
425                     protocolEnabled,
426                     [asyncResp](const boost::system::error_code& ec2) {
427                     if (ec2)
428                     {
429                         messages::internalError(asyncResp->res);
430                         return;
431                     }
432                 });
433             }
434         }
435     });
436 }
437 
438 inline std::string getHostName()
439 {
440     std::string hostName;
441 
442     std::array<char, HOST_NAME_MAX> hostNameCStr{};
443     if (gethostname(hostNameCStr.data(), hostNameCStr.size()) == 0)
444     {
445         hostName = hostNameCStr.data();
446     }
447     return hostName;
448 }
449 
450 inline void
451     getNTPProtocolEnabled(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
452 {
453     sdbusplus::asio::getProperty<std::string>(
454         *crow::connections::systemBus, "xyz.openbmc_project.Settings",
455         "/xyz/openbmc_project/time/sync_method",
456         "xyz.openbmc_project.Time.Synchronization", "TimeSyncMethod",
457         [asyncResp](const boost::system::error_code& ec,
458                     const std::string& timeSyncMethod) {
459         if (ec)
460         {
461             return;
462         }
463 
464         if (timeSyncMethod ==
465             "xyz.openbmc_project.Time.Synchronization.Method.NTP")
466         {
467             asyncResp->res.jsonValue["NTP"]["ProtocolEnabled"] = true;
468         }
469         else if (timeSyncMethod == "xyz.openbmc_project.Time.Synchronization."
470                                    "Method.Manual")
471         {
472             asyncResp->res.jsonValue["NTP"]["ProtocolEnabled"] = false;
473         }
474     });
475 }
476 
477 inline std::string encodeServiceObjectPath(std::string_view serviceName)
478 {
479     sdbusplus::message::object_path objPath(
480         "/xyz/openbmc_project/control/service");
481     objPath /= serviceName;
482     return objPath.str;
483 }
484 
485 inline void handleBmcNetworkProtocolHead(
486     crow::App& app, const crow::Request& req,
487     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
488 {
489     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
490     {
491         return;
492     }
493     asyncResp->res.addHeader(
494         boost::beast::http::field::link,
495         "</redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json>; rel=describedby");
496 }
497 
498 inline void handleManagersNetworkProtocolPatch(
499     App& app, const crow::Request& req,
500     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
501 {
502     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
503     {
504         return;
505     }
506     std::optional<std::string> newHostName;
507     std::optional<std::vector<nlohmann::json>> ntpServerObjects;
508     std::optional<bool> ntpEnabled;
509     std::optional<bool> ipmiEnabled;
510     std::optional<bool> sshEnabled;
511 
512     // clang-format off
513         if (!json_util::readJsonPatch(
514                 req, asyncResp->res,
515                 "HostName", newHostName,
516                 "NTP/NTPServers", ntpServerObjects,
517                 "NTP/ProtocolEnabled", ntpEnabled,
518                 "IPMI/ProtocolEnabled", ipmiEnabled,
519                 "SSH/ProtocolEnabled", sshEnabled))
520         {
521             return;
522         }
523     // clang-format on
524 
525     asyncResp->res.result(boost::beast::http::status::no_content);
526     if (newHostName)
527     {
528         messages::propertyNotWritable(asyncResp->res, "HostName");
529         return;
530     }
531 
532     if (ntpEnabled)
533     {
534         handleNTPProtocolEnabled(*ntpEnabled, asyncResp);
535     }
536     if (ntpServerObjects)
537     {
538         getEthernetIfaceData(
539             [asyncResp, ntpServerObjects](
540                 const bool success, std::vector<std::string>& currentNtpServers,
541                 const std::vector<std::string>& /*domainNames*/) {
542             if (!success)
543             {
544                 messages::internalError(asyncResp->res);
545                 return;
546             }
547             handleNTPServersPatch(asyncResp, *ntpServerObjects,
548                                   std::move(currentNtpServers));
549         });
550     }
551 
552     if (ipmiEnabled)
553     {
554         handleProtocolEnabled(
555             *ipmiEnabled, asyncResp,
556             encodeServiceObjectPath(std::string(ipmiServiceName) + '@'));
557     }
558 
559     if (sshEnabled)
560     {
561         handleProtocolEnabled(*sshEnabled, asyncResp,
562                               encodeServiceObjectPath(sshServiceName));
563     }
564 }
565 
566 inline void handleManagersNetworkProtocolHead(
567     App& app, const crow::Request& req,
568     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
569 {
570     if (!redfish::setUpRedfishRoute(app, req, asyncResp))
571     {
572         return;
573     }
574     asyncResp->res.addHeader(
575         boost::beast::http::field::link,
576         "</redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json>; rel=describedby");
577 }
578 
579 inline void handleManagersNetworkProtocolGet(
580     App& app, const crow::Request& req,
581     const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
582 {
583     handleManagersNetworkProtocolHead(app, req, asyncResp);
584     getNetworkData(asyncResp, req);
585 }
586 
587 inline void requestRoutesNetworkProtocol(App& app)
588 {
589     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/NetworkProtocol/")
590         .privileges(redfish::privileges::patchManagerNetworkProtocol)
591         .methods(boost::beast::http::verb::patch)(
592             std::bind_front(handleManagersNetworkProtocolPatch, std::ref(app)));
593 
594     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/NetworkProtocol/")
595         .privileges(redfish::privileges::headManagerNetworkProtocol)
596         .methods(boost::beast::http::verb::head)(
597             std::bind_front(handleManagersNetworkProtocolHead, std::ref(app)));
598 
599     BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/NetworkProtocol/")
600         .privileges(redfish::privileges::getManagerNetworkProtocol)
601         .methods(boost::beast::http::verb::get)(
602             std::bind_front(handleManagersNetworkProtocolGet, std::ref(app)));
603 }
604 
605 } // namespace redfish
606