Browse Source

Original protobufs

Miti Mazmudar 4 years ago
commit
21852fef9a
1 changed files with 106 additions and 0 deletions
  1. 106 0
      ProtobufLAMessages.proto

+ 106 - 0
ProtobufLAMessages.proto

@@ -0,0 +1,106 @@
+// Design decision - could define structures within a structure as messages *within* a message and then refer to the nested msg in another msg as Msg1.nested_msg
+// Or could define the nested message separately and use it within the message 1 as a type.
+// *Think* that the first option effectively "exposes" the nested msg as a valid msg that can be set/get by the application. Want to "hide" this.
+// The second method is easy to automatically generate from the C code and so am using it for now. TODO: Define a CPP class that hides the undesired getters/setters, as per the best practice at https://developers.google.com/protocol-buffers/docs/cpptutorial under "Protocol Buffers and O-O Design"
+// TODO: Hide setters/getters for these fields in the generated .h file..?
+
+// uint8_t, uint16_t for Protobuf - uint32, as per here - https://stackoverflow.com/questions/42295695/small-scalar-types-and-google-protocol-buffers
+// TODO: Do I need to ensure that the value here is within the defined here? Seems not, as it comes from a trusted source.
+
+// "Repeated" - can be repeated 0 or more times - however, arrays in C or CPP with fixed size that have all their elements defined - are a stricter version of this. (Protobuf doesn't let you define constant-sized arrays.)
+// packed=true is necessary to ensure successive, efficient 'packing'
+
+syntax = "proto2";
+option optimize_for = LITE_RUNTIME;
+// LITE_RUNTIME supports serializetocodedstream - which is helpful to read/write multiple messages - https://groups.google.com/forum/#!topic/protobuf/MlUMUPp5WDc and https://developers.google.com/protocol-buffers/docs/techniques?csw=1#streaming
+
+// Only have base classes for those structs in the composite structs that have more than 1 element - this causes a significant reduction in the size of the generated .cc and .h files.
+
+/*
+message protobuf_sgx_cpu_svn_t {
+  repeated uint32 svn = 1 [packed=true];
+}
+
+message protobuf_sgx_report_data_t {
+  repeated uint32 d = 1 [packed=true];
+}
+
+message protobuf_sgx_key_id_t {
+  repeated uint32 id = 1 [packed=true];
+}
+
+message protobuf_sgx_mac_t {
+  repeated uint32 mac = 1 [packed=true];
+}
+
+message protobuf_sgx_measurement_t {
+  repeated uint32 m = 1 [packed=true];
+}
+*/
+
+message  protobuf_sgx_attributes_t {
+  required uint64 flags = 1;
+  required uint64 xfrm = 2;
+}
+
+message protobuf_sgx_ec256_public_t {
+  repeated uint32 gx = 1 [packed=true];
+  repeated uint32 gy = 2 [packed=true];
+}
+
+// Composite message types
+// Tag numbers - first all the repeated ones (arrays) and then the required ones, as per the docs.
+message protobuf_sgx_report_body_t {
+  repeated uint32 cpu_svn = 1 [packed=true];
+  required uint32 misc_select = 9;
+  repeated uint32 reserved1 = 2 [packed=true];
+  required protobuf_sgx_attributes_t attributes = 10;
+  repeated uint32 mr_enclave = 3 [packed=true];
+  repeated uint32 reserved2 = 4 [packed=true];
+  repeated uint32 mr_signer = 5 [packed=true];
+  repeated uint32 reserved3 = 6 [packed=true];
+  required uint32 isv_prod_id = 11;
+  required uint32 isv_svn = 12;
+  repeated uint32 reserved4 = 7 [packed=true];
+  repeated uint32 report_data = 8 [packed=true];
+}
+
+message protobuf_sgx_report_t {
+  required protobuf_sgx_report_body_t body = 1;
+  repeated uint32 key_id = 2 [packed=true];
+  repeated uint32 mac = 3 [packed=true];
+}
+
+message protobuf_sgx_target_info_t {
+  repeated uint32 mr_enclave = 1 [packed=true];
+  required protobuf_sgx_attributes_t attributes = 4;
+  repeated uint32 reserved1 = 2 [packed=true];
+  required uint32 misc_select = 5;
+  repeated uint32 reserved2 = 3 [packed=true];
+}
+
+message protobuf_sgx_dh_msg1_t {
+  required protobuf_sgx_ec256_public_t g_a = 1;
+  required protobuf_sgx_target_info_t target = 2;
+}
+
+message protobuf_sgx_dh_msg2_t {
+  required protobuf_sgx_ec256_public_t  g_b = 1;
+  required protobuf_sgx_report_t        report = 2;
+  repeated uint32 cmac = 3 [packed=true];
+}
+
+message protobuf_sgx_dh_msg3_body_t {
+  required protobuf_sgx_report_t report = 1;
+  repeated uint32 additional_prop = 2;
+}
+
+message protobuf_sgx_dh_msg3_t {
+  required protobuf_sgx_dh_msg3_body_t msg3_body = 1;
+  repeated uint32 cmac = 2 [packed=true];
+}
+
+// for post-LA key establishment and other msgs (in particular, between Apache and Decryptor)
+message protobuf_post_LA_encrypted_msg_t {
+  required bytes msg = 1 ; 	
+}