NVIDIA/bmcweb

NVIDIA/bmcweb

Description: A do everything Redfish, KVM, GUI, and DBus webserver for OpenBMC

Language: C++

License: Apache-2.0

Stars: 7

Forks: 7

Open issues: 0

Created: 2024-05-06T16:46:17Z

Pushed: 2026-06-10T18:22:41Z

Default branch: develop

Fork: yes

Parent repository: openbmc/bmcweb

Archived: no

README:

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 for 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](docs/Redfish.md).
• 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. HTTP/1 and HTTP/2 are supported using ALPN registration for TLS connections and h2c upgrade header for http connections.

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 conforms 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.

Compile bmcweb with default options

meson setup 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.

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 be seen from the persistent_data namespace.

Temporary files

bmcweb uses /tmp/bmcweb for temporary file storage during multipart form uploads. This directory is automatically cleaned up by systemd on service restart via the TemporaryFileSystem directive in the service file.

TLS certificate generation

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

Compression

bmcweb supports various forms of http compression, including zstd and gzip. Client headers are observed to determine whether compressed payloads are supported.

Redfish Aggregation

bmcweb is capable of aggregating resources from satellite BMCs. Refer to AGGREGATION.md for more information on how to enable and use this feature.