transport: storage: add support for SPDM over the storage binding (DSP0286) #2827

twilfredo · 2024-09-05T02:17:59Z

This series adds libspdm transport support for SPDM over Storage Binding Specification [1]. This allows for example NVMe or SCSI devices that conform to [1] to communicate with a host requester using the storage transport medium as defined in [1].

[1] https://www.dmtf.org/sites/default/files/standards/documents/DSP0286_1.0.0WIP90.pdf

twilfredo · 2024-09-05T02:18:09Z

@alistair23

steven-bellock · 2024-09-05T14:53:54Z

A couple of high level comments.

This pull request will not be able to be merged until DSP0286 has been published, but that looks to be soonish.
The WDC-authored files have a WDC copyright. I believe (not 100 % sure) that per the "DMTF Members’ Software Submission Policy" it should have the DMTF copyright. If you want to keep the WDC copyright we can talk to the DMTF open source folks to clarify things.

twilfredo · 2024-09-06T04:51:39Z

A couple of high level comments.

1. This pull request will not be able to be merged until DSP0286 has been published, but that looks to be soonish.

Yeah that sounds good, just wanted to get comments early on

2. The WDC-authored files have a WDC copyright. I believe (not 100 % sure) that per the "DMTF Members’ Software Submission Policy" it should have the DMTF copyright. If you want to keep the WDC copyright we can talk to the DMTF open source folks to clarify things.

I've updated the license header with an author tag, is that sufficient? Diff: https://github.com/DMTF/libspdm/compare/7a14888587717c8a16e7390388fd39629e7a7076..c63269b162af091a35ef282052980087a378c68f

steven-bellock · 2024-09-06T16:28:10Z

Presumably authorship is recorded in the commit log, but if you want to put it in the file itself:

/**
 *  Copyright Notice:
 *  Copyright 2024 DMTF. All rights reserved.
 *  License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libspdm/blob/main/LICENSE.md
 **/
 
 /**
  *  Author: Wilfred Mallawa <[email protected]>
  *          Alistair Francis <[email protected]>
  **/

include/industry_standard/storage.h

library/spdm_transport_storage_lib/CMakeLists.txt

library/spdm_transport_storage_lib/libspdm_storage.c

jyao1 · 2024-09-11T02:46:37Z

Usually, the implementation for WIP should NOT be posted to main, but a WIP specific branch
For example, StorageBinding_WIP, in this case.

The WIP branch can be merged into main, after the WIP spec becomes official standard.

twilfredo · 2024-09-11T03:29:40Z

Usually, the implementation for WIP should NOT be posted to main, but a WIP specific branch For example, StorageBinding_WIP, in this case.

The WIP branch can be merged into main, after the WIP spec becomes official standard.

Okay noted, are you happy to keep this up for now? since review is in progress.

jyao1 · 2024-09-11T03:51:34Z

Okay noted, are you happy to keep this up for now? since review is in progress.

That is fine. We can keep reviewing and address all feedback in this PR.

Whenever you think it is done and ready for merge, you can switch to branch merge request.

include/industry_standard/storage.h

library/spdm_transport_storage_lib/libspdm_storage.c

jyao1 · 2024-11-01T02:22:44Z

@twilfredo , do you want to keep it in PR? or do you want to push to a branch, and keep updating the branch?

I am OK either way. But I just feel a branch might be more helpful.

twilfredo · 2024-11-01T06:11:21Z

@twilfredo , do you want to keep it in PR? or do you want to push to a branch, and keep updating the branch?

I am OK either way. But I just feel a branch might be more helpful.

I'll stick to the PR is that's okay with everyone. I'm just waiting for the spec to be ratified so I can address all the changes in one go.

Add support for bswap16 and 32. Also rename the existing `libspdm_le_to_be_64` to `libspdm_byte_swap_64` for consistency. Signed-off-by: Wilfred Mallawa <[email protected]>

twilfredo · 2024-11-27T06:42:19Z

What is the correct way to generate a seed for the fuzzing tests to go here unit_test/fuzzing/seeds mapping to the respective tests.

As requested by @jyao1 I have added some unit tests to test the storage transport api, but I'm unsure about how the seeds are generated (hence why some of the the CI is failing also).

As defined by DSP0826, add support for SPDM storage transport. The transport layer uses a virtual storage header that encapsulates SPDM requests to allow the caller to generate the required parameters for a storage SPDM request. SPDM responses are not transport encoded, with this header, instead just the message is returned. Signed-off-by: Wilfred Mallawa <[email protected]> Signed-off-by: Alistair Francis <[email protected]>

This allows transports such as Storage (DSP0286) to determine if the next response is protected via secured messages. Unlike other transport layers, storage does not encode the message type in a response header. As such, the requester must track the expected type. The issue [1] discusses this implementation requirement in further detail with regards to DSP0286. [1] DMTF/SPDM-WG#3520 Signed-off-by: Wilfred Mallawa <[email protected]> Signed-off-by: Alistair Francis <[email protected]>

Signed-off-by: Wilfred Mallawa <[email protected]>

twilfredo force-pushed the wilfred/add-trans-storage-05.9 branch 7 times, most recently from 8ab52c6 to 7a14888 Compare September 5, 2024 04:21

twilfredo force-pushed the wilfred/add-trans-storage-05.9 branch from 7a14888 to c63269b Compare September 6, 2024 04:50

steven-bellock requested changes Sep 8, 2024

View reviewed changes

twilfredo force-pushed the wilfred/add-trans-storage-05.9 branch 3 times, most recently from e50ff9f to 8fc10b2 Compare September 9, 2024 01:34

steven-bellock reviewed Sep 9, 2024

View reviewed changes

library/spdm_transport_storage_lib/libspdm_storage.c Outdated Show resolved Hide resolved