Interface for Enclave attributes

Signed-off-by: Rajeev Ranjan <[email protected]>

Author: rranjan3

enclave_manager/avalon_enclave_manager/base_enclave_info.py

@@ -19,7 +19,8 @@
 from ssl import SSLError
 from requests.exceptions import Timeout
 from requests.exceptions import HTTPError
-from abc import ABC, abstractmethod
+from abc import abstractmethod
+from avalon_enclave_manager.enclave_attributes import EnclaveAttributes
 import avalon_enclave_manager.ias_client as ias_client
 
 import logging
@@ -29,7 +30,7 @@
 SIG_RL_UPDATE_PERIOD = 8 * 60 * 60  # in seconds every 8 hours
 
 
-class BaseEnclaveInfo(ABC):
+class BaseEnclaveInfo(EnclaveAttributes):
     """
     Abstract base class to initialize enclave, signup enclave and hold
     data obtained post signup.

enclave_manager/avalon_enclave_manager/enclave_attributes.py

@@ -0,0 +1,64 @@
+# Copyright 2020 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import logging
+from abc import ABC, abstractmethod
+
+logger = logging.getLogger(__name__)
+
+
+class EnclaveAttributes(ABC):
+    """
+    Interface to be implemented by all enclaves that run within
+    Intel SGX enclave.
+    """
+
+    # -----------------------------------------------------------------
+
+    @abstractmethod
+    def get_enclave_measurement(self):
+        """
+        A getter for enclave measurement
+
+        Returns :
+            @returns mr_enclave - Enclave measurement for enclave
+        """
+        pass
+
+    # -----------------------------------------------------------------
+
+    @abstractmethod
+    def get_enclave_basename(self):
+        """
+        A getter for enclave basename
+
+        Returns :
+            @returns basename - Basename of enclave
+        """
+        pass
+
+    # -----------------------------------------------------------------
+
+    @abstractmethod
+    def get_extended_measurements(self):
+        """
+        A getter for enclave extended measurements which is a tuple of enclave
+        basename and enclave measurement
+
+        Returns :
+            @returns basename,measurement - A tuple of basename & measurement
+        """
+        pass
+
+    # -----------------------------------------------------------------

enclave_manager/avalon_enclave_manager/graphene/graphene_enclave_info.py

@@ -13,21 +13,22 @@
 # limitations under the License.
 
 import logging
+from avalon_enclave_manager.enclave_attributes import EnclaveAttributes
 
 logger = logging.getLogger(__name__)
 
 # -------------------------------------------------------------------------
 
 
-class SignupGraphene():
+class GrapheneEnclaveInfo(EnclaveAttributes):
     """
-    Signup Object that will be used by BaseEnclave Manager
+    Signup Object that will be used by GrapheneEnclaveManager
     """
 
 # -------------------------------------------------------------------------
     def __init__(self, worker_signup_json):
         """
-        Constructor for SignupGraphene.
+        Constructor for GrapheneEnclaveInfo.
         Creates signup object.
         """
         self.sealed_data = worker_signup_json["sealed_data"]
@@ -41,3 +42,37 @@ def __init__(self, worker_signup_json):
         self.extended_measurements = None
 
 # -------------------------------------------------------------------------
+    def get_enclave_measurement(self):
+        """
+        A getter for enclave measurement
+
+        Returns :
+            @returns mr_enclave - Enclave measurement for enclave
+        """
+        # Return None as of now. Read from proof_data when enabled.
+        return None
+
+# -----------------------------------------------------------------
+
+    def get_enclave_basename(self):
+        """
+        A getter for enclave basename
+
+        Returns :
+            @returns basename - Basename of enclave
+        """
+        return None
+
+# -----------------------------------------------------------------
+
+    def get_extended_measurements(self):
+        """
+        A getter for enclave extended measurements which is a tuple of enclave
+        basename and enclave measurement
+
+        Returns :
+            @returns basename,measurement - A tuple of basename & measurement
+        """
+        return None
+
+# -----------------------------------------------------------------

enclave_manager/avalon_enclave_manager/graphene/graphene_enclave_manager.py

@@ -25,7 +25,7 @@
 from avalon_enclave_manager.work_order_processor_manager \
     import WOProcessorManager
 from avalon_enclave_manager.graphene.graphene_enclave_info \
-    import SignupGraphene
+    import GrapheneEnclaveInfo
 from utility.zmq_comm import ZmqCommunication
 
 logger = logging.getLogger(__name__)
@@ -93,7 +93,7 @@ def _create_signup_data(self):
         try:
             # Send signup request to Graphene worker
             worker_signup = self.zmq_socket.send_request_zmq(
-                                            json.dumps(json_request))
+                json.dumps(json_request))
         except Exception as ex:
             logger.error("Exception while sending data over ZMQ:" + str(ex))
             return None
@@ -108,7 +108,7 @@ def _create_signup_data(self):
             logger.error("Exception during signup json creation:" + str(ex))
             return None
         # Create Signup Graphene object
-        signup_data = SignupGraphene(worker_signup_json)
+        signup_data = GrapheneEnclaveInfo(worker_signup_json)
         return signup_data
 
 # -------------------------------------------------------------------------