Google Git
Sign in
gbmc / gbmcweb / refs/heads/gbmc-release-24.8.x
commit42766693206561c0968779243be987d041f288b5[log] [tgz]
authorEdward Lee <edwarddl@google.com>Wed Apr 03 21:57:50 2024 +0000
committerEdward Lee <edwarddl@google.com>Wed Apr 03 22:22:27 2024 +0000
treec47f018e60fe04b03af4409c5aebda6b2a1ccbb6
parentb652d29ea9287b9e30b81816a24cbffa869306f3 [diff]
Fix Crash on FaultLog Expand Query and pass in gRPC Authz State

req is passed in by reference and when DBus cache is not populated,
this will trigger a dbus call. This means by the time the lambda
is triggered, req has gone out of scope and it becomes a dangling
reference.

This means that access to it results in undefined behavior.

We are also missing some authzState being passed in for GRPC requests.

Tested:
https://paste.googleplex.com/5697285345771520

Change-Id: I874a2f615880534517e1746e19cfb996f863d646
Signed-off-by: Edward Lee <edwarddl@google.com>
(cherry picked from commit 52819f744af8c4a7a97a4af92351112679803c9e)
1 file changed
tree: c47f018e60fe04b03af4409c5aebda6b2a1ccbb6
  1. .github/
  2. config/
  3. grpc-redfish/
  4. http/
  5. include/
  6. mapper/
  7. plugins/
  8. redfish-core/
  9. scripts/
  10. src/
  11. static/
  12. subprojects/
  13. test/
  14. .clang-format
  15. .clang-tidy
  16. .dockerignore
  17. .gitignore
  18. .markdownlint.yaml
  19. .openbmc-enforce-gitlint
  20. .prettierignore
  21. .shellcheck
  22. AGGREGATION.md
  23. CLIENTS.md
  24. COMMON_ERRORS.md
  25. DBUS_USAGE.md
  26. DEVELOPING.md
  27. HEADERS.md
  28. LICENSE
  29. meson.build
  30. meson_options.txt
  31. OEM_SCHEMAS.md
  32. OWNERS
  33. PLUGINS.md
  34. README.md
  35. README_GOOGLE.md
  36. Redfish.md
  37. run-ci
  38. setup.cfg
  39. 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.