Google Git
Sign in
gbmc / gbmcweb / 2c4a6c57d68d3bb80db9a80c05a7c22e7f3a4e1c
commit2c4a6c57d68d3bb80db9a80c05a7c22e7f3a4e1c[log] [tgz]
authorRahul Kapoor <rahulkpr@google.com>Mon May 19 16:27:37 2025 -0700
committerCopybara-Service <copybara-worker@google.com>Mon May 19 16:28:16 2025 -0700
tree27f2578024086bfc4ce438bbb5706331da32078e
parent036d22d6a3dc881fdb756338e93eeb071ff5119e [diff]
Adding implementation for subscription manager

This CL introduces the implementation of subscription manager and related classes.
It includes the following features:
- ResourceMonitor to monitor the sampling intervals for each resource.
- ActiveSubscription to manage a single subscription.
- SubscriptionManagerImpl which provide APIs to add/remove subscriptions.
- Resample function which downsample data collected by the data source.
- Unit tests to validate the implementation.

In addition to above changes, added `SubscriptionPolicy` to SubscriptionParams to allow the subscriber to specify Resource to subscribe and whether subscription should apply to all resources or specific based on the given identifiers

Tested:
 Unit Test

#tlbmc
#tlbmc-hft

PiperOrigin-RevId: 760813662
Change-Id: I78f76b4ea6dcd6cfb07ff3489cbee4be38c7d53d
3 files changed
tree: 27f2578024086bfc4ce438bbb5706331da32078e
  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.