Google Git
Sign in
gbmc / gbmcweb / f3e2299b9a58f2f74cabf967a4e68b468c4fcb21
commitf3e2299b9a58f2f74cabf967a4e68b468c4fcb21[log] [tgz]
authorDavid Tang <davtang@google.com>Tue Jun 24 09:25:50 2025 -0700
committerCopybara-Service <copybara-worker@google.com>Tue Jun 24 09:26:28 2025 -0700
tree16ae1cafc8c60fdc46d31e4d06a5a92faad80f99
parentf140b1e7799e9e79ea53a99674052041931e05b4 [diff]
Create flag to allow sensor creation failures in tlBMC

Introduce a flag in tlBMC central config (`allow_sensor_creation_failure`) such that configuring this to true will allow sensor creation failures to not fail tlBMC store creation. This is helpful on platforms in development when TlbmcOwned sensors may not all be available but we want tlBMC to continue serving data for valid sensors. Since many TlbmcOwned sensors will now have SkipDbusRead configured, this will allow readings to continue for valid sensors and just log the sensor creation failure.

This implementation creates a sensor object with Status `STATUS_CREATION_FAILED`, indicating that the sensor creation attempt has failed and the sensor data will not refresh for this sensor. When tlBMC owns sensor collection, this object will be surfaced with this status to indicate to clients that an expected sensor is not present on the machine.

By default, `allow_sensor_creation_failure` will always be configured to FALSE, meaning that any sensor failure encountered will lead to failure of tlBMC store creation. This is the intended production behavior and this flag should never be set to false when tlBMC is configured on prod machines.

Also updated AllSensor errors, all sensor errors received when attempting to create the AllSensors response will be merged and can be identified by sensor key, see output below

#tlbmc

Tested:
 - real sensor failure output: https://paste.googleplex.com/5085865891856384
 - platform11 after powercycle: https://paste.googleplex.com/4747093809561600
PiperOrigin-RevId: 775266878
Change-Id: If89e65dfcc2c0f3c1553472d1a32c7c6d75ff244
11 files changed
tree: 16ae1cafc8c60fdc46d31e4d06a5a92faad80f99
  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. DBUS_USAGE.md
  29. DEVELOPING.md
  30. gcovr.cfg
  31. HEADERS.md
  32. LICENSE
  33. meson.build
  34. meson_options.txt
  35. OEM_SCHEMAS.md
  36. OWNERS
  37. PLUGINS.md
  38. README.md
  39. README_GOOGLE.md
  40. Redfish.md
  41. run-ci
  42. setup.cfg
  43. TESTING.md
  44. 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.