Google Git
Sign in
gbmc / gbmcweb / 79c5ff08d764e025d38c701ac2cc6455f620cd7a
commit79c5ff08d764e025d38c701ac2cc6455f620cd7a[log] [tgz]
authorJosh Lehan <krellan@google.com>Sat Jun 25 20:17:41 2022 -0700
committerRahul Kapoor <rahulkpr@google.com>Wed Aug 02 19:52:54 2023 +0000
tree46f4a7dcca73f3f40814eb7a797e192f1ea4ba08
parent7c9cfa12a230ea5420fcfcdadf5eadeca0162e39 [diff]
bmcweb: New LogServices feature ExternalStorer

This is a new feature that lets external users dynamically update
certain areas of the Redfish tree at runtime. The first usage is in
LogServices.

Design document:
https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/52150
API/examples/tutorial document:
https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/52295

The GET and POST commands are complete, the remaining commands will
be implemented soon. The integration hook is complete for LogServices.
The filesystem is used for all backing storage.

Tested: The unit tests pass. With this script providing appropriate
external input, the Redfish Service Validator passes:
https://gist.github.com/Krellan/f511e65166ebe5435fde3f847d28fe73

Patch Tracking Bug: b/236410938
Upstream info / review: https://gerrit.openbmc.org/c/openbmc/bmcweb/+/51303/38
Upstream-Status: Denied
Justification:
Ed disagrees with the architecture of this feature, and wants it to be
something that can globally apply to all of the Redfish tree instead,
not just to specific endpoints patched to become ExternalStorer hooks.
He also wants it to be schema-aware, performing schema validation,
instead of just accepting any valid JSON.

Change-Id: Iec65d9ff421cbe77afd5f47cbcb6e4330caa0ef1
Signed-off-by: Josh Lehan <krellan@google.com>

%% original patch: 0001-bmcweb-New-LogServices-feature-ExternalStorer.patch
5 files changed
tree: 46f4a7dcca73f3f40814eb7a797e192f1ea4ba08
  1. .github/
  2. config/
  3. grpc-redfish/
  4. http/
  5. include/
  6. redfish-core/
  7. scripts/
  8. src/
  9. static/
  10. subprojects/
  11. test/
  12. .clang-format
  13. .clang-tidy
  14. .dockerignore
  15. .gitignore
  16. .markdownlint.yaml
  17. .openbmc-enforce-gitlint
  18. .prettierignore
  19. .shellcheck
  20. AGGREGATION.md
  21. CLIENTS.md
  22. COMMON_ERRORS.md
  23. DBUS_USAGE.md
  24. DEVELOPING.md
  25. HEADERS.md
  26. LICENSE
  27. meson.build
  28. meson_options.txt
  29. OEM_SCHEMAS.md
  30. OWNERS
  31. README.md
  32. Redfish.md
  33. run-ci
  34. setup.cfg
  35. TESTING.md
README.md

OpenBMC webserver

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.