Google Git
Sign in
gbmc / gbmcweb / 82d1c7af722f80233dd7ec98e8c8e757b9d40935
commit82d1c7af722f80233dd7ec98e8c8e757b9d40935[log] [tgz]
authorgBMC Team <gbmc-core@google.com>Fri Oct 24 09:33:14 2025 -0700
committerCopybara-Service <copybara-worker@google.com>Fri Oct 24 09:34:11 2025 -0700
tree6708ddb143b1b3f8c831807721057d5668c35ab9
parent796febf6593d98493a0dc56034b6ce1a1a45c22b [diff]
Refactor Collectible policy ID validators + AgentIdentifier message for Feed Configuration.

This changes all policy IDs to lower kebab case and renames AGENT_TYPE to ENDPOINT_TYPE (as agent is a pretty machine-specific term). Also wrap sampling_interval in PeriodicPolicy to make it less confusing and explicit.

PiperOrigin-RevId: 823561019
Change-Id: I2421d9f5c2db3451aee09f01ce3f5b4ec368efb5
1 file changed
tree: 6708ddb143b1b3f8c831807721057d5668c35ab9
  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. .openbmc-no-sanitize
  25. .prettierignore
  26. .shellcheck
  27. AGGREGATION.md
  28. CLIENTS.md
  29. COMMON_ERRORS.md
  30. copy.bara.sky
  31. DBUS_USAGE.md
  32. DEVELOPING.md
  33. gcovr.cfg
  34. HEADERS.md
  35. LICENSE
  36. meson.build
  37. meson_options.txt
  38. OEM_SCHEMAS.md
  39. OWNERS
  40. PLUGINS.md
  41. README.md
  42. README_GOOGLE.md
  43. Redfish.md
  44. run-ci
  45. setup.cfg
  46. TESTING.md
  47. 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.