| commit | cf7eba094fd41b2e5236af935a8113db387e647c | [log] [tgz] |
|---|---|---|
| author | Nan Zhou <nanzhoumails@gmail.com> | Thu Jul 21 23:53:20 2022 +0000 |
| committer | Ed Tanous <ed@tanous.net> | Fri Jul 22 00:50:39 2022 +0000 |
| tree | c31b43c16ad74d47380d09348717d292ca40fc0a | |
| parent | ce8ea743055f1b82c60790db40aa3295e03bdf9c [diff] |
chassis: replace lambda with inline functions It has been a convention that request route functions take inline functions instead of lambdas. The benifets include less indents, beging more readable + unit test-able (take a look at the unit test that this commit adds for example). This commit also fixed neccessary headers to make the test compile. The headers of the unit test source is a complete list. But headers of the core codes are not complete. These header clean up will be done in a separate effort once https://gerrit.openbmc.org/c/openbmc/bmcweb/+/55138 is submitted. Tested: 1. no service validator errors on real hardware. Signed-off-by: Nan Zhou <nanzhoumails@gmail.com> Change-Id: I4b23ba54707cea947b5db771c72aa64899041511
This component attempts to be a "do everything" embedded webserver for OpenBMC.
The webserver implements a few distinct interfaces:
bmcweb at a protocol level supports http and https. TLS is supported through OpenSSL.
Bmcweb supports multiple authentication protocols:
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.
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.
bmcweb is configured per the meson build files. Available options are documented in meson_options.txt
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.
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'"
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.
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.