Line data Source code
1 : /**
2 : * Copyright Notice:
3 : * Copyright 2023-2025 DMTF. All rights reserved.
4 : * License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libspdm/blob/main/LICENSE.md
5 : **/
6 :
7 : #include "spdm_unit_test.h"
8 : #include "internal/libspdm_responder_lib.h"
9 :
10 : #if LIBSPDM_ENABLE_VENDOR_DEFINED_MESSAGES
11 :
12 : #define VENDOR_DEFINED_REQUEST_PAYLOAD_SIZE 16
13 : #define VENDOR_DEFINED_RESPONSE_PAYLOAD_SIZE 64
14 :
15 : #pragma pack(1)
16 : typedef struct {
17 : spdm_message_header_t header;
18 : uint16_t standard_id;
19 : uint8_t vendor_id_len;
20 : uint8_t vendor_id[SPDM_MAX_VENDOR_ID_LENGTH];
21 : } libspdm_vendor_request_test;
22 :
23 : typedef struct {
24 : spdm_message_header_t header;
25 : uint16_t standard_id;
26 : uint8_t vendor_id_len;
27 : uint8_t vendor_id[SPDM_MAX_VENDOR_ID_LENGTH];
28 : } libspdm_vendor_response_test;
29 : #pragma pack()
30 :
31 : static uint32_t m_session_id = 0xffffffff;
32 :
33 2 : static libspdm_return_t libspdm_vendor_response_func_test(
34 : void *spdm_context,
35 : const uint32_t *session_id,
36 : uint16_t req_standard_id,
37 : uint8_t req_vendor_id_len,
38 : const void *req_vendor_id,
39 : uint32_t req_size,
40 : const void *req_data,
41 : uint32_t *resp_size,
42 : void *resp_data)
43 : {
44 2 : if (req_data == NULL ||
45 2 : resp_size == NULL ||
46 : resp_data == NULL)
47 0 : return LIBSPDM_STATUS_INVALID_PARAMETER;
48 :
49 2 : assert_int_equal(*session_id, m_session_id);
50 :
51 : /* get pointer to response data payload and populate */
52 2 : uint8_t *resp_payload = (uint8_t *)resp_data;
53 : /* get pointer to response length and populate */
54 2 : *resp_size = VENDOR_DEFINED_RESPONSE_PAYLOAD_SIZE;
55 : /* store length of response */
56 2 : libspdm_set_mem(resp_payload, *resp_size, 0xFF);
57 :
58 2 : printf("Got request 0x%x, sent response 0x%x\n",
59 2 : ((const uint8_t*)req_data)[0], ((uint8_t*)resp_data)[0]);
60 :
61 2 : return LIBSPDM_STATUS_SUCCESS;
62 : }
63 :
64 : /**
65 : * Test 1: Sending a vendor defined request using the internal response handler
66 : * Expected behavior: client returns a status of LIBSPDM_STATUS_SUCCESS and expected response
67 : **/
68 1 : static void rsp_vendor_defined_response_case1(void **state)
69 : {
70 : libspdm_return_t status;
71 : libspdm_test_context_t *spdm_test_context;
72 : libspdm_context_t *spdm_context;
73 1 : uint8_t request_buffer[LIBSPDM_MAX_SPDM_MSG_SIZE] = {0};
74 1 : uint8_t response_buffer[LIBSPDM_MAX_SPDM_MSG_SIZE] = {0};
75 1 : libspdm_vendor_request_test request = {0};
76 1 : libspdm_vendor_response_test response = {0};
77 1 : size_t response_len = 0;
78 : libspdm_session_info_t *session_info;
79 : uint8_t *request_ptr;
80 :
81 1 : response.vendor_id_len = sizeof(response.vendor_id);
82 :
83 1 : spdm_test_context = *state;
84 1 : spdm_context = spdm_test_context->spdm_context;
85 1 : spdm_test_context->case_id = 0x1;
86 1 : spdm_context->connection_info.algorithm.base_hash_algo =
87 : SPDM_ALGORITHMS_BASE_HASH_ALGO_TPM_ALG_SHA_256;
88 1 : request.header.spdm_version = SPDM_MESSAGE_VERSION_11;
89 1 : spdm_context->connection_info.version = request.header.spdm_version <<
90 : SPDM_VERSION_NUMBER_SHIFT_BIT;
91 1 : spdm_context->connection_info.connection_state = LIBSPDM_CONNECTION_STATE_NEGOTIATED;
92 1 : spdm_context->local_context.is_requester = true;
93 :
94 1 : spdm_context->latest_session_id = m_session_id;
95 1 : spdm_context->last_spdm_request_session_id_valid = true;
96 1 : spdm_context->last_spdm_request_session_id = m_session_id;
97 1 : session_info = &spdm_context->session_info[0];
98 1 : libspdm_session_info_init(spdm_context, session_info, m_session_id,
99 : SECURED_SPDM_VERSION_11 << SPDM_VERSION_NUMBER_SHIFT_BIT, true);
100 1 : libspdm_secured_message_set_session_state(
101 : session_info->secured_message_context,
102 : LIBSPDM_SESSION_STATE_ESTABLISHED);
103 :
104 1 : status = libspdm_register_vendor_callback_func(spdm_context,
105 : libspdm_vendor_response_func_test);
106 1 : assert_int_equal(status, LIBSPDM_STATUS_SUCCESS);
107 :
108 1 : request.header.request_response_code = SPDM_VENDOR_DEFINED_REQUEST;
109 1 : request.standard_id = 6;
110 1 : request.vendor_id_len = 2;
111 1 : libspdm_set_mem(request.vendor_id, sizeof(request.vendor_id), 0xAA);
112 :
113 1 : response_len = sizeof(response) + sizeof(uint16_t)
114 : + VENDOR_DEFINED_RESPONSE_PAYLOAD_SIZE;
115 :
116 : /* copy header of request structure to buffer */
117 1 : libspdm_copy_mem(request_buffer, sizeof(request_buffer), &request,
118 1 : sizeof(request.header) + 3 + request.vendor_id_len);
119 : /* write the request data len to the correct offset in the request_buffer */
120 1 : request_ptr = request_buffer + sizeof(request.header) + 3 + request.vendor_id_len;
121 1 : libspdm_write_uint16(request_ptr, VENDOR_DEFINED_REQUEST_PAYLOAD_SIZE);
122 : /* set the request data to the correct offset in the request_buffer */
123 1 : request_ptr += sizeof(uint16_t);
124 1 : libspdm_set_mem(request_ptr, VENDOR_DEFINED_REQUEST_PAYLOAD_SIZE, 0xAA);
125 :
126 : /* requires correctly encoded spdm vendor request message */
127 1 : status = libspdm_get_vendor_defined_response(spdm_context,
128 1 : sizeof(spdm_vendor_defined_request_msg_t) + request.vendor_id_len + sizeof(uint16_t) + VENDOR_DEFINED_REQUEST_PAYLOAD_SIZE,
129 : request_buffer, &response_len, response_buffer);
130 :
131 1 : assert_int_equal(status, LIBSPDM_STATUS_SUCCESS);
132 :
133 : /* Verify response IDs are copied from request */
134 1 : libspdm_copy_mem(&response, sizeof(response),
135 1 : response_buffer, sizeof(spdm_vendor_defined_response_msg_t) + request.vendor_id_len);
136 :
137 1 : assert_int_equal(response.header.spdm_version, SPDM_MESSAGE_VERSION_11);
138 1 : assert_int_equal(response.header.request_response_code, SPDM_VENDOR_DEFINED_RESPONSE);
139 1 : assert_int_equal(response.standard_id, request.standard_id);
140 1 : assert_int_equal(response.vendor_id_len, request.vendor_id_len);
141 1 : assert_memory_equal(response.vendor_id, request.vendor_id, request.vendor_id_len);
142 1 : }
143 :
144 : /**
145 : * Test 2: Sending a vendor defined request using the internal response handler with Large VDM support
146 : * Expected behavior: client returns a status of LIBSPDM_STATUS_SUCCESS and expected response
147 : **/
148 1 : static void rsp_vendor_defined_response_case2(void **state)
149 : {
150 : libspdm_return_t status;
151 : libspdm_test_context_t *spdm_test_context;
152 : libspdm_context_t *spdm_context;
153 1 : uint8_t request_buffer[LIBSPDM_MAX_SPDM_MSG_SIZE] = {0};
154 1 : uint8_t response_buffer[LIBSPDM_MAX_SPDM_MSG_SIZE] = {0};
155 1 : libspdm_vendor_request_test request = {0};
156 1 : libspdm_vendor_response_test response = {0};
157 1 : size_t response_len = 0;
158 1 : size_t request_len = 0;
159 : libspdm_session_info_t *session_info;
160 : uint8_t *request_ptr;
161 :
162 1 : spdm_test_context = *state;
163 1 : spdm_context = spdm_test_context->spdm_context;
164 1 : spdm_test_context->case_id = 0x2;
165 1 : spdm_context->connection_info.algorithm.base_hash_algo =
166 : SPDM_ALGORITHMS_BASE_HASH_ALGO_TPM_ALG_SHA_256;
167 1 : request.header.spdm_version = SPDM_MESSAGE_VERSION_14;
168 1 : spdm_context->connection_info.version = request.header.spdm_version <<
169 : SPDM_VERSION_NUMBER_SHIFT_BIT;
170 1 : spdm_context->connection_info.connection_state = LIBSPDM_CONNECTION_STATE_NEGOTIATED;
171 1 : spdm_context->connection_info.capability.flags |= SPDM_GET_CAPABILITIES_REQUEST_FLAGS_LARGE_RESP_CAP;
172 1 : spdm_context->local_context.capability.flags |= SPDM_GET_CAPABILITIES_RESPONSE_FLAGS_LARGE_RESP_CAP;
173 1 : spdm_context->local_context.is_requester = false;
174 :
175 1 : spdm_context->latest_session_id = m_session_id;
176 1 : spdm_context->last_spdm_request_session_id_valid = true;
177 1 : spdm_context->last_spdm_request_session_id = m_session_id;
178 1 : session_info = &spdm_context->session_info[0];
179 1 : libspdm_session_info_init(spdm_context, session_info, m_session_id,
180 : SECURED_SPDM_VERSION_11 << SPDM_VERSION_NUMBER_SHIFT_BIT, true);
181 1 : libspdm_secured_message_set_session_state(
182 : session_info->secured_message_context,
183 : LIBSPDM_SESSION_STATE_ESTABLISHED);
184 :
185 1 : status = libspdm_register_vendor_callback_func(spdm_context,
186 : libspdm_vendor_response_func_test);
187 1 : assert_int_equal(status, LIBSPDM_STATUS_SUCCESS);
188 :
189 1 : request.header.request_response_code = SPDM_VENDOR_DEFINED_REQUEST;
190 1 : request.header.param1 = SPDM_VENDOR_DEFINED_REQUEST_LARGE_REQ;
191 1 : request.standard_id = 6;
192 1 : request.vendor_id_len = 2;
193 1 : libspdm_set_mem(request.vendor_id, sizeof(request.vendor_id), 0xAA);
194 :
195 1 : response_len = sizeof(response) + sizeof(uint16_t) + sizeof(uint32_t)
196 : + VENDOR_DEFINED_RESPONSE_PAYLOAD_SIZE;
197 :
198 : /* copy header of request structure to buffer */
199 1 : libspdm_copy_mem(request_buffer, sizeof(request_buffer),
200 1 : &request, sizeof(spdm_vendor_defined_request_msg_t) + request.vendor_id_len);
201 : /* write the request data len to the correct offset in the request_buffer */
202 1 : request_ptr = request_buffer + sizeof(spdm_vendor_defined_request_msg_t) + request.vendor_id_len;
203 1 : libspdm_write_uint16(request_ptr, 0);
204 1 : request_ptr += sizeof(uint16_t);
205 1 : libspdm_write_uint32(request_ptr, VENDOR_DEFINED_REQUEST_PAYLOAD_SIZE);
206 : /* set the request data to the correct offset in the request_buffer */
207 1 : request_ptr += sizeof(uint32_t);
208 1 : libspdm_set_mem(request_ptr, VENDOR_DEFINED_REQUEST_PAYLOAD_SIZE, 0xAA);
209 1 : request_len = sizeof(spdm_vendor_defined_request_msg_t) + request.vendor_id_len + sizeof(uint16_t) +
210 : sizeof(uint32_t) + VENDOR_DEFINED_REQUEST_PAYLOAD_SIZE;
211 :
212 : /* requires correctly encoded spdm vendor request message */
213 1 : status = libspdm_get_vendor_defined_response(spdm_context, request_len,
214 : request_buffer, &response_len, response_buffer);
215 :
216 : /* copy to response data structure in the same way as for request */
217 1 : libspdm_copy_mem(&response, sizeof(response),
218 1 : response_buffer, sizeof(spdm_vendor_defined_response_msg_t) + request.vendor_id_len);
219 :
220 1 : assert_int_equal(status, LIBSPDM_STATUS_SUCCESS);
221 1 : assert_int_equal(response.header.spdm_version, SPDM_MESSAGE_VERSION_14);
222 1 : assert_int_equal(response.header.request_response_code, SPDM_VENDOR_DEFINED_RESPONSE);
223 1 : assert_int_equal(response.header.param1, SPDM_VENDOR_DEFINED_RESPONSE_LARGE_RESP);
224 1 : }
225 :
226 1 : int libspdm_rsp_vendor_defined_response_test(void)
227 : {
228 1 : const struct CMUnitTest test_cases[] = {
229 : cmocka_unit_test(rsp_vendor_defined_response_case1),
230 : cmocka_unit_test(rsp_vendor_defined_response_case2),
231 : };
232 :
233 1 : libspdm_test_context_t test_context = {
234 : LIBSPDM_TEST_CONTEXT_VERSION,
235 : true,
236 : };
237 :
238 1 : libspdm_setup_test_context(&test_context);
239 :
240 1 : return cmocka_run_group_tests(test_cases,
241 : libspdm_unit_test_group_setup,
242 : libspdm_unit_test_group_teardown);
243 : }
244 :
245 : #endif /* LIBSPDM_ENABLE_VENDOR_DEFINED_MESSAGES */
|
