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