Skip to content

Commit

Permalink
Fixed compatibility issues with the new Vendor Defined Commands API
Browse files Browse the repository at this point in the history 
If the new Vendor Defined Responder callback pointers are not assigned and the default get_response_func() pointer is assigned, VENDOR_DEFINED_REQUEST messages will get routed to get_responder_func() instead.

Fixes #2532

Signed-off-by: Ionut Ursachi <[email protected]>
  • Loading branch information
@uvinrg @jyao1
uvinrg authored and jyao1 committed Jan 26, 2024
1 parent 5cc6915 commit 672868f
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 4 deletions.
19 changes: 19 additions & 0 deletions library/spdm_responder_lib/libspdm_rsp_vendor_response.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,25 @@ libspdm_return_t libspdm_get_vendor_defined_response(libspdm_context_t *spdm_con
return LIBSPDM_STATUS_INVALID_PARAMETER;
}

/* Check if caller is using the old Vendor Defined API */
if ((spdm_context->vendor_response_callback == NULL ||
spdm_context->vendor_response_get_id == NULL)) {

if (spdm_context->get_response_func != NULL) {

return ((libspdm_get_response_func)spdm_context->get_response_func)(
spdm_context,
&spdm_context->session_info->session_id,
false,
request_size,
request,
response_size,
response
);
} else
return LIBSPDM_STATUS_UNSUPPORTED_CAP;
}

spdm_request = request;

if (spdm_request->header.spdm_version != libspdm_get_connection_version(spdm_context)) {
Expand Down
103 changes: 99 additions & 4 deletions unit_test/test_spdm_responder/receive_send.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ libspdm_return_t my_test_get_vendor_id_func(
}

libspdm_return_t my_test_get_response_func(
void *spdm_context, const uint32_t *session_id, bool is_app_message,
size_t request_size, const void *request, size_t *response_size,
void *response)
{
/* response message size is greater than the sending transmit buffer size of responder */
*response_size = CHUNK_GET_UNIT_TEST_OVERRIDE_DATA_TRANSFER_SIZE + 1;
return LIBSPDM_STATUS_SUCCESS;
}

libspdm_return_t my_test_get_response_func2(
void *spdm_context,
uint16_t req_standard_id,
uint8_t req_vendor_id_len,
Expand Down Expand Up @@ -232,8 +242,7 @@ void libspdm_test_responder_receive_send_rsp_case2(void** state)
libspdm_zero_mem(response, response_size);

/* Make response message size greater than the sending transmit buffer size of responder */
libspdm_register_vendor_get_id_callback_func(spdm_context, my_test_get_vendor_id_func);
libspdm_register_vendor_callback_func(spdm_context, my_test_get_response_func);
spdm_context->get_response_func = (void *)my_test_get_response_func;

status = libspdm_build_response(spdm_context, NULL, false,
&response_size, (void**)&response);
Expand All @@ -256,10 +265,92 @@ void libspdm_test_responder_receive_send_rsp_case2(void** state)

/**
* Test 3: Test Responder Receive Send flow triggers chunk get mode
* if response message size is larger than responder sending transmit buffer size.
**/
void libspdm_test_responder_receive_send_rsp_case3(void** state)
{
libspdm_return_t status;
libspdm_test_context_t* spdm_test_context;
libspdm_context_t* spdm_context;
size_t response_size;
uint8_t* response;
spdm_error_response_t* spdm_response;
spdm_vendor_defined_request_msg_t spdm_request;
void* message;
size_t message_size;
uint32_t transport_header_size;
uint8_t chunk_handle;

spdm_test_context = *state;
spdm_context = spdm_test_context->spdm_context;
spdm_test_context->case_id = 2;
spdm_context->connection_info.version = SPDM_MESSAGE_VERSION_12 <<
SPDM_VERSION_NUMBER_SHIFT_BIT;

spdm_context->connection_info.connection_state =
LIBSPDM_CONNECTION_STATE_AUTHENTICATED;

spdm_context->local_context.capability.flags |=
(SPDM_GET_CAPABILITIES_RESPONSE_FLAGS_MEAS_CAP
| SPDM_GET_CAPABILITIES_RESPONSE_FLAGS_CHUNK_CAP);
spdm_context->connection_info.capability.flags |=
SPDM_GET_CAPABILITIES_REQUEST_FLAGS_CHUNK_CAP;

/* The local Responder transmit buffer size for sending a single and complete SPDM message */
spdm_context->local_context.capability.sender_data_transfer_size =
CHUNK_GET_UNIT_TEST_OVERRIDE_DATA_TRANSFER_SIZE;
/* The peer Requester buffer size for receiving a single and complete SPDM message */
spdm_context->connection_info.capability.data_transfer_size =
LIBSPDM_DATA_TRANSFER_SIZE;

spdm_context->connection_info.capability.max_spdm_msg_size =
LIBSPDM_MAX_SPDM_MSG_SIZE;

libspdm_zero_mem(&spdm_request, sizeof(spdm_request));
spdm_request.header.spdm_version = SPDM_MESSAGE_VERSION_12;
spdm_request.header.request_response_code = SPDM_VENDOR_DEFINED_REQUEST;

libspdm_copy_mem(spdm_context->last_spdm_request,
libspdm_get_scratch_buffer_last_spdm_request_capacity(spdm_context),
&spdm_request, sizeof(spdm_request));
spdm_context->last_spdm_request_size = sizeof(spdm_request);

assert_int_equal(spdm_context->chunk_context.get.chunk_in_use, false);
libspdm_acquire_sender_buffer(spdm_context, &message_size, (void**) &message);

response = message;
response_size = message_size;
libspdm_zero_mem(response, response_size);

/* Make response message size greater than the sending transmit buffer size of responder */
libspdm_register_vendor_get_id_callback_func(spdm_context, my_test_get_vendor_id_func);
libspdm_register_vendor_callback_func(spdm_context, my_test_get_response_func2);

status = libspdm_build_response(spdm_context, NULL, false,
&response_size, (void**)&response);
assert_int_equal(status, LIBSPDM_STATUS_SUCCESS);
transport_header_size = spdm_context->local_context.capability.transport_header_size;

/* Verify responder returned error large response with chunk_handle == 1
* and responder is in chunking mode (get.chunk_in_use). */
spdm_response = (spdm_error_response_t*) ((uint8_t*)message + transport_header_size);
assert_int_equal(spdm_response->header.spdm_version, SPDM_MESSAGE_VERSION_12);
assert_int_equal(spdm_response->header.request_response_code, SPDM_ERROR);
assert_int_equal(spdm_response->header.param1, SPDM_ERROR_CODE_LARGE_RESPONSE);
assert_int_equal(spdm_response->header.param2, 0);

chunk_handle = *(uint8_t*)(spdm_response + 1);
assert_int_equal(chunk_handle, spdm_context->chunk_context.get.chunk_handle);
assert_int_equal(spdm_context->chunk_context.get.chunk_in_use, true);
libspdm_release_sender_buffer(spdm_context);
}

/**
* Test 4: Test Responder Receive Send flow triggers chunk get mode
* if response buffer is larger than requester max_spdm_msg_size.
* expect: SPDM_ERROR_CODE_RESPONSE_TOO_LARGE
**/
void libspdm_test_responder_receive_send_rsp_case3(void** state)
void libspdm_test_responder_receive_send_rsp_case4(void** state)
{
/* This test case is partially copied from test_requester_get_measurement_case4 */
libspdm_return_t status;
Expand Down Expand Up @@ -398,9 +489,13 @@ int libspdm_responder_receive_send_test_main(void)
/* response message size is larger than responder sending transmit buffer size */
cmocka_unit_test_setup(libspdm_test_responder_receive_send_rsp_case2,
libspdm_unit_test_group_setup),
/* response message size is larger than requester max_spdm_msg_size */
/* response message size is larger than responder sending transmit buffer size
* using the new Vendor Defined Message API */
cmocka_unit_test_setup(libspdm_test_responder_receive_send_rsp_case3,
libspdm_unit_test_group_setup),
/* response message size is larger than requester max_spdm_msg_size */
cmocka_unit_test_setup(libspdm_test_responder_receive_send_rsp_case4,
libspdm_unit_test_group_setup),
};

libspdm_setup_test_context(&m_libspdm_responder_receive_send_test_context);
Expand Down

0 comments on commit 672868f

Please sign in to comment.