Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / c05bba459941ae17aa9508529ccd0284e5300213
commitc05bba459941ae17aa9508529ccd0284e5300213[log] [tgz]
authorEd Tanous <edtanous@google.com>Wed Jun 28 08:33:29 2023 -0700
committerEd Tanous <ed@tanous.net>Fri Jun 30 15:40:43 2023 +0000
tree85152ba94e7372018abfbe819c26dd68e607934a
parent1017ef80f690e1d4c0a7c9799a9a3e26551308df [diff]
Fix a bug for zero arg EventLog entries

When the EventLog is pushed to the files, there is a case where we can't
know the difference between a message with zero args, and a message with
one arg, where the first arg is empty string.  They both show up in the
log similar to

<DATE> OpenBMC.MessageId,

This causes Redfish to return a LogEntry with one empty argument.

This commit uses the registry information to resize the args array
appropriately, dependent on what message is being sent, effectively
ignoring what the developer put into their logs.  If there's too many
args, they're removed, if there's not enough args, empty args are added.

Tested:
GET /redfish/v1/Systems/system/LogServices/EventLog/Entries

Returned an entry with the properties:

"Message": "Power restore policy applied.",
"MessageArgs": [],
"MessageId": "OpenBMC.0.1.PowerRestorePolicyApplied",

Which appear to be correct.

Change-Id: I7d6f150bddad88d1c3da9d0424268d1eac902145
Signed-off-by: Ed Tanous <edtanous@google.com>
1 file changed
tree: 85152ba94e7372018abfbe819c26dd68e607934a
  1. .github/
  2. config/
  3. http/
  4. include/
  5. redfish-core/
  6. scripts/
  7. src/
  8. static/
  9. subprojects/
  10. test/
  11. .clang-format
  12. .clang-tidy
  13. .dockerignore
  14. .gitignore
  15. .markdownlint.yaml
  16. .openbmc-enforce-gitlint
  17. .prettierignore
  18. .shellcheck
  19. AGGREGATION.md
  20. CLIENTS.md
  21. COMMON_ERRORS.md
  22. DBUS_USAGE.md
  23. DEVELOPING.md
  24. HEADERS.md
  25. LICENSE
  26. meson.build
  27. meson_options.txt
  28. OEM_SCHEMAS.md
  29. OWNERS
  30. README.md
  31. Redfish.md
  32. run-ci
  33. setup.cfg
  34. TESTING.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for OpenBMC.

Features

The webserver implements a few distinct interfaces:

  • DBus event websocket. Allows registering on changes to specific dbus paths, properties, and will send an event from the websocket if those filters match.
  • OpenBMC DBus REST api. Allows direct, low interference, high fidelity access to dbus and the objects it represents.
  • Serial: A serial websocket for interacting with the host serial console through websockets.
  • Redfish: A protocol compliant, DBus to Redfish translator.
  • KVM: A websocket based implementation of the RFB (VNC) frame buffer protocol intended to mate to webui-vue to provide a complete KVM implementation.

Protocols

bmcweb at a protocol level supports http and https. TLS is supported through OpenSSL.

AuthX

Authentication

Bmcweb supports multiple authentication protocols:

  • Basic authentication per RFC7617
  • Cookie based authentication for authenticating against webui-vue
  • Mutual TLS authentication based on OpenSSL
  • Session authentication through webui-vue
  • XToken based authentication conformant to Redfish DSP0266

Each of these types of authentication is able to be enabled or disabled both via runtime policy changes (through the relevant Redfish APIs) or via configure time options. All authentication mechanisms supporting username/password are routed to libpam, to allow for customization in authentication implementations.

Authorization

All authorization in bmcweb is determined at routing time, and per route, and conform to the Redfish PrivilegeRegistry.

*Note: Non-Redfish functions are mapped to the closest equivalent Redfish privilege level.

Configuration

bmcweb is configured per the meson build files. Available options are documented in meson_options.txt

Compile bmcweb with default options

meson setup builddir
ninja -C builddir

If any of the dependencies are not found on the host system during configuration, meson will automatically download them via its wrap dependencies mentioned in bmcweb/subprojects.

Use of persistent data

bmcweb relies on some on-system data for storage of persistent data that is internal to the process. Details on the exact data stored and when it is read/written can seen from the persistent_data namespace.

TLS certificate generation

When SSL support is enabled and a usable certificate is not found, bmcweb will generate a self-signed a certificate before launching the server. Please see the bmcweb source code for details on the parameters this certificate is built with.

Redfish Aggregation

bmcweb is capable of aggregating resources from satellite BMCs. Refer to AGGREGATION.md for more information on how to enable and use this feature.