Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 9d6459e891b33d9785b53553da30ecc3db2189af
commit9d6459e891b33d9785b53553da30ecc3db2189af[log] [tgz]
authorOliver Brewka <oliver.brewka@9elements.com>Wed Aug 27 13:39:15 2025 +0200
committerOliver Brewka <oliver.brewka@9elements.com>Wed Nov 12 18:09:32 2025 +0100
tree039bd5cae7c8d57740bedd91fb22c26c0a5824a4
parent3af76e1508cce1272751ede5f4f633a74888950f [diff]
Dynamic EventLogService handler

In order to reuse the handler for the EventLogService under Managers,
extract the logic from the handler and put it into a separate function
in the eventlog util. Add an additional argument that specifies
the redfish resource, so we can handle Systems and Managers resource
with the same handler.

Tested: Code compiles. Redfish validation succeeds.
Additionally the curl output with and without the changes has been
diffed. No differences observed.

Change-Id: I48825b55b41afeafa02283dc91cf4cb1cd4cd7c3
Signed-off-by: Oliver Brewka <oliver.brewka@9elements.com>
3 files changed
tree: 039bd5cae7c8d57740bedd91fb22c26c0a5824a4
  1. .github/
  2. config/
  3. docs/
  4. features/
  5. http/
  6. include/
  7. redfish-core/
  8. scripts/
  9. src/
  10. static/
  11. subprojects/
  12. test/
  13. .clang-format
  14. .clang-tidy
  15. .codespell-ignore
  16. .dockerignore
  17. .eslintignore
  18. .gitignore
  19. .markdownlint.yaml
  20. .openbmc-enforce-gitlint
  21. .prettierignore
  22. .shellcheck
  23. DEVELOPING.md
  24. LICENSE
  25. meson.build
  26. meson.options
  27. OWNERS
  28. README.md
  29. run-ci
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. Http1 and http2 are supported using ALPN registration for TLS connections and h2c upgrade header for http connections.

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.

Compression

bmcweb supports various forms of http compression, including zstd and gzip. Client headers are observed to determine whether compressed payloads are supported.

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.