How openbmc/bmcweb works
bmcweb is an embedded OpenBMC web server exposing Redfish and several device-specific interfaces. A client request enters the HTTP application and router, is handled by an interface or Redfish route, and returns an HTTP response; Redfish handlers translate between API resources and DBus-backed system state. The README documents authentication, event delivery, KVM, serial console, virtual media, aggregation, and protocol support. Some implementation wiring is unsampled, so edges are limited to README statements and source-index references.
Main entry points: routing.hpp Route dispatch · query.hpp Redfish query handling · app.hpp HTTP application · lib Redfish resources
Components 25
HTTP server
- HTTP application
http/app.hpp - Route dispatch
http/routing.hpp - HTTP request
http/http_request.hpp - HTTP response
http/http_response.hpp - HTTP body
http/http_body.hpp - TLS and HTTP/2
http/mutual_tls.cpp
Identity and security
- Authentication
include/authentication.hpp - Sessions and persistence
include/persistent_data.hpp - Web UI login
features/webui_login/login_routes.hpp - PAM
Redfish API
- Redfish resources
redfish-core/lib - Redfish query handling
redfish-core/include/query.hpp - Query parameters
redfish-core/include/utils/query_param.hpp - Redfish messages
redfish-core/include/error_messages.hpp - Resource aggregation
redfish-core/include/redfish_aggregator.hpp - Event subscriptions
redfish-core/include/event_service_manager.hpp
Device interfaces
- OpenBMC DBus REST
features/openbmc_rest/openbmc_dbus_rest.hpp - DBus event websocket
features/openbmc_rest/dbus_monitor.hpp - Serial console
features/serial/obmc_console.hpp - KVM websocket
features/kvm/kvm_websocket.hpp - Virtual media
features/virtual_media/vm_websocket.hpp
System state
- DBus access
include/dbus_utility.hpp - System DBus
- Event service store
include/event_service_store.hpp
Other components
- API client
Connections 23
- API client → HTTP application: sends request
README.md - HTTP application → Route dispatch: dispatches
http/app.hpp - Route dispatch → HTTP request: routes request
http/routing.hpp - HTTP request → HTTP response: produces response
- HTTP application → TLS and HTTP/2: serves HTTP(S)
README.md - Route dispatch → Web UI login: routes login
features/webui_login/login_routes.hpp - Web UI login → Sessions and persistence: creates session
features/webui_login/login_routes.hpp - Authentication → PAM: authenticates credentials
README.md - Route dispatch → Redfish resources: dispatches Redfish
README.md - Redfish resources → DBus access: reads system state
redfish-core/lib/storage.hpp - Redfish resources → Redfish query handling: uses query handling
redfish-core/lib/managers.hpp - Redfish query handling → Query parameters: parses parameters
redfish-core/include/query.hpp - Query parameters → Redfish messages: formats errors
redfish-core/include/utils/query_param.hpp - Redfish query handling → Resource aggregation: forwards remote requests
redfish-core/include/query.hpp - Redfish query handling → HTTP response: fills response
redfish-core/include/query.hpp - DBus access → System DBus: calls methods
include/dbus_utility.hpp - Route dispatch → OpenBMC DBus REST: routes DBus REST
features/openbmc_rest/openbmc_dbus_rest.hpp - Route dispatch → DBus event websocket: routes event websocket
README.md - Route dispatch → Serial console: routes console websocket
features/serial/obmc_console.hpp - Route dispatch → KVM websocket: routes KVM websocket
README.md - Route dispatch → Virtual media: routes virtual media
features/virtual_media/vm_websocket.hpp - Event subscriptions → Event service store: uses persistent store
redfish-core/include/event_service_manager.hpp - Event subscriptions → HTTP response: sends event stream
redfish-core/include/event_service_manager.hpp