Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 4b78c8b29f8c52373727891929a6302c30f93442
commit4b78c8b29f8c52373727891929a6302c30f93442[log] [tgz]
authorNan Zhou <nanzhoumails@gmail.com>Tue Nov 08 17:27:22 2022 +0000
committerNan Zhou <nanzhoumails@gmail.com>Tue Nov 08 18:51:12 2022 +0000
treed073c4348fb7595f9d19c1346ce4d4f229184d49
parentf1240b47b47b01b0ccab0bb5c977d6ca126e4b60 [diff]
Add a whitespace in test

This is a dummy commit to test owner plugin. It can be merged in as well
given that it adds a little bit readability.

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: Ia4cc1866ebeb19e6d0f1d1ceece0ecc73fb4b468
1 file changed
tree: d073c4348fb7595f9d19c1346ce4d4f229184d49
  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-ignore
  13. .clang-tidy
  14. .dockerignore
  15. .gitignore
  16. .openbmc-enforce-gitlint
  17. .shellcheck
  18. CLIENTS.md
  19. COMMON_ERRORS.md
  20. DBUS_USAGE.md
  21. DEVELOPING.md
  22. HEADERS.md
  23. LICENSE
  24. meson.build
  25. meson_options.txt
  26. OEM_SCHEMAS.md
  27. OWNERS
  28. README.md
  29. Redfish.md
  30. run-ci
  31. setup.cfg
  32. 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.