Google Git
Sign in
gbmc / gbmcweb / a5efa7bbe4a656011398f5ec87cd3d8411230261
commita5efa7bbe4a656011398f5ec87cd3d8411230261[log] [tgz]
authorDavid Tang <davtang@google.com>Sun Jul 20 22:36:15 2025 -0700
committerCopybara-Service <copybara-worker@google.com>Sun Jul 20 22:37:06 2025 -0700
tree28c10d588bc6c2ef281e13993a961431250e1c6f
parenta8ce3aa11338f2d9c784ea6cddec63cee753edf2 [diff]
Return Disabled status for problematic Sensors instead of error code in query response

The current implementation always return an error status in tlBMC query response when an unhealthy sensor is queried. This violates client expectations when queries such as Expand are executed since legacy bmcweb/dbus-sensors behavior is to silently ignore failed sensors.

To align with client expectations, return the sensor with "Disabled" status if unhealthy and include a detailed error message for debug. Overall query will always return OK status if the API is successfully executing regardless of underlying health of the sensor(s) being queried.

#tlbmc

PiperOrigin-RevId: 785295710
Change-Id: Ic1a52870ce2b30ba3e1ab2316263bbb880963e4d
1 file changed
tree: 28c10d588bc6c2ef281e13993a961431250e1c6f
  1. .github/
  2. config/
  3. g3/
  4. http/
  5. include/
  6. plugins/
  7. redfish-core/
  8. redfish_authorization/
  9. scripts/
  10. src/
  11. static/
  12. subprojects/
  13. test/
  14. tlbmc/
  15. .clang-format
  16. .clang-tidy
  17. .clang-tidy-ignore
  18. .dockerignore
  19. .gitignore
  20. .markdownlint.yaml
  21. .openbmc-enforce-gitlint
  22. .openbmc-no-clang
  23. .prettierignore
  24. .shellcheck
  25. AGGREGATION.md
  26. CLIENTS.md
  27. COMMON_ERRORS.md
  28. copy.bara.sky
  29. DBUS_USAGE.md
  30. DEVELOPING.md
  31. gcovr.cfg
  32. HEADERS.md
  33. LICENSE
  34. meson.build
  35. meson_options.txt
  36. OEM_SCHEMAS.md
  37. OWNERS
  38. PLUGINS.md
  39. README.md
  40. README_GOOGLE.md
  41. Redfish.md
  42. run-ci
  43. setup.cfg
  44. TESTING.md
  45. UNIT_TESTING.md
README.md

OpenBMC webserver

This project is Google's version of BMCWeb.

See Readme Google for Google added features. The following is the original README of OpenBMC/BMCWeb.

==============================================================================

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 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.