Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 1.3 transcript support for multi-key #2435

Merged
merged 4 commits into from
Nov 23, 2023
Merged

Add 1.3 transcript support for multi-key #2435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c361b48
Fix latest_session_id assignment issue.
jyao1 Nov 19, 2023
a22a114
1.3 fix transcript size calculation
jyao1 Nov 13, 2023
561ecf9
1.3 Add DIGEST to transcript.
jyao1 Nov 13, 2023
281def2
1.3 add mutli_key_conn set/get data.
jyao1 Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 106 additions & 31 deletions include/internal/libspdm_common_lib.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,48 +146,63 @@ typedef struct {
uint8_t buffer[LIBSPDM_MAX_MESSAGE_VCA_BUFFER_SIZE];
} libspdm_vca_managed_buffer_t;

/*
* +--------------------------+------------------------------------------+---------+
* | DIGESTS 1.3 | 4 + (H [+ 4]) * SlotNum = [36, 548] | [1, 18] |
* +--------------------------+------------------------------------------+---------+
* It is for multi-key.
*/
#define LIBSPDM_MAX_MESSAGE_D_BUFFER_SIZE (4 + \
(LIBSPDM_MAX_HASH_SIZE + 4) * SPDM_MAX_SLOT_COUNT)

typedef struct {
size_t max_buffer_size;
size_t buffer_size;
uint8_t buffer[LIBSPDM_MAX_MESSAGE_D_BUFFER_SIZE];
} libspdm_message_d_managed_buffer_t;

#if LIBSPDM_RECORD_TRANSCRIPT_DATA_SUPPORT

/*
* +--------------------------+------------------------------------------+---------+
* | GET_DIGESTS 1.2 | 4 | 1 |
* | DIGESTS 1.2 | 4 + H * SlotNum = [36, 516] | [1, 18] |
* | GET_DIGESTS 1.3 | 4 | 1 |
* | DIGESTS 1.3 | 4 + (H [+ 4]) * SlotNum = [36, 548] | [1, 18] |
* +--------------------------+------------------------------------------+---------+
* | GET_CERTIFICATE 1.2 | 8 | 1 |
* | CERTIFICATE 1.2 | 8 + PortionLen | [1, ] |
* | GET_CERTIFICATE 1.3 | 8 | 1 |
* | CERTIFICATE 1.3 | 8 + PortionLen | [1, ] |
* +--------------------------+------------------------------------------+---------+
*/
#define LIBSPDM_MAX_MESSAGE_B_BUFFER_SIZE (24 + \
LIBSPDM_MAX_HASH_SIZE * SPDM_MAX_SLOT_COUNT + \
(LIBSPDM_MAX_HASH_SIZE + 4) * SPDM_MAX_SLOT_COUNT + \
LIBSPDM_MAX_CERT_CHAIN_SIZE)

/*
* +--------------------------+------------------------------------------+---------+
* | CHALLENGE 1.2 | 40 | 1 |
* | CHALLENGE_AUTH 1.2 | 38 + H * 2 + S [+ O] = [166, 678] | [6, 23] |
* | CHALLENGE 1.3 | 44 | 1 |
* | CHALLENGE_AUTH 1.3 | 46 + H * 2 + S [+ O] = [166, 678] | [6, 23] |
* +--------------------------+------------------------------------------+---------+
*/
#define LIBSPDM_MAX_MESSAGE_C_BUFFER_SIZE (78 + \
#define LIBSPDM_MAX_MESSAGE_C_BUFFER_SIZE (90 + \
LIBSPDM_MAX_HASH_SIZE * 2 + \
LIBSPDM_MAX_ASYM_KEY_SIZE + SPDM_MAX_OPAQUE_DATA_SIZE)

/*
* +--------------------------+------------------------------------------+---------+
* | GET_MEASUREMENTS 1.2 | 5 + Nonce (0 or 32) | 1 |
* | MEASUREMENTS 1.2 | 42 + MeasRecLen (+ S) [+ O] = [106, 554] | [4, 19] |
* | GET_MEASUREMENTS 1.3 | 13 + Nonce (0 or 32) | 1 |
* | MEASUREMENTS 1.3 | 50 + MeasRecLen (+ S) [+ O] = [106, 554] | [4, 19] |
* +--------------------------+------------------------------------------+---------+
*/
#define LIBSPDM_MAX_MESSAGE_M_BUFFER_SIZE (47 + SPDM_NONCE_SIZE + \
#define LIBSPDM_MAX_MESSAGE_M_BUFFER_SIZE (63 + SPDM_NONCE_SIZE + \
LIBSPDM_MAX_MEASUREMENT_RECORD_SIZE + \
LIBSPDM_MAX_ASYM_KEY_SIZE + SPDM_MAX_OPAQUE_DATA_SIZE)

/*
* +--------------------------+------------------------------------------+---------+
* | KEY_EXCHANGE 1.2 | 42 + D [+ O] = [106, 554] | [4, 19] |
* | KEY_EXCHANGE_RSP 1.2 | 42 + D + H + S (+ H) [+ O] = [234, 1194] | [8, 40] |
* | KEY_EXCHANGE 1.3 | 42 + D [+ O] = [106, 554] | [4, 19] |
* | KEY_EXCHANGE_RSP 1.3 | 42 + D + H + S (+ H) [+ O] = [234, 1194] | [8, 40] |
* +--------------------------+------------------------------------------+---------+
* | PSK_EXCHANGE 1.2 | 12 [+ PSKHint] + R [+ O] = 44 | 2 |
* | PSK_EXCHANGE_RSP 1.2 | 12 + R + H (+ H) [+ O] = [108, 172] | [4, 6] |
* | PSK_EXCHANGE 1.3 | 12 [+ PSKHint] + R [+ O] = 44 | 2 |
* | PSK_EXCHANGE_RSP 1.3 | 12 + R + H (+ H) [+ O] = [108, 172] | [4, 6] |
* +--------------------------+------------------------------------------+---------+
*/
#define LIBSPDM_MAX_MESSAGE_K_BUFFER_SIZE (84 + LIBSPDM_MAX_DHE_KEY_SIZE * 2 + \
Expand All @@ -196,11 +211,11 @@ typedef struct {

/*
* +--------------------------+------------------------------------------+---------+
* | FINISH 1.2 | 4 (+ S) + H = [100, 580] | [4, 20] |
* | FINISH_RSP 1.2 | 4 (+ H) = [36, 69] | [1, 3] |
* | FINISH 1.3 | 4 (+ S) + H = [100, 580] | [4, 20] |
* | FINISH_RSP 1.3 | 4 (+ H) = [36, 69] | [1, 3] |
* +--------------------------+------------------------------------------+---------+
* | PSK_FINISH 1.2 | 4 + H = [36, 68] | [1, 3] |
* | PSK_FINISH_RSP 1.2 | 4 | 1 |
* | PSK_FINISH 1.3 | 4 + H = [36, 68] | [1, 3] |
* | PSK_FINISH_RSP 1.3 | 4 | 1 |
* +--------------------------+------------------------------------------+---------+
*/
#define LIBSPDM_MAX_MESSAGE_F_BUFFER_SIZE (8 + LIBSPDM_MAX_HASH_SIZE * 2 + \
Expand All @@ -215,7 +230,9 @@ typedef struct {

#define LIBSPDM_MAX_MESSAGE_TH_BUFFER_SIZE \
(LIBSPDM_MAX_MESSAGE_VCA_BUFFER_SIZE + \
LIBSPDM_MAX_MESSAGE_D_BUFFER_SIZE + \
LIBSPDM_MAX_CERT_CHAIN_SIZE + LIBSPDM_MAX_MESSAGE_K_BUFFER_SIZE + \
LIBSPDM_MAX_MESSAGE_D_BUFFER_SIZE + \
LIBSPDM_MAX_CERT_CHAIN_SIZE + LIBSPDM_MAX_MESSAGE_F_BUFFER_SIZE)

typedef struct {
Expand Down Expand Up @@ -295,6 +312,7 @@ typedef struct {
typedef struct {
/* the message_a must be plan text because we do not know the algorithm yet.*/
libspdm_vca_managed_buffer_t message_a;
libspdm_message_d_managed_buffer_t message_d;
#if LIBSPDM_RECORD_TRANSCRIPT_DATA_SUPPORT
libspdm_message_b_managed_buffer_t message_b;
libspdm_message_c_managed_buffer_t message_c;
Expand All @@ -308,34 +326,43 @@ typedef struct {
#endif
} libspdm_transcript_t;

/* TH for KEY_EXCHANGE response signature: Concatenate (A, Ct, K)
/* TH for KEY_EXCHANGE response signature: Concatenate (A, D, Ct, K)
* D = DIGEST, if MULTI_KEY_CONN_RSP
* Ct = certificate chain
* K = Concatenate (KEY_EXCHANGE request, KEY_EXCHANGE response\signature+verify_data)*/

/* TH for KEY_EXCHANGE response HMAC: Concatenate (A, Ct, K)
/* TH for KEY_EXCHANGE response HMAC: Concatenate (A, D, Ct, K)
* D = DIGEST, if MULTI_KEY_CONN_RSP
* Ct = certificate chain
* K = Concatenate (KEY_EXCHANGE request, KEY_EXCHANGE response\verify_data)*/

/* TH for FINISH request signature: Concatenate (A, Ct, K, CM, F)
/* TH for FINISH request signature: Concatenate (A, D, Ct, K, EncapD, CM, F)
* D = DIGEST, if MULTI_KEY_CONN_RSP
* Ct = certificate chain
* K = Concatenate (KEY_EXCHANGE request, KEY_EXCHANGE response)*/
/* CM = mutual certificate chain *
* K = Concatenate (KEY_EXCHANGE request, KEY_EXCHANGE response)
* EncapD = Encap DIGEST, if MULTI_KEY_CONN_REQ
* CM = mutual certificate chain
* F = Concatenate (FINISH request\signature+verify_data)*/

/* TH for FINISH response HMAC: Concatenate (A, Ct, K, CM, F)
/* TH for FINISH response HMAC: Concatenate (A, D, Ct, K, EncapD, CM, F)
* D = DIGEST, if MULTI_KEY_CONN_RSP
* Ct = certificate chain
* K = Concatenate (KEY_EXCHANGE request, KEY_EXCHANGE response)*/
/* CM = mutual certificate chain *
* K = Concatenate (KEY_EXCHANGE request, KEY_EXCHANGE response)
* EncapD = Encap DIGEST, if MULTI_KEY_CONN_REQ
* CM = mutual certificate chain, if MutAuth
* F = Concatenate (FINISH request\verify_data)*/

/* th1: Concatenate (A, Ct, K)
/* th1: Concatenate (A, D, Ct, K)
* D = DIGEST, if MULTI_KEY_CONN_RSP
* Ct = certificate chain
* K = Concatenate (KEY_EXCHANGE request, KEY_EXCHANGE response)*/

/* th2: Concatenate (A, Ct, K, CM, F)
/* th2: Concatenate (A, D, Ct, K, EncapD, CM, F)
* D = DIGEST, if MULTI_KEY_CONN_RSP
* Ct = certificate chain
* K = Concatenate (KEY_EXCHANGE request, KEY_EXCHANGE response)*/
/* CM = mutual certificate chain *
* K = Concatenate (KEY_EXCHANGE request, KEY_EXCHANGE response)
* EncapD = Encap DIGEST, if MULTI_KEY_CONN_REQ
* CM = mutual certificate chain, if MutAuth
* F = Concatenate (FINISH request, FINISH response)*/

/* TH for PSK_EXCHANGE response HMAC: Concatenate (A, K)
Expand All @@ -357,6 +384,7 @@ typedef struct {
* F = Concatenate (PSK_FINISH request, PSK_FINISH response)*/

typedef struct {
libspdm_message_d_managed_buffer_t message_encap_d;
#if LIBSPDM_RECORD_TRANSCRIPT_DATA_SUPPORT
libspdm_message_k_managed_buffer_t message_k;
libspdm_message_f_managed_buffer_t message_f;
Expand Down Expand Up @@ -1172,6 +1200,14 @@ void libspdm_append_msg_log(libspdm_context_t *spdm_context, void *message, size
**/
void libspdm_reset_message_a(libspdm_context_t *spdm_context);

/**
* Reset message D cache in SPDM context.
*
* @param spdm_context A pointer to the SPDM context.
* @param spdm_session_info A pointer to the SPDM session context.
**/
void libspdm_reset_message_d(libspdm_context_t *spdm_context);

/**
* Reset message B cache in SPDM context.
*
Expand Down Expand Up @@ -1218,6 +1254,14 @@ void libspdm_reset_message_m(libspdm_context_t *spdm_context, void *session_info
**/
void libspdm_reset_message_k(libspdm_context_t *spdm_context, void *spdm_session_info);

/**
* Reset message EncapD cache in SPDM context.
*
* @param spdm_context A pointer to the SPDM context.
* @param spdm_session_info A pointer to the SPDM session context.
**/
void libspdm_reset_message_encap_d(libspdm_context_t *spdm_context, void *spdm_session_info);

/**
* Reset message F cache in SPDM context.
*
Expand All @@ -1238,6 +1282,20 @@ void libspdm_reset_message_f(libspdm_context_t *spdm_context, void *spdm_session
**/
libspdm_return_t libspdm_append_message_a(libspdm_context_t *spdm_context, const void *message,
size_t message_size);

/**
* Append message D cache in SPDM context.
*
* @param spdm_context A pointer to the SPDM context.
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_d(libspdm_context_t *spdm_context, const void *message,
size_t message_size);

/**
* Append message B cache in SPDM context.
*
Expand Down Expand Up @@ -1324,6 +1382,23 @@ libspdm_return_t libspdm_append_message_k(libspdm_context_t *spdm_context,
bool is_requester, const void *message,
size_t message_size);

/**
* Append message EncapD cache in SPDM context.
*
* @param spdm_context A pointer to the SPDM context.
* @param spdm_session_info A pointer to the SPDM session context.
* @param is_requester Indicate of the key generation for a requester or a responder.
* @param message Message buffer.
* @param message_size Size in bytes of message buffer.
*
* @return RETURN_SUCCESS message is appended.
* @return RETURN_OUT_OF_RESOURCES message is not appended because the internal cache is full.
**/
libspdm_return_t libspdm_append_message_encap_d(libspdm_context_t *spdm_context,
void *spdm_session_info,
bool is_requester, const void *message,
size_t message_size);

/**
* Append message F cache in SPDM context.
*
Expand Down
15 changes: 9 additions & 6 deletions include/library/spdm_common_lib.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@ typedef enum {
LIBSPDM_DATA_SEQUENCE_NUMBER_ENDIAN,
LIBSPDM_DATA_SESSION_SEQUENCE_NUMBER_ENDIAN,

LIBSPDM_DATA_MULTI_KEY_CONN_REQ,
LIBSPDM_DATA_MULTI_KEY_CONN_RSP,

/* MAX */
LIBSPDM_DATA_MAX
} libspdm_data_type_t;
Expand Down Expand Up @@ -234,16 +237,16 @@ typedef enum {
/*
* +--------------------------+------------------------------------------+---------+
* | GET_VERSION | 4 | 1 |
* | VERSION {1.0, 1.1, 1.2} | 6 + 2 * 3 = 12 | 1 |
* | VERSION {1.0 ~ 1.3} | 6 + 2 * 4 = 14 | 1 |
* +--------------------------+------------------------------------------+---------+
* | GET_CAPABILITIES 1.2 | 20 | 1 |
* | CAPABILITIES 1.2 | 20 | 1 |
* | GET_CAPABILITIES 1.3 | 20 | 1 |
* | CAPABILITIES 1.3 | 20 [+ 46] | 1 |
* +--------------------------+------------------------------------------+---------+
* | NEGOTIATE_ALGORITHMS 1.2 | 32 + 4 * 4 = 48 | 2 |
* | ALGORITHMS 1.2 | 36 + 4 * 4 = 52 | 2 |
* | NEGOTIATE_ALGORITHMS 1.3 | 32 + 4 * 4 = 48 | 2 |
* | ALGORITHMS 1.3 | 36 + 4 * 4 = 52 | 2 |
* +--------------------------+------------------------------------------+---------+
*/
#define LIBSPDM_MAX_MESSAGE_VCA_BUFFER_SIZE (150 + 2 * LIBSPDM_MAX_VERSION_COUNT)
#define LIBSPDM_MAX_MESSAGE_VCA_BUFFER_SIZE (200 + 2 * LIBSPDM_MAX_VERSION_COUNT)

/**
* Set an SPDM context data.
Expand Down
Loading