Merge pull request #257 from Dstack-TEE/tcbinfo-fields

sdk: Add some missing fields in TcbInfo

Author: kvinwang

sdk/go/dstack/client.go

@@ -48,12 +48,17 @@ type EventLog struct {
 
 // Represents the TCB information
 type TcbInfo struct {
-	Mrtd     string     `json:"mrtd"`
-	Rtmr0    string     `json:"rtmr0"`
-	Rtmr1    string     `json:"rtmr1"`
-	Rtmr2    string     `json:"rtmr2"`
-	Rtmr3    string     `json:"rtmr3"`
-	EventLog []EventLog `json:"event_log"`
+	Mrtd  string `json:"mrtd"`
+	Rtmr0 string `json:"rtmr0"`
+	Rtmr1 string `json:"rtmr1"`
+	Rtmr2 string `json:"rtmr2"`
+	Rtmr3 string `json:"rtmr3"`
+	// The hash of the OS image. This is empty if the OS image is not measured by KMS.
+	OsImageHash string     `json:"os_image_hash,omitempty"`
+	ComposeHash string     `json:"compose_hash"`
+	DeviceID    string     `json:"device_id"`
+	AppCompose  string     `json:"app_compose"`
+	EventLog    []EventLog `json:"event_log"`
 }
 
 // Represents the response from an info request
@@ -65,8 +70,9 @@ type InfoResponse struct {
 	AppName         string `json:"app_name"`
 	DeviceID        string `json:"device_id"`
 	KeyProviderInfo string `json:"key_provider_info"`
-	OsImageHash     string `json:"os_image_hash"`
-	ComposeHash     string `json:"compose_hash"`
+	// Optional: empty if OS image is not measured by KMS
+	OsImageHash string `json:"os_image_hash,omitempty"`
+	ComposeHash string `json:"compose_hash"`
 }
 
 // DecodeTcbInfo decodes the TcbInfo string into a TcbInfo struct

sdk/go/dstack/client_test.go

@@ -409,6 +409,18 @@ func TestInfo(t *testing.T) {
 	if len(tcbInfo.EventLog) == 0 {
 		t.Error("expected event log to not be empty")
 	}
+
+	if tcbInfo.ComposeHash == "" {
+		t.Error("expected compose_hash to not be empty")
+	}
+
+	if tcbInfo.DeviceID == "" {
+		t.Error("expected device_id to not be empty")
+	}
+
+	if tcbInfo.AppCompose == "" {
+		t.Error("expected app_compose to not be empty")
+	}
 }
 
 func TestGetKeySignatureVerification(t *testing.T) {

sdk/js/src/__tests__/index.test.ts

@@ -67,6 +67,11 @@ describe('DstackClient', () => {
     expect(result.app_id).not.toBe('')
     expect(result.instance_id).not.toBe('')
     expect(result.tcb_info).not.toBe('')
+    expect(result.tcb_info).toHaveProperty('os_image_hash')
+    expect(result.tcb_info).toHaveProperty('compose_hash')
+    expect(result.tcb_info).toHaveProperty('device_id')
+    expect(result.tcb_info).toHaveProperty('app_compose')
+    expect(result.tcb_info).toHaveProperty('event_log')
   })
 
   it('should be able to decode tcb info', async () => {

sdk/js/src/index.ts

@@ -46,7 +46,7 @@ export interface InfoResponse {
   tcb_info: TcbInfo
   app_name: string
   device_id: string
-  os_image_hash: string
+  os_image_hash?: string // Optional: empty if OS image is not measured by KMS
   key_provider_info: string
   compose_hash: string
 }

sdk/python/src/dstack_sdk/dstack_client.py

@@ -95,6 +95,10 @@ class TcbInfo(BaseModel):
     rtmr1: str
     rtmr2: str
     rtmr3: str
+    os_image_hash: str = ""  # Optional: empty if OS image is not measured by KMS
+    compose_hash: str
+    device_id: str
+    app_compose: str
     event_log: List[EventLog]
 
 
@@ -105,7 +109,7 @@ class InfoResponse(BaseModel):
     tcb_info: TcbInfo
     app_name: str
     device_id: str
-    os_image_hash: str
+    os_image_hash: str = ""  # Optional: empty if OS image is not measured by KMS
     key_provider_info: str
     compose_hash: str
 

sdk/python/tests/test_client.py

@@ -1,3 +1,5 @@
+from dstack_sdk.dstack_client import TcbInfo
+from dstack_sdk.dstack_client import InfoResponse
 import hashlib
 import pytest
 
@@ -25,6 +27,26 @@ def test_sync_client_get_tls_key():
     assert len(result.key) > 0
     assert len(result.certificate_chain) > 0
 
+def test_sync_client_get_info():
+    client = DstackClient()
+    result = client.info()
+    check_info_response(result)
+
+def check_info_response(result: InfoResponse):
+    assert isinstance(result, InfoResponse)
+    assert isinstance(result.app_id, str)
+    assert isinstance(result.instance_id, str)
+    assert isinstance(result.tcb_info, TcbInfo)
+    assert len(result.tcb_info.mrtd) == 96
+    assert len(result.tcb_info.rtmr0) == 96
+    assert len(result.tcb_info.rtmr1) == 96
+    assert len(result.tcb_info.rtmr2) == 96
+    assert len(result.tcb_info.rtmr3) == 96
+    assert len(result.tcb_info.compose_hash) == 64
+    assert len(result.tcb_info.device_id) == 64
+    assert len(result.tcb_info.app_compose) > 0
+    assert len(result.tcb_info.event_log) > 0
+
 @pytest.mark.asyncio
 async def test_async_client_get_key():
     client = AsyncDstackClient()
@@ -46,6 +68,12 @@ async def test_async_client_get_tls_key():
     assert result.key.startswith('-----BEGIN PRIVATE KEY-----')
     assert len(result.certificate_chain) > 0
 
+@pytest.mark.asyncio
+async def test_async_client_get_info():
+    client = AsyncDstackClient()
+    result = await client.info()
+    check_info_response(result)
+
 @pytest.mark.asyncio
 async def test_tls_key_uniqueness():
     """Test that TLS keys are unique across multiple calls."""

sdk/run-tests.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+set -e
+
+export DSTACK_SIMULATOR_ENDPOINT=$(realpath simulator/dstack.sock)
+export TAPPD_SIMULATOR_ENDPOINT=$(realpath simulator/tappd.sock)
+
+pushd simulator
+./build.sh
+./dstack-simulator >/dev/null 2>&1 &
+SIMULATOR_PID=$!
+trap "kill $SIMULATOR_PID 2>/dev/null || true" EXIT
+popd
+
+pushd rust/
+cargo test
+popd
+
+pushd go/
+go test -v ./dstack
+DSTACK_SIMULATOR_ENDPOINT=$TAPPD_SIMULATOR_ENDPOINT go test -v ./tappd
+popd
+
+pushd python/
+if [ ! -d .venv ]; then
+    python -m venv .venv
+fi
+source .venv/bin/activate
+pip install -e .
+pip install pytest pytest-asyncio evidence-api web3 solders
+pytest
+popd
+
+pushd js/
+npm install
+npm run test -- --run
+popd

sdk/rust/src/dstack_client.rs

@@ -146,6 +146,8 @@ pub struct InfoResponse {
     /// The device identifier
     pub device_id: String,
     /// The hash of the OS image
+    /// Optional: empty if OS image is not measured by KMS
+    #[serde(default)]
     pub os_image_hash: String,
     /// Information about the key provider
     pub key_provider_info: String,
@@ -176,6 +178,15 @@ pub struct TcbInfo {
     pub rtmr2: String,
     /// The value of RTMR3 (Runtime Measurement Register 3)
     pub rtmr3: String,
+    /// The hash of the OS image. This is empty if the OS image is not measured by KMS.
+    #[serde(default)]
+    pub os_image_hash: String,
+    /// The hash of the compose configuration
+    pub compose_hash: String,
+    /// The device identifier
+    pub device_id: String,
+    /// The app compose
+    pub app_compose: String,
     /// The event log entries
     pub event_log: Vec<EventLog>,
 }

sdk/rust/tests/test_client.rs

@@ -70,5 +70,21 @@ async fn test_report_data() {
 #[tokio::test]
 async fn test_info() {
     let client = AsyncDstackClient::new(None);
-    let _info = client.info().await.unwrap();
+    let info = client.info().await.unwrap();
+    assert!(!info.app_id.is_empty());
+    assert!(!info.instance_id.is_empty());
+    assert!(!info.app_cert.is_empty());
+    assert!(!info.tcb_info.mrtd.is_empty());
+    assert!(!info.tcb_info.rtmr0.is_empty());
+    assert!(!info.tcb_info.rtmr1.is_empty());
+    assert!(!info.tcb_info.rtmr2.is_empty());
+    assert!(!info.tcb_info.rtmr3.is_empty());
+    assert!(!info.tcb_info.compose_hash.is_empty());
+    assert!(!info.tcb_info.device_id.is_empty());
+    assert!(!info.tcb_info.app_compose.is_empty());
+    assert!(!info.tcb_info.event_log.is_empty());
+    assert!(!info.app_name.is_empty());
+    assert!(!info.device_id.is_empty());
+    assert!(!info.key_provider_info.is_empty());
+    assert!(!info.compose_hash.is_empty());
 }