| // Licensed under the Apache-2.0 license |
| // SPDX-License-Identifier: Apache-2.0 |
| |
| //! SPDM Responder Service |
| //! |
| //! This service implements the SPDM responder (server) role, which responds |
| //! to attestation and measurement requests from SPDM requesters. |
| //! |
| //! ## Overview |
| //! |
| //! The SPDM responder receives requests and provides: |
| //! - Version and capability information |
| //! - Certificate chains for authentication |
| //! - Device measurements |
| //! - Challenge-response attestation |
| //! |
| //! ## Architecture |
| //! |
| //! ```text |
| //! ┌─────────────────────────┐ |
| //! │ MCTP Transport │ |
| //! │ (incoming messages) │ |
| //! └───────────┬─────────────┘ |
| //! │ SPDM requests |
| //! ▼ |
| //! ┌─────────────────────────┐ |
| //! │ SPDM Responder │◄── This crate |
| //! │ (SpdmContext wrapper) │ |
| //! └───────────┬─────────────┘ |
| //! │ |
| //! ▼ |
| //! ┌─────────────────────────────────────┐ |
| //! │ Platform Implementations │ |
| //! │ - CertStore (certificates) │ |
| //! │ - Hash (SHA-384) │ |
| //! │ - RNG (random numbers) │ |
| //! │ - Evidence (measurements) │ |
| //! │ - Transport (MCTP) │ |
| //! └─────────────────────────────────────┘ |
| //! ``` |
| //! |
| //! ## Usage |
| //! |
| //! ```rust,no_run |
| //! use spdm_responder::SpdmResponder; |
| //! |
| //! // Create platform implementations |
| //! let cert_store = Ast1060CertStore::new(crypto_handle); |
| //! let hash = SpdmCryptoHash::new(crypto_handle); |
| //! let rng = SpdmCryptoRng::new(crypto_handle); |
| //! let evidence = Ast1060Evidence::new(); |
| //! let transport = MctpSpdmTransport::new(mctp_client); |
| //! |
| //! // Create responder |
| //! let mut responder = SpdmResponder::new( |
| //! transport, |
| //! cert_store, |
| //! hash, |
| //! rng, |
| //! evidence, |
| //! )?; |
| //! |
| //! // Process messages in loop |
| //! loop { |
| //! responder.process_message()?; |
| //! } |
| //! ``` |
| |
| #![no_std] |
| |
| pub use openprot_spdm_common::{DEFAULT_DTS, DEFAULT_SMS}; |
| |
| use spdm_lib::cert_store::SpdmCertStore; |
| use spdm_lib::codec::MessageBuf; |
| use spdm_lib::context::SpdmContext; |
| use spdm_lib::error::SpdmError; |
| use spdm_lib::platform::evidence::SpdmEvidence; |
| use spdm_lib::platform::hash::SpdmHash; |
| use spdm_lib::platform::rng::SpdmRng; |
| use spdm_lib::platform::transport::SpdmTransport; |
| use spdm_lib::protocol::algorithms::{ |
| AeadCipherSuite, AlgorithmPriorityTable, BaseAsymAlgo, BaseHashAlgo, DeviceAlgorithms, |
| DheNamedGroup, KeySchedule, LocalDeviceAlgorithms, MeasurementHashAlgo, |
| MeasurementSpecification, MelSpecification, OtherParamSupport, ReqBaseAsymAlg, |
| }; |
| use spdm_lib::protocol::version::SpdmVersion; |
| |
| /// Supported SPDM versions (static to avoid lifetime issues) |
| static SUPPORTED_VERSIONS: [SpdmVersion; 2] = [SpdmVersion::V12, SpdmVersion::V11]; |
| use spdm_lib::protocol::{CapabilityFlags, DeviceCapabilities}; |
| |
| /// SPDM responder result type |
| pub type ResponderResult<T> = Result<T, ResponderError>; |
| |
| /// SPDM responder errors |
| #[derive(Debug)] |
| pub enum ResponderError { |
| /// SPDM protocol error |
| SpdmError(SpdmError), |
| /// Message buffer error |
| BufferError, |
| } |
| |
| impl From<SpdmError> for ResponderError { |
| fn from(e: SpdmError) -> Self { |
| ResponderError::SpdmError(e) |
| } |
| } |
| |
| /// SPDM responder configuration. |
| /// |
| /// Use [`ResponderConfig::default()`] to get defaults, modify as needed, |
| /// then pass to [`SpdmResponder::new()`]. |
| /// |
| /// # Example |
| /// |
| /// ```rust,no_run |
| /// use spdm_responder::ResponderConfig; |
| /// |
| /// // Get defaults and customize |
| /// let mut config = ResponderConfig::default(); |
| /// let mut caps = ResponderConfig::default_capabilities(); |
| /// caps.data_transfer_size = 2048; |
| /// config.capabilities = Some(caps); |
| /// |
| /// let mut algos = ResponderConfig::default_algorithms(); |
| /// algos.device_algorithms.base_hash_algo.set_tpm_alg_sha_512(1); |
| /// config.algorithms = Some(algos); |
| /// ``` |
| #[derive(Default)] |
| pub struct ResponderConfig<'a> { |
| /// Device capabilities. If `None`, default capabilities are used. |
| pub capabilities: Option<DeviceCapabilities>, |
| /// Device algorithms. If `None`, default algorithms are used. |
| pub algorithms: Option<LocalDeviceAlgorithms<'a>>, |
| } |
| |
| impl ResponderConfig<'_> { |
| /// Get the default device capabilities for a responder. |
| /// |
| /// Returns capabilities that can be modified and passed back via |
| /// [`ResponderConfig::capabilities`]. |
| pub fn default_capabilities() -> DeviceCapabilities { |
| let mut flags = CapabilityFlags::default(); |
| flags.set_cert_cap(1); |
| flags.set_chal_cap(1); |
| flags.set_meas_cap(2); // Measurements with signature |
| flags.set_meas_fresh_cap(1); |
| flags.set_chunk_cap(1); |
| |
| DeviceCapabilities { |
| ct_exponent: 0, |
| flags, |
| data_transfer_size: DEFAULT_DTS, |
| max_spdm_msg_size: DEFAULT_SMS, |
| include_supported_algorithms: true, |
| } |
| } |
| |
| /// Get the default device algorithms for a responder. |
| /// |
| /// Returns algorithms that can be modified and passed back via |
| /// [`ResponderConfig::algorithms`]. |
| /// |
| /// Default configuration: |
| /// - Measurement: DMTF specification with SHA-384 |
| /// - Asymmetric: ECDSA with NIST P-384 |
| /// - Hash: SHA-384 |
| pub fn default_algorithms<'a>() -> LocalDeviceAlgorithms<'a> { |
| let mut measurement_spec = MeasurementSpecification::default(); |
| measurement_spec.set_dmtf_measurement_spec(1); |
| |
| let mut measurement_hash_algo = MeasurementHashAlgo::default(); |
| measurement_hash_algo.set_tpm_alg_sha_384(1); |
| |
| let mut base_asym_algo = BaseAsymAlgo::default(); |
| base_asym_algo.set_tpm_alg_ecdsa_ecc_nist_p384(1); |
| |
| let mut base_hash_algo = BaseHashAlgo::default(); |
| base_hash_algo.set_tpm_alg_sha_384(1); |
| |
| let device_algorithms = DeviceAlgorithms { |
| measurement_spec, |
| other_param_support: OtherParamSupport::default(), |
| measurement_hash_algo, |
| base_asym_algo, |
| base_hash_algo, |
| mel_specification: MelSpecification::default(), |
| dhe_group: DheNamedGroup::default(), |
| aead_cipher_suite: AeadCipherSuite::default(), |
| req_base_asym_algo: ReqBaseAsymAlg::default(), |
| key_schedule: KeySchedule::default(), |
| }; |
| |
| let algorithm_priority_table = AlgorithmPriorityTable { |
| measurement_specification: None, |
| opaque_data_format: None, |
| base_asym_algo: None, |
| base_hash_algo: None, |
| mel_specification: None, |
| dhe_group: None, |
| aead_cipher_suite: None, |
| req_base_asym_algo: None, |
| key_schedule: None, |
| }; |
| |
| LocalDeviceAlgorithms { |
| device_algorithms, |
| algorithm_priority_table, |
| } |
| } |
| } |
| |
| /// SPDM responder state and configuration. |
| /// |
| /// This wraps the spdm-lib `SpdmContext` and provides a simplified interface |
| /// for processing SPDM messages. |
| pub struct SpdmResponder<'a> { |
| context: SpdmContext<'a>, |
| } |
| |
| impl<'a> SpdmResponder<'a> { |
| /// Create a new SPDM responder with platform implementations. |
| /// |
| /// # Arguments |
| /// |
| /// * `transport` - Transport layer implementation (e.g., MCTP) |
| /// * `cert_store` - Certificate store with device certificates |
| /// * `hash` - Hash implementation for protocol operations |
| /// * `m1_hash` - Hash implementation for M1 transcript |
| /// * `l1_hash` - Hash implementation for L1 transcript |
| /// * `rng` - Random number generator |
| /// * `evidence` - Evidence provider for measurements |
| /// * `config` - Optional configuration (uses defaults if None) |
| /// |
| /// # Returns |
| /// |
| /// A new `SpdmResponder` instance ready to process messages. |
| #[allow(clippy::too_many_arguments)] |
| pub fn new( |
| transport: &'a mut dyn SpdmTransport, |
| cert_store: &'a mut dyn SpdmCertStore, |
| hash: &'a mut dyn SpdmHash, |
| m1_hash: &'a mut dyn SpdmHash, |
| l1_hash: &'a mut dyn SpdmHash, |
| rng: &'a mut dyn SpdmRng, |
| evidence: &'a dyn SpdmEvidence, |
| config: Option<ResponderConfig<'a>>, |
| ) -> ResponderResult<Self> { |
| let config = config.unwrap_or_default(); |
| |
| // Use provided capabilities or create defaults |
| let capabilities = match config.capabilities { |
| Some(caps) => { |
| #[cfg(debug_assertions)] |
| validate_device_capabilities(&caps); |
| caps |
| } |
| None => ResponderConfig::default_capabilities(), |
| }; |
| |
| // Use provided algorithms or create defaults |
| let algorithms = match config.algorithms { |
| Some(algos) => { |
| #[cfg(debug_assertions)] |
| validate_device_algorithms(&algos); |
| algos |
| } |
| None => ResponderConfig::default_algorithms(), |
| }; |
| |
| // Create SPDM context |
| let context = SpdmContext::new( |
| &SUPPORTED_VERSIONS, |
| transport, |
| capabilities, |
| algorithms, |
| cert_store, |
| None, // No peer cert store needed for responder |
| hash, |
| m1_hash, |
| l1_hash, |
| rng, |
| evidence, |
| )?; |
| |
| Ok(Self { context }) |
| } |
| |
| /// Process a single SPDM message. |
| /// |
| /// This method: |
| /// 1. Receives a request via the transport layer |
| /// 2. Processes it through the SPDM context |
| /// 3. Sends the response back via the transport layer |
| /// |
| /// # Arguments |
| /// |
| /// * `buffer` - Message buffer (must be at least MAX_SPDM_MSG_SIZE bytes) |
| /// |
| /// # Returns |
| /// |
| /// - `Ok(())` if message processed successfully |
| /// - `Err(ResponderError)` on error |
| /// |
| /// # Note |
| /// |
| /// This should be called in a loop to continuously process messages. |
| /// Transport errors indicate connection closed. |
| pub fn process_message(&mut self, buffer: &'a mut [u8]) -> ResponderResult<()> { |
| let mut message_buf = MessageBuf::new(buffer); |
| self.context.responder_process_message(&mut message_buf)?; |
| Ok(()) |
| } |
| |
| /// Get reference to the underlying SPDM context. |
| /// |
| /// This allows direct access to context state if needed. |
| pub fn context(&self) -> &SpdmContext<'a> { |
| &self.context |
| } |
| |
| /// Get mutable reference to the underlying SPDM context. |
| /// |
| /// This allows direct manipulation of context state if needed. |
| pub fn context_mut(&mut self) -> &mut SpdmContext<'a> { |
| &mut self.context |
| } |
| } |
| |
| /// Validate device capabilities in debug builds. |
| #[cfg(debug_assertions)] |
| fn validate_device_capabilities(caps: &DeviceCapabilities) { |
| use spdm_lib::protocol::capabilities::MIN_DATA_TRANSFER_SIZE_V12; |
| |
| debug_assert!( |
| caps.data_transfer_size >= MIN_DATA_TRANSFER_SIZE_V12, |
| "data_transfer_size ({}) must be >= MIN_DATA_TRANSFER_SIZE_V12 ({})", |
| caps.data_transfer_size, |
| MIN_DATA_TRANSFER_SIZE_V12 |
| ); |
| |
| debug_assert!( |
| caps.max_spdm_msg_size >= caps.data_transfer_size, |
| "max_spdm_msg_size ({}) must be >= data_transfer_size ({})", |
| caps.max_spdm_msg_size, |
| caps.data_transfer_size |
| ); |
| |
| // Responder should have at least cert or measurement capability |
| debug_assert!( |
| caps.flags.cert_cap() != 0 || caps.flags.meas_cap() != 0, |
| "responder should have cert_cap or meas_cap enabled" |
| ); |
| } |
| |
| /// Validate device algorithms in debug builds. |
| #[cfg(debug_assertions)] |
| fn validate_device_algorithms(algos: &LocalDeviceAlgorithms) { |
| let measurement_hash_algo = algos.device_algorithms.measurement_hash_algo; |
| debug_assert!( |
| measurement_hash_algo.0.count_ones() <= 1, |
| "measurement_hash_algo must have at most one bit set" |
| ); |
| |
| let base_hash_algo = algos.device_algorithms.base_hash_algo; |
| debug_assert!( |
| base_hash_algo.0 != 0, |
| "base_hash_algo must have at least one algorithm enabled" |
| ); |
| |
| let base_asym_algo = algos.device_algorithms.base_asym_algo; |
| debug_assert!( |
| base_asym_algo.0 != 0, |
| "base_asym_algo must have at least one algorithm enabled" |
| ); |
| } |