Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 86711e7095486db50b389e2cc5ec9224a396bc58
commit86711e7095486db50b389e2cc5ec9224a396bc58[log] [tgz]
authorEd Tanous <edtanous@google.com>Wed Feb 15 10:07:56 2023 -0800
committerEd Tanous <ed@tanous.net>Thu Feb 16 18:57:12 2023 +0000
treef9a247a0b7ecaabb3d5823e95eb9fef109b8914c
parent7da847b63120150b4fd0538306b37bc32645e0b3 [diff]
Revert "Implement Manager/ServiceRootUptime"

This reverts commit ee61a619da7f180a3148317d569d2dabd1cd9832.

This feature was tested against an old version of schemas, and upstream
DMTF seems to have changed the definition in the meantime.  This wasn't
caught because of the same test failure as yesterday.

Mea Culpa

Change-Id: I0be095f5dea0f036927202f367542275abc0ebe3
Signed-off-by: Ed Tanous <edtanous@google.com>
2 files changed
tree: f9a247a0b7ecaabb3d5823e95eb9fef109b8914c
  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. .dockerignore
  14. .gitignore
  15. .markdownlint.yaml
  16. .openbmc-enforce-gitlint
  17. .prettierignore
  18. .shellcheck
  19. CLIENTS.md
  20. COMMON_ERRORS.md
  21. DBUS_USAGE.md
  22. DEVELOPING.md
  23. HEADERS.md
  24. LICENSE
  25. meson.build
  26. meson_options.txt
  27. OEM_SCHEMAS.md
  28. OWNERS
  29. README.md
  30. Redfish.md
  31. run-ci
  32. setup.cfg
  33. 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 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.