| commit | 7c4c52cb4e855b1f25f25e87d3b7f9cafa63e157 | [log] [tgz] |
|---|---|---|
| author | Carson Labrado <clabrado@google.com> | Mon Nov 28 22:43:38 2022 +0000 |
| committer | Ed Tanous <ed@tanous.net> | Fri Jan 20 21:32:22 2023 +0000 |
| tree | e24cd57242ed234f9427825285dedb75dcd5f954 | |
| parent | 4cdc2e8d4cc2358e5e35e978502c944f44fe5c67 [diff] |
Aggregation: Aggregate top level collections Adds aggregation support for all top level collections which do not follow the usual form of /redfish/v1/<collection>. As part of this change we no longer forward all requests that fit the above format such as /redfish/v1/UpdateService. We now skip the forwarding rather than sending a request. Previously we forwarded all potential collection requests and then relied on the lack of a "Members" array in the response to denote that the request was not actually for a valid collection. Tested: We aggregate or try to aggregate these URIs as collections: /redfish/v1/Chassis /redfish/v1/Chassis/ /redfish/v1/Fabrics /redfish/v1/Fabrics/ /redfish/v1/TelemetryService/MetricReports /redfish/v1/TelemetryService/MetricReports/ We aggregate or try to aggregate these URIs as satellite resources /redfish/v1/Chassis/5B247A_<chassisID> /redfish/v1/TelemetryService/MetricReports/5B247A_reportID /redfish/v1/UpdateService/FirmwareInventory/5B247A_firmwareID We do not attempt to aggregate these URIs at all: /redfish/v1/Fake /redfish/v1/Fake/ /redfish/v1/Fake/5B247A_fakeID /redfish/v1/TelemetryService /redfish/v1/TelemetryService/ /redfish/v1/TelemetryService/5B247A_fakeID Signed-off-by: Carson Labrado <clabrado@google.com> Change-Id: I133503ab3e4df7777df094768786e511880ca70f
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.