commit | 90896601f4f6d28d8cee76232482f77a1f0df3d7 | [log] [tgz] |
---|---|---|
author | Igor Kanyuka <ifelmail@gmail.com> | Thu Mar 13 08:52:38 2025 +0000 |
committer | Igor Kanyuka <ifelmail@gmail.com> | Thu Apr 03 16:32:29 2025 +0000 |
tree | ce1cb67b2c631634f638334963164151492b3486 | |
parent | 608ad2cc0e17bf62ff34bae7ceb499816fe13fbb [diff] |
Fix crash on requesting all events if dbus logging enabled afterLogEntriesGetManagedObjects prepares members array (all the LogEntry objects) to be used in response to the /EventLog/Entries requests. It calls the fillEventLogLogEntryFromPropertyMap for every event passing the dbus properties map and json object, expecting the function to translate the properties map to JSON. It stores all the json objects in an array. It uses .emplace_back on the array to create an empty instance of JSON object which it immediately passes to be filled. If something fails in fillEventLogLogEntryFromPropertyMap (like DBus property map is malformed), it fires an internal error and return immediately without filling any fields in JSON object. As a result, in case of earlier return from the function, the array will have objects with no data. After collecting all the objects, it reorders the elements by Id, however as some of them have no Id fields populated, accessing to non-existent fields causes service to crash. Testing: Before the command [1] the process core dumped. After, the same command [1] works [2]. Requesting individual entries keeps working [3]. [1] Command to fetch all EventLog Entries: ``` curl -ks -H "Content-Type: application/json" -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries ``` [2] Result from the server after fixing ``` root@bmc:~# curl -ks -H "Content-Type: application/json" -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries { "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries", "@odata.type": "#LogEntryCollection.LogEntryCollection", "Description": "Collection of System Event Log Entries", "Name": "System Event Log Entries", "error": { "@Message.ExtendedInfo": [ { "@odata.type": "#Message.v1_1_1.Message", "Message": "The request failed due to an internal service error. The service is still operational.", "MessageArgs": [], "MessageId": "Base.1.19.InternalError", "MessageSeverity": "Critical", "Resolution": "Resubmit the request. If the problem persists, consider resetting the service." } ], "code": "Base.1.19.InternalError", "message": "The request failed due to an internal service error. The service is still operational." } } ``` [3] Fetching a single entry correct and failing ``` root@bmc:~# curl -ks -H "Content-Type: application/json" -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries/1 { "error": { "@Message.ExtendedInfo": [ { "@odata.type": "#Message.v1_1_1.Message", "Message": "The request failed due to an internal service error. The service is still operational.", "MessageArgs": [], "MessageId": "Base.1.19.InternalError", "MessageSeverity": "Critical", "Resolution": "Resubmit the request. If the problem persists, consider resetting the service." } ], "code": "Base.1.19.InternalError", "message": "The request failed due to an internal service error. The service is still operational." } } root@bmc:~# curl -ks -H "Content-Type: application/json" -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries/2 { "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/2", "@odata.type": "#LogEntry.v1_9_0.LogEntry", "AdditionalDataURI": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/2/attachment", "Created": "2025-04-02T09:54:37.777+00:00", "EntryType": "Event", "Id": "2", "Message": "Sensor 'BIC_JI_SENSOR_MB_RETIMER_TEMP_C' reading of 10.2 (xyz.openbmc_project.Sensor.Value.Unit.DegreesC) is below the 15.5 lower critical threshold.", "MessageArgs": [ "BIC_JI_SENSOR_MB_RETIMER_TEMP_C", "10.2", "xyz.openbmc_project.Sensor.Value.Unit.DegreesC", "15.5" ], "MessageId": "SensorEvent.1.0.ReadingBelowLowerCriticalThreshold", "Modified": "2025-04-02T09:54:37.777+00:00", "Name": "System Event Log Entry", "Resolution": "Check the condition of the resources listed in RelatedItem.", "Resolved": false, "Severity": "Critical" } ``` Change-Id: I231b2266ccee27e83363cd1363c130d3fe8f1ed3 Signed-off-by: Igor Kanyuka <ifelmail@gmail.com>
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 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
.
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.
bmcweb is capable of aggregating resources from satellite BMCs. Refer to AGGREGATION.md for more information on how to enable and use this feature.