Repository files navigation

This component attempts to be a "do everything" embedded webserver for OpenBMC.

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 accessto dbus and the objects it represents.
• Serial: A serial websocket for interacting with the host serial consolethrough websockets.
• Redfish: A protocol compliant,DBus to Redfish translator.
• KVM: A websocket based implementation of the RFB (VNC) frame buffer protocolintended to mate to webui-vue to provide a complete KVM implementation.

bmcweb at a protocol level supports http and https. TLS is supported throughOpenSSL.

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 viaruntime policy changes (through the relevant Redfish APIs) or via configure timeoptions. All authentication mechanisms supporting username/password are routedto libpam, to allow for customization in authentication implementations.

All authorization in bmcweb is determined at routing time, and per route, andconform to the Redfish PrivilegeRegistry.

*Note: Non-Redfish functions are mapped to the closest equivalent Redfishprivilege level.

bmcweb is configured per themeson build files. Availableoptions are documented inmeson_options.txt

meson builddirninja -C builddir

If any of the dependencies are not found on the host system duringconfiguration, meson will automatically download them via its wrap dependenciesmentioned inbmcweb/subprojects.

bmcweb by default is compiled with runtime logging disabled, as a performanceconsideration. To enable it in a standalone build, add the

-Dlogging='enabled'

option to your configure flags. If building within Yocto, add the following toyour local.conf.

EXTRA_OEMESON:pn-bmcweb:append ="-Dbmcweb-logging='enabled'"

bmcweb relies on some on-system data for storage of persistent data that isinternal to the process. Details on the exact data stored and when it isread/written can seen from thepersistent_data namespace.

When SSL support is enabled and a usable certificate is not found, bmcweb willgenerate a self-signed a certificate before launching the server. Please see thebmcweb source code for details on the parameters this certificate is built with.