Google Git
Sign in
gbmc / gbmcweb / f8883d0fb533a7edbdd6859728328d6783ad9284
commitf8883d0fb533a7edbdd6859728328d6783ad9284[log] [tgz]
authorNan Zhou <nanzhou@google.com>Mon Jul 07 13:25:27 2025 -0700
committerCopybara-Service <copybara-worker@google.com>Mon Jul 07 13:26:01 2025 -0700
treec4529953226ea6e0f4f6842ec101a5d73fba739d
parent64d1bf22c4f934ab3191a95788daf53908c4f467 [diff]
Composable tlbmc

This CL made modules in tlBMC flexible and configurable at runtime. See designs in go/composable-tlbmc

Changes are:

1. Make collectors composable. For a collector, if it is not enabled, its equivalent dummy collector is created. A dummy collector will return empty resources or not found on its interfaces. This is needed as the code base does not do nullptr check today.
1. Defined a central config proto, so that collector are enabled by configs. Every platform can have its unique config
1. Platform is determined at tlbmc runtime, no need for to specify platform at compile time
1. A single textproto file is created to configure tlbmc across platforms. This is to ensure the WIP gbmcweb msvfud package can still support single package for every platform. This textproto file will be maintained in https://gbmc-private.googlesource.com/ as I can't leak code names.
1. Made a factory method so that the logic of creating tlbmc App and store can be tested. Today it's in webserver_main_include and it is not tested.
1. Made a `default` platform which represents all platform that have `tlbmc` enabled but without FRU collector and Sensor collector turned on. Added e2e tests for it

#tlbmc

PiperOrigin-RevId: 780235972
Change-Id: Ibefb10261c36af674f00cb450d157918daec7aeb
20 files changed
tree: c4529953226ea6e0f4f6842ec101a5d73fba739d
  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.