Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 677bb756282b3029ed7c8cbf2c0440b89b0d5928
commit677bb756282b3029ed7c8cbf2c0440b89b0d5928[log] [tgz]
authorEd Tanous <edtanous@google.com>Thu Sep 15 10:52:19 2022 -0700
committerEd Tanous <ed@tanous.net>Fri Sep 16 23:52:35 2022 +0000
tree3f64bafaac93d162ef792fd4349550429d0ce18a
parent6169de2c39d2b08451a64fbf45798ae8cb5624fb [diff]
Fix regression on expand handling

It was found that as part of
c1d019a6056a2a0ef50e577b3139ab5a8dc49355 Sensor optimization

We missed updating the odata.id for the expand case.  This wasn't really
found because most clients either use expand, or they don't, and
depending on which path you take, both paths are valid.  With that said,
we should be following the spec here, and returning the same result
regardless of whether we're being processed as expand or not.

This patchset is a little rough, and probably should be iterated on.

TODO (at a later date).  Try to get a tool that can detect these
failures.

Tested: Tested by @Carson to resolve the regression.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Ieed7796895a3c5937fd901d5afa7dd4ea0693099
1 file changed
tree: 3f64bafaac93d162ef792fd4349550429d0ce18a
  1. .github/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. subprojects/
  9. .clang-format
  10. .clang-ignore
  11. .clang-tidy
  12. .dockerignore
  13. .gitignore
  14. .openbmc-enforce-gitlint
  15. .shellcheck
  16. bmcweb.service.in
  17. bmcweb.socket.in
  18. bmcweb_config.h.in
  19. build_x86.sh
  20. build_x86_docker.sh
  21. CLIENTS.md
  22. COMMON_ERRORS.md
  23. DEVELOPING.md
  24. Dockerfile
  25. Dockerfile.base
  26. HEADERS.md
  27. LICENSE
  28. meson.build
  29. meson_options.txt
  30. OEM_SCHEMAS.md
  31. OWNERS
  32. pam-webserver
  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, (Redfish.md)[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.

Debug logging

bmcweb by default is compiled with runtime logging disabled, as a performance consideration. To enable it in a standalone build, add the

-Dlogging='enabled'

option to your configure flags. If building within Yocto, add the following to your local.conf.

EXTRA_OEMESON:pn-bmcweb:append = "-Dbmcweb-logging='enabled'"

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.