Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 01c78a0617321a3b3ea9bde09b7deb6aa510545b
commit01c78a0617321a3b3ea9bde09b7deb6aa510545b[log] [tgz]
authorNan Zhou <nanzhoumails@gmail.com>Tue Sep 20 18:17:20 2022 +0000
committerEd Tanous <ed@tanous.net>Wed Sep 21 17:14:24 2022 +0000
treefa5040d6124664f2166cb23701e97980ef751ded
parent043bec0965b9e9ba55888440fec4588c28335e5c [diff]
registries: iwyu

Made the auto-generated headers and the openbmc registry include what
they use. Also alligned the include style.

Tested: code compiles.

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: I6577d5e12bc02da3bd7bf5780f89a4860b314e19
6 files changed
tree: fa5040d6124664f2166cb23701e97980ef751ded
  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.