Google Git
Sign in
gbmc / gbmcweb / fa9601da5c5f414af4542c79df1d0a2d7d26b1a4
commitfa9601da5c5f414af4542c79df1d0a2d7d26b1a4[log] [tgz]
authorNan Zhou <nanzhou@google.com>Tue Sep 19 17:19:55 2023 +0000
committerNan Zhou <nanzhou@google.com>Thu Sep 21 16:05:47 2023 +0000
tree781ad93a7503c2eec1d3f0f556cfe96c36b403ea
parent53d6d73c9d06f6a2400615bb71a61728f9af4abc [diff]
plugin: implement appendRedfishHandler

This commit implements the Redfish Plugin macro:
    REDFISH_HANDLER_APPEND

This plugin macro gives plugin user ability to append another async
callback to an existing route. The appended callback will be guaranteed
to run after the original callback, and before the query parameter
processing.

The plugin takes URL, Verb, and the callback function.

TESTED: see unit test. The execution order is unit tested.

Change-Id: I838f1fea3c0c7388d2a96fa21e2ed3f9ab2e29b1
Signed-off-by: Nan Zhou <nanzhou@google.com>
5 files changed
tree: 781ad93a7503c2eec1d3f0f556cfe96c36b403ea
  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. README.md
  34. Redfish.md
  35. run-ci
  36. setup.cfg
  37. 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.