Change error on FW update invalid Content-Type

Return 415 for invalid Content-Type in firmware update POST

Change-Id: I6b9cf6629c12ce191804bd0ce23bc97da9328c82
Signed-off-by: Sandeep Patil <sandeep

Change error on FW update invalid Content-Type

Return 415 for invalid Content-Type in firmware update POST

Change-Id: I6b9cf6629c12ce191804bd0ce23bc97da9328c82
Signed-off-by: Sandeep Patil <sandeepap@ami.com>

show more ...

update service: extract addRelatedItem

Deduplicate the logic to add a related item to a fw inventory item.

Tested: next patch in chain

Change-Id: I94455e165900011955de9196db49c7c89807ea3d
Signed-o

update service: extract addRelatedItem

Deduplicate the logic to add a related item to a fw inventory item.

Tested: next patch in chain

Change-Id: I94455e165900011955de9196db49c7c89807ea3d
Signed-off-by: Alexander Hansen <alexander.hansen@9elements.com>

show more ...

update service: extract get version callback

Extract getSoftwareVersionCallback from inline lambda for readability
reasons.

Tested: Next patches in series.

Change-Id: I5b89bcfb47b55336bbbe70063bb6

update service: extract get version callback

Extract getSoftwareVersionCallback from inline lambda for readability
reasons.

Tested: Next patches in series.

Change-Id: I5b89bcfb47b55336bbbe70063bb68f94f2513a21
Signed-off-by: Alexander Hansen <alexander.hansen@9elements.com>

show more ...

update service: extract function from lambda

Extract handleUpdateServiceFirmwareInventoryGetCallback for readability
reasons.
Tested: on Tyan s8030. fw inventory response as before.
```
curl --insec

update service: extract function from lambda

Extract handleUpdateServiceFirmwareInventoryGetCallback for readability
reasons.
Tested: on Tyan s8030. fw inventory response as before.
```
curl --insecure --user root:root https://${bmc}/redfish/v1/UpdateService/FirmwareInventory/HostSPIFlash_7715
{
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/HostSPIFlash_7715",
"@odata.type": "#SoftwareInventory.v1_1_0.SoftwareInventory",
"Description": "Unknown image",
"Id": "HostSPIFlash_7715",
"Name": "Software Inventory",
"Status": {
"Health": "Warning",
"HealthRollup": "OK",
"State": "Disabled"
},
"Updateable": true,
"Version": "Unknown"
}
```

Change-Id: Ib71edd91c82dfe1893f7eca1d53b0b05f5bf1415
Signed-off-by: Alexander Hansen <alexander.hansen@9elements.com>

show more ...

Refactor multipart update parameter extraction

This commit extracts helper functions to improve code readability:
- parseFormPartName(): Parses the 'name' parameter from Content-
Disposition
- proce

Refactor multipart update parameter extraction

This commit extracts helper functions to improve code readability:
- parseFormPartName(): Parses the 'name' parameter from Content-
Disposition
- processUpdateParameters(): Handles UpdateParameters JSON processing

The extractMultipartUpdateParameters() function is refactored to use
these helpers, making the code more modular and easier to understand.

This is a pure refactoring with no functional changes.

Change-Id: I9bfd3c92666bbe362512d9fdd9472a4e44ad2241
Signed-off-by: Ed Tanous <etanous@nvidia.com>
Signed-off-by: Rajeev Ranjan <ranjan.rajeev1609@gmail.com>

show more ...

Task: Fix missing properties in task monitor

Task monitor URI when the task is running contains partial information.
Properties like progress percent, message is missing. Same issue is
present when

Task: Fix missing properties in task monitor

Task monitor URI when the task is running contains partial information.
Properties like progress percent, message is missing. Same issue is
present when task is created and response is returned.

This patch fixes missing properties in task creation response and task
monitor URI.

Tested:
- Task creation with fwupdate response shows all properties
- Task monitor URI provides complete information when running
- Verified task creation and monitor response for log service

Change-Id: I77c6d9b9302d13b8480cf5a3419b8c6754e5049d
Signed-off-by: Chinmay Shripad Hegde <hosmanechinmay@gmail.com>
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Software: Add LowestSupportedVersion

A Minimum Version interface was added.[1] This is the minimum software
version that a component must have to operate. Like other interfaces it
is optional. Minim

Software: Add LowestSupportedVersion

A Minimum Version interface was added.[1] This is the minimum software
version that a component must have to operate. Like other interfaces it
is optional. MinimumVersion maps to Redfish's LowestSupportedVersion.[2]

"LowestSupportedVersion": {
"description": "The lowest supported version of this software.",
"longDescription": "This property shall represent the lowest
supported version of this software. This string is formatted using the
same format used for the `Version` property.",
"readonly": true,
"type": [
"string",
"null"
],
"versionAdded": "v1_1_0"

phosphor-bmc-code-mgmt has support for minimum version.[3]

phosphor-bmc-code-mgmt logs a Software Incompatible[4] error if this
minimum version is not met. Mapping this error to a Redfish error is
not done here but could be added later.

This assumes the D-Bus path is /xyz/openbmc_project/software/$id.

phosphor-bmc-code-mgmt moved this interface under $id at 72323[5]. We
assume D-Bus Path /xyz/openbmc_project/software/ + $id for other
properties already.

[1]: https://github.com/openbmc/phosphor-dbus-interfaces/commit/9012243e543abdc5851b7e878c17c991b2a2a8b7
[2]: https://redfish.dmtf.org/schemas/v1/SoftwareInventory.v1_10_2.json
[3]: https://github.com/openbmc/phosphor-bmc-code-mgmt/blob/85c71a13e0938cc4d36caf6b8e735e9740b2e351/meson.options#L100
[4]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/1c140b9766a15d1cbb8546fa02d5050d772a171d/yaml/xyz/openbmc_project/Software/Version.errors.yaml#L1
[5]: https://gerrit.openbmc.org/c/openbmc/phosphor-bmc-code-mgmt/+/72323

Tested: Using an IBM p10bmc see:
{
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/788d20be",
"@odata.type": "#SoftwareInventory.v1_1_0.SoftwareInventory",
"Description": "BMC image",
...
"LowestSupportedVersion": "fw1020.00-39.1",
...

The Redfish Validator has no new errors.

Change-Id: I17e6d64c86a7d6312726783425101775a959dc04
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Separate endpoint for MultipartHttpPushUri Update

Currently, the UpdateService uses the same endpoint
"/redfish/v1/UpdateService/update" for both "application/octet-stream"
and "multipart/form-data"

Separate endpoint for MultipartHttpPushUri Update

Currently, the UpdateService uses the same endpoint
"/redfish/v1/UpdateService/update" for both "application/octet-stream"
and "multipart/form-data" HTTP push methods. This change introduces a
dedicated endpoint "/redfish/v1/UpdateService/update-multipart" to
handle multipart firmware updates separately, aligning with the Redfish
spec recommendations[1] and Section 3.1.2 Multipart HTTP push update in
Redfish FW Update White Paper [2].

Spec examples in [1], Section 7.12, shows '/update-multipart' endpoint
as a dedicated URI for MultipartHttpPushUri.

[1] https://www.dmtf.org/sites/default/files/standards/documents/DSP0266_1.22.0.pdf
[2] https://www.dmtf.org/sites/default/files/standards/documents/DSP2062_1.0.2.pdf

Tested:
- Verified GET on UpdateService
```
curl -k https://user:pass@<bmc-ip>/redfish/v1/UpdateService
...
"MultipartHttpPushUri": "/redfish/v1/UpdateService/update-multipart",
...
```
- Verified MultipartPushURI update using the new URI.
```
curl -X POST -k https://user:pass@<bmc-ip>/redfish/v1/UpdateService/update-multipart --form 'UpdateParameters={"Targets":["/redfish/v1/Managers/bmc"]};type=application/json' --form "UpdateFile=@<fwpkg>;type=application/octet-stream"
{
"@odata.id": "/redfish/v1/TaskService/Tasks/1",
"@odata.type": "#Task.v1_4_3.Task",
"Id": "1",
"TaskState": "Running",
"TaskStatus": "OK"
}
```

Change-Id: I477d7d64571113079d51bff9f188cfa776e6dafa
Signed-off-by: Rajeev Ranjan <ranjan.rajeev1609@gmail.com>

show more ...

Add async_method_call to utility

Adding async_method_call in dbus utility gives us a place where we can
intercept method call requests from dbus to potentially add
logging/caching.

An example of lo

Add async_method_call to utility

Adding async_method_call in dbus utility gives us a place where we can
intercept method call requests from dbus to potentially add
logging/caching.

An example of logging is in the later commit:
https://gerrit.openbmc.org/c/openbmc/bmcweb/+/78265/

We already do this for setProperty, this moves the method calls to
follow a similar pattern.

Tested: Redfish service validator passes.

Change-Id: I6d2c96e2b6b6a023ed2138106a55faebca161592
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Fix getting a response for wrong URI

Resolve getting a response for wrong URI in Update Service
URI (/redfish/v1/UpdateService/FirmwareInventory/)

- After the fix a wrong URI that partially matches

Fix getting a response for wrong URI

Resolve getting a response for wrong URI in Update Service
URI (/redfish/v1/UpdateService/FirmwareInventory/)

- After the fix a wrong URI that partially matches the
last characters in a valid URI now gets a 404 as shown
in the example below :

$ curl -k -H "X-Auth-Token: $bmc_token" -X GET
https://$bmc/redfish/v1/UpdateService/FirmwareInventory/5e
{
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The resource at the URI '/redfish/v1/
UpdateService/FirmwareInventory/5e' was not found.",
"MessageArgs": [
"/redfish/v1/UpdateService/FirmwareInventory/5e"
],
"MessageId": "Base.1.19.ResourceMissingAtURI",
"MessageSeverity": "Critical",
"Resolution": "Place a valid resource at the URI or
correct the URI and resubmit the request."
}
],
"code": "Base.1.19.ResourceMissingAtURI",
"message": "The resource at the URI '/redfish/v1/
UpdateService/FirmwareInventory/5e' was not found."
}

- Two common errors were fixed with the changes
- imprecise-matching
- not-responding-to-404

- The fix also includes changes to the software images to
only look under /xyz/openbmc_project/software/.

Tested: No longer getting a response for wrong URI in Update
Service URI.

Change-Id: I72d8452b8ca1ef095d093a57bc14fade380be617
Signed-off-by: Abiola Asojo <abiola.asojo@ibm.com>

show more ...

Up the default code update timeout

This timer is the time to write the image to /tmp/images/, the code
update app to untar and create a xyz.openbmc_project.Software.Activation
interface.

We have se

Up the default code update timeout

This timer is the time to write the image to /tmp/images/, the code
update app to untar and create a xyz.openbmc_project.Software.Activation
interface.

We have seen this take just over 25 seconds a few times, in one case it
took 30 seconds, and this times out. We are using a large image, 150MB+,
and other requests are going on but believe our use case is valid, so
bump the default timeout to 50 seconds.

In the times it has timed out, the time appears split between 1 and 2.
With 1) writing the image to /tmp/images and inotify firing and
2) phosphor-version-software-manager untarring the image and creating
the interface.

In the future this code should go away with the new code update, this
commit is more to note code updates can be slow due to the BMC's limited
resources and larger code update images exist.

```
// Can conclude the timer was set at 13:55:27...
Wed Feb 5 13:55:42 2025 xxx phosphor-version-software-manager: Untaring /tmp/images/f285ea12-b506-4182-86bc-b9706f09bc1f to /tmp/images/imagek9D7Iu
Wed Feb 5 13:55:52 2025 xxx bmcweb: [ERROR update_service.hpp:427] FW image may has already been uploaded to server
Wed Feb 5 13:55:52 2025 xxx bmcweb: [ERROR update_service.hpp:426] Timed out waiting for firmware object being created
Wed Feb 5 13:55:52 2025 xxx bmcweb: [CRITICAL error_messages.cpp:287] Internal Error /usr/src/debug/bmcweb/1.0+git/redfish-core/lib/update_service.hpp(438:41) `void redfish::afterAvailbleTimerAsyncWait(const std::shared_ptr<bmcweb::AsyncResp>&, const boost::system::error_code&)`:
```

Tested: Since bumping this timeout haven't hit this timeout.

Change-Id: I9f2ce9a24a55d72484113b3fbe226dc76b0bd2a5
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Remove getIoContext from Request object

At one point it was thought that we could pass the io_context object
through the request object, and have the potential to run multiple
io_context instances (

Remove getIoContext from Request object

At one point it was thought that we could pass the io_context object
through the request object, and have the potential to run multiple
io_context instances (one per connection).

Given the safety refactoring we had to do in
9838eb20341568971b9543c2187372d20daf64aa that idea is on ice for the
moment, and would need a major rethink of code to be viable. For the
moment, and in prep for
https://gerrit.openbmc.org/c/openbmc/bmcweb/+/75668

make sure all calls are pulling from the same io object.

Tested: Unit tests pass. Redfish service validator passes.

Change-Id: I877752005c4ce94efbc13ce815f3cd0d99cc3d51
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

clang-format: update latest spec and reformat

Copy the latest format file from the docs repository and apply.

Change-Id: I2f0b9d0fb6e01ed36a2f34c750ba52de3b6d15d1
Signed-off-by: Patrick Williams <p

clang-format: update latest spec and reformat

Copy the latest format file from the docs repository and apply.

Change-Id: I2f0b9d0fb6e01ed36a2f34c750ba52de3b6d15d1
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

Fix includes

Clang-tidy misc-include-cleaner appears to now be enforcing
significantly more headers than previously. That is overall a good
thing, but forces us to fix some issues. This commit is

Fix includes

Clang-tidy misc-include-cleaner appears to now be enforcing
significantly more headers than previously. That is overall a good
thing, but forces us to fix some issues. This commit is largely just
taking the clang-recommended fixes and checking them in. Subsequent
patches will fix the more unique issues.

Note, that a number of new ignores are added into the .clang-tidy file.
These can be cleaned up over time as they're understood. The majority
are places where boost includes a impl/x.hpp and x.hpp, but expects you
to use the later. include-cleaner opts for the impl, but it isn't clear
why.

Change-Id: Id3fdd7ee6df6c33b2fd35626898523048dd51bfb
Signed-off-by: Ed Tanous <etanous@nvidia.com>
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Use SPDX identifiers

SPDX identifiers are simpler, and reduce the amount of cruft we have in
code files. They are recommended by linux foundation, and therefore we
should do as they allow.

This pa

Use SPDX identifiers

SPDX identifiers are simpler, and reduce the amount of cruft we have in
code files. They are recommended by linux foundation, and therefore we
should do as they allow.

This patchset does not intend to modify any intent on any existing
copyrights or licenses, only to standardize their inclusion.

[1] https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects

Change-Id: I935c7c0156caa78fc368c929cebd0f068031e830
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Move getProperty calls to utility

Having all dbus calls run through the same utility reduces the amount of
generated code, and more importantly, gives us a place where we can log
the requests and re

Move getProperty calls to utility

Having all dbus calls run through the same utility reduces the amount of
generated code, and more importantly, gives us a place where we can log
the requests and responses to help with debugging.

Tested: Redfish service validator passes.

Change-Id: Ic1bf45130b5069cd57f7af26e12c8d3159c87c67
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Put simple update behind an option

4e338b2313f9f2a91aa1fb36693e36a328d58933 Removed tftp update support
from the codebase, but left SimpleUpdate in a non functional state.

Given that a number of fo

Put simple update behind an option

4e338b2313f9f2a91aa1fb36693e36a328d58933 Removed tftp update support
from the codebase, but left SimpleUpdate in a non functional state.

Given that a number of forks have implemented the HTTPS/SCP versions of
simple update, we don't want to fully delete the code at this time, so
for the moment put it behind an option flag.

Tested: WIP

Change-Id: Ibab1e3a48ff640787eabf8ed5f7a5c08e3381307
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Update error types to use dmtf

In a prior patch these were InvalidUpload, an openbmc oem defined
message. Map the messages to dmtf base registry messages, primarily
MissingOrMalformedPart

Tested:

Update error types to use dmtf

In a prior patch these were InvalidUpload, an openbmc oem defined
message. Map the messages to dmtf base registry messages, primarily
MissingOrMalformedPart

Tested: on last patch of series.

Change-Id: I0b04deabb01b8e299af259e0036f6007737068c6
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Remove InvalidUpload response code

Invalid response is something from the openbmc registry, so it's not
a valid thing to return as a response code. For this patch, remove
the generated error messag

Remove InvalidUpload response code

Invalid response is something from the openbmc registry, so it's not
a valid thing to return as a response code. For this patch, remove
the generated error message, and replace the one place it's used with
internalError.

Tested: On last patch in series.

Change-Id: I8215935f00923c72fd7763645c06d0b6af73c01d
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Format readjson

clang-format may potentially reformat the readJson calls if they may
have more keys or key names are longer. This makes formatting in a way
that's readable by forcing to break a line

Format readjson

clang-format may potentially reformat the readJson calls if they may
have more keys or key names are longer. This makes formatting in a way
that's readable by forcing to break a line for each key using an
empty-comment (`//`) each line.

It also allows trivially alphabetizing the list such that new additions
are less likely to have merge conflicts.

Tested:
- Check whitespace only.
- Code compiles.
- Redfish Service Validator with the same results before this

Change-Id: I3824a8c4faa9fa7c820d5d2fab6b565404926e2c
Signed-off-by: Ed Tanous <etanous@nvidia.com>
Signed-off-by: Myung Bae <myungbae@us.ibm.com>

show more ...

update service: update the updateable BMC

Update the updateable BMC rather than functional BMC because for dual
image systems functional BMC is not updated in place.

Tested:
```
> curl -k -H "X-Aut

update service: update the updateable BMC

Update the updateable BMC rather than functional BMC because for dual
image systems functional BMC is not updated in place.

Tested:
```
> curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/octet-stream" -X POST -T obmc-phosphor-image-romulus-20240529184214.static.mtd.tar https://${bmc}/redfish/v1/UpdateService/update
{
"@odata.id": "/redfish/v1/TaskService/Tasks/0",
"@odata.type": "#Task.v1_4_3.Task",
"Id": "0",
"TaskState": "Running",
"TaskStatus": "OK"
}
```

Change-Id: Ia11bd276ba5ac1d849942b33a7b6c50e74335024
Signed-off-by: Jagpal Singh Gill <paligill@gmail.com>

show more ...

Remove duplicated block comments

Static analysis flags that these two comments are redundant[1], which
seem to be duplicated a lot in copyright headers. Although there is a
larger discussion that c

Remove duplicated block comments

Static analysis flags that these two comments are redundant[1], which
seem to be duplicated a lot in copyright headers. Although there is a
larger discussion that can likely be had.

[1] https://sonarcloud.io/project/issues?issueStatuses=OPEN%2CCONFIRMED&id=edtanous_bmcweb&open=AY9_HYjgKXKyw1ZFwgVP

Tested: Comment change only. Code compiles.

Change-Id: Ia960317761f558a87842347ca0b5f3da63f8e730
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

static -> inline

Declaring a function static in a header makes no sense, because a header
isn't a compile unit. Find all the issues and replace them with inline.

Change-Id: Icfc2b72d94b41a3a880da1

static -> inline

Declaring a function static in a header makes no sense, because a header
isn't a compile unit. Find all the issues and replace them with inline.

Change-Id: Icfc2b72d94b41a3a880da1ae6975beaa30a6792b
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

clang-format: re-format for clang-18

clang-format-18 isn't compatible with the clang-format-17 output, so we
need to reformat the code with the latest version. The way clang-18
handles lambda forma

clang-format: re-format for clang-18

clang-format-18 isn't compatible with the clang-format-17 output, so we
need to reformat the code with the latest version. The way clang-18
handles lambda formatting also changed, so we have made changes to the
organization default style format to better handle lambda formatting.

See I5e08687e696dd240402a2780158664b7113def0e for updated style.
See Iea0776aaa7edd483fa395e23de25ebf5a6288f71 for clang-18 enablement.

Change-Id: Iceec1dc95b6c908ec6c21fb40093de9dd18bf11a
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

update service: use return path for task callback

Currently the update service is using the start update path for
monitoring the activation interfaces, but instead it needs to use the
object path re

update service: use return path for task callback

Currently the update service is using the start update path for
monitoring the activation interfaces, but instead it needs to use the
object path returned by start update API. By using the returned path the
changes to the activation interface are passed over to the task status.
For more details refer to design -
https://gerrit.openbmc.org/c/openbmc/phosphor-dbus-interfaces/+/65738
https://gerrit.openbmc.org/c/openbmc/docs/+/65739

Tested:
Start update with ApplyTime as onReset
```
> curl -k -H "X-Auth-Token: $token" -H "Content-Type:multipart/form-data" -X POST -F UpdateParameters="{\"Targets\":[\"/redfish/v1/UpdateService/FirmwareInventory/3c956be0\"],\"@Redfish.OperationApplyTime\":\"OnReset\"};type=application/json" -F "UpdateFile=@obmc-phosphor-image-romulus-20240529184214.static.mtd.tar;type=application/octet-stream" https://${bmc}/redfish/v1/UpdateService/update
{
"@odata.id": "/redfish/v1/TaskService/Tasks/0",
"@odata.type": "#Task.v1_4_3.Task",
"Id": "0",
"TaskState": "Running",
"TaskStatus": "OK"
}

...

> curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/TaskService/Tasks/0
{
"@odata.id": "/redfish/v1/TaskService/Tasks/0",
"@odata.type": "#Task.v1_4_3.Task",
"EndTime": "2024-08-12T07:35:42+00:00",
"HidePayload": false,
"Id": "0",
"Messages": [
...
},
"PercentComplete": 100,
"StartTime": "2024-08-12T07:35:15+00:00",
"TaskMonitor": "/redfish/v1/TaskService/TaskMonitors/0",
"TaskState": "Completed",
"TaskStatus": "OK"
}
```

Change-Id: Ib17c5da329361fc59b0a1923ace214a8bf9e8371
Signed-off-by: Jagpal Singh Gill <paligill@gmail.com>

show more ...