Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 1188a58e8e3d4423f2932dfe3a51610670309281
commit1188a58e8e3d4423f2932dfe3a51610670309281[log] [tgz]
authorEd Tanous <etanous@nvidia.com>Wed Oct 08 12:09:59 2025 -0700
committerEd Tanous <ed@tanous.net>Thu Oct 16 00:23:10 2025 +0000
treea4913d08df5dbc231c6865e2cf5ce0855090569c
parentb360d5b91cff2c98113e259203a02e5e7d6963a2 [diff]
Make DBus aggregation optional

There are a number of scenarios where Entity manager might not be
running, or might have errored out.  For resilience, this should ONLY
result in the aggregated sources disappearing, and should not effect the
main collections.

One use case for this is local development and testing the aggregation.

To accomplish this, modify the getSatteliteConfigs function to always
call the callback, in the case of an error, calling with an empty map of
satellites.

Tested: Launched bmcweb directly with insecure-disable-auth and
redfish-aggregation enabled.  Created an aggregated source:

```
curl -vvvv -k https://localhost:18080/redfish/v1/AggregationService/AggregationSources -H "Content-Type: application/json" --request POST --data '{"HostName":"https://10.114.132.149", "UserName": "root", "Password": "0penBmc"}'
```

Change-Id: Ica667fe27a35b33a99d0b411a06407b73efe6731
Signed-off-by: Ed Tanous <etanous@nvidia.com>
2 files changed
tree: a4913d08df5dbc231c6865e2cf5ce0855090569c
  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.