add a new rpc method QueryEnclaveInfoResponse that returns mrenclave and debug info of the enclave

Signed-off-by: Jun Kimura <jun.kimura@datachain.jp>

Author: bluele

modules/enclave-api/src/enclave.rs

@@ -55,6 +55,8 @@ pub trait EnclaveInfo: Sync + Send {
     fn get_eid(&self) -> sgx_enclave_id_t;
     /// `metadata` returns the metadata of the enclave
     fn metadata(&self) -> SgxResult<metadata_t>;
+    /// `is_debug` returns true if the enclave is in debug mode
+    fn is_debug(&self) -> bool;
     /// `get_key_manager` returns a key manager for Enclave Keys
     fn get_key_manager(&self) -> &EnclaveKeyManager;
 }
@@ -68,6 +70,10 @@ impl<S: CommitStore> EnclaveInfo for Enclave<S> {
     fn metadata(&self) -> SgxResult<metadata_t> {
         host::sgx_get_metadata(&self.path)
     }
+    /// `is_debug` returns true if the enclave is in debug mode
+    fn is_debug(&self) -> bool {
+        self.sgx_enclave.is_debug()
+    }
     /// `get_keymanager` returns a key manager for Enclave Keys
     fn get_key_manager(&self) -> &EnclaveKeyManager {
         &self.key_manager

modules/service/src/enclave.rs

@@ -4,7 +4,8 @@ use crypto::Address;
 use enclave_api::EnclaveProtoAPI;
 use lcp_proto::lcp::service::enclave::v1::{
     query_server::Query, EnclaveKeyInfo, QueryAvailableEnclaveKeysRequest,
-    QueryAvailableEnclaveKeysResponse, QueryEnclaveKeyRequest, QueryEnclaveKeyResponse,
+    QueryAvailableEnclaveKeysResponse, QueryEnclaveInfoRequest, QueryEnclaveInfoResponse,
+    QueryEnclaveKeyRequest, QueryEnclaveKeyResponse,
 };
 use lcp_types::Mrenclave;
 use store::transaction::CommitStore;
@@ -16,6 +17,22 @@ where
     S: CommitStore + 'static,
     E: EnclaveProtoAPI<S> + 'static,
 {
+    async fn enclave_info(
+        &self,
+        _req: Request<QueryEnclaveInfoRequest>,
+    ) -> Result<Response<QueryEnclaveInfoResponse>, Status> {
+        self.enclave
+            .metadata()
+            .map(|metadata| {
+                let res = QueryEnclaveInfoResponse {
+                    mrenclave: metadata.enclave_css.body.enclave_hash.m.to_vec(),
+                    enclave_debug: self.enclave.is_debug(),
+                };
+                Response::new(res)
+            })
+            .map_err(|e| Status::aborted(e.to_string()))
+    }
+
     async fn available_enclave_keys(
         &self,
         req: Request<QueryAvailableEnclaveKeysRequest>,

proto/definitions/lcp/service/enclave/v1/query.proto

@@ -7,10 +7,18 @@ option go_package = "github.com/datachainlab/lcp/go/relay/enclave";
 option (gogoproto.goproto_getters_all) = false;
 
 service Query {
+  rpc EnclaveInfo(QueryEnclaveInfoRequest) returns (QueryEnclaveInfoResponse);
   rpc AvailableEnclaveKeys(QueryAvailableEnclaveKeysRequest) returns (QueryAvailableEnclaveKeysResponse);
   rpc EnclaveKey(QueryEnclaveKeyRequest) returns (QueryEnclaveKeyResponse);
 }
 
+message QueryEnclaveInfoRequest {}
+
+message QueryEnclaveInfoResponse {
+  bytes mrenclave = 1;
+  bool enclave_debug = 2;
+}
+
 message QueryAvailableEnclaveKeysRequest {
   bytes mrenclave = 1;
   bool enclave_debug = 2;

proto/src/descriptor.bin

@@ -1,6 +1,19 @@
 #[derive(::serde::Serialize, ::serde::Deserialize)]
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
+pub struct QueryEnclaveInfoRequest {}
+#[derive(::serde::Serialize, ::serde::Deserialize)]
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct QueryEnclaveInfoResponse {
+    #[prost(bytes = "vec", tag = "1")]
+    pub mrenclave: ::prost::alloc::vec::Vec<u8>,
+    #[prost(bool, tag = "2")]
+    pub enclave_debug: bool,
+}
+#[derive(::serde::Serialize, ::serde::Deserialize)]
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
 pub struct QueryAvailableEnclaveKeysRequest {
     #[prost(bytes = "vec", tag = "1")]
     pub mrenclave: ::prost::alloc::vec::Vec<u8>,
@@ -209,6 +222,25 @@ pub mod query_client {
             self.inner = self.inner.accept_compressed(encoding);
             self
         }
+        pub async fn enclave_info(
+            &mut self,
+            request: impl tonic::IntoRequest<super::QueryEnclaveInfoRequest>,
+        ) -> Result<tonic::Response<super::QueryEnclaveInfoResponse>, tonic::Status> {
+            self.inner
+                .ready()
+                .await
+                .map_err(|e| {
+                    tonic::Status::new(
+                        tonic::Code::Unknown,
+                        format!("Service was not ready: {}", e.into()),
+                    )
+                })?;
+            let codec = tonic::codec::ProstCodec::default();
+            let path = http::uri::PathAndQuery::from_static(
+                "/lcp.service.enclave.v1.Query/EnclaveInfo",
+            );
+            self.inner.unary(request.into_request(), path, codec).await
+        }
         pub async fn available_enclave_keys(
             &mut self,
             request: impl tonic::IntoRequest<super::QueryAvailableEnclaveKeysRequest>,
@@ -260,6 +292,10 @@ pub mod query_server {
     /// Generated trait containing gRPC methods that should be implemented for use with QueryServer.
     #[async_trait]
     pub trait Query: Send + Sync + 'static {
+        async fn enclave_info(
+            &self,
+            request: tonic::Request<super::QueryEnclaveInfoRequest>,
+        ) -> Result<tonic::Response<super::QueryEnclaveInfoResponse>, tonic::Status>;
         async fn available_enclave_keys(
             &self,
             request: tonic::Request<super::QueryAvailableEnclaveKeysRequest>,
@@ -331,6 +367,46 @@ pub mod query_server {
         fn call(&mut self, req: http::Request<B>) -> Self::Future {
             let inner = self.inner.clone();
             match req.uri().path() {
+                "/lcp.service.enclave.v1.Query/EnclaveInfo" => {
+                    #[allow(non_camel_case_types)]
+                    struct EnclaveInfoSvc<T: Query>(pub Arc<T>);
+                    impl<
+                        T: Query,
+                    > tonic::server::UnaryService<super::QueryEnclaveInfoRequest>
+                    for EnclaveInfoSvc<T> {
+                        type Response = super::QueryEnclaveInfoResponse;
+                        type Future = BoxFuture<
+                            tonic::Response<Self::Response>,
+                            tonic::Status,
+                        >;
+                        fn call(
+                            &mut self,
+                            request: tonic::Request<super::QueryEnclaveInfoRequest>,
+                        ) -> Self::Future {
+                            let inner = self.0.clone();
+                            let fut = async move {
+                                (*inner).enclave_info(request).await
+                            };
+                            Box::pin(fut)
+                        }
+                    }
+                    let accept_compression_encodings = self.accept_compression_encodings;
+                    let send_compression_encodings = self.send_compression_encodings;
+                    let inner = self.inner.clone();
+                    let fut = async move {
+                        let inner = inner.0;
+                        let method = EnclaveInfoSvc(inner);
+                        let codec = tonic::codec::ProstCodec::default();
+                        let mut grpc = tonic::server::Grpc::new(codec)
+                            .apply_compression_config(
+                                accept_compression_encodings,
+                                send_compression_encodings,
+                            );
+                        let res = grpc.unary(method, req).await;
+                        Ok(res)
+                    };
+                    Box::pin(fut)
+                }
                 "/lcp.service.enclave.v1.Query/AvailableEnclaveKeys" => {
                     #[allow(non_camel_case_types)]
                     struct AvailableEnclaveKeysSvc<T: Query>(pub Arc<T>);