Google Git
Sign in
gbmc / gbmcweb / 44ea5dcb68d717ba8ba474591c749749eb593901
commit44ea5dcb68d717ba8ba474591c749749eb593901[log] [tgz]
authorgBMC Team <gbmc-core@google.com>Sun Jul 20 18:44:45 2025 -0700
committerCopybara-Service <copybara-worker@google.com>Sun Jul 20 18:45:28 2025 -0700
treecf3220e6987453d34435d3fe44cda359a3c5c392
parentf079ee46fe6e4b73687166f7e153650fda0ae237 [diff]
BEGIN_PUBLIC
Add a new Google OEM BootNumber Redfish Schema
END_PUBLIC

Followed the internal g3doc for authorize-new-redfish-uris

Tested:
//third_party/milotic/external/cc/authz:milotic_redfish_authorizer_cli -- --command TestAuthorization --redfish_uri /redfish/v1/Systems/system/Oem/Google/BootNumber --operation GET --redfish_role Redfishz --configuration_path /google/src/cloud/jiayanli/CS-authorizer_enums-2025-07-17_133150/google3/platforms/gbmc/msvp/redfish_authz_policy/prod/gdu/redfish.json --base_privileges_folder /google/src/cloud/jiayanli/CS-authorizer_enums-2025-07-17_133150/google3/third_party/milotic/external/auth_config/production/
Starting local Blaze server (blaze-2025.07.10-1 (mainline @781264572)) and connecting to it...
INFO: Streaming build results to: http://sponge2/cdf03580-9c4e-4c72-8544-3c57175e19c8
INFO: Analyzed target //third_party/milotic/external/cc/authz:milotic_redfish_authorizer_cli (637 packages loaded, 25950 targets and 2072 aspects configured).
INFO: Found 1 target...
Target //third_party/milotic/external/cc/authz:milotic_redfish_authorizer_cli up-to-date:
  blaze-bin/third_party/milotic/external/cc/authz/milotic_redfish_authorizer_cli
INFO: Elapsed time: 55.164s, Forge stats: 8848/8861 actions cached, 12.1s CPU used, 0.0s queue time, 1.83 GB ObjFS output (novel bytes: 0.0 MB), 0.0 MB local output, Critical Path: 32.14s, Remote (92.00% of the time): [queue: 0.00%, network: 37.09%, setup: 0.54%, process: 11.87%, fetch: 37.37%]
INFO: Build completed successfully, 10399 total actions
INFO: Running command line: blaze-bin/third_party/milotic/external/cc/authz/milotic_redfish_authorizer_cli <args omitted>
INFO: Streaming build results to: http://sponge2/cdf03580-9c4e-4c72-8544-3c57175e19c8
Peer |Redfishz| is authorized to perform the operation |GET| at the given URI |/redfish/v1/Systems/system/Oem/Google/BootNumber|.

added-testdata-queries: Already tested via ALL_URIS
integration-test-bug-id: 409172603
PiperOrigin-RevId: 785249488
Change-Id: Ia1ab6e8627face6ffe7d037b374157fd910236d7
3 files changed
tree: cf3220e6987453d34435d3fe44cda359a3c5c392
  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. copy.bara.sky
  29. DBUS_USAGE.md
  30. DEVELOPING.md
  31. gcovr.cfg
  32. HEADERS.md
  33. LICENSE
  34. meson.build
  35. meson_options.txt
  36. OEM_SCHEMAS.md
  37. OWNERS
  38. PLUGINS.md
  39. README.md
  40. README_GOOGLE.md
  41. Redfish.md
  42. run-ci
  43. setup.cfg
  44. TESTING.md
  45. 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.