Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / a5f87d487143a5478528826bab72b9f5a093f305
commita5f87d487143a5478528826bab72b9f5a093f305[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Tue Jan 07 09:52:46 2025 -0600
committerGunnar Mills <gmills@us.ibm.com>Tue Jan 07 09:57:23 2025 -0600
tree0b1f25c95d9c7ed7ccc8c61f632b9e815be2b996
parentd35c241d30bba30a1d42ebc85ef8072f283cb820 [diff]
SW: Don't log if no association

We define logging levels in DEVELOPING.md[1], an error is "Something
went wrong, and we weren't able to give the expected response. Service
is still operational. "error" should be used for unexpected conditions
that prevented bmcweb from fulfilling the request. "error" shall be used
for 5xx errors.".

This clearly isn't an error since we just ignore not having an
association and move on. Moved these traces to DEBUG. Andrew mentioned
these cluttering the journal when running CI.

[1]: https://github.com/openbmc/bmcweb/blob/master/DEVELOPING.md#logging-levels

Tested: This is changing a Logging Level only.

Change-Id: If9324ab32a1f30f446a1b6f359d8a76af899378a
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
1 file changed
tree: 0b1f25c95d9c7ed7ccc8c61f632b9e815be2b996
  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.