Google Git
Sign in
gbmc / gbmcweb / 1f2dd1aae4f969b292b573d5274b8f9cd97b9fb3
commit1f2dd1aae4f969b292b573d5274b8f9cd97b9fb3[log] [tgz]
authorNan Zhou <nanzhou@google.com>Tue Sep 09 12:23:45 2025 -0700
committerCopybara-Service <copybara-worker@google.com>Tue Sep 09 12:24:23 2025 -0700
tree16de16a8f87ee5ce933d47ffbaa1c7c6ee86b4aa
parenta22023bdfc6dc3d82194c86e0961bc7cadc34809 [diff]
Automated g4 rollback of changelist 803317436.

*** Reason for rollback ***

b/443840282 build breaks

*** Original change description ***

Removing BMCWEB_ENABLE_GRPC flag on g3 side first since BUILD dependencies need to be amended for reverse workflow to succeed.
b/416589112 Remove support for BMCWEB_ENABLE_GRPC undef code paths.

***

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