Google Git
Sign in
gbmc / gbmcweb / 677598a7711f7cd2b568aa6941f65f6a4034e807
commit677598a7711f7cd2b568aa6941f65f6a4034e807[log] [tgz]
authorDavid Tang <davtang@google.com>Wed May 21 16:48:42 2025 -0700
committerCopybara-Service <copybara-worker@google.com>Wed May 21 16:49:21 2025 -0700
tree5e1c10f012bdf9a44c342a002e278893719446b8
parent9f9b93c821c7a6b74d218e3f0a06caf2df7181a8 [diff]
Refactor SubFru definition to be based on the ResourceType instead of "IsSubFru" field

It is incorrect to allow SubFrus to be defined as `RESOURCE_TYPE_BOARD`. A subfru should be defined as a logical or physical resource attached to a Fru but cannot be removed from the Fru and is not detectable on its own. This refactor will prevent SubFrus from being defined as `RESOURCE_TYPE_BOARD` and must be defined with `RESOURCE_TYPE_ASSEMBLY` instead.

Since these are subfru objects, they must be defined with `PART_LOCATION_TYPE_EMBEDDED`. This requirement is still enforced. Since these will now be populated under the Assembly collection which is not yet owned by tlBMC, configs with `RESOURCE_TYPE_ASSEMBLY` are no longer expected in the redfish response.

Follow up cl/758881979 will propagate sensors from children assemblies to the parent Fru as described in go/tlbmc-redfish-gf-tree-assimilation.

#tlbmc

PiperOrigin-RevId: 761720588
Change-Id: If006d6c88aac636a52ad23b1bcebbaee3e938710
4 files changed
tree: 5e1c10f012bdf9a44c342a002e278893719446b8
  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.