spdm_requester_lib.h

/**
 *  Copyright Notice:
 *  Copyright 2021-2026 DMTF. All rights reserved.
 *  License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/libspdm/blob/main/LICENSE.md
 **/

#ifndef SPDM_REQUESTER_LIB_H
#define SPDM_REQUESTER_LIB_H

#ifdef __cplusplus
extern "C" {
#endif

#include "library/spdm_common_lib.h"

/**
 * This function sends GET_VERSION, GET_CAPABILITIES, NEGOTIATE_ALGORITHMS
 * to initialize the connection with SPDM responder.
 *
 * Before this function, the requester configuration data can be set via libspdm_set_data.
 * After this function, the negotiated configuration data can be got via libspdm_get_data.
 *
 * @param  spdm_context      A pointer to the SPDM context.
 * @param  get_version_only  If the requester sends GET_VERSION only or not.
 **/
libspdm_return_t libspdm_init_connection(void *spdm_context, bool get_version_only);

#if LIBSPDM_SEND_GET_CERTIFICATE_SUPPORT
/**
 * This function sends GET_DIGEST to get all digest of the certificate chains from device.
 *
 * TotalDigestSize = sizeof(digest) * count in slot_mask
 *
 * @param  spdm_context         A pointer to the SPDM context.
 * @param  session_id           Indicates if it is a secured message protected via SPDM session.
 *                              If session_id is NULL, it is a normal message.
 *                              If session_id is not NULL, it is a secured message.
 * @param  slot_mask            Bitmask of the slots that contain certificates.
 * @param  total_digest_buffer  A pointer to a destination buffer to store the digests.
 *
 * @retval LIBSPDM_STATUS_SUCCESS
 *         GET_DIGESTS was sent and DIGESTS was received.
 * @retval LIBSPDM_STATUS_INVALID_STATE_LOCAL
 *         Cannot send GET_DIGESTS due to Requester's state.
 * @retval LIBSPDM_STATUS_UNSUPPORTED_CAP
 *         Cannot send GET_DIGESTS because the Requester's and/or Responder's CERT_CAP = 0.
 * @retval LIBSPDM_STATUS_INVALID_MSG_SIZE
 *         The size of the DIGESTS response is invalid.
 * @retval LIBSPDM_STATUS_INVALID_MSG_FIELD
 *         The DIGESTS response contains one or more invalid fields.
 * @retval LIBSPDM_STATUS_ERROR_PEER
 *         The Responder returned an unexpected error.
 * @retval LIBSPDM_STATUS_BUSY_PEER
 *         The Responder continually returned Busy error messages.
 * @retval LIBSPDM_STATUS_RESYNCH_PEER
 *         The Responder returned a RequestResynch error message.
 * @retval LIBSPDM_STATUS_BUFFER_FULL
 *         The buffer used to store transcripts is exhausted.
 **/
libspdm_return_t libspdm_get_digest(void *spdm_context, const uint32_t *session_id,
                                    uint8_t *slot_mask, void *total_digest_buffer);

/**
 * This function sends GET_CERTIFICATE to get certificate chain in one slot from device.
 *
 * This function verify the integrity of the certificate chain.
 * root_hash -> Root certificate -> Intermediate certificate -> Leaf certificate.
 *
 * If the peer root certificate hash is deployed,
 * this function also verifies the digest with the root hash in the certificate chain.
 *
 * @param  spdm_context     A pointer to the SPDM context.
 * @param  session_id       Indicates if it is a secured message protected via SPDM session.
 *                          If session_id is NULL, it is a normal message.
 * @param  slot_id          The number of slot for the certificate chain.
 * @param  cert_chain_size  On input, indicates the size in bytes of the destination buffer.
 *                          On output, indicates the size in bytes of the certificate chain.
 * @param  cert_chain       A pointer to a destination buffer to store the certificate chain.
 *
 * @retval LIBSPDM_STATUS_SUCCESS
 *         GET_CERTIFICATE was sent and CERTIFICATE was received.
 * @retval LIBSPDM_STATUS_INVALID_STATE_LOCAL
 *         Cannot send GET_CERTIFICATE due to Requester's state.
 * @retval LIBSPDM_STATUS_UNSUPPORTED_CAP
 *         Cannot send GET_CERTIFICATE because the Requester's and/or Responder's CERT_CAP = 0.
 * @retval LIBSPDM_STATUS_INVALID_MSG_SIZE
 *         The size of the CERTIFICATE response is invalid.
 * @retval LIBSPDM_STATUS_INVALID_MSG_FIELD
 *         The CERTIFICATE response contains one or more invalid fields.
 * @retval LIBSPDM_STATUS_ERROR_PEER
 *         The Responder returned an unexpected error.
 * @retval LIBSPDM_STATUS_BUSY_PEER
 *         The Responder continually returned Busy error messages.
 * @retval LIBSPDM_STATUS_RESYNCH_PEER
 *         The Responder returned a RequestResynch error message.
 * @retval LIBSPDM_STATUS_BUFFER_FULL
 *         The buffer used to store transcripts is exhausted.
 * @retval LIBSPDM_STATUS_VERIF_FAIL
 *         Verification of the certificate chain failed.
 * @retval LIBSPDM_STATUS_INVALID_CERT
 *         The certificate is unable to be parsed or contains invalid field values.
 * @retval LIBSPDM_STATUS_CRYPTO_ERROR
 *         A generic cryptography error occurred.
 **/
libspdm_return_t libspdm_get_certificate(void *spdm_context,
                                         const uint32_t *session_id,
                                         uint8_t slot_id,
                                         size_t *cert_chain_size,
                                         void *cert_chain);

/**
 * This function sends GET_CERTIFICATE to get certificate chain in one slot from the device,
 * and allows the Integrator to specify the size of the certificate chain blocks.
 *
 * This function verifies the integrity of the certificate chain:
 * root_hash -> Root certificate -> Intermediate certificate -> Leaf certificate.
 *
 * If the peer root certificate hash is deployed, this function also verifies the digest with the
 * root hash in the certificate chain.
 *
 * @param  spdm_context       A pointer to the SPDM context.
 * @param  session_id         Indicates if it is a secured message protected via SPDM session.
 *                            If session_id is NULL, it is a normal message.
 * @param  slot_id            The number of slot for the certificate chain.
 * @param  length             The length of the certificate chain block to retrieve.
 *                            If length is 0, the default maximum block size will be used.
 * @param  cert_chain_size    On input, indicates the size in bytes of the destination buffer.
 *                            On output, indicates the size in bytes of the certificate chain.
 * @param  cert_chain         A pointer to a destination buffer to store the certificate chain.
 * @param  trust_anchor       A buffer to hold the trust_anchor which is used to validate the peer certificate, if not NULL.
 * @param  trust_anchor_size  A buffer to hold the trust_anchor_size, if not NULL.
 **/
libspdm_return_t libspdm_get_certificate_ex(void *spdm_context,
                                            const uint32_t *session_id,
                                            uint8_t slot_id,
                                            uint32_t length,
                                            size_t *cert_chain_size,
                                            void *cert_chain,
                                            const void **trust_anchor,
                                            size_t *trust_anchor_size);
/**
 * This function sends GET_CERTIFICATE to get the storage size of the certificate chain slot from the device.
 *
 * @param  spdm_context        A pointer to the SPDM context.
 * @param  session_id          Indicates if it is a secured message protected via SPDM session.
 *                             If session_id is NULL, it is a normal message.
 * @param  slot_id             The number of slot for the certificate chain.
 * @param  slot_storage_size   On output, indicate the slot storage size.
 */
libspdm_return_t libspdm_get_slot_storage_size(void *spdm_context, const uint32_t *session_id,
                                               uint8_t slot_id, uint32_t *slot_storage_size);
#endif /* LIBSPDM_SEND_GET_CERTIFICATE_SUPPORT */

#if LIBSPDM_SEND_CHALLENGE_SUPPORT
/**
 * This function sends CHALLENGE to authenticate the device based upon the key in one slot.
 *
 * This function verifies the signature in the challenge auth.
 *
 * If basic mutual authentication is requested from the responder,
 * this function also perform the basic mutual authentication.
 *
 * @param  spdm_context           A pointer to the SPDM context.
 * @param  reserved               Reserved for session_id and is ignored.
 * @param  slot_id                The number of slot for the challenge.
 * @param  measurement_hash_type  The type of the measurement hash.
 * @param  measurement_hash       A pointer to a destination buffer to store the measurement hash.
 * @param  slot_mask              A pointer to a destination to store the slot mask.
 **/
libspdm_return_t libspdm_challenge(void *spdm_context, void *reserved,
                                   uint8_t slot_id,
                                   uint8_t measurement_hash_type,
                                   void *measurement_hash,
                                   uint8_t *slot_mask);

/**
 * This function sends CHALLENGE to authenticate the device based upon the key in one slot.
 *
 * This function verifies the signature in the challenge auth.
 *
 * If basic mutual authentication is requested from the responder,
 * this function also performs the basic mutual authentication.
 *
 * @param  spdm_context           A pointer to the SPDM context.
 * @param  reserved               Reserved for session_id and is ignored.
 * @param  slot_id                The number of slot for the challenge.
 * @param  measurement_hash_type  The type of the measurement hash.
 * @param  measurement_hash       A pointer to a destination buffer to store the measurement hash.
 * @param  slot_mask              A pointer to a destination to store the slot mask.
 * @param  requester_nonce_in     A buffer to hold the requester nonce (32 bytes) as input, if not NULL.
 * @param  requester_nonce        A buffer to hold the requester nonce (32 bytes), if not NULL.
 * @param  responder_nonce        A buffer to hold the responder nonce (32 bytes), if not NULL.
 * @param  opaque_data            A buffer to hold the responder opaque data, if not NULL.
 * @param  opaque_data_size       On input, the size of the opaque data buffer.
 *                                Responder opaque data should be less than 1024 bytes.
 *                                On output, the size of the opaque data.
 **/
libspdm_return_t libspdm_challenge_ex(void *spdm_context, void *reserved,
                                      uint8_t slot_id,
                                      uint8_t measurement_hash_type,
                                      void *measurement_hash,
                                      uint8_t *slot_mask,
                                      const void *requester_nonce_in,
                                      void *requester_nonce,
                                      void *responder_nonce,
                                      void *opaque_data,
                                      size_t *opaque_data_size);

/**
 * This function sends CHALLENGE to authenticate the device based upon the key in one slot.
 *
 * This function verifies the signature in the challenge auth.
 *
 * If basic mutual authentication is requested from the responder,
 * this function also performs the basic mutual authentication.
 *
 * @param  spdm_context           A pointer to the SPDM context.
 * @param  reserved               Reserved for session_id and is ignored.
 * @param  slot_id                The number of slot for the challenge.
 * @param  requester_context      A buffer to hold the requester context (8 bytes) as input, if not NULL.
 *                                It is used only if the negotiated version >= 1.3.
 * @param  measurement_hash_type  The type of the measurement hash.
 * @param  measurement_hash       A pointer to a destination buffer to store the measurement hash.
 * @param  slot_mask              A pointer to a destination to store the slot mask.
 * @param  requester_nonce_in     A buffer to hold the requester nonce (32 bytes) as input, if not NULL.
 * @param  requester_nonce        A buffer to hold the requester nonce (32 bytes), if not NULL.
 * @param  responder_nonce        A buffer to hold the responder nonce (32 bytes), if not NULL.
 * @param  opaque_data            A buffer to hold the responder opaque data, if not NULL.
 * @param  opaque_data_size       On input, the size of the opaque data buffer.
 *                                Responder opaque data should be less than 1024 bytes.
 *                                On output, the size of the opaque data.
 **/
libspdm_return_t libspdm_challenge_ex2(void *spdm_context, void *reserved,
                                       uint8_t slot_id,
                                       const void *requester_context,
                                       uint8_t measurement_hash_type,
                                       void *measurement_hash,
                                       uint8_t *slot_mask,
                                       const void *requester_nonce_in,
                                       void *requester_nonce,
                                       void *responder_nonce,
                                       void *opaque_data,
                                       size_t *opaque_data_size);
#endif /* LIBSPDM_SEND_CHALLENGE_SUPPORT */

#if LIBSPDM_ENABLE_CAPABILITY_MEAS_CAP
/**
 * This function sends GET_MEASUREMENT
 * to get measurement from the device.
 *
 * If the signature is requested, this function verifies the signature of the measurement.
 *
 * @param  spdm_context               A pointer to the SPDM context.
 * @param  session_id                 Indicates if it is a secured message protected via SPDM session.
 *                                    If session_id is NULL, it is a normal message.
 *                                    If session_id is NOT NULL, it is a secured message.
 * @param  request_attribute          The request attribute of the request message.
 * @param  measurement_operation      The measurement operation of the request message.
 * @param  slot_id                    The number of slot for the certificate chain.
 * @param  content_changed            The measurement content changed output param.
 * @param  number_of_blocks           The number of blocks of the measurement record.
 * @param  measurement_record_length  On input, indicate the size in bytes of the destination buffer to store the measurement record.
 *                                    On output, indicate the size in bytes of the measurement record.
 * @param  measurement_record         A pointer to a destination buffer to store the measurement record.
 **/
libspdm_return_t libspdm_get_measurement(void *spdm_context, const uint32_t *session_id,
                                         uint8_t request_attribute,
                                         uint8_t measurement_operation,
                                         uint8_t slot_id,
                                         uint8_t *content_changed,
                                         uint8_t *number_of_blocks,
                                         uint32_t *measurement_record_length,
                                         void *measurement_record);

/**
 * This function sends GET_MEASUREMENT to get measurement from the device.
 *
 * If the signature is requested, this function verifies the signature of the measurement.
 *
 * @param  spdm_context               A pointer to the SPDM context.
 * @param  session_id                 Indicates if it is a secured message protected via SPDM session.
 *                                    If session_id is NULL, it is a normal message.
 *                                    If session_id is NOT NULL, it is a secured message.
 * @param  request_attribute          The request attribute of the request message.
 * @param  measurement_operation      The measurement operation of the request message.
 * @param  slot_id                    The number of slot for the certificate chain.
 * @param  content_changed            The measurement content changed output param.
 * @param  number_of_blocks           The number of blocks of the measurement record.
 * @param  measurement_record_length  On input, indicate the size in bytes of the destination buffer to store the measurement record.
 *                                    On output, indicate the size in bytes of the measurement record.
 * @param  measurement_record         A pointer to a destination buffer to store the measurement record.
 * @param  requester_nonce_in         A buffer to hold the requester nonce (32 bytes) as input, if not NULL.
 * @param  requester_nonce            A buffer to hold the requester nonce (32 bytes), if not NULL.
 * @param  responder_nonce            A buffer to hold the responder nonce (32 bytes), if not NULL.
 * @param  opaque_data                A buffer to hold the responder opaque data, if not NULL.
 * @param  opaque_data_size           On input, the size of the opaque data buffer.
 *                                    Responder opaque data should be less than 1024 bytes.
 *                                    On output, the size of the opaque data.
 **/
libspdm_return_t libspdm_get_measurement_ex(void *spdm_context, const uint32_t *session_id,
                                            uint8_t request_attribute,
                                            uint8_t measurement_operation,
                                            uint8_t slot_id,
                                            uint8_t *content_changed,
                                            uint8_t *number_of_blocks,
                                            uint32_t *measurement_record_length,
                                            void *measurement_record,
                                            const void *requester_nonce_in,
                                            void *requester_nonce,
                                            void *responder_nonce,
                                            void *opaque_data,
                                            size_t *opaque_data_size);

/**
 * This function sends GET_MEASUREMENT to get measurement from the device.
 *
 * If the signature is requested, this function verifies the signature of the measurement.
 *
 * @param  spdm_context               A pointer to the SPDM context.
 * @param  session_id                 Indicates if it is a secured message protected via SPDM session.
 *                                    If session_id is NULL, it is a normal message.
 *                                    If session_id is NOT NULL, it is a secured message.
 * @param  request_attribute          The request attribute of the request message.
 * @param  measurement_operation      The measurement operation of the request message.
 * @param  slot_id                    The number of slot for the certificate chain.
 * @param  requester_context          A buffer to hold the requester context (8 bytes) as input, if not NULL.
 *                                    It is used only if the negotiated version >= 1.3.
 * @param  content_changed            The measurement content changed output param.
 * @param  number_of_blocks           The number of blocks of the measurement record.
 * @param  measurement_record_length  On input, indicate the size in bytes of the destination buffer to store the measurement record.
 *                                    On output, indicate the size in bytes of the measurement record.
 * @param  measurement_record         A pointer to a destination buffer to store the measurement record.
 * @param  requester_nonce_in         A buffer to hold the requester nonce (32 bytes) as input, if not NULL.
 * @param  requester_nonce            A buffer to hold the requester nonce (32 bytes), if not NULL.
 * @param  responder_nonce            A buffer to hold the responder nonce (32 bytes), if not NULL.
 * @param  opaque_data                A buffer to hold the responder opaque data, if not NULL.
 * @param  opaque_data_size           On input, the size of the opaque data buffer.
 *                                    Responder opaque data should be less than 1024 bytes.
 *                                    On output, the size of the opaque data.
 **/
libspdm_return_t libspdm_get_measurement_ex2(void *spdm_context, const uint32_t *session_id,
                                             uint8_t request_attribute,
                                             uint8_t measurement_operation,
                                             uint8_t slot_id,
                                             const void *requester_context,
                                             uint8_t *content_changed,
                                             uint8_t *number_of_blocks,
                                             uint32_t *measurement_record_length,
                                             void *measurement_record,
                                             const void *requester_nonce_in,
                                             void *requester_nonce,
                                             void *responder_nonce,
                                             void *opaque_data,
                                             size_t *opaque_data_size);
#endif /* LIBSPDM_ENABLE_CAPABILITY_MEAS_CAP*/

#if LIBSPDM_SEND_GET_ENDPOINT_INFO_SUPPORT
/**
 * This function sends GET_ENDPOINT_INFO from the device *
 *
 *
 * @param  context                    A pointer to the SPDM context.
 * @param  session_id                 Indicates if it is a secured message protected via SPDM session.
 *                                    If session_id is NULL, it is a normal message.
 *                                    If session_id is not NULL, it is a secured message.
 * @param  request_attributes         The request attribute of the request message.
 * @param  sub_code                   The subcode of endpoint info.
 * @param  slot_id                    The number of slot for the endpoint info.
 * @param  ep_info_len                On input, indicate the size in bytes of the destination buffer
 *                                    to store the endpoint info record.
 *                                    On output, indicate the size in bytes of the endpoint info record.
 * @param  ep_info                    A pointer to a destination buffer to store the endpoint info record.
 * @param  requester_nonce_in         A buffer to hold the requester nonce (32 bytes) as input, if not NULL.
 * @param  requester_nonce            A buffer to hold the requester nonce (32 bytes), if not NULL.
 * @param  responder_nonce            A buffer to hold the responder nonce (32 bytes), if not NULL.
 *
 **/
libspdm_return_t libspdm_get_endpoint_info(void *spdm_context,
                                           const uint32_t *session_id,
                                           uint8_t request_attributes,
                                           uint8_t sub_code,
                                           uint8_t slot_id,
                                           uint32_t *ep_info_len,
                                           void *ep_info,
                                           const void *requester_nonce_in,
                                           void *requester_nonce,
                                           void *responder_nonce);
#endif /* LIBSPDM_SEND_GET_ENDPOINT_INFO_SUPPORT */


#if LIBSPDM_ENABLE_CAPABILITY_MEL_CAP
/**
 * This function sends GET_MEASUREMENT_EXTENSION_LOG to get MEL from device.
 *
 * @param  spdm_context               A pointer to the SPDM context.
 * @param  session_id                 Indicates if it is a secured message protected via SPDM session.
 *                                    If session_id is NULL, it is a normal message.
 *                                    If session_id is not NULL, it is a secured message.
 * @param  mel_size                   On input, indicate the size in bytes of the destination buffer to store.
 *                                    On output, indicate the size in bytes of the MEL.
 * @param  measure_exten_log          A pointer to a destination buffer to store the MEL.
 **/
libspdm_return_t libspdm_get_measurement_extension_log(void *spdm_context,
                                                       const uint32_t *session_id,
                                                       size_t *mel_size,
                                                       void *measure_exten_log);
#endif /* LIBSPDM_ENABLE_CAPABILITY_MEL_CAP */

#if LIBSPDM_ENABLE_CAPABILITY_GET_KEY_PAIR_INFO_CAP
/**
 * This function sends GET_KEY_PAIR_INFO to get key pair info from device.
 *
 * @param  spdm_context               A pointer to the SPDM context.
 * @param  session_id                 Indicates if it is a secured message protected via SPDM session.
 *                                    If session_id is NULL, it is a normal message.
 *                                    If session_id is not NULL, it is a secured message.
 * @param  key_pair_id                Indicate which key pair ID's information to retrieve.
 *
 * @param  total_key_pairs            Indicate the total number of key pairs on the responder.
 * @param  capabilities               Indicate the capabilities of the requested key pairs.
 * @param  key_usage_capabilities     Indicate the key usages the responder allows.
 * @param  current_key_usage          Indicate the currently configured key usage for the requested key pairs ID.
 * @param  asym_algo_capabilities     Indicate the asymmetric algorithms the Responder supports for this key pair ID.
 * @param  current_asym_algo          Indicate the currently configured asymmetric algorithm for this key pair ID.
 * @param  pqc_asym_algo_capabilities Indicate the post-quantum cryptography asymmetric algorithms the Responder supports for this key pair ID.
 * @param  current_pqc_asym_algo      Indicate the currently configured post-quantum cryptography asymmetric algorithm for this key pair ID.
 * @param  assoc_cert_slot_mask       This field is a bit mask representing the currently associated certificate slots.
 * @param  public_key_info_len        On input, indicate the size in bytes of the destination buffer to store.
 *                                    On output, indicate the size in bytes of the public_key_info.
 * @param  public_key_info            A pointer to a destination buffer to store the public_key_info.
 **/
libspdm_return_t libspdm_get_key_pair_info(void *spdm_context, const uint32_t *session_id,
                                           uint8_t key_pair_id, uint8_t *total_key_pairs,
                                           uint16_t *capabilities,
                                           uint16_t *key_usage_capabilities,
                                           uint16_t *current_key_usage,
                                           uint32_t *asym_algo_capabilities,
                                           uint32_t *current_asym_algo,
                                           uint32_t *pqc_asym_algo_capabilities,
                                           uint32_t *current_pqc_asym_algo,
                                           uint8_t *assoc_cert_slot_mask,
                                           uint16_t *public_key_info_len,
                                           void *public_key_info
                                           );

#endif /* LIBSPDM_ENABLE_CAPABILITY_GET_KEY_PAIR_INFO_CAP */

#if LIBSPDM_ENABLE_CAPABILITY_SET_KEY_PAIR_INFO_CAP
/**
 * This function sends GET_KEY_PAIR_INFO to get key pair info from device.
 *
 * @param  spdm_context                 A pointer to the SPDM context.
 * @param  session_id                   Indicates if it is a secured message protected via SPDM session.
 *                                      If session_id is NULL, it is a normal message.
 *                                      If session_id is not NULL, it is a secured message.
 * @param  key_pair_id                  Indicate which key pair ID's information to retrieve.
 * @param  operation                    Set key pair info operation: change/erase/generate.
 * @param  desired_key_usage            Indicate the desired key usage for the requested key pair ID.
 * @param  desired_asym_algo            Indicate the desired asymmetric algorithm for the requested key pair ID.
 * @param  desired_pqc_asym_algo        Indicate the desired PQC asymmetric algorithm for the requested key pair ID.
 * @param  desired_assoc_cert_slot_mask Indicate the desired certificate slot association for the requested key pair ID.
 **/
libspdm_return_t libspdm_set_key_pair_info(void *spdm_context, const uint32_t *session_id,
                                           uint8_t key_pair_id,
                                           uint8_t operation,
                                           uint16_t desired_key_usage,
                                           uint32_t desired_asym_algo,
                                           uint32_t desired_pqc_asym_algo,
                                           uint8_t desired_assoc_cert_slot_mask
                                           );
#endif /* LIBSPDM_ENABLE_CAPABILITY_SET_KEY_PAIR_INFO_CAP */

#if (LIBSPDM_ENABLE_CAPABILITY_KEY_EX_CAP) || (LIBSPDM_ENABLE_CAPABILITY_PSK_CAP)
/**
 * This function sends KEY_EXCHANGE/FINISH or PSK_EXCHANGE/PSK_FINISH
 * to start an SPDM Session.
 *
 * If encapsulated mutual authentication is requested from the responder,
 * this function also perform the encapsulated mutual authentication.
 *
 * @param  spdm_context           A pointer to the SPDM context.
 * @param  use_psk                False means to use KEY_EXCHANGE/FINISH to start a session.
 *                                True means to use PSK_EXCHANGE/PSK_FINISH to start a session.
 * @param  psk_hint               The psk_hint in PSK_EXCHANGE. It is ignored if use_psk is false.
 * @param  psk_hint_size          The size in bytes of psk_hint. It is ignored if use_psk is false.
 * @param  measurement_hash_type  The type of the measurement hash.
 * @param  slot_id                The number of slot for the certificate chain.
 * @param  session_policy         The policy for the session.
 * @param  session_id             The session ID of the session.
 * @param  heartbeat_period       The heartbeat period for the session.
 * @param  measurement_hash       A pointer to a destination buffer to store the measurement hash.
 **/
libspdm_return_t libspdm_start_session(void *spdm_context, bool use_psk,
                                       const void *psk_hint,
                                       uint16_t psk_hint_size,
                                       uint8_t measurement_hash_type,
                                       uint8_t slot_id,
                                       uint8_t session_policy,
                                       uint32_t *session_id,
                                       uint8_t *heartbeat_period,
                                       void *measurement_hash);

/**
 * This function retrieves the supported algorithms from the responder.
 * It sends the GET_VERSION and GET_CAPABILITIES requests, where GET_CAPABILITIES.Param1[0] is set.
 * If the Responder supports this extended capability, the Responder will include the Supported
 * Algorithms Block in its CAPABILITIES response.
 *
 * @param spdm_context                          A pointer to the SPDM context.
 * @param responder_supported_algorithms_length  On input, indicates the size in bytes of the provided buffer.
 *                                              The buffer must be large enough to hold the supported algorithms block.
 *                                              On output, the size in bytes of the supported algorithms data.
 * @param responder_supported_algorithms_buffer  A pointer to a destination buffer to store the supported algorithms.
 *                                              Must not be NULL. The buffer must be large enough to hold the supported algorithms data.
 * @param spdm_version                          A pointer to store the SPDM version used for the request.
 *
 * @retval RETURN_SUCCESS                        The supported algorithms were successfully retrieved.
 * @retval RETURN_DEVICE_ERROR                   A device error occurs when communicates with the device.
 * @retval RETURN_UNSUPPORTED                    The operation is not supported by the device.
 * @retval RETURN_SECURITY_VIOLATION             Any verification fails.
 *
 * @note   The buffer must be large enough to hold the supported algorithms block.
 *         The function will assert if responder_supported_algorithms_buffer is NULL.
 */
libspdm_return_t libspdm_get_supported_algorithms(void *spdm_context,
                                                  size_t *responder_supported_algorithms_length,
                                                  void *responder_supported_algorithms_buffer,
                                                  uint8_t *spdm_version);

/**
 * This function sends KEY_EXCHANGE or PSK_EXCHANGE to start an SPDM Session.
 *
 * If encapsulated mutual authentication is requested from the responder,
 * this function also perform the encapsulated mutual authentication.
 *
 * @param  spdm_context               A pointer to the SPDM context.
 * @param  use_psk                    False means to use KEY_EXCHANGE to start a session.
 *                                    True means to use PSK_EXCHANGE to start a session.
 * @param  psk_hint                   The psk_hint in PSK_EXCHANGE. It is ignored if use_psk is false.
 * @param  psk_hint_size              The size in bytes of psk_hint. It is ignored if use_psk is false.
 * @param  measurement_hash_type      The type of the measurement hash.
 * @param  slot_id                    The number of slot for the certificate chain.
 * @param  session_policy             The policy for the session.
 * @param  session_id                 The session ID of the session.
 * @param  heartbeat_period           The heartbeat period for the session.
 * @param  measurement_hash           A pointer to a destination buffer to store the measurement hash.
 * @param  requester_random_in        A buffer to hold the requester random as input, if not NULL.
 * @param  requester_random_in_size   The size of requester_random_in.
 *                                    If use_psk is false, it must be 32 bytes.
 *                                    If use_psk is true, it means the PSK context and must be 32 bytes at least,
 *                                    but not exceed LIBSPDM_PSK_CONTEXT_LENGTH.
 * @param  requester_random           A buffer to hold the requester random, if not NULL.
 * @param  requester_random_size      On input, the size of requester_random buffer.
 *                                    On output, the size of data returned in requester_random buffer.
 *                                    If use_psk is false, it must be 32 bytes.
 *                                    If use_psk is true, it means the PSK context and must be 32 bytes at least.
 * @param  responder_random           A buffer to hold the responder random, if not NULL.
 * @param  responder_random_size      On input, the size of requester_random buffer.
 *                                    On output, the size of data returned in requester_random buffer.
 *                                    If use_psk is false, it must be 32 bytes.
 *                                    If use_psk is true, it means the PSK context. It could be 0 if device does not support context.
 * @param  requester_opaque_data      A buffer to hold the requester opaque data, if not NULL.
 *                                    If not NULL, this function will not generate any opaque data,
 *                                    including secured message versions.
 * @param  requester_opaque_data_size The size of the opaque data, if requester_opaque_data is not NULL.
 * @param  responder_opaque_data      A buffer to hold the responder opaque data, if not NULL.
 * @param  responder_opaque_data_size On input, the size of the opaque data buffer.
 *                                    Opaque data should be less than 1024 bytes.
 *                                    On output, the size of the opaque data.
 **/
libspdm_return_t libspdm_start_session_exchange(void *spdm_context, bool use_psk,
                                                const void *psk_hint,
                                                uint16_t psk_hint_size,
                                                uint8_t measurement_hash_type,
                                                uint8_t slot_id,
                                                uint8_t session_policy,
                                                uint32_t *session_id,
                                                uint8_t *heartbeat_period,
                                                void *measurement_hash,
                                                const void *requester_random_in,
                                                size_t requester_random_in_size,
                                                void *requester_random,
                                                size_t *requester_random_size,
                                                void *responder_random,
                                                size_t *responder_random_size,
                                                const void *requester_opaque_data,
                                                size_t requester_opaque_data_size,
                                                void *responder_opaque_data,
                                                size_t *responder_opaque_data_size);

/**
 * This function sends FINISH or PSK_FINISH to start an SPDM Session.
 *
 * @param  spdm_context               A pointer to the SPDM context.
 * @param  session_id                 The session ID of the session.
 * @param  requester_opaque_data      A buffer to hold the requester opaque data, if not NULL.
 *                                    If not NULL, this function will not generate any opaque data,
 *                                    including secured message versions.
 *                                    This parameter is only used for SPDM 1.4 and later
 * @param  requester_opaque_data_size The size of the opaque data, if requester_opaque_data is not NULL.
 *                                    This parameter is only used for SPDM 1.4 and later
 * @param  responder_opaque_data      A buffer to hold the responder opaque data, if not NULL.
 *                                    This parameter is only used for SPDM 1.4 and later
 * @param  responder_opaque_data_size On input, the size of the opaque data buffer.
 *                                    Opaque data should be less than 1024 bytes.
 *                                    On output, the size of the opaque data.
 *                                    This parameter is only used for SPDM 1.4 and later
 */
libspdm_return_t libspdm_start_session_finish(void *spdm_context,
                                              uint32_t session_id,
                                              const void *requester_opaque_data,
                                              size_t requester_opaque_data_size,
                                              void *responder_opaque_data,
                                              size_t *responder_opaque_data_size);

/**
 * This function sends END_SESSION to stop an SPDM Session.
 *
 * @param  spdm_context            A pointer to the SPDM context.
 * @param  session_id              The session ID of the session.
 * @param  end_session_attributes  The end session attribute for the session.
 **/
libspdm_return_t libspdm_stop_session(void *spdm_context, uint32_t session_id,
                                      uint8_t end_session_attributes);
#endif /* (LIBSPDM_ENABLE_CAPABILITY_KEY_EX_CAP) || (LIBSPDM_ENABLE_CAPABILITY_PSK_CAP) */

/**
 * Send an SPDM or APP message.
 *
 * The SPDM message can be a normal message or a secured message in SPDM session.
 *
 * The APP message is encoded to a secured message directly in SPDM session.
 * The APP message format is defined by the transport layer.
 * Take MCTP as example: APP message == MCTP header (MCTP_MESSAGE_TYPE_SPDM) + SPDM message
 *
 * @param  spdm_context    A pointer to the SPDM context.
 * @param  session_id      Indicates if it is a secured message protected via SPDM session.
 *                         If session_id is NULL, it is a normal message.
 *                         If session_id is NOT NULL, it is a secured message.
 * @param  is_app_message  Indicates if it is an APP message or SPDM message.
 * @param  request         A pointer to the request data.
 * @param  request_size    Size in bytes of the request data.
 **/
libspdm_return_t libspdm_send_data(void *spdm_context, const uint32_t *session_id,
                                   bool is_app_message,
                                   const void *request, size_t request_size);

/**
 * Receive an SPDM or APP message.
 *
 * The SPDM message can be a normal message or a secured message in SPDM session.
 *
 * The APP message is encoded to a secured message directly in SPDM session.
 * The APP message format is defined by the transport layer.
 * Take MCTP as example: APP message == MCTP header (MCTP_MESSAGE_TYPE_SPDM) + SPDM message
 *
 * @param  spdm_context    A pointer to the SPDM context.
 * @param  session_id      Indicates if it is a secured message protected via SPDM session.
 *                         If session_id is NULL, it is a normal message.
 *                         If session_id is NOT NULL, it is a secured message.
 * @param  is_app_message  Indicates if it is an APP message or SPDM message.
 * @param  response        A pointer to the response data.
 * @param  response_size   Size in bytes of the response data.
 *                         On input, it means the size in bytes of response data buffer.
 *                         On output, it means the size in bytes of copied response data buffer if
 *                         LIBSPDM_STATUS_SUCCESS is returned, and means the size in bytes of
 *                         desired response data buffer if LIBSPDM_STATUS_BUFFER_TOO_SMALL is
 *                         returned.
 **/
libspdm_return_t libspdm_receive_data(void *spdm_context, const uint32_t *session_id,
                                      bool is_app_message,
                                      void *response, size_t *response_size);

/**
 * Send and receive an SPDM or APP message.
 *
 * The SPDM message can be a normal message or a secured message in SPDM session.
 * This API handles SPDM chunking when sending and receiving SPDM messages.
 *
 * The APP message is encoded to a secured message directly in SPDM session.
 * The APP message format is defined by the transport layer.
 * This API does not handle APP message chunking.
 * Take MCTP as example: APP message == MCTP header (MCTP_MESSAGE_TYPE_SPDM) + SPDM message
 *
 * @param  spdm_context    A pointer to the SPDM context.
 * @param  session_id      Indicates if it is a secured message protected via SPDM session.
 *                         If session_id is NULL, it is a normal message.
 *                         If session_id is NOT NULL, it is a secured message.
 * @param  is_app_message  Indicates if it is an APP message or SPDM message.
 * @param  request         A pointer to the request data.
 * @param  request_size    Size in bytes of the request data.
 * @param  response        A pointer to the response data.
 * @param  response_size   Size in bytes of the response data.
 *                         On input, it means the size in bytes of response data buffer.
 *                         On output, it means the size in bytes of copied response data buffer if
 *                         LIBSPDM_STATUS_SUCCESS is returned, and means the size in bytes of
 *                         desired response data buffer if LIBSPDM_STATUS_BUFFER_TOO_SMALL is
 *                         returned.
 **/
libspdm_return_t libspdm_send_receive_data(void *spdm_context,
                                           const uint32_t *session_id,
                                           bool is_app_message,
                                           const void *request, size_t request_size,
                                           void *response, size_t *response_size);

/**
 * Send and receive an SPDM message.
 *
 * The SPDM message can be a normal message or a secured message in SPDM session.
 * This API handles SPDM chunking.
 *
 *
 * @param  spdm_context    A pointer to the SPDM context.
 * @param  session_id      Indicates if it is a secured message protected via SPDM session.
 *                         If session_id is NULL, it is a normal message.
 *                         If session_id is NOT NULL, it is a secured message.
 * @param  request         A pointer to the request data.
 * @param  request_size    Size in bytes of the request data.
 * @param  response        A pointer to the response data.
 *                         The request and response message buffers can be the same buffer.
 * @param  response_size   Size in bytes of the response data.
 *                         On input, it means the size in bytes of response data buffer.
 *                         On output, it means the size in bytes of copied response data buffer if
 *                         LIBSPDM_STATUS_SUCCESS is returned, and means the size in bytes of
 *                         desired response data buffer if LIBSPDM_STATUS_BUFFER_TOO_SMALL is
 *                         returned.
 **/
libspdm_return_t libspdm_send_receive_spdm_data(void *spdm_context,
                                                const uint32_t *session_id,
                                                const void *request, size_t request_size,
                                                void *response, size_t *response_size);

#if (LIBSPDM_ENABLE_CAPABILITY_KEY_EX_CAP) || (LIBSPDM_ENABLE_CAPABILITY_PSK_CAP)
/**
 * This function sends HEARTBEAT
 * to an SPDM Session.
 *
 * @param  spdm_context  A pointer to the SPDM context.
 * @param  session_id    The session ID of the session.
 **/
libspdm_return_t libspdm_heartbeat(void *spdm_context, uint32_t session_id);

/**
 * This function sends KEY_UPDATE
 * to update keys for an SPDM Session.
 *
 * After keys are updated, this function also uses VERIFY_NEW_KEY to verify the key.
 *
 * @param  spdm_context      A pointer to the SPDM context.
 * @param  session_id        The session ID of the session.
 * @param  single_direction  true means the operation is UPDATE_KEY.
 *                           false means the operation is UPDATE_ALL_KEYS.
 **/
libspdm_return_t libspdm_key_update(void *spdm_context, uint32_t session_id, bool single_direction);
#endif /* (LIBSPDM_ENABLE_CAPABILITY_KEY_EX_CAP) || (LIBSPDM_ENABLE_CAPABILITY_PSK_CAP) */

/**
 * This function executes a series of SPDM encapsulated requests and receives SPDM encapsulated responses.
 *
 * This function starts with the first encapsulated request (such as GET_ENCAPSULATED_REQUEST)
 * and ends with last encapsulated response (such as RESPONSE_PAYLOAD_TYPE_ABSENT or RESPONSE_PAYLOAD_TYPE_SLOT_NUMBER).
 *
 * @param  spdm_context  A pointer to the SPDM context.
 * @param  session_id    Indicate if the encapsulated request is a secured message.
 *                       If session_id is NULL, it is a normal message.
 *                       If session_id is not NULL, it is a secured message.
 **/
libspdm_return_t libspdm_send_receive_encap_request(void *spdm_context, const uint32_t *session_id);

/**
 * Process the encapsulated request and return the encapsulated response.
 *
 * @param  spdm_context        A pointer to the SPDM context.
 * @param  spdm_request_size   Size in bytes of the request data.
 * @param  spdm_request        A pointer to the request data.
 * @param  spdm_response_size  Size in bytes of the response data.
 *                             On input, it means the size in bytes of response data buffer.
 *                             On output, it means the size in bytes of copied response data buffer
 *                             if LIBSPDM_STATUS_SUCCESS is returned, and means the size in bytes of
 *                             desired response data buffer if LIBSPDM_STATUS_BUFFER_TOO_SMALL is
 *                             returned.
 * @param  spdm_response       A pointer to the response data.
 **/
typedef libspdm_return_t (*libspdm_get_encap_response_func)(
    void *spdm_context, size_t spdm_request_size,
    void *spdm_request, size_t *spdm_response_size,
    void *spdm_response);

/**
 * Register an SPDM encapsulated message process function.
 *
 * If the default encapsulated message process function cannot handle the encapsulated message,
 * this function will be invoked.
 *
 * @param  spdm_context             A pointer to the SPDM context.
 * @param  get_encap_response_func  The function to process the encapsuled message.
 **/
void libspdm_register_get_encap_response_func(void *spdm_context,
                                              const libspdm_get_encap_response_func
                                              get_encap_response_func);

/**
 * Generate encapsulated ERROR message.
 *
 * This function can be called in libspdm_get_encap_response_func.
 *
 * @param  spdm_context        A pointer to the SPDM context.
 * @param  error_code          The error code of the message.
 * @param  error_data          The error data of the message.
 * @param  spdm_response_size  Size in bytes of the response data.
 *                             On output, it means the size in bytes of copied response data buffer
 *                             if LIBSPDM_STATUS_SUCCESS is returned, and means the size in bytes of
 *                             desired response data buffer if LIBSPDM_STATUS_BUFFER_TOO_SMALL is
 *                             returned.
 * @param  spdm_response       A pointer to the response data.
 **/
libspdm_return_t libspdm_generate_encap_error_response(
    const void *spdm_context, uint8_t error_code, uint8_t error_data,
    size_t *spdm_response_size, void *spdm_response);

/**
 * Generate encapsulated ERROR message with extended error data.
 *
 * This function can be called in libspdm_get_encap_response_func.
 *
 * @param  spdm_context              A pointer to the SPDM context.
 * @param  error_code                The error code of the message.
 * @param  error_data                The error data of the message.
 * @param  extended_error_data_size  The size in bytes of the extended error data.
 * @param  extended_error_data       A pointer to the extended error data.
 * @param  spdm_response_size        Size in bytes of the response data.
 *                                   On output, it means the size in bytes of copied response data
 *                                   buffer if LIBSPDM_STATUS_SUCCESS is returned, and means the
 *                                   size in bytes of desired response data buffer if
 *                                   LIBSPDM_STATUS_BUFFER_TOO_SMALL is returned.
 * @param  spdm_response             A pointer to the response data.
 **/
libspdm_return_t libspdm_generate_encap_extended_error_response(
    const void *spdm_context, uint8_t error_code, uint8_t error_data,
    size_t extended_error_data_size, const uint8_t *extended_error_data,
    size_t *spdm_response_size, void *spdm_response);

#if LIBSPDM_ENABLE_CAPABILITY_CSR_CAP
/**
 * This function sends GET_CSR
 * to get csr from the device.
 *
 * @param[in]  context                A pointer to the SPDM context.
 * @param[in]  session_id             Indicates if it is a secured message protected via SPDM session.
 *                                    If session_id is NULL, it is a normal message.
 *                                    If session_id is NOT NULL, it is a secured message.
 * @param[in]  requester_info         Requester info to gen CSR
 * @param[in]  requester_info_length  The length of requester info
 * @param[in]  opaque_data            Opaque data from requester.
 * @param[in]  opaque_data_length     The length of opaque_data.
 * @param[out] csr                    Address to store CSR.
 * @param[in, out] csr_len            On input, *csr_len indicates the max csr buffer size.
 *                                    On output, *csr_len indicates the actual csr buffer size.
 **/
libspdm_return_t libspdm_get_csr(void *spdm_context,
                                 const uint32_t *session_id,
                                 void *requester_info, uint16_t requester_info_length,
                                 void *opaque_data, uint16_t opaque_data_length,
                                 void *csr, size_t *csr_len);

#if LIBSPDM_ENABLE_CAPABILITY_CSR_CAP_EX
/**
 * This function sends GET_CSR for SPDM 1.3 to get CSR from the device.
 *
 * @param[in]  context                A pointer to the SPDM context.
 * @param[in]  session_id             Indicates if it is a secured message protected via SPDM session.
 *                                    If session_id is NULL, it is a normal message.
 *                                    If session_id is NOT NULL, it is a secured message.
 * @param[in]  requester_info         Requester info to gen CSR
 * @param[in]  requester_info_length  The length of requester info
 * @param[in]  opaque_data            Opaque data from requester.
 * @param[in]  opaque_data_length     The length of opaque_data.
 * @param[out] csr                    Address to store CSR.
 * @param[in, out] csr_len            On input, *csr_len indicates the max csr buffer size.
 *                                    On output, *csr_len indicates the actual csr buffer size.
 * @param[in]  request_attribute      GET_CSR request attributes that includes the CSRCertModel,
 *                                    CSRTrackingTag, and Overwrite fields.
 *                                    This field is only used for SPDM 1.3 and above.
 * @param[in]  key_pair_id            The value of this field shall be the unique key pair number identifying the desired
 *                                    asymmetric key pair to associate with SlotID.
 * @param[out] available_csr_tracking_tag   available CSRTrackingTag when the Responder sends a ResetRequired error message
 **/
libspdm_return_t libspdm_get_csr_ex(void * spdm_context,
                                    const uint32_t *session_id,
                                    void * requester_info, uint16_t requester_info_length,
                                    void * opaque_data, uint16_t opaque_data_length,
                                    void *csr, size_t *csr_len,
                                    uint8_t request_attribute,
                                    uint8_t key_pair_id,
                                    uint8_t *available_csr_tracking_tag);
#endif /*LIBSPDM_ENABLE_CAPABILITY_CSR_CAP_EX*/
#endif /*LIBSPDM_ENABLE_CAPABILITY_CSR_CAP*/

#if LIBSPDM_ENABLE_CAPABILITY_SET_CERT_CAP
/**
 * This function try to send SET_CERTIFICATE
 * to set certificate from the device.
 *
 * @param  context          A pointer to the SPDM context.
 * @param  session_id       Indicates if it is a secured message protected via SPDM session.
 *                          If session_id is NULL, it is a normal message.
 *                          If session_id is NOT NULL, it is a secured message.
 * @param  slot_id          The number of slot for the certificate chain.
 * @param  cert_chain       The pointer for the certificate chain to set.
 *                          The cert chain is a full SPDM certificate chain, including Length and Root Cert Hash.
 * @param  cert_chain_size  The size of the certificate chain to set.
 **/
libspdm_return_t libspdm_set_certificate(void *spdm_context,
                                         const uint32_t *session_id, uint8_t slot_id,
                                         void *cert_chain, size_t cert_chain_size);

/**
 * This function try to send SET_CERTIFICATE
 * to set certificate or erase certificate from the device.
 *
 * @param  context          A pointer to the SPDM context.
 * @param  session_id       Indicates if it is a secured message protected via SPDM session.
 *                          If session_id is NULL, it is a normal message.
 *                          If session_id is NOT NULL, it is a secured message.
 * @param  slot_id          The number of slot for the certificate chain.
 * @param  cert_chain       The pointer for the certificate chain to set.
 *                          The cert chain is a full SPDM certificate chain, including Length and Root Cert Hash.
 *                          For SPDM 1.2, the cert_chain must be non-NULL.
 *                          For SPDM 1.3 and above:
 *                          If the request_attribute Erase bit is set, the cert_chain must be NULL;
 *                          If the request_attribute Erase bit is not set, the cert_chain must be non-NULL.
 * @param  cert_chain_size  The size of the certificate chain to set.
 *                          For SPDM 1.2, the cert_chain_size must be non-zero.
 *                          For SPDM 1.3 and above:
 *                          If the request_attribute Erase bit is set, the cert_chain_size must be 0;
 *                          If the request_attribute Erase bit is not set, the cert_chain_size must be non-zero.
 *                          If the cert_chain is NULL, the cert_chain_size must be 0.
 * @param  request_attribute Set certificate request attributes. This field is only used for SPDM 1.3 and above.
 *                          And the bit[0~3] of request_attribute must be 0.
 * @param  key_pair_id      The value of this field shall be the unique key pair number identifying the desired
 *                          asymmetric key pair to associate with SlotID .
 **/
libspdm_return_t libspdm_set_certificate_ex(void *spdm_context,
                                            const uint32_t *session_id, uint8_t slot_id,
                                            void *cert_chain, size_t cert_chain_size,
                                            uint8_t request_attribute,
                                            uint8_t key_pair_id);
#endif /* LIBSPDM_ENABLE_CAPABILITY_SET_CERT_CAP */

#if LIBSPDM_EVENT_RECIPIENT_SUPPORT
/** This function retrieves the supported event types from the device.
 *
 *  This function can only be called after a secure session has been established with the device.
 *
 *  @param  spdm_context       A pointer to the SPDM context.
 *  @param  session_id         The session ID of the session.
 *  @param  event_group_count  The number of event groups in supported_event_groups_list.
 *  @param  supported_event_groups_list_len On input, the size, in bytes, of the
 *                                          supported_event_groups_list buffer.
 *                                          On output, the size, in bytes, of the supported event
 *                                          groups list returned by the device.
 *  @param  supported_event_groups_list     A pointer to the caller-provided buffer.
 **/
libspdm_return_t libspdm_get_event_types(void *spdm_context,
                                         uint32_t session_id,
                                         uint8_t *event_group_count,
                                         uint32_t *supported_event_groups_list_len,
                                         void *supported_event_groups_list);

/** This function subscribes to the specified event types.
 *
 *  This function can only be called after a secure session has been established with the device.
 *
 *  @param  spdm_context       A pointer to the SPDM context.
 *  @param  session_id         The session ID of the session.
 *  @param  subscribe_event_group_count The number of event groups in subscribe_list. If this value
 *                                      is 0 then subscription to all events will be cleared and
 *                                      subscribe_list_len must be 0 and subscribe_list must be
 *                                      NULL.
 *  @param  subscribe_list_len The size, in bytes, of subscribe_list.
 *  @param  subscribe_list     List of event types and event groups.
 **/
libspdm_return_t libspdm_subscribe_event_types(void *spdm_context,
                                               uint32_t session_id,
                                               uint8_t subscribe_event_group_count,
                                               uint32_t subscribe_list_len,
                                               void *subscribe_list);
#endif /* LIBSPDM_EVENT_RECIPIENT_SUPPORT */

#if LIBSPDM_ENABLE_CAPABILITY_EVENT_CAP
/** Send a list of events to the device.
 *
 * This function can only be called after a secure session has been established with the device and
 * the device has subscribed to Requester events.
 *
 *  @param  spdm_context      A pointer to the SPDM context.
 *  @param  session_id        The session ID of the session.
 *  @param  event_count       The number of events in events_list.
 *  @param  events_list_size  The size, in bytes, of events_list.
 *  @param  events_list       Buffer containing the list of events.
 **/
libspdm_return_t libspdm_send_event(void *spdm_context,
                                    uint32_t session_id,
                                    uint32_t event_count,
                                    size_t events_list_size,
                                    void *events_list);
#endif /* LIBSPDM_ENABLE_CAPABILITY_EVENT_CAP */

#if LIBSPDM_ENABLE_MSG_LOG
/* For now these functions are only available to the Requester. They may become available to the
 * Responder at a later time.
 */

/**
 * This function initializes message logging. The caller must provide a buffer and the buffer's
 * size.
 *
 * @param  context          A pointer to the SPDM context.
 * @param  msg_buffer       A pointer to a caller-provided buffer.
 * @param  msg_buffer_size  The size of the buffer in bytes. It must be greater than zero.
 **/
void libspdm_init_msg_log (void *spdm_context, void *msg_buffer, size_t msg_buffer_size);

/**
 * This function sets the mode in which the message logger operates.
 *
 * @param  context A pointer to the SPDM context.
 * @param  mode    A bitmask specifying the mode in which the message logger operates.
 *                 LIBSPDM_MSG_LOG_MODE_ENABLE - when set the message logger is active.
 */
void libspdm_set_msg_log_mode (void *spdm_context, uint32_t mode);

/**
 * This function returns the status of the message logger.
 *
 * @param  context  A pointer to the SPDM context.
 *
 * @return uint32_t A bitmask giving the status of the message logger.
 *                  LIBSPDM_MSG_LOG_STATUS_BUFFER_FULL - if set the message logging buffer has
 *                                                       reached capacity.
 */
uint32_t libspdm_get_msg_log_status (void *spdm_context);

/**
 * This function returns the size of the message log.
 *
 * @param  context  A pointer to the SPDM context.
 * @return size_t   The size of the message log in bytes.
 */
size_t libspdm_get_msg_log_size (void *spdm_context);

/**
 * This function resets the message log while retaining the message buffer and maximum size given in
 * libspdm_init_msg_log.
 *
 * @param context  A pointer to the SPDM context.
 */
void libspdm_reset_msg_log (void *spdm_context);
#endif /* LIBSPDM_ENABLE_MSG_LOG */

#if LIBSPDM_ENABLE_VENDOR_DEFINED_MESSAGES

/**
 * This function sends VENDOR_DEFINED_REQUEST to the device and gets back a VENDOR_DEFINED_RESPONSE.
 *
 * This is useful for creating unique requests/responses to devices.
 * In libspdm, libspdm_init_connection call is needed first, so NEGOTIATE_ALGORITHMS step is done before
 * sending a vendor defined request
 * For each VENDOR_DEFINED_REQUEST, a VENDOR_DEFINED_RESPONSE is expected, even if it has a data payload field of size zero.
 *
 * @param  spdm_context         A pointer to the SPDM context.
 * @param  session_id           Indicates if it is a secured message protected via SPDM session.
 *                              If session_id is NULL, it is a normal message.
 *                              If session_id is NOT NULL, it is a secured message.
 * @param  req_standard_id      Registry or Standards body used for request
 * @param  req_vendor_id_len    Length in bytes of the vendor id field for the request
 * @param  req_vendor_id        Vendor ID assigned by the Registry or Standards Body. Little-endian format
 * @param  req_size             Length of the request
 * @param  req_data             The vendor defined request
 * @param  resp_standard_id     Registry or Standards body used for response
 * @param  resp_vendor_id_len   Length in bytes of the vendor id field for the response
 * @param  resp_vendor_id       Vendor ID assigned by the Registry or Standards Body. Little-endian format
 * @param  resp_size            Length of the response
 * @param  resp_data            The vendor defined response
 *
 * @retval LIBSPDM_STATUS_SUCCESS
 *         VENDOR_DEFINED_REQUEST was sent and VENDOR_DEFINED_RESPONSE was received.
 * @retval LIBSPDM_STATUS_INVALID_STATE_LOCAL
 *         Cannot send VENDOR_DEFINED_REQUEST due to Requester's state.
 * @retval LIBSPDM_STATUS_ERROR_PEER
 *         The Responder returned an unexpected error.
 * @retval LIBSPDM_STATUS_BUSY_PEER
 *         The Responder continually returned Busy error messages.
 * @retval LIBSPDM_STATUS_RESYNCH_PEER
 *         The Responder returned a RequestResynch error message.
 * @retval LIBSPDM_STATUS_BUFFER_FULL
 *         The buffer used to store transcripts is exhausted.
 **/
libspdm_return_t libspdm_vendor_send_request_receive_response(
    void *spdm_context,
    const uint32_t *session_id,
    uint16_t req_standard_id,
    uint8_t req_vendor_id_len,
    const void *req_vendor_id,
    uint32_t req_size,
    const void *req_data,
    uint16_t *resp_standard_id,
    uint8_t *resp_vendor_id_len,
    void *resp_vendor_id,
    uint32_t *resp_size,
    void *resp_data);

#endif /* LIBSPDM_ENABLE_VENDOR_DEFINED_MESSAGES */

#ifdef __cplusplus
}
#endif

#endif /* SPDM_REQUESTER_LIB_H */