Google GitGoogle Git
Sign in
gbmc/gbmcweb/5f39d8f771d64cf5e8511d611bfa67828d48a648
commit
5f39d8f771d64cf5e8511d611bfa67828d48a648
[log]
author
gBMC Team <gbmc-core@google.com>
Thu Sep 10 19:11:43 2026 -0700
committer
Copybara-Service <copybara-worker@google.com>
Thu Sep 10 19:13:10 2026 -0700
tree
298fecdb3e3cac516653b6fb8885b90adbb24b99
parent
a93e90b2a3e273b741d1c87e9227e75fa9c5d892 [diff]
Add tlBMC Redfish PATCH override route and dev-signed safety gating for sensors

This change implements software sensor override management via Redfish:
- Supports `PATCH /redfish/v1/Chassis/<ChassisId>/Sensors/<SensorId>` with payload `Oem.Google.SensorValueOverridden: true` and `Reading` to instantiate a software override (enforces that `Reading` must be present).
- Supports `PATCH` with `Oem.Google.SensorValueOverridden: false` to clear an active override (enforces that `Reading` must NOT be present).
- Conditionally decorates `GET` responses with `Oem.Google.SensorValueOverridden: true` only when a software override is active, omitting the field entirely when inactive.
- Implements compile-time safety gating using `constexpr bool enableTlbmcSensorOverride` from `bmcweb_config.h` (configured via Meson option `tlbmc-sensor-override` and Bazel build flag `tlbmc_sensor_override`), with runtime environment variable fallback `ENABLE_TLBMC_SENSOR_OVERRIDE` for test environments. Returns HTTP 403 Forbidden (`Base.1.13.0.ActionNotSupported`) on production builds when disabled.

Google-Bug-Id:550410302
PiperOrigin-RevId: 979525293
Change-Id: I1843082e86e8a0e6ff422f3f7a2c92199fdd7abf
5 files changed
tree: 298fecdb3e3cac516653b6fb8885b90adbb24b99
  1. .github/
  2. config/
  3. devpath_plugin/
  4. g3/
  5. http/
  6. include/
  7. install/
  8. plugins/
  9. redfish-core/
  10. redfish_authorization/
  11. scripts/
  12. src/
  13. static/
  14. subprojects/
  15. test/
  16. tlbmc/
  17. .clang-format
  18. .clang-tidy
  19. .clang-tidy-ignore
  20. .dockerignore
  21. .gitignore
  22. .markdownlint.yaml
  23. .openbmc-enforce-gitlint
  24. .openbmc-no-clang
  25. .openbmc-no-sanitize
  26. .prettierignore
  27. .shellcheck
  28. AGGREGATION.md
  29. CLIENTS.md
  30. COMMON_ERRORS.md
  31. copy.bara.sky
  32. DBUS_USAGE.md
  33. DEVELOPING.md
  34. exception_stack_tracer.dynlist
  35. gcovr.cfg
  36. HEADERS.md
  37. LICENSE
  38. meson.build
  39. meson_options.txt
  40. OEM_SCHEMAS.md
  41. OWNERS
  42. PLUGINS.md
  43. README.md
  44. README_GOOGLE.md
  45. Redfish.md
  46. run-ci
  47. setup.cfg
  48. TESTING.md
  49. 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.