Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 471cd2498a5c2d82f8e2a567b69e46c6a4ea6d14
commit471cd2498a5c2d82f8e2a567b69e46c6a4ea6d14[log] [tgz]
authorEd Tanous <ed@tanous.net>Wed Jun 19 15:21:47 2024 -0700
committerEd Tanous <ed@tanous.net>Fri Aug 02 17:16:54 2024 +0000
treed555f5c5d6b40eb57fe5e2073d717305ebb660f7
parent539d8c6bc399e516d39bcaa18262cf206f4c1035 [diff]
Remove EventType

EventType::Event doesn't exist in the Event schema.

Initially, we thought to change it to EventType::Alert, but further
inspection of the Redfish schemas shows that the property itself is
deprecated, so rather than try to make it "correct" it is better to just
remove it.

This is technically a breaking API change, but given that very few
schema-correct implementations of Redfish clients exist, even fewer
EventService receivers exist, and this hasn't been reported before, I'd
be extremely surprised if this broke any implementation.

Tested: Sending test events shows no EventType generated.

Change-Id: I933b2cc1dc2fb71714392949dd6eb030fbdcf8aa
Signed-off-by: Ed Tanous <ed@tanous.net>
1 file changed
tree: d555f5c5d6b40eb57fe5e2073d717305ebb660f7
  1. .github/
  2. config/
  3. http/
  4. include/
  5. redfish-core/
  6. scripts/
  7. src/
  8. static/
  9. subprojects/
  10. test/
  11. .clang-format
  12. .clang-tidy
  13. .codespell-ignore
  14. .dockerignore
  15. .eslintignore
  16. .gitignore
  17. .markdownlint.yaml
  18. .openbmc-enforce-gitlint
  19. .prettierignore
  20. .shellcheck
  21. AGGREGATION.md
  22. CLIENTS.md
  23. COMMON_ERRORS.md
  24. DBUS_USAGE.md
  25. DEVELOPING.md
  26. HEADERS.md
  27. LICENSE
  28. meson.build
  29. meson.options
  30. OEM_SCHEMAS.md
  31. OWNERS
  32. README.md
  33. Redfish.md
  34. REDFISH_CHECKLIST.md
  35. run-ci
  36. 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 setup 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.