blob: 1e85a0dc61f695bc0246448384bd4fa1391eb7d9 [file] [log] [blame]
Vernon Mauery240b1862018-10-08 12:05:16 -07001/**
2 * Copyright © 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#include "config.h"
17
18#include "settings.hpp"
19
20#include <dlfcn.h>
21
Vernon Mauery735ee952019-02-15 13:38:52 -080022#include <boost/algorithm/string.hpp>
Ed Tanous98605052025-02-13 16:57:13 -080023#include <boost/asio/detached.hpp>
Ed Tanous778418d2020-08-17 23:20:21 -070024#include <boost/asio/io_context.hpp>
Ed Tanous26a386f2025-02-13 16:57:13 -080025#include <boost/asio/spawn.hpp>
Vernon Mauery240b1862018-10-08 12:05:16 -070026#include <host-cmd-manager.hpp>
27#include <ipmid-host/cmd.hpp>
28#include <ipmid/api.hpp>
29#include <ipmid/handler.hpp>
30#include <ipmid/message.hpp>
31#include <ipmid/oemrouter.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -070032#include <ipmid/types.hpp>
Vernon Mauerye808bae2024-05-31 14:55:36 -070033#include <phosphor-logging/lg2.hpp>
Vernon Mauery240b1862018-10-08 12:05:16 -070034#include <sdbusplus/asio/connection.hpp>
35#include <sdbusplus/asio/object_server.hpp>
Patrick Williams3b301a32025-02-03 13:05:36 -050036#include <sdbusplus/asio/sd_event.hpp>
Vernon Mauery240b1862018-10-08 12:05:16 -070037#include <sdbusplus/bus.hpp>
38#include <sdbusplus/bus/match.hpp>
39#include <sdbusplus/timer.hpp>
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -050040
41#include <algorithm>
42#include <any>
43#include <exception>
44#include <filesystem>
45#include <forward_list>
46#include <map>
47#include <memory>
48#include <optional>
Vernon Mauery240b1862018-10-08 12:05:16 -070049#include <tuple>
Vernon Mauery240b1862018-10-08 12:05:16 -070050#include <unordered_map>
51#include <utility>
52#include <vector>
53
Vernon Mauery240b1862018-10-08 12:05:16 -070054namespace fs = std::filesystem;
55
56using namespace phosphor::logging;
57
Vernon Mauery240b1862018-10-08 12:05:16 -070058// IPMI Spec, shared Reservation ID.
59static unsigned short selReservationID = 0xFFFF;
60static bool selReservationValid = false;
61
62unsigned short reserveSel(void)
63{
64 // IPMI spec, Reservation ID, the value simply increases against each
65 // execution of the Reserve SEL command.
66 if (++selReservationID == 0)
67 {
68 selReservationID = 1;
69 }
70 selReservationValid = true;
71 return selReservationID;
72}
73
74bool checkSELReservation(unsigned short id)
75{
76 return (selReservationValid && selReservationID == id);
77}
78
79void cancelSELReservation(void)
80{
81 selReservationValid = false;
82}
83
84EInterfaceIndex getInterfaceIndex(void)
85{
86 return interfaceKCS;
87}
88
89sd_bus* bus;
Patrick Williams3b301a32025-02-03 13:05:36 -050090sd_event* events = nullptr;
91sd_event* ipmid_get_sd_event_connection(void)
92{
93 return events;
94}
Vernon Mauery240b1862018-10-08 12:05:16 -070095sd_bus* ipmid_get_sd_bus_connection(void)
96{
97 return bus;
98}
99
100namespace ipmi
101{
102
103static inline unsigned int makeCmdKey(unsigned int cluster, unsigned int cmd)
104{
105 return (cluster << 8) | cmd;
106}
107
108using HandlerTuple = std::tuple<int, /* prio */
109 Privilege, HandlerBase::ptr /* handler */
110 >;
111
112/* map to handle standard registered commands */
113static std::unordered_map<unsigned int, /* key is NetFn/Cmd */
114 HandlerTuple>
115 handlerMap;
116
Vernon Maueryf984a012018-10-08 12:05:18 -0700117/* special map for decoding Group registered commands (NetFn 2Ch) */
118static std::unordered_map<unsigned int, /* key is Group/Cmd (NetFn is 2Ch) */
119 HandlerTuple>
120 groupHandlerMap;
121
122/* special map for decoding OEM registered commands (NetFn 2Eh) */
123static std::unordered_map<unsigned int, /* key is Iana/Cmd (NetFn is 2Eh) */
124 HandlerTuple>
125 oemHandlerMap;
126
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800127using FilterTuple = std::tuple<int, /* prio */
128 FilterBase::ptr /* filter */
129 >;
130
131/* list to hold all registered ipmi command filters */
132static std::forward_list<FilterTuple> filterList;
133
Vernon Mauery240b1862018-10-08 12:05:16 -0700134namespace impl
135{
136/* common function to register all standard IPMI handlers */
137bool registerHandler(int prio, NetFn netFn, Cmd cmd, Privilege priv,
138 HandlerBase::ptr handler)
139{
140 // check for valid NetFn: even; 00-0Ch, 30-3Eh
141 if (netFn & 1 || (netFn > netFnTransport && netFn < netFnGroup) ||
142 netFn > netFnOemEight)
143 {
144 return false;
145 }
146
147 // create key and value for this handler
148 unsigned int netFnCmd = makeCmdKey(netFn, cmd);
149 HandlerTuple item(prio, priv, handler);
150
151 // consult the handler map and look for a match
152 auto& mapCmd = handlerMap[netFnCmd];
153 if (!std::get<HandlerBase::ptr>(mapCmd) || std::get<int>(mapCmd) <= prio)
154 {
155 mapCmd = item;
156 return true;
157 }
158 return false;
159}
160
Vernon Maueryf984a012018-10-08 12:05:18 -0700161/* common function to register all Group IPMI handlers */
162bool registerGroupHandler(int prio, Group group, Cmd cmd, Privilege priv,
163 HandlerBase::ptr handler)
164{
165 // create key and value for this handler
166 unsigned int netFnCmd = makeCmdKey(group, cmd);
167 HandlerTuple item(prio, priv, handler);
168
169 // consult the handler map and look for a match
170 auto& mapCmd = groupHandlerMap[netFnCmd];
171 if (!std::get<HandlerBase::ptr>(mapCmd) || std::get<int>(mapCmd) <= prio)
172 {
173 mapCmd = item;
174 return true;
175 }
176 return false;
177}
178
179/* common function to register all OEM IPMI handlers */
180bool registerOemHandler(int prio, Iana iana, Cmd cmd, Privilege priv,
181 HandlerBase::ptr handler)
182{
183 // create key and value for this handler
184 unsigned int netFnCmd = makeCmdKey(iana, cmd);
185 HandlerTuple item(prio, priv, handler);
186
187 // consult the handler map and look for a match
188 auto& mapCmd = oemHandlerMap[netFnCmd];
189 if (!std::get<HandlerBase::ptr>(mapCmd) || std::get<int>(mapCmd) <= prio)
190 {
191 mapCmd = item;
Vernon Mauerye808bae2024-05-31 14:55:36 -0700192 lg2::debug("registered OEM Handler: NetFn/Cmd={NETFNCMD}", "IANA",
193 lg2::hex, iana, "CMD", lg2::hex, cmd, "NETFNCMD", lg2::hex,
194 netFnCmd);
Vernon Maueryf984a012018-10-08 12:05:18 -0700195 return true;
196 }
Alexander Hansen7197b342023-09-06 11:45:15 +0200197
Vernon Mauerye808bae2024-05-31 14:55:36 -0700198 lg2::warning("could not register OEM Handler: NetFn/Cmd={NETFNCMD}", "IANA",
199 lg2::hex, iana, "CMD", lg2::hex, cmd, "NETFNCMD", lg2::hex,
200 netFnCmd);
Vernon Maueryf984a012018-10-08 12:05:18 -0700201 return false;
202}
203
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800204/* common function to register all IPMI filter handlers */
205void registerFilter(int prio, FilterBase::ptr filter)
206{
207 // check for initial placement
208 if (filterList.empty() || std::get<int>(filterList.front()) < prio)
209 {
210 filterList.emplace_front(std::make_tuple(prio, filter));
Yong Libe063232021-03-04 16:52:52 +0800211 return;
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800212 }
213 // walk the list and put it in the right place
214 auto j = filterList.begin();
215 for (auto i = j; i != filterList.end() && std::get<int>(*i) > prio; i++)
216 {
217 j = i;
218 }
219 filterList.emplace_after(j, std::make_tuple(prio, filter));
220}
221
Vernon Mauery240b1862018-10-08 12:05:16 -0700222} // namespace impl
223
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800224message::Response::ptr filterIpmiCommand(message::Request::ptr request)
225{
226 // pass the command through the filter mechanism
227 // This can be the firmware firewall or any OEM mechanism like
228 // whitelist filtering based on operational mode
229 for (auto& item : filterList)
230 {
231 FilterBase::ptr filter = std::get<FilterBase::ptr>(item);
232 ipmi::Cc cc = filter->call(request);
233 if (ipmi::ccSuccess != cc)
234 {
235 return errorResponse(request, cc);
236 }
237 }
238 return message::Response::ptr();
239}
240
Vernon Mauery240b1862018-10-08 12:05:16 -0700241message::Response::ptr executeIpmiCommandCommon(
242 std::unordered_map<unsigned int, HandlerTuple>& handlers,
243 unsigned int keyCommon, message::Request::ptr request)
244{
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800245 // filter the command first; a non-null message::Response::ptr
246 // means that the message has been rejected for some reason
Vernon Mauery51f78142020-01-13 16:28:59 -0800247 message::Response::ptr filterResponse = filterIpmiCommand(request);
Vernon Mauery08a70aa2018-11-07 09:36:22 -0800248
Vernon Mauery240b1862018-10-08 12:05:16 -0700249 Cmd cmd = request->ctx->cmd;
250 unsigned int key = makeCmdKey(keyCommon, cmd);
251 auto cmdIter = handlers.find(key);
252 if (cmdIter != handlers.end())
253 {
Vernon Mauery51f78142020-01-13 16:28:59 -0800254 // only return the filter response if the command is found
255 if (filterResponse)
256 {
Vernon Mauerye808bae2024-05-31 14:55:36 -0700257 lg2::debug("request for NetFn/Cmd {NETFN}/{CMD} has been filtered",
258 "NETFN", lg2::hex, keyCommon, "CMD", lg2::hex, cmd);
Vernon Mauery51f78142020-01-13 16:28:59 -0800259 return filterResponse;
260 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700261 HandlerTuple& chosen = cmdIter->second;
262 if (request->ctx->priv < std::get<Privilege>(chosen))
263 {
264 return errorResponse(request, ccInsufficientPrivilege);
265 }
266 return std::get<HandlerBase::ptr>(chosen)->call(request);
267 }
268 else
269 {
270 unsigned int wildcard = makeCmdKey(keyCommon, cmdWildcard);
271 cmdIter = handlers.find(wildcard);
272 if (cmdIter != handlers.end())
273 {
Vernon Mauery51f78142020-01-13 16:28:59 -0800274 // only return the filter response if the command is found
275 if (filterResponse)
276 {
Vernon Mauerye808bae2024-05-31 14:55:36 -0700277 lg2::debug(
278 "request for NetFn/Cmd {NETFN}/{CMD} has been filtered",
279 "NETFN", lg2::hex, keyCommon, "CMD", lg2::hex, cmd);
Vernon Mauery51f78142020-01-13 16:28:59 -0800280 return filterResponse;
281 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700282 HandlerTuple& chosen = cmdIter->second;
283 if (request->ctx->priv < std::get<Privilege>(chosen))
284 {
285 return errorResponse(request, ccInsufficientPrivilege);
286 }
287 return std::get<HandlerBase::ptr>(chosen)->call(request);
288 }
289 }
290 return errorResponse(request, ccInvalidCommand);
291}
292
Vernon Maueryf984a012018-10-08 12:05:18 -0700293message::Response::ptr executeIpmiGroupCommand(message::Request::ptr request)
294{
295 // look up the group for this request
William A. Kennington IIId10d9052019-04-24 01:57:36 -0700296 uint8_t bytes;
297 if (0 != request->payload.unpack(bytes))
Vernon Maueryf984a012018-10-08 12:05:18 -0700298 {
299 return errorResponse(request, ccReqDataLenInvalid);
300 }
William A. Kennington IIId10d9052019-04-24 01:57:36 -0700301 auto group = static_cast<Group>(bytes);
Patrick Williams1318a5e2024-08-16 15:19:54 -0400302 message::Response::ptr response =
303 executeIpmiCommandCommon(groupHandlerMap, group, request);
William A. Kennington IIIda31f9a2019-04-25 01:36:32 -0700304 ipmi::message::Payload prefix;
305 prefix.pack(bytes);
306 response->prepend(prefix);
Vernon Maueryf984a012018-10-08 12:05:18 -0700307 return response;
308}
309
310message::Response::ptr executeIpmiOemCommand(message::Request::ptr request)
311{
312 // look up the iana for this request
William A. Kennington IIId10d9052019-04-24 01:57:36 -0700313 uint24_t bytes;
314 if (0 != request->payload.unpack(bytes))
Vernon Maueryf984a012018-10-08 12:05:18 -0700315 {
316 return errorResponse(request, ccReqDataLenInvalid);
317 }
William A. Kennington IIId10d9052019-04-24 01:57:36 -0700318 auto iana = static_cast<Iana>(bytes);
Alexander Hansen7197b342023-09-06 11:45:15 +0200319
Vernon Mauerye808bae2024-05-31 14:55:36 -0700320 lg2::debug("unpack IANA {IANA}", "IANA", lg2::hex, iana);
Alexander Hansen7197b342023-09-06 11:45:15 +0200321
Patrick Williams1318a5e2024-08-16 15:19:54 -0400322 message::Response::ptr response =
323 executeIpmiCommandCommon(oemHandlerMap, iana, request);
William A. Kennington IIIda31f9a2019-04-25 01:36:32 -0700324 ipmi::message::Payload prefix;
325 prefix.pack(bytes);
326 response->prepend(prefix);
Vernon Maueryf984a012018-10-08 12:05:18 -0700327 return response;
328}
329
Vernon Mauery240b1862018-10-08 12:05:16 -0700330message::Response::ptr executeIpmiCommand(message::Request::ptr request)
331{
332 NetFn netFn = request->ctx->netFn;
Vernon Maueryf984a012018-10-08 12:05:18 -0700333 if (netFnGroup == netFn)
334 {
335 return executeIpmiGroupCommand(request);
336 }
337 else if (netFnOem == netFn)
338 {
339 return executeIpmiOemCommand(request);
340 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700341 return executeIpmiCommandCommon(handlerMap, netFn, request);
342}
343
Vernon Mauery735ee952019-02-15 13:38:52 -0800344namespace utils
345{
346template <typename AssocContainer, typename UnaryPredicate>
347void assoc_erase_if(AssocContainer& c, UnaryPredicate p)
348{
349 typename AssocContainer::iterator next = c.begin();
350 typename AssocContainer::iterator last = c.end();
351 while ((next = std::find_if(next, last, p)) != last)
352 {
353 c.erase(next++);
354 }
355}
356} // namespace utils
357
358namespace
359{
360std::unordered_map<std::string, uint8_t> uniqueNameToChannelNumber;
361
362// sdbusplus::bus::match::rules::arg0namespace() wants the prefix
363// to match without any trailing '.'
364constexpr const char ipmiDbusChannelMatch[] =
365 "xyz.openbmc_project.Ipmi.Channel";
366void updateOwners(sdbusplus::asio::connection& conn, const std::string& name)
367{
368 conn.async_method_call(
369 [name](const boost::system::error_code ec,
370 const std::string& nameOwner) {
Patrick Williams1318a5e2024-08-16 15:19:54 -0400371 if (ec)
372 {
373 lg2::error("Error getting dbus owner for {INTERFACE}",
374 "INTERFACE", name);
375 return;
376 }
377 // start after ipmiDbusChannelPrefix (after the '.')
378 std::string chName =
379 name.substr(std::strlen(ipmiDbusChannelMatch) + 1);
380 try
381 {
382 uint8_t channel = getChannelByName(chName);
383 uniqueNameToChannelNumber[nameOwner] = channel;
384 lg2::info(
385 "New interface mapping: {INTERFACE} -> channel {CHANNEL}",
386 "INTERFACE", name, "CHANNEL", channel);
387 }
388 catch (const std::exception& e)
389 {
390 lg2::info("Failed interface mapping, no such name: {INTERFACE}",
391 "INTERFACE", name);
392 }
393 },
Vernon Mauery735ee952019-02-15 13:38:52 -0800394 "org.freedesktop.DBus", "/", "org.freedesktop.DBus", "GetNameOwner",
395 name);
396}
397
Jayanth Othayoth9f3073a2024-12-08 09:29:43 -0600398void doListNames(sdbusplus::asio::connection& conn)
Vernon Mauery735ee952019-02-15 13:38:52 -0800399{
400 conn.async_method_call(
Jayanth Othayoth9f3073a2024-12-08 09:29:43 -0600401 [&conn](const boost::system::error_code ec,
402 std::vector<std::string> busNames) {
Patrick Williams1318a5e2024-08-16 15:19:54 -0400403 if (ec)
Vernon Mauery735ee952019-02-15 13:38:52 -0800404 {
Patrick Williams1318a5e2024-08-16 15:19:54 -0400405 lg2::error("Error getting dbus names: {ERROR}", "ERROR",
406 ec.message());
407 std::exit(EXIT_FAILURE);
408 return;
Vernon Mauery735ee952019-02-15 13:38:52 -0800409 }
Patrick Williams1318a5e2024-08-16 15:19:54 -0400410 // Try to make startup consistent
411 std::sort(busNames.begin(), busNames.end());
412
413 const std::string channelPrefix =
414 std::string(ipmiDbusChannelMatch) + ".";
415 for (const std::string& busName : busNames)
416 {
417 if (busName.find(channelPrefix) == 0)
418 {
419 updateOwners(conn, busName);
420 }
421 }
422 },
Vernon Mauery735ee952019-02-15 13:38:52 -0800423 "org.freedesktop.DBus", "/org/freedesktop/DBus", "org.freedesktop.DBus",
424 "ListNames");
425}
426
Patrick Williams5d82f472022-07-22 19:26:53 -0500427void nameChangeHandler(sdbusplus::message_t& message)
Vernon Mauery735ee952019-02-15 13:38:52 -0800428{
429 std::string name;
430 std::string oldOwner;
431 std::string newOwner;
432
433 message.read(name, oldOwner, newOwner);
434
435 if (!oldOwner.empty())
436 {
437 if (boost::starts_with(oldOwner, ":"))
438 {
439 // Connection removed
440 auto it = uniqueNameToChannelNumber.find(oldOwner);
441 if (it != uniqueNameToChannelNumber.end())
442 {
443 uniqueNameToChannelNumber.erase(it);
444 }
445 }
446 }
447 if (!newOwner.empty())
448 {
449 // start after ipmiDbusChannelMatch (and after the '.')
450 std::string chName = name.substr(std::strlen(ipmiDbusChannelMatch) + 1);
451 try
452 {
453 uint8_t channel = getChannelByName(chName);
454 uniqueNameToChannelNumber[newOwner] = channel;
Vernon Mauerye808bae2024-05-31 14:55:36 -0700455 lg2::info("New interface mapping: {INTERFACE} -> channel {CHANNEL}",
456 "INTERFACE", name, "CHANNEL", channel);
Vernon Mauery735ee952019-02-15 13:38:52 -0800457 }
458 catch (const std::exception& e)
459 {
Vernon Mauerye808bae2024-05-31 14:55:36 -0700460 lg2::info("Failed interface mapping, no such name: {INTERFACE}",
461 "INTERFACE", name);
Vernon Mauery735ee952019-02-15 13:38:52 -0800462 }
463 }
464};
465
466} // anonymous namespace
467
468static constexpr const char intraBmcName[] = "INTRABMC";
Patrick Williams5d82f472022-07-22 19:26:53 -0500469uint8_t channelFromMessage(sdbusplus::message_t& msg)
Vernon Mauery735ee952019-02-15 13:38:52 -0800470{
471 // channel name for ipmitool to resolve to
472 std::string sender = msg.get_sender();
473 auto chIter = uniqueNameToChannelNumber.find(sender);
474 if (chIter != uniqueNameToChannelNumber.end())
475 {
476 return chIter->second;
477 }
478 // FIXME: currently internal connections are ephemeral and hard to pin down
479 try
480 {
481 return getChannelByName(intraBmcName);
482 }
483 catch (const std::exception& e)
484 {
485 return invalidChannel;
486 }
487} // namespace ipmi
488
Vernon Mauery240b1862018-10-08 12:05:16 -0700489/* called from sdbus async server context */
Patrick Williams5d82f472022-07-22 19:26:53 -0500490auto executionEntry(boost::asio::yield_context yield, sdbusplus::message_t& m,
491 NetFn netFn, uint8_t lun, Cmd cmd, ipmi::SecureBuffer& data,
Vernon Mauery240b1862018-10-08 12:05:16 -0700492 std::map<std::string, ipmi::Value>& options)
493{
Vernon Mauery735ee952019-02-15 13:38:52 -0800494 const auto dbusResponse =
Vernon Mauery997952a2021-07-30 14:06:14 -0700495 [netFn, lun, cmd](Cc cc, const ipmi::SecureBuffer& data = {}) {
Patrick Williams1318a5e2024-08-16 15:19:54 -0400496 constexpr uint8_t netFnResponse = 0x01;
497 uint8_t retNetFn = netFn | netFnResponse;
498 return std::make_tuple(retNetFn, lun, cmd, cc, data);
499 };
Vernon Mauery735ee952019-02-15 13:38:52 -0800500 std::string sender = m.get_sender();
501 Privilege privilege = Privilege::None;
Vernon Maueryd6a2da02019-04-09 16:00:46 -0700502 int rqSA = 0;
Kumar Thangavelf7d081f2020-08-19 20:41:18 +0530503 int hostIdx = 0;
Vernon Mauery735ee952019-02-15 13:38:52 -0800504 uint8_t userId = 0; // undefined user
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530505 uint32_t sessionId = 0;
Vernon Mauery735ee952019-02-15 13:38:52 -0800506
507 // figure out what channel the request came in on
508 uint8_t channel = channelFromMessage(m);
509 if (channel == invalidChannel)
510 {
511 // unknown sender channel; refuse to service the request
Vernon Mauerye808bae2024-05-31 14:55:36 -0700512 lg2::error("ERROR determining source IPMI channel from "
513 "{SENDER} NetFn/Cmd {NETFN}/{CMD}",
514 "SENDER", sender, "NETFN", lg2::hex, netFn, "CMD", lg2::hex,
515 cmd);
Vernon Mauery735ee952019-02-15 13:38:52 -0800516 return dbusResponse(ipmi::ccDestinationUnavailable);
517 }
518
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530519 // session-based channels are required to provide userId, privilege and
520 // sessionId
Vernon Mauery735ee952019-02-15 13:38:52 -0800521 if (getChannelSessionSupport(channel) != EChannelSessSupported::none)
522 {
523 try
524 {
525 Value requestPriv = options.at("privilege");
526 Value requestUserId = options.at("userId");
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530527 Value requestSessionId = options.at("currentSessionId");
Vernon Mauery735ee952019-02-15 13:38:52 -0800528 privilege = static_cast<Privilege>(std::get<int>(requestPriv));
529 userId = static_cast<uint8_t>(std::get<int>(requestUserId));
Rajashekar Gade Reddy4d226402019-11-13 17:13:05 +0530530 sessionId =
531 static_cast<uint32_t>(std::get<uint32_t>(requestSessionId));
Vernon Mauery735ee952019-02-15 13:38:52 -0800532 }
533 catch (const std::exception& e)
534 {
Vernon Mauerye808bae2024-05-31 14:55:36 -0700535 lg2::error("ERROR determining IPMI session credentials on "
536 "channel {CHANNEL} for userid {USERID}",
537 "CHANNEL", channel, "USERID", userId, "NETFN", lg2::hex,
538 netFn, "CMD", lg2::hex, cmd);
Vernon Mauery735ee952019-02-15 13:38:52 -0800539 return dbusResponse(ipmi::ccUnspecifiedError);
540 }
541 }
542 else
543 {
544 // get max privilege for session-less channels
545 // For now, there is not a way to configure this, default to Admin
546 privilege = Privilege::Admin;
Vernon Maueryd6a2da02019-04-09 16:00:46 -0700547
548 // ipmb should supply rqSA
549 ChannelInfo chInfo;
550 getChannelInfo(channel, chInfo);
551 if (static_cast<EChannelMediumType>(chInfo.mediumType) ==
552 EChannelMediumType::ipmb)
553 {
554 const auto iter = options.find("rqSA");
555 if (iter != options.end())
556 {
557 if (std::holds_alternative<int>(iter->second))
558 {
559 rqSA = std::get<int>(iter->second);
560 }
561 }
Kumar Thangavelf7d081f2020-08-19 20:41:18 +0530562 const auto iteration = options.find("hostId");
563 if (iteration != options.end())
564 {
565 if (std::holds_alternative<int>(iteration->second))
566 {
567 hostIdx = std::get<int>(iteration->second);
568 }
569 }
Vernon Maueryd6a2da02019-04-09 16:00:46 -0700570 }
Vernon Mauery735ee952019-02-15 13:38:52 -0800571 }
572 // check to see if the requested priv/username is valid
Vernon Mauerye808bae2024-05-31 14:55:36 -0700573 lg2::debug("Set up ipmi context: Ch:NetFn/Cmd={CHANNEL}:{NETFN}/{CMD}",
574 "SENDER", sender, "NETFN", lg2::hex, netFn, "LUN", lg2::hex, lun,
575 "CMD", lg2::hex, cmd, "CHANNEL", channel, "USERID", userId,
576 "SESSIONID", lg2::hex, sessionId, "PRIVILEGE",
577 static_cast<uint8_t>(privilege), "RQSA", lg2::hex, rqSA);
Vernon Mauery735ee952019-02-15 13:38:52 -0800578
Patrick Williams1318a5e2024-08-16 15:19:54 -0400579 auto ctx = std::make_shared<ipmi::Context>(
580 getSdBus(), netFn, lun, cmd, channel, userId, sessionId, privilege,
581 rqSA, hostIdx, yield);
Vernon Mauery240b1862018-10-08 12:05:16 -0700582 auto request = std::make_shared<ipmi::message::Request>(
Vernon Mauery997952a2021-07-30 14:06:14 -0700583 ctx, std::forward<ipmi::SecureBuffer>(data));
Vernon Mauery240b1862018-10-08 12:05:16 -0700584 message::Response::ptr response = executeIpmiCommand(request);
585
Vernon Mauery735ee952019-02-15 13:38:52 -0800586 return dbusResponse(response->cc, response->payload.raw);
Vernon Mauery240b1862018-10-08 12:05:16 -0700587}
588
589/** @struct IpmiProvider
590 *
591 * RAII wrapper for dlopen so that dlclose gets called on exit
592 */
593struct IpmiProvider
594{
595 public:
596 /** @brief address of the opened library */
597 void* addr;
598 std::string name;
599
600 IpmiProvider() = delete;
601 IpmiProvider(const IpmiProvider&) = delete;
602 IpmiProvider& operator=(const IpmiProvider&) = delete;
603 IpmiProvider(IpmiProvider&&) = delete;
604 IpmiProvider& operator=(IpmiProvider&&) = delete;
605
606 /** @brief dlopen a shared object file by path
607 * @param[in] filename - path of shared object to open
608 */
609 explicit IpmiProvider(const char* fname) : addr(nullptr), name(fname)
610 {
Vernon Mauerye808bae2024-05-31 14:55:36 -0700611 lg2::debug("Open IPMI provider library: {PROVIDER}", "PROVIDER", name);
Vernon Mauery240b1862018-10-08 12:05:16 -0700612 try
613 {
614 addr = dlopen(name.c_str(), RTLD_NOW);
615 }
Patrick Williamsa2ad2da2021-10-06 12:21:46 -0500616 catch (const std::exception& e)
Vernon Mauery240b1862018-10-08 12:05:16 -0700617 {
Vernon Mauerye808bae2024-05-31 14:55:36 -0700618 lg2::error("ERROR opening IPMI provider {PROVIDER}: {ERROR}",
619 "PROVIDER", name, "ERROR", e);
Vernon Mauery240b1862018-10-08 12:05:16 -0700620 }
621 catch (...)
622 {
Vernon Mauery03d7a4b2021-01-19 11:22:17 -0800623 const char* what = currentExceptionType();
Vernon Mauerye808bae2024-05-31 14:55:36 -0700624 lg2::error("ERROR opening IPMI provider {PROVIDER}: {ERROR}",
625 "PROVIDER", name, "ERROR", what);
Vernon Mauery240b1862018-10-08 12:05:16 -0700626 }
627 if (!isOpen())
628 {
Vernon Mauerye808bae2024-05-31 14:55:36 -0700629 lg2::error("ERROR opening IPMI provider {PROVIDER}: {ERROR}",
630 "PROVIDER", name, "ERROR", dlerror());
Vernon Mauery240b1862018-10-08 12:05:16 -0700631 }
632 }
633
634 ~IpmiProvider()
635 {
636 if (isOpen())
637 {
638 dlclose(addr);
639 }
640 }
641 bool isOpen() const
642 {
643 return (nullptr != addr);
644 }
645};
646
647// Plugin libraries need to contain .so either at the end or in the middle
648constexpr const char ipmiPluginExtn[] = ".so";
649
650/* return a list of self-closing library handles */
651std::forward_list<IpmiProvider> loadProviders(const fs::path& ipmiLibsPath)
652{
653 std::vector<fs::path> libs;
654 for (const auto& libPath : fs::directory_iterator(ipmiLibsPath))
655 {
Vernon Maueryb0ab5fe2019-03-06 14:03:00 -0800656 std::error_code ec;
Vernon Mauery240b1862018-10-08 12:05:16 -0700657 fs::path fname = libPath.path();
Vernon Maueryb0ab5fe2019-03-06 14:03:00 -0800658 if (fs::is_symlink(fname, ec) || ec)
659 {
660 // it's a symlink or some other error; skip it
661 continue;
662 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700663 while (fname.has_extension())
664 {
665 fs::path extn = fname.extension();
666 if (extn == ipmiPluginExtn)
667 {
668 libs.push_back(libPath.path());
669 break;
670 }
671 fname.replace_extension();
672 }
673 }
674 std::sort(libs.begin(), libs.end());
675
676 std::forward_list<IpmiProvider> handles;
677 for (auto& lib : libs)
678 {
679#ifdef __IPMI_DEBUG__
Vernon Mauerye808bae2024-05-31 14:55:36 -0700680 lg2::debug("Registering handler {HANDLER}", "HANDLER", lib);
Vernon Mauery240b1862018-10-08 12:05:16 -0700681#endif
682 handles.emplace_front(lib.c_str());
683 }
684 return handles;
685}
686
687} // namespace ipmi
688
Vernon Mauery240b1862018-10-08 12:05:16 -0700689#ifdef ALLOW_DEPRECATED_API
690/* legacy registration */
691void ipmi_register_callback(ipmi_netfn_t netFn, ipmi_cmd_t cmd,
692 ipmi_context_t context, ipmid_callback_t handler,
693 ipmi_cmd_privilege_t priv)
694{
Vernon Mauerybe376302019-03-21 13:02:05 -0700695 auto h = ipmi::makeLegacyHandler(handler, context);
Vernon Mauery240b1862018-10-08 12:05:16 -0700696 // translate priv from deprecated enum to current
697 ipmi::Privilege realPriv;
698 switch (priv)
699 {
700 case PRIVILEGE_CALLBACK:
701 realPriv = ipmi::Privilege::Callback;
702 break;
703 case PRIVILEGE_USER:
704 realPriv = ipmi::Privilege::User;
705 break;
706 case PRIVILEGE_OPERATOR:
707 realPriv = ipmi::Privilege::Operator;
708 break;
709 case PRIVILEGE_ADMIN:
710 realPriv = ipmi::Privilege::Admin;
711 break;
712 case PRIVILEGE_OEM:
713 realPriv = ipmi::Privilege::Oem;
714 break;
715 case SYSTEM_INTERFACE:
716 realPriv = ipmi::Privilege::Admin;
717 break;
718 default:
719 realPriv = ipmi::Privilege::Admin;
720 break;
721 }
Vernon Mauerye8d43232019-03-26 16:23:43 -0700722 // The original ipmi_register_callback allowed for group OEM handlers
723 // to be registered via this same interface. It just so happened that
724 // all the handlers were part of the DCMI group, so default to that.
725 if (netFn == NETFUN_GRPEXT)
726 {
Vernon Mauery82cffcc2023-07-27 10:59:20 -0700727 ipmi::impl::registerGroupHandler(ipmi::prioOpenBmcBase, ipmi::groupDCMI,
728 cmd, realPriv, h);
Vernon Mauerye8d43232019-03-26 16:23:43 -0700729 }
730 else
731 {
732 ipmi::impl::registerHandler(ipmi::prioOpenBmcBase, netFn, cmd, realPriv,
733 h);
734 }
Vernon Mauery240b1862018-10-08 12:05:16 -0700735}
736
Vernon Maueryf984a012018-10-08 12:05:18 -0700737namespace oem
738{
739
740class LegacyRouter : public oem::Router
741{
742 public:
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500743 virtual ~LegacyRouter() {}
Vernon Maueryf984a012018-10-08 12:05:18 -0700744
745 /// Enable message routing to begin.
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500746 void activate() override {}
Vernon Maueryf984a012018-10-08 12:05:18 -0700747
748 void registerHandler(Number oen, ipmi_cmd_t cmd, Handler handler) override
749 {
750 auto h = ipmi::makeLegacyHandler(std::forward<Handler>(handler));
751 ipmi::impl::registerOemHandler(ipmi::prioOpenBmcBase, oen, cmd,
752 ipmi::Privilege::Admin, h);
753 }
754};
755static LegacyRouter legacyRouter;
756
757Router* mutableRouter()
758{
759 return &legacyRouter;
760}
761
762} // namespace oem
763
Vernon Mauery240b1862018-10-08 12:05:16 -0700764/* legacy alternative to executionEntry */
Patrick Williams5d82f472022-07-22 19:26:53 -0500765void handleLegacyIpmiCommand(sdbusplus::message_t& m)
Vernon Mauery240b1862018-10-08 12:05:16 -0700766{
Vernon Mauery23b70212019-05-08 15:19:05 -0700767 // make a copy so the next two moves don't wreak havoc on the stack
Patrick Williams5d82f472022-07-22 19:26:53 -0500768 sdbusplus::message_t b{m};
Ed Tanous98605052025-02-13 16:57:13 -0800769 boost::asio::spawn(
Jayanth Othayoth531223f2024-11-11 07:30:15 -0600770 *getIoContext(),
771 [b = std::move(b)](boost::asio::yield_context yield) {
772 sdbusplus::message_t m{std::move(b)};
773 unsigned char seq = 0, netFn = 0, lun = 0, cmd = 0;
774 ipmi::SecureBuffer data;
Vernon Mauery240b1862018-10-08 12:05:16 -0700775
Jayanth Othayoth531223f2024-11-11 07:30:15 -0600776 m.read(seq, netFn, lun, cmd, data);
777 std::shared_ptr<sdbusplus::asio::connection> bus = getSdBus();
778 auto ctx = std::make_shared<ipmi::Context>(
779 bus, netFn, lun, cmd, 0, 0, 0, ipmi::Privilege::Admin, 0, 0,
780 yield);
781 auto request = std::make_shared<ipmi::message::Request>(
782 ctx, std::forward<ipmi::SecureBuffer>(data));
783 ipmi::message::Response::ptr response =
784 ipmi::executeIpmiCommand(request);
Vernon Mauery240b1862018-10-08 12:05:16 -0700785
Jayanth Othayoth531223f2024-11-11 07:30:15 -0600786 // Responses in IPMI require a bit set. So there ya go...
787 netFn |= 0x01;
Vernon Mauery240b1862018-10-08 12:05:16 -0700788
Jayanth Othayoth531223f2024-11-11 07:30:15 -0600789 const char *dest, *path;
790 constexpr const char* DBUS_INTF = "org.openbmc.HostIpmi";
Vernon Mauery240b1862018-10-08 12:05:16 -0700791
Jayanth Othayoth531223f2024-11-11 07:30:15 -0600792 dest = m.get_sender();
793 path = m.get_path();
794 boost::system::error_code ec;
795 bus->yield_method_call(yield, ec, dest, path, DBUS_INTF,
796 "sendMessage", seq, netFn, lun, cmd,
797 response->cc, response->payload.raw);
798 if (ec)
799 {
800 lg2::error(
801 "Failed to send response to requestor ({NETFN}/{CMD}): {ERROR}",
802 "ERROR", ec.message(), "SENDER", dest, "NETFN", lg2::hex,
803 netFn, "CMD", lg2::hex, cmd);
804 }
805 },
Ed Tanous98605052025-02-13 16:57:13 -0800806 boost::asio::detached);
Vernon Mauery240b1862018-10-08 12:05:16 -0700807}
808
809#endif /* ALLOW_DEPRECATED_API */
810
811// Calls host command manager to do the right thing for the command
812using CommandHandler = phosphor::host::command::CommandHandler;
813std::unique_ptr<phosphor::host::command::Manager> cmdManager;
814void ipmid_send_cmd_to_host(CommandHandler&& cmd)
815{
Vernon Mauery5e096a22022-06-01 15:11:16 -0700816 cmdManager->execute(std::forward<CommandHandler>(cmd));
Vernon Mauery240b1862018-10-08 12:05:16 -0700817}
818
819std::unique_ptr<phosphor::host::command::Manager>& ipmid_get_host_cmd_manager()
820{
821 return cmdManager;
822}
823
Vernon Mauery20ff3332019-03-01 16:52:25 -0800824// These are symbols that are present in libipmid, but not expected
825// to be used except here (or maybe a unit test), so declare them here
826extern void setIoContext(std::shared_ptr<boost::asio::io_context>& newIo);
827extern void setSdBus(std::shared_ptr<sdbusplus::asio::connection>& newBus);
828
Vernon Mauery240b1862018-10-08 12:05:16 -0700829int main(int argc, char* argv[])
830{
831 // Connect to system bus
Vernon Mauery20ff3332019-03-01 16:52:25 -0800832 auto io = std::make_shared<boost::asio::io_context>();
833 setIoContext(io);
Vernon Mauery240b1862018-10-08 12:05:16 -0700834 if (argc > 1 && std::string(argv[1]) == "-session")
835 {
836 sd_bus_default_user(&bus);
837 }
838 else
839 {
840 sd_bus_default_system(&bus);
841 }
Vernon Mauery20ff3332019-03-01 16:52:25 -0800842 auto sdbusp = std::make_shared<sdbusplus::asio::connection>(*io, bus);
843 setSdBus(sdbusp);
Vernon Mauery240b1862018-10-08 12:05:16 -0700844
Patrick Williams3b301a32025-02-03 13:05:36 -0500845 // TODO: Hack to keep the sdEvents running.... Not sure why the sd_event
846 // queue stops running if we don't have a timer that keeps re-arming
847 sdbusplus::Timer t2([]() { ; });
848 t2.start(std::chrono::microseconds(500000), true);
849
850 // TODO: Remove all vestiges of sd_event from phosphor-host-ipmid
851 // until that is done, add the sd_event wrapper to the io object
852 sdbusplus::asio::sd_event_wrapper sdEvents(*io);
853
Vernon Mauery240b1862018-10-08 12:05:16 -0700854 cmdManager = std::make_unique<phosphor::host::command::Manager>(*sdbusp);
855
856 // Register all command providers and filters
Vernon Mauery4ec4e402019-03-20 13:09:27 -0700857 std::forward_list<ipmi::IpmiProvider> providers =
858 ipmi::loadProviders(HOST_IPMI_LIB_PATH);
Vernon Mauery240b1862018-10-08 12:05:16 -0700859
Vernon Mauery240b1862018-10-08 12:05:16 -0700860#ifdef ALLOW_DEPRECATED_API
861 // listen on deprecated signal interface for kcs/bt commands
862 constexpr const char* FILTER = "type='signal',interface='org.openbmc."
863 "HostIpmi',member='ReceivedMessage'";
Patrick Williams5d82f472022-07-22 19:26:53 -0500864 sdbusplus::bus::match_t oldIpmiInterface(*sdbusp, FILTER,
865 handleLegacyIpmiCommand);
Vernon Mauery240b1862018-10-08 12:05:16 -0700866#endif /* ALLOW_DEPRECATED_API */
867
Vernon Mauery735ee952019-02-15 13:38:52 -0800868 // set up bus name watching to match channels with bus names
Patrick Williams5d82f472022-07-22 19:26:53 -0500869 sdbusplus::bus::match_t nameOwnerChanged(
Vernon Mauery735ee952019-02-15 13:38:52 -0800870 *sdbusp,
871 sdbusplus::bus::match::rules::nameOwnerChanged() +
872 sdbusplus::bus::match::rules::arg0namespace(
873 ipmi::ipmiDbusChannelMatch),
874 ipmi::nameChangeHandler);
Jayanth Othayoth9f3073a2024-12-08 09:29:43 -0600875 ipmi::doListNames(*sdbusp);
Vernon Mauery735ee952019-02-15 13:38:52 -0800876
James Feistb0094a72019-11-26 09:07:15 -0800877 int exitCode = 0;
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700878 // set up boost::asio signal handling
Patrick Williams1318a5e2024-08-16 15:19:54 -0400879 std::function<SignalResponse(int)> stopAsioRunLoop = [&io, &exitCode](
880 int signalNumber) {
Vernon Mauerye808bae2024-05-31 14:55:36 -0700881 lg2::info("Received signal {SIGNAL}; quitting", "SIGNAL", signalNumber);
Patrick Williamsfbc6c9d2023-05-10 07:50:16 -0500882 io->stop();
883 exitCode = signalNumber;
884 return SignalResponse::breakExecution;
885 };
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700886 registerSignalHandler(ipmi::prioOpenBmcBase, SIGINT, stopAsioRunLoop);
887 registerSignalHandler(ipmi::prioOpenBmcBase, SIGTERM, stopAsioRunLoop);
888
Richard Marian Thomaiyar369406e2020-01-09 14:56:54 +0530889 sdbusp->request_name("xyz.openbmc_project.Ipmi.Host");
890 // Add bindings for inbound IPMI requests
891 auto server = sdbusplus::asio::object_server(sdbusp);
892 auto iface = server.add_interface("/xyz/openbmc_project/Ipmi",
893 "xyz.openbmc_project.Ipmi.Server");
894 iface->register_method("execute", ipmi::executionEntry);
895 iface->initialize();
896
Vernon Mauery240b1862018-10-08 12:05:16 -0700897 io->run();
898
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700899 // destroy all the IPMI handlers so the providers can unload safely
900 ipmi::handlerMap.clear();
901 ipmi::groupHandlerMap.clear();
902 ipmi::oemHandlerMap.clear();
903 ipmi::filterList.clear();
904 // unload the provider libraries
Vernon Mauery4ec4e402019-03-20 13:09:27 -0700905 providers.clear();
Vernon Mauery1b7f6f22019-03-13 13:11:25 -0700906
James Feistb0094a72019-11-26 09:07:15 -0800907 std::exit(exitCode);
Vernon Mauery240b1862018-10-08 12:05:16 -0700908}