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