package primihub.rpc

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc NewDataset (NewDatasetRequest, NewDatasetResponse)

  service.proto:8

  message NewDatasetRequest

  service.proto:12

  • NewDatasetRequest.Operator op_type = 1

  • optional MetaInfo meta_info = 2

  message NewDatasetResponse

  service.proto:22

  • NewDatasetResponse.ResultCode ret_code = 1

  • string dataset_url = 2

  • string ret_msg = 3

• rpc GetDataset (GetDatasetRequest, GetDatasetResponse)

  service.proto:9

  message GetDatasetRequest

  service.proto:32

  • repeated string id = 1

    dataset id for request meta info, empty to accquire all dataset

  message GetDatasetResponse

  service.proto:36

  • GetDatasetResponse.ResultCode ret_code = 1

  • string ret_msg = 2

  • repeated DatasetData data_set = 3

• rpc SubmitTask (PushTaskRequest, PushTaskReply)

  worker.proto:100

  task operation

• rpc KillTask (KillTaskRequest, KillTaskResponse)

  worker.proto:101

  message KillTaskRequest

  worker.proto:66

  • optional TaskContext task_info = 1

  • KillTaskRequest.ExecutorType executor = 2

  message KillTaskResponse

  worker.proto:75

  • retcode ret_code = 1

  • string msg_info = 2

• rpc ExecuteTask (PushTaskRequest, PushTaskReply)

  worker.proto:102

• rpc StopTask (TaskContext, Empty)

  worker.proto:103

• rpc FetchTaskStatus (TaskContext, TaskStatusReply)

  worker.proto:105

  task status operation

  message TaskStatusReply

  worker.proto:94

  • repeated TaskStatus task_status = 1

• rpc UpdateTaskStatus (TaskStatus, Empty)

  worker.proto:106

• rpc Send (stream TaskRequest, TaskResponse)

  worker.proto:109

  data exchange operation

• rpc Recv (TaskRequest, stream TaskResponse)

  worker.proto:110

• rpc SendRecv (stream TaskRequest, stream TaskResponse)

  worker.proto:111

• rpc ForwardSend (stream ForwardTaskRequest, TaskResponse)

  worker.proto:112

  forward data as proxy

  message ForwardTaskRequest

  worker.proto:61

  • optional Node dest_node = 1

  • optional TaskRequest task_request = 2

• rpc ForwardRecv (TaskRequest, stream TaskRequest)

  worker.proto:113

  forward data as proxy

A set of ciphertexts, used for queries or responses.

Used in: PirRequest, PirResponse

• repeated bytes ct = 1

Used in: MetaInfo

• string name = 1

• DataTypeInfo.PlainDataType type = 2

Used in: DataTypeInfo

• NA = 0

  / A NULL type having no physical storage

• BOOL = 1

  / Boolean as 1 bit, LSB bit-packed ordering

• UINT8 = 2

  / Unsigned 8-bit little-endian integer

• INT8 = 3

  / Signed 8-bit little-endian integer

• UINT16 = 4

  / Unsigned 16-bit little-endian integer

• INT16 = 5

  / Signed 16-bit little-endian integer

• UINT32 = 6

  / Unsigned 32-bit little-endian integer

• INT32 = 7

  / Signed 32-bit little-endian integer

• UINT64 = 8

  / Unsigned 64-bit little-endian integer

• INT64 = 9

  / Signed 64-bit little-endian integer

• HALF_FLOAT = 10

  / 2-byte floating point value

• FLOAT = 11

  / 4-byte floating point value

• DOUBLE = 12

  / 8-byte floating point value

• STRING = 13

  / UTF8 variable-length string as List<Char>

• BINARY = 14

  / Variable-length bytes (no guarantee of UTF8-ness)

• FIXED_SIZE_BINARY = 15

  / Fixed-size binary. Each value occupies the same number of bytes

• DATE32 = 16

  / int32_t days since the UNIX epoch

• DATE64 = 17

  / int64_t milliseconds since the UNIX epoch

• TIMESTAMP = 18

  / Exact timestamp encoded with int64 since UNIX epoch / Default unit millisecond

• TIME32 = 19

  / Time as signed 32-bit integer, representing either seconds or / milliseconds since midnight

• TIME64 = 20

  / Time as signed 64-bit integer, representing either microseconds or / nanoseconds since midnight

• INTERVAL_MONTHS = 21

  / YEAR_MONTH interval in SQL style

• INTERVAL_DAY_TIME = 22

  / DAY_TIME interval in SQL style

• DECIMAL128 = 23

  / Precision- and scale-based decimal type with 128 bits.

• DECIMAL = 24

  / Defined for backward-compatibility. DECIMAL == DECIMAL128

• DECIMAL256 = 25

  / Precision- and scale-based decimal type with 256 bits.

Used in: Task

• map<string, string> data = 1

Used in: GetDatasetResponse

• DatasetData.Status available = 1

• optional MetaInfo meta_info = 2

Used in: DatasetData

• Available = 0

• Unavailable = 1

Used as response type in: VMNode.StopTask, VMNode.UpdateTaskStatus

(message has no fields)

Server response after encrypting client elements under the commutative encryption scheme, sent back to the client as an array of binary strings.

• repeated bytes encrypted_elements = 1

Used in: VirtualMachine

• bytes ip = 1

• int32 port = 2

• bytes name = 3

• LinkType link_type = 4

• oneof algorithm_request

  • PsiRequest psi_request = 1

  • PirRequest pir_request = 2

• optional Params params = 3

• bytes submit_client_id = 4

• oneof algorithm_response

  • PsiResponse psi_response = 1

  • PirResponse pir_response = 2

Used in: GetDatasetResponse

• SUCCESS = 0

• FAIL = 1

Used in: KillTaskRequest

• CLIENT = 0

  executed by client

• SCHEDULER = 1

  executed by scheduler

Used in: Task

• PYTHON = 0

• JAVA = 1

• CPP = 2

• PROTO = 3

Used in: EndPoint

• SERVER = 0

• CLIENT = 1

Used in: DatasetData, NewDatasetRequest

• string id = 1

  global unique

• string driver = 2

  dataset type

• string access_info = 3

  dataset access info

• string address = 4

  location of dataset

• MetaInfo.Visibility visibility = 5

  vibility for dataset

• repeated DataTypeInfo data_type = 6

Used in: MetaInfo

• PUBLIC = 0

• PRIVATE = 1

Used in: NewDatasetRequest

• REGISTER = 0

• UNREGISTER = 1

• UPDATE = 2

Used in: NewDatasetResponse

• SUCCESS = 0

• FAIL = 1

Used in: ForwardTaskRequest, PushTaskReply, Task

• bytes node_id = 1

• bytes ip = 2

• int32 port = 3

• int32 data_port = 4

• bool use_tls = 5

• bytes role = 6

• repeated VirtualMachine vm = 7

• int32 rank = 8

  to identify if node has same role

Used in: Params

• VarType var_type = 1

• bool is_array = 2

• oneof oneof_value

  • int32 value_int32 = 3

  • bytes value_string = 4

  • int32_array value_int32_array = 5

  • string_array value_string_array = 6

  • int64 value_int64 = 7

  • int64_array value_int64_array = 8

  • float value_float = 9

  • float_array value_float_array = 10

  • double value_double = 11

  • double_array value_double_array = 12

  • bool value_bool = 13

  • bool_array value_bool_array = 14

Used in: ExecuteTaskRequest, Task

• map<string, ParamValue> param_map = 1

Request sent from the client to the server. Includes 1 or more query ciphertexts and a set of galois keys to be used.

Used in: ExecuteTaskRequest

• repeated Ciphertexts query = 1

  Each query may have 1 or more ciphertexts.

• bytes galois_keys = 2

  Galois keys, needed to compute substitution operation on ciphertexts.

• bytes relin_keys = 3

  Relinearization keys, only needed for recursion depths more than 1.

• bytes job_id = 4

• bytes task_id = 5

Response to a query, a set of ciphertexts.

Used in: ExecuteTaskResponse

• int32 ret_code = 1

  0: success 1: doing 2: error

• repeated Ciphertexts reply = 2

  Reply to query as a set of 1 or more serialized ciphertexts.

• ID_PIR = 0

• KEY_PIR = 1

Client request with encoded elements sent to the server as an array of binary strings, together with a boolean reveal_intersection that indicates whether the client wants to learn the elements in the intersection or only its size.

Used in: ExecuteTaskRequest

• bool reveal_intersection = 1

• repeated bytes encrypted_elements = 2

• bytes job_id = 3

• bytes task_id = 4

Used in: ExecuteTaskResponse

• int32 ret_code = 1

  0: success 1: doing 2: error

• optional ServerSetup server_setup = 2

• repeated bytes encrypted_elements = 3

• repeated int64 intersection = 1

• ECDH = 0

• KKRT = 1

• TEE = 2

• VOLE = 3

• INTERSECTION = 0

• DIFFERENCE = 1

Used as response type in: VMNode.ExecuteTask, VMNode.SubmitTask

• int32 ret_code = 1

  0: success 1: doing 2: error

• bytes node_id = 2

• optional TaskContext task_info = 3

• bytes msg_info = 6

• int32 party_count = 7

  number of participate parties

• repeated Node notify_server = 8

• repeated Node task_server = 9

Used as request type in: VMNode.ExecuteTask, VMNode.SubmitTask

• bytes intended_worker_id = 1

• optional Task task = 2

• int64 sequence_number = 3

• int64 client_processed_up_to = 4

• bytes submit_client_id = 5

• bool manual_launch = 6

Setup phase message for server.

Used in: PsiResponse

• oneof data_structure

  • ServerSetup.GCSInfo gcs = 1

  • ServerSetup.BloomFilterInfo bloom_filter = 2

• bytes bits = 3

Used in: ServerSetup

• int32 num_hash_functions = 1

Used in: ServerSetup

• int32 div = 1

• int64 hash_range = 2

• repeated bytes item = 1

Used in: PushTaskRequest

• TaskType type = 1

• string name = 2

• Language language = 3

• optional Params params = 4

• bytes code = 5

• map<string, Node> node_map = 6

  key: node_id deprecated remove in future

• repeated string input_datasets = 7

  deprecated, remove in future

• optional TaskContext task_info = 8

• string party_name = 11

  participate name

• map<string, Dataset> party_datasets = 13

  key: party, value: party related datasets

• map<string, Node> party_access_info = 14

  key: party, value: Party Access info

Used as request type in: VMNode.FetchTaskStatus, VMNode.StopTask

Used as field type in: KillTaskRequest, PushTaskReply, Task, TaskRequest, TaskStatus

• string task_id = 1

• string job_id = 2

• string request_id = 3

Used as request type in: VMNode.ForwardRecv, VMNode.Recv, VMNode.Send, VMNode.SendRecv

Used as response type in: VMNode.ForwardRecv

Used as field type in: ForwardTaskRequest

• optional TaskContext task_info = 1

• string role = 2

• uint64 data_len = 3

• bytes data = 22

Used as response type in: VMNode.ForwardSend, VMNode.Recv, VMNode.Send, VMNode.SendRecv

• retcode ret_code = 1

• string msg_info = 2

• uint64 data_len = 4

• bytes data = 20

Used as request type in: VMNode.UpdateTaskStatus

Used as field type in: TaskStatusReply

• optional TaskContext task_info = 1

• string party = 2

• TaskStatus.StatusCode status = 3

• string message = 4

Used in: TaskStatus

• RUNNING = 0

• SUCCESS = 1

• FAIL = 2

• NONEXIST = 3

• FINISHED = 4

Used in: Task

• ACTOR_TASK = 0

• NODE_TASK = 1

• PIR_TASK = 2

• PSI_TASK = 3

• NODE_PIR_TASK = 4

• NODE_PSI_TASK = 5

• TEE_TASK = 6

• TEE_EXECUTOR_TASK = 7

• TEE_DATAPROVIDER_TASK = 8

Used in: ParamValue

• INT32 = 0

• INT64 = 1

• STRING = 2

• FLOAT = 3

• DOUBLE = 4

• CHAR = 5

• BYTE = 6

Used in: Node

• int32 party_id = 1

• optional EndPoint next = 2

• optional EndPoint prev = 3

• WORKER = 0

• DRIVER = 1

Used in: ParamValue

• repeated bool value_bool_array = 1

Used in: ParamValue

• repeated double value_double_array = 1

Used in: ParamValue

• repeated float value_float_array = 1

Used in: ParamValue

• repeated int32 value_int32_array = 1

Used in: ParamValue

• repeated int64 value_int64_array = 1

Used in: KillTaskResponse, TaskResponse

• SUCCESS = 0

• FAIL = 1

Used in: ParamValue

• repeated bytes value_string_array = 1