Package: ski
The ski package is the protobuf designed for common e2ee instant messenger applications.
e2ees/AcceptMsg.proto
AcceptMsg
Msg form invitee for completing a key agreement.
| Field | Type | Label | Description |
|---|
| from | E2eeAddress | | The sender's address. |
| to | E2eeAddress | | The receiver's address. |
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| encaps_ciphertext | bytes | | The ciphertext encapsulated by the inviter's identity public key, empty in ECC. |
| ratchet_key | bytes | | The invitee's ratchet key. |
Top
e2ees/AcceptRequest.proto
AcceptRequest
Request for sending an accept msg.
| Field | Type | Label | Description |
|---|
| msg | AcceptMsg | | The included msg for this request. |
Top
e2ees/AcceptResponse.proto
AcceptResponse
Response for sending Accept msg.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
Top
e2ees/Account.proto
Account
Account for keeping keys and registeration information.
| Field | Type | Label | Description |
|---|
| version | string | | The version used for this account. |
| e2ees_pack_id | uint32 | | The e2ee pack ID used for this account. |
| address | E2eeAddress | | The address with device ID for this account. |
| server_cert | Certificate | | The certificate of the server that create this account. |
| identity_key | IdentityKey | | The identity key pair. |
| signed_pre_key | SignedPreKey | | The signed pre-key pair. |
| one_time_pre_key_list | OneTimePreKey | repeated | The one-time pre-key pairs. |
| next_one_time_pre_key_id | uint32 | | Next one-time pre-key pair ID. |
| saved | bool | | The account is saved or not. |
| password | string | | The password for logining to server. |
| auth | string | | The jwt for authorizing request to server. |
| expires_in | int64 | | The expiration time of auth. |
Top
e2ees/AcquireSyncMsg.proto
AcquireSyncMsg
Msg for acquiring un-processed msgs form server.
| Field | Type | Label | Description |
|---|
| last_proto_msg_tag | ProtoMsgTag | | The last handled tag for acquiring un-handled msg from server. |
Top
e2ees/AddGroupMemberDeviceMsg.proto
AddGroupMemberDeviceMsg
Msg for adding a device of group member.
| Field | Type | Label | Description |
|---|
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| sender_address | E2eeAddress | | The sender's address. |
| sequence | uint32 | | The sequence for related group session. |
| group_info | GroupInfo | | The group information, including the group name, the group address and all of the group members. |
| adding_member_device | GroupMemberInfo | | The information of a group member's new device. |
Top
e2ees/AddGroupMemberDeviceRequest.proto
AddGroupMemberDeviceRequest
Request for adding a device of group member.
Top
e2ees/AddGroupMemberDeviceResponse.proto
AddGroupMemberDeviceResponse
Response for adding a device of group member.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| group_member_list | GroupMember | repeated | The group members. |
| adding_member_device_info | GroupMemberInfo | | The information of a group member's new device. |
Top
e2ees/AddGroupMembersMsg.proto
AddGroupMembersMsg
Msg for adding group members.
| Field | Type | Label | Description |
|---|
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| sender_address | E2eeAddress | | The sender's address. |
| sequence | uint32 | | The sequence for related group session. |
| group_info | GroupInfo | | The group information, including the group name, the group address and all of the group members. |
| adding_member_list | GroupMember | repeated | The adding group members. |
| adding_member_info_list | GroupMemberInfo | repeated | The adding group members' information. |
Top
e2ees/AddGroupMembersRequest.proto
AddGroupMembersRequest
Request for adding group members.
Top
e2ees/AddGroupMembersResponse.proto
AddGroupMembersResponse
Response for adding group members.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server |
| msg | string | | The message given by the server |
| added_group_member_list | GroupMember | repeated | The added group members |
| group_member_list | GroupMember | repeated | The group members |
| adding_member_info_list | GroupMemberInfo | repeated | The adding group members' information |
Top
e2ees/AddUserDeviceMsg.proto
AddUserDeviceMsg
Msg for adding user device.
| Field | Type | Label | Description |
|---|
| user_address | E2eeAddress | | The added user e2ee address |
| old_address_list | E2eeAddress | repeated | The list of other e2ee address that has the same user ID |
Top
e2ees/AlgTypeDs.proto
AlgTypeDs
Algorithm type for Digital signature.
| Name | Number | Description |
|---|
| ALG_TYPE_DS_CURVE25519 | 0 | |
| ALG_TYPE_DS_MLDSA_44 | 1 | |
| ALG_TYPE_DS_MLDSA_65 | 9 | |
| ALG_TYPE_DS_MLDSA_87 | 17 | |
| ALG_TYPE_DS_FALCON_512 | 33 | |
| ALG_TYPE_DS_FALCON_1024 | 41 | |
| ALG_TYPE_DS_SPHINCS_SHA2_128F | 65 | |
| ALG_TYPE_DS_SPHINCS_SHA2_128S | 69 | |
| ALG_TYPE_DS_SPHINCS_SHA2_192F | 73 | |
| ALG_TYPE_DS_SPHINCS_SHA2_192S | 77 | |
| ALG_TYPE_DS_SPHINCS_SHA2_256F | 81 | |
| ALG_TYPE_DS_SPHINCS_SHA2_256S | 85 | |
| ALG_TYPE_DS_SPHINCS_SHAKE_128F | 89 | |
| ALG_TYPE_DS_SPHINCS_SHAKE_128S | 93 | |
| ALG_TYPE_DS_SPHINCS_SHAKE_192F | 97 | |
| ALG_TYPE_DS_SPHINCS_SHAKE_192S | 101 | |
| ALG_TYPE_DS_SPHINCS_SHAKE_256F | 105 | |
| ALG_TYPE_DS_SPHINCS_SHAKE_256S | 109 | |
Top
e2ees/AlgTypeHash.proto
AlgTypeHash
Algorithm type for hash function.
| Name | Number | Description |
|---|
| ALG_TYPE_HASH_SHA2_224 | 0 | |
| ALG_TYPE_HASH_SHA2_256 | 1 | |
| ALG_TYPE_HASH_SHA2_384 | 2 | |
| ALG_TYPE_HASH_SHA2_512 | 3 | |
| ALG_TYPE_HASH_SHA3_224 | 8 | |
| ALG_TYPE_HASH_SHA3_256 | 9 | |
| ALG_TYPE_HASH_SHA3_384 | 10 | |
| ALG_TYPE_HASH_SHA3_512 | 11 | |
| ALG_TYPE_HASH_SHAKE_128 | 12 | |
| ALG_TYPE_HASH_SHAKE_256 | 13 | |
Top
e2ees/AlgTypeKem.proto
AlgTypeKem
Algorithm type for Kem.
| Name | Number | Description |
|---|
| ALG_TYPE_KEM_CURVE25519 | 0 | |
| ALG_TYPE_KEM_HQC_128 | 1 | |
| ALG_TYPE_KEM_HQC_192 | 9 | |
| ALG_TYPE_KEM_HQC_256 | 17 | |
| ALG_TYPE_KEM_MLKEM_512 | 33 | |
| ALG_TYPE_KEM_MLKEM_768 | 41 | |
| ALG_TYPE_KEM_MLKEM_1024 | 49 | |
| ALG_TYPE_KEM_MCELIECE_348864 | 65 | |
| ALG_TYPE_KEM_MCELIECE_348864F | 69 | |
| ALG_TYPE_KEM_MCELIECE_460896 | 73 | |
| ALG_TYPE_KEM_MCELIECE_460896F | 77 | |
| ALG_TYPE_KEM_MCELIECE_6688128 | 81 | |
| ALG_TYPE_KEM_MCELIECE_6688128F | 85 | |
| ALG_TYPE_KEM_MCELIECE_6960119 | 89 | |
| ALG_TYPE_KEM_MCELIECE_6960119F | 93 | |
| ALG_TYPE_KEM_MCELIECE_8192128 | 97 | |
| ALG_TYPE_KEM_MCELIECE_8192128F | 101 | |
Top
e2ees/AlgTypeSe.proto
AlgTypeSe
Algorithm type for Symmetric encryption.
| Name | Number | Description |
|---|
| ALG_TYPE_SE_AES256GCM | 0 | |
Top
e2ees/Certificate.proto
Cert
A cert data with public key is provided by an issuee and can be signed by an issuer.
| Field | Type | Label | Description |
|---|
| issuee | Subject | | The owner of this certificate. |
| public_key_alg | AlgTypeDs | | The public key algorithm. |
| public_key | bytes | | The public key data. |
| issuer | Subject | | The signer of this certificate. |
| not_before | int64 | | The certificate issue date. |
| not_after | int64 | | The certificate expiry date. |
Certificate
The certificate message.
| Field | Type | Label | Description |
|---|
| version | uint32 | | The version number |
| hash_alg | AlgTypeHash | | The hash algorithm for creating fingerprint of cert attribute and signing public key. |
| signing_alg | AlgTypeDs | | The algorithm for generating the signature. |
| cert | Cert | | The cert data that is provided by issuee. |
| cert_fingerprint | bytes | | The hash value as the fingerprint of cert attribute. |
| signing_public_key_fingerprint | bytes | | The hash value as the fingerprint of the signing public key. |
| signature | bytes | | The signature that is signed by signing private key that is owned by issuer. |
| ts | int64 | | The lastest update time stamp for this certificate. |
| valid | bool | | The validity of this certificate. |
Subject
A subject is used to describe issuer or issuee.
| Field | Type | Label | Description |
|---|
| cn | string | | The common name. |
| domain | string | | The domain name. |
| o | string | | The organization name |
| ou | string | repeated | The organization unit name. |
Top
e2ees/ChainKey.proto
ChainKey
The chain key.
| Field | Type | Label | Description |
|---|
| index | uint32 | | The index of the chain key. |
| shared_key | bytes | | The chain key data. |
Top
e2ees/ClientHeartbeatMsg.proto
ClientHeartbeatMsg
Msg for client heartbeat.
| Field | Type | Label | Description |
|---|
| client_t | int64 | | The timestamp of client. |
Top
e2ees/ConsumeProtoMsgRequest.proto
ConsumeProtoMsgRequest
Request for consuming a proto msg received from server.
| Field | Type | Label | Description |
|---|
| proto_msg_id | string | | The proto msg ID to be consumed. |
| state | ProtoMsgOpState | | The operational state of the consumed proto msg. |
ProtoMsgOpState
The operational state of proto msg.
| Name | Number | Description |
|---|
| PROTO_MSG_OP_STATE_UNSPECIFIED | 0 | |
| PROTO_MSG_OP_STATE_SUCCEEDEDED | 1 | |
| PROTO_MSG_OP_STATE_FAILED_SIGNATURE | 2 | |
| PROTO_MSG_OP_STATE_FAILED_DECRYPTION | 3 | |
| PROTO_MSG_OP_STATE_FAILED_ESCAPE | 4 | |
Top
e2ees/ConsumeProtoMsgResponse.proto
ConsumeProtoMsgResponse
Response for consuming a proto msg.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
Top
e2ees/CreateGroupMsg.proto
CreateGroupMsg
Msg for creating a group.
| Field | Type | Label | Description |
|---|
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| sender_address | E2eeAddress | | The sender's address. |
| group_info | GroupInfo | | The group information, including the group name, the group address and all of the group members. |
| member_info_list | GroupMemberInfo | repeated | The group members' information. |
Top
e2ees/CreateGroupRequest.proto
CreateGroupRequest
Request for creating a group.
| Field | Type | Label | Description |
|---|
| msg | CreateGroupMsg | | The included msg for this request. |
Top
e2ees/CreateGroupResponse.proto
CreateGroupResponse
Response for creating a group.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| group_address | E2eeAddress | | The group address. |
| member_info_list | GroupMemberInfo | repeated | The group members' information. |
Top
e2ees/DsAlgType.proto
DsAlgType
Digital signature algorithm type.
| Name | Number | Description |
|---|
| DS_ALG_TYPE_CURVE25519 | 0 | |
| DS_ALG_TYPE_MLDSA_44 | 1 | |
| DS_ALG_TYPE_MLDSA_65 | 9 | |
| DS_ALG_TYPE_MLDSA_87 | 17 | |
| DS_ALG_TYPE_FALCON_512 | 33 | |
| DS_ALG_TYPE_FALCON_1024 | 41 | |
| DS_ALG_TYPE_SPHINCS_SHA2_128F | 65 | |
| DS_ALG_TYPE_SPHINCS_SHA2_128S | 69 | |
| DS_ALG_TYPE_SPHINCS_SHA2_192F | 73 | |
| DS_ALG_TYPE_SPHINCS_SHA2_192S | 77 | |
| DS_ALG_TYPE_SPHINCS_SHA2_256F | 81 | |
| DS_ALG_TYPE_SPHINCS_SHA2_256S | 85 | |
| DS_ALG_TYPE_SPHINCS_SHAKE_128F | 89 | |
| DS_ALG_TYPE_SPHINCS_SHAKE_128S | 93 | |
| DS_ALG_TYPE_SPHINCS_SHAKE_192F | 97 | |
| DS_ALG_TYPE_SPHINCS_SHAKE_192S | 101 | |
| DS_ALG_TYPE_SPHINCS_SHAKE_256F | 105 | |
| DS_ALG_TYPE_SPHINCS_SHAKE_256S | 109 | |
Top
e2ees/E2eeAddress.proto
E2eeAddress
The address for designating an end point of user or group.
| Field | Type | Label | Description |
|---|
| domain | string | | The domain of the address. |
| user | PeerUser | | The user peer of the address. |
| group | PeerGroup | | The group peer of the address. |
PeerGroup
Group peer.
| Field | Type | Label | Description |
|---|
| group_name | string | | The optional group name. |
| group_id | string | | The group ID. |
PeerUser
User peer.
| Field | Type | Label | Description |
|---|
| user_name | string | | The optional user name. |
| user_id | string | | The user's ID. |
| device_id | string | | The user's device ID. |
Top
e2ees/E2eeMsg.proto
E2eeMsg
Msg for end to end encryption.
Top
e2ees/E2eePackId.proto
E2eePackId
Msg for e2ee pack ID.
| Field | Type | Label | Description |
|---|
| ver | int32 | | The version. |
| ds | AlgTypeDs | | The digital signature algorithm type. |
| kem | AlgTypeKem | | The kem algorithm type. |
| se | AlgTypeSe | | The symmetric encryption algorithm type. |
| hash | AlgTypeHash | | The hash function algorithm type. |
Top
e2ees/FriendManagerMsg.proto
FriendManagerMsg
Msg for friend manager.
| Field | Type | Label | Description |
|---|
| modified_date | int64 | | The modified date of the friend manager msg. |
| msgId | string | | The msg ID. |
| user_address | E2eeAddress | | The user address. |
| user_name | string | | The user name. |
| op | FriendOp | | The operation of this msg. |
| friend | FriendshipDTO | | The friend data. |
FriendshipDTO
The data object representing a friend.
FriendOp
The friend operations.
| Name | Number | Description |
|---|
| FRIEND_OP_ADDING_SEND | 0 | |
| FRIEND_OP_ADDING_RECEIVE | 1 | |
| FRIEND_OP_ADDED | 2 | |
| FRIEND_OP_BLOCKED | 3 | |
| FRIEND_OP_UNBLOCKED | 4 | |
| FRIEND_OP_REMOVED | 5 | |
| FRIEND_OP_UPDATE_MEMONAME | 6 | |
| FRIEND_OP_RECOMMEND | 7 | |
Top
e2ees/GetGroupRequest.proto
GetGroupRequest
Request for getting a group.
| Field | Type | Label | Description |
|---|
| group_address | E2eeAddress | | The group address. |
| sender_address | E2eeAddress | | The sender address. |
Top
e2ees/GetGroupResponse.proto
GetGroupResponse
Response for getting a group.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| group_name | string | | The group name. |
| group_address | E2eeAddress | | The group address. |
| group_member_list | GroupMember | repeated | The list of group members. |
Top
e2ees/GetPreKeyBundleRequest.proto
GetPreKeyBundleRequest
Request for getting pre-key bundle.
| Field | Type | Label | Description |
|---|
| domain | string | | The domain. |
| user_id | string | | The user's ID. |
| device_id | string | | The user's device ID. |
Top
e2ees/GetPreKeyBundleResponse.proto
GetPreKeyBundleResponse
Response for getting pre-key bundle.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| user_id | string | | The user's ID. |
| pre_key_bundles | PreKeyBundle | repeated | The user's pre-key bundles for all devices. |
Top
e2ees/GroupInfo.proto
GroupInfo
The group information.
| Field | Type | Label | Description |
|---|
| group_name | string | | The group name. |
| group_address | E2eeAddress | | The group address. |
| group_member_list | GroupMember | repeated | The list of group members. |
Top
e2ees/GroupManagerMsg.proto
AddGroupMembersArg
Argument for adding group members.
CreateGroupArg
Argument for creating a group.
DestroyGroupArg
Argument for destroying a group.
GroupManagerMsg
Msg for group manager.
JoinGroupArg
Argument for joining a group.
RemoveGroupMembersArg
Argument for removing group members.
UpdateGroupAdminsArg
Argument for updating the group admins.
UpdateGroupAvatarArg
Argument for updating the group avatar.
UpdateGroupNameArg
Argument for updating the group name.
GroupOp
The group operations.
| Name | Number | Description |
|---|
| GROUP_OP_UNSPECIFIED | 0 | |
| GROUP_OP_CREATE_GROUP | 11 | |
| GROUP_OP_UPDATE_GROUP_NAME | 12 | |
| GROUP_OP_UPDATE_GROUP_AVATAR | 13 | |
| GROUP_OP_UPDATE_GROUP_ADMINS | 14 | |
| GROUP_OP_ADD_GROUP_MEMBERS | 21 | |
| GROUP_OP_JOIN_GROUP | 22 | |
| GROUP_OP_REMOVE_GROUP_MEMBERS | 23 | |
| GROUP_OP_DESTROY_GROUP | 30 | |
Top
e2ees/GroupMember.proto
GroupMember
The group member.
| Field | Type | Label | Description |
|---|
| user_id | string | | The group member's users ID. |
| domain | string | | The group member's domain. |
| role | GroupRole | | The group member's role. |
GroupRole
The group role.
| Name | Number | Description |
|---|
| GROUP_ROLE_MEMBER | 0 | |
| GROUP_ROLE_MANAGER | 1 | |
| GROUP_ROLE_PENDING_MEMBER | 10 | |
| GROUP_ROLE_PENDING_MANAGER | 11 | |
Top
e2ees/GroupMemberInfo.proto
GroupMemberInfo
The group member information with signed public key that is
bound to a user device.
| Field | Type | Label | Description |
|---|
| member_address | E2eeAddress | | The group member's address. |
| sign_public_key | bytes | | The signed public key part of the user's uploaded public identity key. |
Top
e2ees/GroupMsgPayload.proto
GroupMsgPayload
Payload for group msg.
| Field | Type | Label | Description |
|---|
| sequence | uint32 | | The sequence of the related group session. |
| ciphertext | bytes | | The ciphertext. |
| signature | bytes | | The signature signed by the sender. |
Top
e2ees/GroupPreKeyBundle.proto
GroupPreKeyBundle
Bundle for group pre-key.
| Field | Type | Label | Description |
|---|
| version | string | | The version. |
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| sender | E2eeAddress | | The sender's address. |
| session_id | string | | The session ID. |
| old_session_id | string | | The optional old session ID. |
| group_info | GroupInfo | | The group information. |
| sequence | uint32 | | The sequence of the related group session. |
| group_seed | bytes | | The seed for the related group session. |
Top
e2ees/GroupSession.proto
GroupSession
The group session.
| Field | Type | Label | Description |
|---|
| version | string | | The version. |
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| session_id | string | | The group session ID. |
| sender | E2eeAddress | | The sender's address. |
| session_owner | E2eeAddress | | The group session owner's address. |
| group_info | GroupInfo | | The group information. |
| sequence | uint32 | | The sequence of the chain key. |
| chain_key | bytes | | The chain key. |
| group_seed | bytes | | The random seed generated by the group creator. |
| associated_data | bytes | | The associated data. |
Top
e2ees/GroupUpdateKeyBundle.proto
GroupUpdateKeyBundle
Bundle for group update key.
| Field | Type | Label | Description |
|---|
| version | string | | The version. |
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| sender | E2eeAddress | | The sender's address. |
| adding | bool | | The flag for identifying this bundle is used for adding or not. |
| session_id | string | | The session ID. |
| group_info | GroupInfo | | Thi group information. |
| sequence | uint32 | | The sequence of the chain key. |
| chain_key | bytes | | The chain key. |
| sign_public_key | bytes | | The signed public key part of the user's uploaded public identity key. |
| adding_member_info_list | GroupMemberInfo | repeated | The list of adding group member information. |
Top
e2ees/IdentityKey.proto
IdentityKey
The identity key.
| Field | Type | Label | Description |
|---|
| asym_key_pair | KeyPair | | The key pair for asymmetric encryption and decryption. |
| sign_key_pair | KeyPair | | The key pair for signing and verifying signature. |
Top
e2ees/IdentityKeyPublic.proto
IdentityKeyPublic
The public key part of an identity key.
| Field | Type | Label | Description |
|---|
| asym_public_key | bytes | | The public key part for asymmetric encryption. |
| sign_public_key | bytes | | The public key part for verifying signature. |
Top
e2ees/InviteMsg.proto
InviteMsg
Msg form inviter for initiating a key agreement.
| Field | Type | Label | Description |
|---|
| version | string | | The version. |
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| session_id | string | | The session ID. |
| from | E2eeAddress | | The sender's address. |
| to | E2eeAddress | | The receiver's address. |
| alice_identity_key | bytes | | The inviter's identity key. |
| alice_base_key | bytes | | The inviter's base key that is the first ratchet public key. |
| pre_shared_input_list | bytes | repeated | The data that needs to generate some shared secret. |
| bob_signed_pre_key_id | uint32 | | The invitee's signed pre-key ID. |
| bob_one_time_pre_key_id | uint32 | | The invitee's one-time pre-key ID. |
| invite_t | int64 | | The server time of invitation for creating this session. |
Top
e2ees/InviteRequest.proto
InviteRequest
Request for sending an invite msg.
| Field | Type | Label | Description |
|---|
| msg | InviteMsg | | The included msg for this request. |
Top
e2ees/InviteResponse.proto
InviteResponse
Response for sending an invite msg.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| session_id | string | | The session ID. |
| invite_t | int64 | | The server time of invitation for creating this session. |
Top
e2ees/KemAlgType.proto
KemAlgType
Kem algorithm type.
| Name | Number | Description |
|---|
| KEM_ALG_TYPE_CURVE25519 | 0 | |
| KEM_ALG_TYPE_HQC_128 | 1 | |
| KEM_ALG_TYPE_HQC_192 | 9 | |
| KEM_ALG_TYPE_HQC_256 | 17 | |
| KEM_ALG_TYPE_MLKEM_512 | 33 | |
| KEM_ALG_TYPE_MLKEM_768 | 41 | |
| KEM_ALG_TYPE_MLKEM_1024 | 49 | |
| KEM_ALG_TYPE_MCELIECE_348864 | 65 | |
| KEM_ALG_TYPE_MCELIECE_348864F | 69 | |
| KEM_ALG_TYPE_MCELIECE_460896 | 73 | |
| KEM_ALG_TYPE_MCELIECE_460896F | 77 | |
| KEM_ALG_TYPE_MCELIECE_6688128 | 81 | |
| KEM_ALG_TYPE_MCELIECE_6688128F | 85 | |
| KEM_ALG_TYPE_MCELIECE_6960119 | 89 | |
| KEM_ALG_TYPE_MCELIECE_6960119F | 93 | |
| KEM_ALG_TYPE_MCELIECE_8192128 | 97 | |
| KEM_ALG_TYPE_MCELIECE_8192128F | 101 | |
Top
e2ees/KeyPair.proto
KeyPair
The Keypair.
| Field | Type | Label | Description |
|---|
| public_key | bytes | | The public key. |
| private_key | bytes | | The private key. |
Top
e2ees/LeaveGroupMsg.proto
LeaveGroupMsg
Msg for leaving a group.
| Field | Type | Label | Description |
|---|
| user_address | E2eeAddress | | The address of the user leaving the group. |
| group_address | E2eeAddress | | The group address. |
Top
e2ees/LeaveGroupRequest.proto
LeaveGroupRequest
Request for leaving a group.
| Field | Type | Label | Description |
|---|
| msg | LeaveGroupMsg | | The included msg for this request. |
Top
e2ees/LeaveGroupResponse.proto
LeaveGroupResponse
Response for leaving a group.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| leave_group_member_address | E2eeAddress | | The address of the user leaving the group. |
| group_address | E2eeAddress | | The group address. |
Top
e2ees/MsgKey.proto
MsgKey
The msg key.
| Field | Type | Label | Description |
|---|
| index | uint32 | | The index of the message key. |
| derived_key | bytes | | The data of the message key. |
Top
e2ees/NotifLevel.proto
NotifLevel
The notification level used to identify the urgency of a msg.
| Name | Number | Description |
|---|
| NOTIF_LEVEL_NORMAL | 0 | The notification level indicates that server will not send push notification to device. |
| NOTIF_LEVEL_SESSION | 1 | The notification level indicates that server will forward msg for establishing session. |
| NOTIF_LEVEL_PUSH | 11 | The notification level indicates that server will send push notification to device. |
| NOTIF_LEVEL_STREAM | 12 | The notification level indicates that server will send push notification with streaming flags to device. |
Top
e2ees/One2oneMsgPayload.proto
One2oneMsgPayload
Payload for one2one msg.
| Field | Type | Label | Description |
|---|
| sequence | uint32 | | The sequence of the chain key. |
| ciphertext | bytes | | The ciphertext. |
| ratchet_key | bytes | | The ratchet public key. |
| root_sequence | uint32 | | The root sequence. |
| sending_message_sequence | uint32 | | The sequence of the sending message. |
Top
e2ees/OneTimePreKey.proto
OneTimePreKey
The one-time pre-key.
| Field | Type | Label | Description |
|---|
| opk_id | uint32 | | The one-time pre-key ID. |
| used | bool | | This one-time pre-key is used or not. |
| key_pair | KeyPair | | The one-time pre-key data. |
Top
e2ees/OneTimePreKeyPublic.proto
OneTimePreKeyPublic
The public part of an one-time pre-key.
| Field | Type | Label | Description |
|---|
| opk_id | uint32 | | The one-time pre-key ID. |
| public_key | bytes | | The public part of this one-time pre-key pair. |
Top
e2ees/PendingRequest.proto
PendingRequest
The pending request.
| Field | Type | Label | Description |
|---|
| type | PendingRequestType | | The type of the pending request |
| request_data | bytes | | The data for the pending request. |
| request_arg_list | bytes | repeated | The optional arguments for the pending request . |
PendingRequestType
The pending request types.
| Name | Number | Description |
|---|
| PENDING_REQUEST_TYPE_GET_PRE_KEY_BUNDLE | 0 | |
| PENDING_REQUEST_TYPE_INVITE | 1 | |
| PENDING_REQUEST_TYPE_ACCEPT | 2 | |
| PENDING_REQUEST_TYPE_PUBLISH_SPK | 3 | |
| PENDING_REQUEST_TYPE_SUPPLY_OPKS | 4 | |
| PENDING_REQUEST_TYPE_SEND_ONE2ONE_MSG | 5 | |
| PENDING_REQUEST_TYPE_CREATE_GROUP | 6 | |
| PENDING_REQUEST_TYPE_ADD_GROUP_MEMBERS | 7 | |
| PENDING_REQUEST_TYPE_ADD_GROUP_MEMBER_DEVICE | 8 | |
| PENDING_REQUEST_TYPE_REMOVE_GROUP_MEMBERS | 9 | |
| PENDING_REQUEST_TYPE_LEAVE_GROUP | 10 | |
| PENDING_REQUEST_TYPE_SEND_GROUP_MSG | 11 | |
| PENDING_REQUEST_TYPE_PROTO_MSG | 12 | |
Top
e2ees/Plaintext.proto
Plaintext
The plaintext.
| Field | Type | Label | Description |
|---|
| version | string | | The version. |
| common_msg | bytes | | The common msg payload that is used for general purpose from application. |
| common_sync_msg | bytes | | The sync msg payload that is forwarded to other devices of the user. |
| user_devices_bundle | UserDevicesBundle | | The user devices' bundle that is used to help sync session with other devices of the user. |
| group_pre_key_bundle | GroupPreKeyBundle | | The group pre-key bundle that is used to help create group session. |
| group_update_key_bundle | GroupUpdateKeyBundle | | The group update key bundle that is used to help renew group session. |
Top
e2ees/PreKeyBundle.proto
PreKeyBundle
Bundle for pre-key.
Top
e2ees/ProtoMsg.proto
ProtoMsg
The proto msg from server.
Top
e2ees/ProtoMsgTag.proto
ProtoMsgTag
The proto msg tag.
| Field | Type | Label | Description |
|---|
| proto_msg_t | int64 | | The server time stamp. |
| proto_msg_id | string | | The proto msg ID. |
Top
e2ees/PublishSpkRequest.proto
PublishSpkRequest
Request for publishing signed pre-key.
| Field | Type | Label | Description |
|---|
| user_address | E2eeAddress | | The user's address. |
| signed_pre_key_public | SignedPreKeyPublic | | The public part of the signed pre-key pair. |
Top
e2ees/PublishSpkResponse.proto
PublishSpkResponse
Response for publishing signed pre-key.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
Top
e2ees/Ratchet.proto
Ratchet
The ratchet.
| Field | Type | Label | Description |
|---|
| root_key | bytes | | The root key. |
| root_sequence | uint32 | | The sequence of the root key. |
| sending_message_sequence | uint32 | | The sequence of the sending message. |
| received_message_sequence | uint32 | | The sequence of the received message. |
| sender_chain | SenderChainNode | | The sender chain. |
| receiver_chain | ReceiverChainNode | | The receiver chains. |
| skipped_msg_key_list | SkippedMsgKeyNode | repeated | The skipped message keys. |
Top
e2ees/ReceiverChainNode.proto
ReceiverChainNode
The receiver chain node.
| Field | Type | Label | Description |
|---|
| their_ratchet_public_key | bytes | | The public part of the ratchet key pair in ECC or the ciphertext given by the sender in PQC. |
| our_ratchet_private_key | bytes | | Our ratchet private key. |
| chain_key | ChainKey | | The chain key. |
Top
e2ees/RegisterUserRequest.proto
RegisterUserRequest
Request for registering an account.
| Field | Type | Label | Description |
|---|
| user_name | string | | The user's name. |
| user_id | string | | The user's ID. |
| device_id | string | | The ID of the user's device. |
| authenticator | string | | Authenticator is the email (mailto:xxx@xxx) that is bound to the registering user. |
| auth_code | string | | Auth code is a 6-digits number that is received by email or an invitation in this format (e2ee:invitorUserId@invitorDomain;invite=xxxxx). |
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| identity_key_public | IdentityKeyPublic | | The public part of the identity key pair. |
| signed_pre_key_public | SignedPreKeyPublic | | The public part of the signed pre-key pair. |
| one_time_pre_key_list | OneTimePreKeyPublic | repeated | The public part of all of the user's one-time pre-key pairs. |
Top
e2ees/RegisterUserResponse.proto
RegisterUserResponse
Response for registering an account.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| address | E2eeAddress | | The user's address. |
| username | string | | The user's name. |
| password | string | | The password. |
| auth | string | | The authorization token. |
| expires_in | int64 | | The expiry time of authorization token. |
| authenticator | string | | The optional authenticator that is bound to this userId. |
| server_cert | Certificate | | The certificate of the server that support the registration. |
| other_device_address_list | E2eeAddress | repeated | The addresses of other devices that is created with this userId. |
| other_user_address_list | E2eeAddress | repeated | The addresses of other users who had built session with this userId. |
| group_info_list | GroupInfo | repeated | The information of groups that had been created or joined by this userId. |
Top
e2ees/RemoveGroupMembersMsg.proto
RemoveGroupMembersMsg
Msg for removing group members.
| Field | Type | Label | Description |
|---|
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| sender_address | E2eeAddress | | The sender's address. |
| group_info | GroupInfo | | The group information. |
| removing_member_list | GroupMember | repeated | The members going to be removed. |
| member_info_list | GroupMemberInfo | repeated | The remaining group members' information. |
Top
e2ees/RemoveGroupMembersRequest.proto
RemoveGroupMembersRequest
Request for removing group members.
Top
e2ees/RemoveGroupMembersResponse.proto
RemoveGroupMembersResponse
Response for removing group members.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| removed_group_member_list | GroupMember | repeated | The removed group members. |
| group_member_list | GroupMember | repeated | The group members. |
| member_info_list | GroupMemberInfo | repeated | The remaining group members' information. |
Top
e2ees/RemoveUserDeviceMsg.proto
RemoveUserDeviceMsg
Msg for removing user device.
| Field | Type | Label | Description |
|---|
| user_address | E2eeAddress | | The removed user e2ee address. |
Top
e2ees/ResponseCode.proto
ResponseCode
Response status codes indicate whether a specific request
has been successfully completed.
Responses are grouped in four classes:
(ref: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)
Informational responses 100–199
Successful responses 200–299
Client error responses 400–499
Server error responses 500–599
Custom responses 1000–1007
| Name | Number | Description |
|---|
| RESPONSE_CODE_UNSPECIFIED | 0 | Unknown response. |
| RESPONSE_CODE_OK | 200 | The request succeeded, and some resources were read or updated. |
| RESPONSE_CODE_CREATED | 201 | The request succeeded, and some new resources were created as a result. |
| RESPONSE_CODE_ACCEPTED | 202 | The request has been received but not yet acted upon. |
| RESPONSE_CODE_NO_CONTENT | 204 | There is no content to send for this request, and some resources were deleted. |
| RESPONSE_CODE_BAD_REQUEST | 400 | The server cannot or will not process the request due to something that is perceived to be a client error. |
| RESPONSE_CODE_UNAUTHORIZED | 401 | The client is not authenticated to get the requested response. |
| RESPONSE_CODE_FORBIDDEN | 403 | The client is authenticated but does not have access rights to the content. |
| RESPONSE_CODE_NOT_FOUND | 404 | The server can not find the requested resource. |
| RESPONSE_CODE_REQUEST_TIMEOUT | 408 | The server timed out waiting for the request, or client timeout waiting for the response. |
| RESPONSE_CODE_REQUEST_CONFLICT | 409 | Indicates that the request could not be processed because of conflict in the current state of the resource. |
| RESPONSE_CODE_EXPECTATION_FAILED | 417 | The server cannot meet the requirements of the expected request data. |
| RESPONSE_CODE_INTERNAL_SERVER_ERROR | 500 | The server has encountered a situation it does not know how to handle. |
| RESPONSE_CODE_SERVICE_UNAVAILABLE | 503 | The server is down for maintenance or overloaded. |
| RESPONSE_CODE_CUSTOM_1000 | 1000 | A custom response code supports the flexibility of diverse server implementations. |
| RESPONSE_CODE_CUSTOM_1001 | 1001 | A custom response code supports the flexibility of diverse server implementations. |
| RESPONSE_CODE_CUSTOM_1002 | 1002 | A custom response code supports the flexibility of diverse server implementations. |
| RESPONSE_CODE_CUSTOM_1003 | 1003 | A custom response code supports the flexibility of diverse server implementations. |
| RESPONSE_CODE_CUSTOM_1004 | 1004 | A custom response code supports the flexibility of diverse server implementations. |
| RESPONSE_CODE_CUSTOM_1005 | 1005 | A custom response code supports the flexibility of diverse server implementations. |
| RESPONSE_CODE_CUSTOM_1006 | 1006 | A custom response code supports the flexibility of diverse server implementations. |
| RESPONSE_CODE_CUSTOM_1007 | 1007 | A custom response code supports the flexibility of diverse server implementations. |
Top
e2ees/SenderChainNode.proto
SenderChainNode
The sender chain node.
| Field | Type | Label | Description |
|---|
| our_ratchet_public_key | bytes | | The public part of the ratchet key pair in ECC or the ciphertext of the encapsulation in PQC. |
| their_ratchet_public_key | bytes | | Their ratchet public key. |
| chain_key | ChainKey | | The chain key. |
Top
e2ees/SendGroupMsgRequest.proto
SendGroupMsgRequest
Request for sending a group msg.
| Field | Type | Label | Description |
|---|
| msg | E2eeMsg | | The included msg for this request. |
| allow_list | E2eeAddress | repeated | Optional allow list. |
| deny_list | E2eeAddress | repeated | Optional deny list. |
Top
e2ees/SendGroupMsgResponse.proto
SendGroupMsgResponse
Response for sending a group msg.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
Top
e2ees/SendOne2oneMsgRequest.proto
SendOne2oneMsgRequest
Request for sending an one2one msg.
| Field | Type | Label | Description |
|---|
| msg | E2eeMsg | | The included msg for this request. |
Top
e2ees/SendOne2oneMsgResponse.proto
SendOne2oneMsgResponse
Response for sending an one2one msg.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
Top
e2ees/ServerHeartbeatMsg.proto
ServerHeartbeatMsg
Msg for server heartbeat.
| Field | Type | Label | Description |
|---|
| hostname | string | | The optional server host name. |
| server_t | int64 | | The server time stamp. |
Top
e2ees/ServerSignedSignature.proto
ServerSignedSignature
The server signed signature.
| Field | Type | Label | Description |
|---|
| version | uint32 | | The version number |
| hash_alg | AlgTypeHash | | The hash algorithm for creating fingerprint of cert attribute and signing public key. |
| signing_alg | AlgTypeDs | | The algorithm for generating the signature. |
| signer | Subject | | The signer information. |
| signing_public_key_fingerprint | bytes | | The hash value as the fingerprint of the signing public key. |
| msg_fingerprint | bytes | | The hash value as the fingerprint of message to be signed. |
| signature | bytes | | The signature of some message signed by the signer's key. |
Top
e2ees/Session.proto
Session
The Session.
| Field | Type | Label | Description |
|---|
| version | string | | The version. |
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| session_id | string | | The session ID. |
| our_address | E2eeAddress | | Our address. |
| their_address | E2eeAddress | | Their address. |
| ratchet | Ratchet | | The ratchet data. |
| associated_data | bytes | | The associated data. |
| temp_shared_secret | bytes | | The shared secret encapsulated by the invitee's pre-key bundle, empty in ECC. |
| fingerprint | bytes | | The fingerprint. |
| alice_base_key | KeyPair | | The inviter's base key pair. |
| bob_signed_pre_key_id | uint32 | | The invitee's signed pre-key ID. |
| bob_one_time_pre_key_id | uint32 | | The invitee's one-time pre-key ID. |
| pre_shared_input_list | bytes | repeated | The data that needs to generate some shared secret. |
| f2f | bool | | The session is face-to-face verified or not. |
| responded | bool | | The invitee has responded or not. |
| invite_t | int64 | | The server time of invitation for creating this session. |
| short_term | bool | | The flag indicates that session is used for short term. |
Top
e2ees/SignedPreKey.proto
SignedPreKey
The signed pre-key.
| Field | Type | Label | Description |
|---|
| spk_id | uint32 | | The signed pre-key ID. |
| key_pair | KeyPair | | The signed pre-key pair. |
| signature | bytes | | The signature of key_pair's public_key signed by the user's identity key. |
| ttl | int64 | | The time stamp indicates that the signed pre-key will be removed. |
Top
e2ees/SignedPreKeyPublic.proto
SignedPreKeyPublic
The public part of a signed pre-key.
| Field | Type | Label | Description |
|---|
| spk_id | uint32 | | The signed pre-key ID. |
| public_key | bytes | | The public part of the signed pre-key pair. |
| signature | bytes | | The signature of public_key signed by the user's identity key. |
Top
e2ees/SkippedMsgKeyNode.proto
SkippedMsgKeyNode
The skipped msg key node.
| Field | Type | Label | Description |
|---|
| ratchet_key_public | bytes | | The public part of the ratchet key. |
| msg_key | MsgKey | | The msg key. |
Top
e2ees/SupplyOpksMsg.proto
SupplyOpksMsg
Msg for sypplying one-time pre-keys.
| Field | Type | Label | Description |
|---|
| server_t | int64 | | |
| opks_num | uint32 | | The number of one-time pre-keys needed to be upload. |
| user_address | E2eeAddress | | The user's address. |
Top
e2ees/SupplyOpksRequest.proto
SupplyOpksRequest
Request for sypplying one-time pre-keys.
| Field | Type | Label | Description |
|---|
| e2ees_pack_id | uint32 | | The E2EE Security pack ID. |
| user_address | E2eeAddress | | The user's address. |
| one_time_pre_key_public_list | OneTimePreKeyPublic | repeated | The public part of one-time pre-key pairs. |
Top
e2ees/SupplyOpksResponse.proto
SupplyOpksResponse
Response for sypplying one-time pre-keys.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
Top
e2ees/SystemManagerMsg.proto
SystemManagerMsg
Msg for system manager.
| Field | Type | Label | Description |
|---|
| modified_date | int64 | | The modified date of the system manager msg. |
| op | SystemOp | | The operation of the system manager msg. |
| payload | bytes | | The optional payload data. |
SystemOp
The system operations.
| Name | Number | Description |
|---|
| SYSTEM_OP_WELCOME_MSG | 0 | |
| SYSTEM_OP_REGISTER_MSG | 1 | |
| SYSTEM_OP_REGISTER_SUCCESS_MSG | 2 | |
| SYSTEM_OP_ANNOUNCEMENT_MSG | 3 | |
| SYSTEM_OP_NOTIFICATION_MSG | 4 | |
Top
e2ees/UpdateUserMsg.proto
UpdateUserAvatarArg
Argument for updating the user avatar.
| Field | Type | Label | Description |
|---|
| user_avatar_url | string | | |
UpdateUserBackupPasskeyArg
Argument for updating the user backup passkey.
| Field | Type | Label | Description |
|---|
| backup_passkey | bytes | | |
UpdateUserMsg
Msg for updating user.
UpdateUserNameArg
Argument for updating the user name.
| Field | Type | Label | Description |
|---|
| username | string | | |
UpdateUserPrivacyArg
Argument for updating the user privacy.
| Field | Type | Label | Description |
|---|
| user_privacy_json | string | | |
UpdateUserStateArg
Argument for updating the user state.
| Field | Type | Label | Description |
|---|
| user_state | int32 | | |
UpdateUserOp
The update user operations.
| Name | Number | Description |
|---|
| UPDATE_USER_OP_NAME | 0 | |
| UPDATE_USER_OP_AVATAR | 1 | |
| UPDATE_USER_OP_STATE | 2 | |
| UPDATE_USER_OP_PRIVACY | 3 | |
| UPDATE_USER_OP_BACKUP_PASSKEY | 4 | |
Top
e2ees/UpdateUserRequest.proto
UpdateUserRequest
Request for updating user.
| Field | Type | Label | Description |
|---|
| msg | UpdateUserMsg | | The included msg for this request. |
Top
e2ees/UpdateUserResponse.proto
UpdateUserResponse
Response for updating user.
| Field | Type | Label | Description |
|---|
| code | ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
Top
e2ees/UpgradeE2eePackMsg.proto
UpgradeE2eePackMsg
Message for upgrading e2ee pack.
| Field | Type | Label | Description |
|---|
| upgrade_ts | int64 | | The server timestamp for upgrading e2ee pack. |
| e2ees_pack_id | uint32 | | The new e2ee pack ID. |
Top
e2ees/UserDevicesBundle.proto
UserDevicesBundle
Bundle for user devices.
| Field | Type | Label | Description |
|---|
| domain | string | | The domain. |
| user_id | string | | The user's ID. |
| device_id_list | string | repeated | All of the user's devices ID. |
Top
ski/AnsweredStreamEvent.proto
AnsweredStreamEvent
The message for answering event of the stream.
| Field | Type | Label | Description |
|---|
| user_address | e2ees.E2eeAddress | | E2ee address with deviceId for whom send this event. |
Top
ski/AudioPayload.proto
AudioPayload
Message for encrypted audio file.
| Field | Type | Label | Description |
|---|
| file_name | string | | The file name. |
| file_path | string | | The url that is used to download this audio file. |
| file_size | int64 | | The file size. |
| modified_date | int64 | | The time stamp of this message. |
| mime_type | string | | The mime type. |
| time_len | int64 | | The time length in milliseconds. |
| passkey | bytes | | The passkey that is used to decrypt the download audio file. |
Top
ski/BlockState.proto
BlockState
State to identify if a friend is blocked or not.
| Name | Number | Description |
|---|
| BLOCK_STATE_NORMAL | 0 | Normal status. |
| BLOCK_STATE_BLOCKED | 1 | Block status. |
Top
Message for contact payload.
| Field | Type | Label | Description |
|---|
| user | string | | Simple e2ee address. |
| nickname | string | | The nickname provided by user. |
Top
ski/CreateStreamEvent.proto
CreateStreamEvent
The message for creating event of the stream.
| Field | Type | Label | Description |
|---|
| stream_type | StreamType | | The type of stream. |
| caller | string | | The simple e2ee address for caller. |
| participants | string | repeated | The list of simple e2ee addresses for whom join the stream. |
| pin_code | string | | The pin code for accessing the stream. |
| passkey | bytes | | The key for encrypting/decrypting the stream. |
Top
ski/DataPayload.proto
DataPayload
The message for data payload.
| Field | Type | Label | Description |
|---|
| name | string | | The class name for decoding data. |
| data | bytes | | The raw data encoded in a sequence of bytes no longer than 2^32 (4GB). |
Top
ski/DeclineStreamEvent.proto
DeclineStreamEvent
The message for declining event of the stream.
| Field | Type | Label | Description |
|---|
| user_address | string | | The simple e2ee address who send this event. |
Top
ski/DecryptStatusPayload.proto
DecryptStatusPayload
The decrypt status message will be sent when a peer decrypted the message and loaded in UI.
| Field | Type | Label | Description |
|---|
| msg_ids | string | repeated | The array of message ids for the messages that have been decrypted. |
| time_decrypt | int64 | | The time stamp that the messages are decrypted. |
Top
ski/DeletePayload.proto
DeletePayload
The message for deleting some msgs.
| Field | Type | Label | Description |
|---|
| to_address | string | | Optional Simple user or group address for which all its msgs will be deleted. |
| delete_msg_ids | string | repeated | The array of message ids of a message to be deleted. |
Top
ski/DestroyStreamEvent.proto
DestroyStreamEvent
The message for destroying event of the stream.
| Field | Type | Label | Description |
|---|
| user_address | string | | The simple e2ee address who send this event. |
| duration | int64 | | The duration for the stream. |
Top
ski/FilePayload.proto
FilePayload
Message for encrypted file payload.
| Field | Type | Label | Description |
|---|
| file_name | string | | The file name. |
| file_path | string | | The url that is used to download this file. |
| file_size | int64 | | The file size. |
| modified_date | int64 | | The time stamp of this message. |
| mime_type | string | | The mime type. |
| passkey | bytes | | The passkey that is used to decrypt the download file. |
Top
ski/Forward.proto
Forward
Message for forwarding another message.
| Field | Type | Label | Description |
|---|
| from | string | | The simple e2ee address for whom is the sender of the forwarded message. |
| msg_id | string | | The message id of the forwarded message. |
| time_stamp | int64 | | The time stamp that this message is forwarded. |
Top
ski/FriendNotifPayload.proto
FriendNotifPayload
Message for friend manager.
Top
ski/FriendStatus.proto
FriendStatus
The frind status message identifies the status of a friendship.
| Name | Number | Description |
|---|
| FRIEND_STATUS_UNSPECIFIED | 0 | The friendship is in unknown status. |
| FRIEND_STATUS_STRANGER | 1 | The friendship is in stranger status. |
| FRIEND_STATUS_ATTENTION | 2 | The friendship is in attention status. |
| FRIEND_STATUS_FRIEND | 3 | The friendship is in friend status. |
| FRIEND_STATUS_REMOVED | 9 | The friendship is removed. (the friend account may have been removed) |
Top
ski/GroupNotifPayload.proto
GroupNotifPayload
Message from group manager.
Top
ski/HidePayload.proto
HidePayload
Message for hiding another messgae by manager of a group.
| Field | Type | Label | Description |
|---|
| hide_msg_ids | string | repeated | The array of message ids of a message to be hided. |
Top
ski/ImagePayload.proto
ImagePayload
Message for encrypted image file.
| Field | Type | Label | Description |
|---|
| file_name | string | | The file name. |
| file_path | string | | The url that is used to download this image file. |
| file_size | int64 | | The file size. |
| modified_date | int64 | | The time stamp of this message. |
| mime_type | string | | The mime type. |
| orientation | int32 | | The orientation of this message in degrees (0, 90, 180, 270). |
| passkey | bytes | | The passkey that is used to decrypt the download image file. |
Top
ski/LocationPayload.proto
LocationPayload
Message for location payload.
| Field | Type | Label | Description |
|---|
| lat | double | | The latitude of a location. |
| lng | double | | The longitude of a location. |
| address | string | | The text address that identify a specific place. |
Top
ski/MsgState.proto
MsgState
The state of a message is used to indicate the state of a transmitted message.
| Name | Number | Description |
|---|
| MSG_STATE_UNSPECIFIED | 0 | The message is in unknown state. |
| MSG_STATE_SENDING | 1 | The message is in sending state. |
| MSG_STATE_SEND_FAILED | 2 | The message is failed to send. |
| MSG_STATE_SEND_PENDED | 3 | The message is pended to send and kept in local database. |
| MSG_STATE_SEND_SUCCEEDED | 5 | The message is succeeded to send and received by server . |
| MSG_STATE_RECEIVED | 10 | The message is received by peer. |
| MSG_STATE_DECRYPT_SUCCEEDED | 11 | The message is succeeded to decrypt by peer. |
| MSG_STATE_DECRYPT_FAILED | 12 | The message is failed to decrypt by peer. |
| MSG_STATE_READ | 13 | The message is read by peer |
| MSG_STATE_HIDED | 20 | The message is hided (by a manager of group). |
| MSG_STATE_DELETED | 21 | The message is deleted. |
Top
ski/MsgType.proto
MsgType
The type of a message is used to identify the message type of a plainMsg.
@see PlainMsg#msg
| Name | Number | Description |
|---|
| MSG_TYPE_UNSPECIFIED | 0 | |
| MSG_TYPE_TEXT | 11 | |
| MSG_TYPE_CONTACT | 12 | |
| MSG_TYPE_LOCATION | 13 | |
| MSG_TYPE_STICKER | 14 | |
| MSG_TYPE_IMAGE | 21 | |
| MSG_TYPE_AUDIO | 22 | |
| MSG_TYPE_VIDEO | 23 | |
| MSG_TYPE_FILE | 24 | |
| MSG_TYPE_STREAM | 31 | |
| MSG_TYPE_DATA | 41 | |
| MSG_TYPE_FRIEND_NOTIF | 61 | |
| MSG_TYPE_GROUP_NOTIF | 62 | |
| MSG_TYPE_SYSTEM_NOTIF | 63 | |
| MSG_TYPE_RETRACT | 71 | |
| MSG_TYPE_DECRYPT_STATUS | 72 | |
| MSG_TYPE_HIDE | 73 | |
| MSG_TYPE_DELETE | 74 | |
Top
ski/PlainMsg.proto
PlainMsg
PlainMsg is the main proto type to transfer plaintext among peers.
| Field | Type | Label | Description |
|---|
| version | string | | The version number is reserved to keep forward compatibility. |
| msg_id | string | | The uuid for this plain message. |
| from | string | | The sender's address in simple e2ee address format without devideId. |
| to | string | | The recipient's address in simple e2ee address format without devideId. |
| time_send | int64 | | The time stamp that is provided by server. |
| time_delete | int64 | | The optional time to delete by client. |
| text | TextPayload | | Text message. |
| contact | ContactPayload | | Contact message. |
| location | LocationPayload | | Location message. |
| sticker | StickerPayload | | Sticker message. |
| image | ImagePayload | | Image message. |
| audio | AudioPayload | | Audio message. |
| video | VideoPayload | | Video message. |
| file | FilePayload | | File message. |
| stream | StreamPayload | | Stream message. |
| data | DataPayload | | Data message |
| friend_notif | FriendNotifPayload | | Notification message from the friend manager. |
| group_notif | GroupNotifPayload | | Notification message from the group manager. |
| system_notif | SystemNotifPayload | | Notification message from the system manager. |
| retract | RetractPayload | | Special message to retract some plainMsgs. |
| decrypt_status | DecryptStatusPayload | | Special message to identify the decryption status of some plainMsgs. |
| hide | HidePayload | | Special message to hide some plainMsgs. |
| delete | DeletePayload | | Special message to delete some plainMsgs. |
| reply | Reply | | The reply attribute is provided if this plainMsg is used to reply another plainMsg. |
| forwards | Forward | repeated | The forwards attribute is an array to keep track the forwarded records. |
| report | Report | | The reply attribute is provided if this plainMsg is used to report against another plainMsg. |
Top
ski/Reply.proto
Reply
The message for replying another message.
| Field | Type | Label | Description |
|---|
| replied_msg_from | string | | The simple e2ee address for whom is the sender of replied message. |
| replied_msg_id | string | | The message id of the message that is replied. |
| replied_msg_type | int32 | | The message type of the message that is replied. |
| replied_msg_text | string | | The replied text. |
Top
ski/Report.proto
Report
The message for reporting another message that is considered to be objectionable.
| Field | Type | Label | Description |
|---|
| msg_id | string | | The message id of a message to be reported. |
| from | string | | The simple e2ee address for whom send the reported message. |
| reason | ReportReason | | The reason for this report. |
Top
ski/ReportReason.proto
ReportReason
The reason for a report of an objectionable message.
| Name | Number | Description |
|---|
| REPORT_REASON_HARASSMENT | 0 | The message is related to harassment. (騷擾) |
| REPORT_REASON_OBJECTIONABLE_ADVERTISING | 100 | The message is related to advertising. (不當內容：廣告) |
| REPORT_REASON_OBJECTIONABLE_FALSE_INFO | 101 | The message is related to false information. (不當內容：不實) |
| REPORT_REASON_OBJECTIONABLE_BLOODINESS | 102 | The message is related to bloodiness. (不當內容：血腥) |
| REPORT_REASON_OBJECTIONABLE_VIOLENCE | 103 | The message is related to violence. (不當內容：暴力) |
| REPORT_REASON_OBJECTIONABLE_PORNOGRAPHY | 104 | The message is related to pornography. (不當內容：色情) |
| REPORT_REASON_OBJECTIONABLE_HATRED | 105 | The message is related to hatred. (不當內容：仇恨) |
| REPORT_REASON_OBJECTIONABLE_DISCRIMINATION | 106 | The message is related to discrimination.(不當內容：歧視) |
| REPORT_REASON_OBJECTIONABLE_SELF_HARM | 107 | The message is related to self-harm. (不當內容：自殘) |
| REPORT_REASON_CONTRABAND_DRUGS | 200 | The message is involved in contraband of drugs. (違禁品：毒品、藥物) |
| REPORT_REASON_CONTRABAND_FIREARMS | 201 | The message is involved in contraband of firearms. (違禁品：槍械) |
| REPORT_REASON_COUNTERFEITING_ME | 300 | The message is a counterfeit of me. (冒充：我) |
| REPORT_REASON_COUNTERFEITING_FRIEND | 301 | The message is a counterfeit of some friend. (冒充：朋友) |
| REPORT_REASON_COUNTERFEITING_OTHER | 302 | The message is a counterfeit of some person. (冒充：其他人) |
| REPORT_REASON_COUNTERFEITING_CELEBRITY | 303 | The message is a counterfeit of some celebrity. (冒充：名人) |
| REPORT_REASON_MALFUNCTION | 400 | The message is malfunctioned. (功能錯誤) |
| REPORT_REASON_OTHER | 900 | Something else. (其它) |
Top
ski/RetractPayload.proto
RetractPayload
The message to retract some other msgs.
| Field | Type | Label | Description |
|---|
| retract_msg_ids | string | repeated | The array of message ids to be retracted. |
Top
ski/StickerPayload.proto
StickerPayload
The message for sticker.
| Field | Type | Label | Description |
|---|
| namespace | string | | The name space of this sticker. |
| category | string | | The category of this sticker. |
| sticker_pack_id | string | | The sticker pack id to that this sticker is belonged. |
| sticker_id | string | | The sticker id of this sticker. |
| desc | string | | The text description of this sticker. |
Top
ski/StreamPayload.proto
StreamPayload
The message for streaming.
Top
ski/StreamType.proto
StreamType
The stream type message.
| Name | Number | Description |
|---|
| STREAM_TYPE_AUDIO | 0 | |
| STREAM_TYPE_VIDEO | 1 | |
| STREAM_TYPE_CAMERA | 2 | |
| STREAM_TYPE_DESKTOP | 3 | |
Top
ski/SyncMsg.proto
SyncMsg
Msg for syncing data among devices.
| Field | Type | Label | Description |
|---|
| op | SyncOp | | The operation of this msg. |
| update_backup_passkey_arg | UpdateBackupPasskeyArg | | The argument for updating backup passkey. |
UpdateBackupPasskeyArg
Argument for updating backup passkey.
| Field | Type | Label | Description |
|---|
| backup_passkey | bytes | | |
SyncOp
The sync operations.
| Name | Number | Description |
|---|
| SYNC_OP_UNSPECIFIED | 0 | |
| SYNC_OP_UPDATE_BACKUP_PASSKEY | 11 | |
Top
ski/SystemNotifPayload.proto
SystemNotifPayload
The message from system manager.
| Field | Type | Label | Description |
|---|
| op | e2ees.SystemOp | | The ststem operation. |
| payload | bytes | | The utf-8 json string content. |
Top
ski/TextPayload.proto
TextPayload
The message for text payload.
| Field | Type | Label | Description |
|---|
| content | string | | The text message that has utf-8 encoding and length limit 20480. |
Top
ski/UserState.proto
UserState
The user state message.
| Name | Number | Description |
|---|
| USER_STATE_NORMAL | 0 | |
| USER_STATE_BLOCKED | 1 | |
| USER_STATE_REVOKED | 2 | |
| USER_STATE_DEPRECATED | 3 | |
Top
ski/UserType.proto
UserType
The user type message.
| Name | Number | Description |
|---|
| USER_TYPE_PERSON | 0 | |
| USER_TYPE_GROUP | 1 | |
| USER_TYPE_BOT | 2 | |
| USER_TYPE_EDU | 3 | |
| USER_TYPE_GOV | 4 | |
| USER_TYPE_ORG | 5 | |
| USER_TYPE_COM | 6 | |
Top
ski/VideoPayload.proto
VideoPayload
The message for encrypted video file.
| Field | Type | Label | Description |
|---|
| file_name | string | | The file name. |
| file_path | string | | The url that is used to download this video file. |
| file_size | int64 | | The file size. |
| modified_date | int64 | | The time stamp of this message. |
| mime_type | string | | The mime type. |
| time_len | int64 | | The time length in milliseconds. |
| passkey | bytes | | The passkey that is used to decrypt the download video file. |
Top
skiserver/AcquireAuthCodeRequest.proto
AcquireAuthCodeRequest
Request for acquiring auth code.
| Field | Type | Label | Description |
|---|
| authenticator | string | | Email (mailto:xxx@xxx) or maybe mobile phone number (tel:xxx@xxx) to receive auth code. |
Top
skiserver/AcquireAuthCodeResponse.proto
AcquireAuthCodeResponse
Response for acquiring auth code.
| Field | Type | Label | Description |
|---|
| code | e2ees.ResponseCode | | The response code. |
| msg | string | | Optional response message. |
| ttl | int32 | | Time to live (seconds) for auth code that has |
Top
skiserver/AcquireGroupMemberInfosRequest.proto
AcquireGroupMemberInfosRequest
Request for acquiring group member info list.
| Field | Type | Label | Description |
|---|
| user_address | e2ees.E2eeAddress | | User address with userId and domain. |
Top
skiserver/AcquireGroupMemberInfosResponse.proto
AcquireGroupMemberInfosResponse
Response for acquiring sign public key of uploaded identity public key.
| Field | Type | Label | Description |
|---|
| code | e2ees.ResponseCode | | The response code. |
| msg | string | | Optional response message. |
| group_member_infos | e2ees.GroupMemberInfo | repeated | List of groupMemberInfo that consists of sign public key of uploaded identity public key. |
Top
skiserver/AcquireServerInfoRequest.proto
AcquireServerInfoRequest
Request for acquiring server info.
Top
skiserver/AcquireServerInfoResponse.proto
AcquireServerInfoResponse
Response for acquiring server info.
Top
skiserver/AddFriendRequest.proto
AddFriendRequest
Request for adding a friend.
| Field | Type | Label | Description |
|---|
| user_address | e2ees.E2eeAddress | | The e2ee address for user who sends this request. |
| to_user | string | | The simple e2ee address of user who will be added as a friend. |
| from_user | string | | The simple e2ee address of user who is adding toUser as a friend. |
| from_username | string | | The name of user who is adding toUser as a friend. |
Top
skiserver/AddFriendResponse.proto
AddFriendResponse
Response for adding a friend.
AddAttentionStatus
The friendship status.
| Name | Number | Description |
|---|
| ADD_ATTENTION_STATUS_REJECTED | 0 | |
| ADD_ATTENTION_STATUS_ATTENTION_ADDED | 1 | |
| ADD_ATTENTION_STATUS_FRIEND_ADDED | 2 | |
| ADD_ATTENTION_STATUS_ALREADY_ATTENDED | 3 | |
| ADD_ATTENTION_STATUS_ALREADY_FRIENDED | 4 | |
| ADD_ATTENTION_STATUS_REMOVE_BLOCKED | 5 | |
| ADD_ATTENTION_STATUS_EXCEPTION | 6 | |
Top
skiserver/AskUserIdAvailableRequest.proto
AskUserIdAvailableRequest
Request for checking if a userId is available.
| Field | Type | Label | Description |
|---|
| user_id | string | | The userId to be registered. |
Top
skiserver/AskUserIdAvailableResponse.proto
AskUserIdAvailableResponse
Response for checking if a userId is available.
Top
skiserver/BackupMsgRequest.proto
BackupMsgRequest
Request for backing up a message.
| Field | Type | Label | Description |
|---|
| backup_msg | MsgBackupDTO | | The backup data. |
Top
skiserver/BackupMsgResponse.proto
BackupMsgResponse
Response for backing up a message.
| Field | Type | Label | Description |
|---|
| code | e2ees.ResponseCode | | The response code. |
| msg | string | | Optional response message. |
| time_backup | int64 | | The back up time of the backup msg. |
Top
skiserver/BackupPasskey.proto
BackupPasskey
Message for BackupPasskey.
BackupPasskeyItem
Message for BackupPasskeyItem.
| Field | Type | Label | Description |
|---|
| ver | int32 | | |
| e2ee_pack_id | uint32 | | The e2ee pack ID used for this passkey. |
| index | int32 | | The index of passkey item start from 0. |
| passkey | bytes | | The passkey for backing up msg. |
| passkey_fingerprint | bytes | | The hash value as the fingerprint of passkey. |
| signing_private_key | bytes | | The private key data for signing backup msg. |
| signing_public_key | bytes | | The public key data for verifying backup msg. |
| signing_public_key_fingerprint | bytes | | The hash value as the fingerprint of the signing public key. |
Top
skiserver/BlockFriendRequest.proto
BlockFriendRequest
Request for blocking a friend.
| Field | Type | Label | Description |
|---|
| user_address | e2ees.E2eeAddress | | The e2ee address for user who sends this request. |
| to_user | string | | The simple e2ee address for a user to be blocked. |
| from_user | string | | The simple e2ee address for the user who is blocking toUser. |
Top
skiserver/BlockFriendResponse.proto
BlockFriendResponse
Response for blocking a friend.
Top
skiserver/E2eeBackupService.proto
E2eeBackupService
The backup unary grpc service.
Top
skiserver/E2eeBidiService.proto
E2eeBidiService
The e2ee bidirection stream grpc service.
Top
skiserver/E2eeS2SService.proto
E2eeS2SService
The e2ee server to server unary grpc service.
Top
skiserver/E2eeUnaryService.proto
E2eeUnaryService
The e2ee unary grpc service.
Top
skiserver/FindUserRequest.proto
FindUserRequest
Request for finding user.
| Field | Type | Label | Description |
|---|
| query | string | | url-encoded string such as: userId%3Dxxx%26domain%3Dxxxx or authenticator%3Duser%40example.com. |
| user_address | e2ees.E2eeAddress | | The address of the user who us sending this request. |
Top
skiserver/FindUserResponse.proto
FindUserResponse
Response for finding a user.
Top
skiserver/GetFriendsRequest.proto
GetFriendsRequest
Request for getting friendship data.
| Field | Type | Label | Description |
|---|
| last_modified_date | int64 | | The latest modified time stamp of friendship in client side. |
Top
skiserver/GetFriendsResponse.proto
GetFriendsResponse
Response for getting friendship data.
Top
skiserver/GetMsgBackupTsRequest.proto
GetMsgBackupTsRequest
Request for acquiring time stamps of backed up msgs.
| Field | Type | Label | Description |
|---|
| msg_ids | string | repeated | The array of msg ids to be queried. |
Top
skiserver/GetMsgBackupTsResponse.proto
GetMsgBackupTsResponse
Response for acquiring time stamps of backed up msgs.
Top
skiserver/GetUserRequest.proto
GetUserRequest
Request for retrieving information of a user.
| Field | Type | Label | Description |
|---|
| to_user | string | | The simple e2ee address for the user whose information is retrieved. |
| user_address | e2ees.E2eeAddress | | The address of the user who is retrieving the information of toUser. |
Top
skiserver/GetUserResponse.proto
GetUserResponse
Response for retrieving information of a user.
Top
skiserver/JoinGroupRequest.proto
JoinGroupRequest
Request for joining a group.
| Field | Type | Label | Description |
|---|
| to_group | string | | The simple e2ee address of the joining group. |
| user_address | e2ees.E2eeAddress | | The address of the user joining the group |
Top
skiserver/JoinGroupResponse.proto
JoinGroupResponse
Response for joining a group.
Top
skiserver/JwtToken.proto
JwtToken
Message for jwt token.
| Field | Type | Label | Description |
|---|
| token | string | | The token. |
| expires_in | int64 | | The expiry time. |
Top
skiserver/LoginRequest.proto
LoginRequest
Request for login.
| Field | Type | Label | Description |
|---|
| user_address | e2ees.E2eeAddress | | The user e2ee address for whom is going to login. |
| password | string | | The password to login the e2ee service. |
Top
skiserver/LoginResponse.proto
LoginResponse
Response for login.
| Field | Type | Label | Description |
|---|
| code | e2ees.ResponseCode | | The response code. |
| msg | string | | Optional response message. |
| auth | string | | The updated authorization code. |
| expires_in | int64 | | The time of expiration for the authorization code. |
| user_state | ski.UserState | | The user state. |
| msgBackup_device_id | string | | The optional main backup deviceId. |
Top
skiserver/LogoutRequest.proto
LogoutRequest
Request for logout.
| Field | Type | Label | Description |
|---|
| user_address | e2ees.E2eeAddress | | The user e2ee address (with device id) for whom is going to logout. |
Top
skiserver/LogoutResponse.proto
LogoutResponse
Response for logout.
Top
skiserver/MemoFriendRequest.proto
MemoFriendRequest
Request for giving a memo name to a friend.
| Field | Type | Label | Description |
|---|
| user_address | e2ees.E2eeAddress | | The e2ee address for user who sends this request. |
| to_user | string | | The simple e2ee address for the user who is giving a memo name. |
| memoname | string | | The memo name (max len = 12 utf-8 chars). |
Top
skiserver/MemoFriendResponse.proto
MemoFriendResponse
Response for giving a memo name to a friend.
Top
skiserver/MsgBackupDTO.proto
MsgBackupDTO
Message for a backup msg.
| Field | Type | Label | Description |
|---|
| msg_id | string | | The msgId of the backup msg. |
| time_send | int64 | | The time of the backup msg that was sent. |
| time_backup | int64 | | The back up time of the backup msg. |
| passkey_fingerprint | bytes | | The passkey fingerprint for the backup msg. |
| signing_public_key_fingerprint | bytes | | The hash value as the fingerprint of the signing public key. |
| encrypted_msg | bytes | | The encrypted backup msg. |
| plain_msg_signature | bytes | | The signature of plain msg to be backed up. |
| encrypted_attachment | bytes | | The optional encrypted attachment data of the backup msg. |
| plain_attachment_signature | bytes | | The optional signature of plain attachment data to be backed up. |
Top
skiserver/MsgBackupTsDTO.proto
MsgBackupTsDTO
Message for the time stamp of a backed up msg.
| Field | Type | Label | Description |
|---|
| msg_id | string | | The msgId of the backup msg. |
| time_send | int64 | | The time of the backup msg that was sent. |
| time_backup | int64 | | The time of the backup msg that was backed up. |
Top
skiserver/NotifyCertUpdateRequest.proto
NotifyCertUpdateRequest
Request for notifying certificates update.
| Field | Type | Label | Description |
|---|
| ts | int64 | | The lastest time stamp for current list of certificates. |
Top
skiserver/NotifyCertUpdateResponse.proto
NotifyCertUpdateResponse
Response for notifying certificates update.
Top
skiserver/RecoverMsgRequest.proto
RecoverMsgRequest
Request for recovering some backed up msgs.
| Field | Type | Label | Description |
|---|
| last_msg_id | string | | Optional last msgId that has been downloaded previously. |
| last_time_send | int64 | | Optional last timestamp for a sent msg. |
| limit | int32 | | The maximal number of messages to be downloaded. (max 500) |
Top
skiserver/RecoverMsgResponse.proto
RecoverMsgResponse
Response for recovering backed up msgs.
Top
skiserver/RemoveFriendRequest.proto
RemoveFriendRequest
Request for removing a friend.
| Field | Type | Label | Description |
|---|
| user_address | e2ees.E2eeAddress | | The e2ee address for user who sends this request. |
| to_user | string | | The simple e2ee address of user who will be removed as a friend. |
| from_user | string | | The simple e2ee address of user who is removing toUser from contacts. |
Top
skiserver/RemoveFriendResponse.proto
RemoveFriendResponse
Response for removing a friend.
Top
skiserver/RemoveUserDeviceRequest.proto
RemoveUserDeviceRequest
Request for removing a user device.
Top
skiserver/RemoveUserDeviceResponse.proto
RemoveUserDeviceResponse
Response for removing a user device.
Top
skiserver/ServerAcquireLoginRequest.proto
ServerAcquireLoginRequest
Request for acquiring server login challenge.
| Field | Type | Label | Description |
|---|
| domain | string | | The domain. |
Top
skiserver/ServerAcquireLoginResponse.proto
ServerAcquireLoginResponse
Response for acquiring server login challenge..
Top
skiserver/ServerLoginRequest.proto
ServerLoginRequest
Request for server login.
| Field | Type | Label | Description |
|---|
| domain | string | | The domain. |
| certFingerprint | bytes | | The certFingerprint for the certificate that can be used to verify the response; |
| challenge | string | | The challenge base64 string. |
| response | string | | The base64 string that is the signature created by signing the challenge with server's key. |
Top
skiserver/ServerLoginResponse.proto
ServerLoginResponse
Response for server login.
Top
skiserver/ServerRefreshTokenRequest.proto
ServerRefreshTokenRequest
The request for refreshing server token.
| Field | Type | Label | Description |
|---|
| domain | string | | The domain. |
| refresh_token | string | | The refresh token. |
Top
skiserver/ServerRefreshTokenResponse.proto
ServerRefreshTokenResponse
The response for refreshing server token.
Top
skiserver/SubmitProtoMsgRequest.proto
SubmitProtoMsgRequest
Request for submitting protoMsg to a s2s service.
| Field | Type | Label | Description |
|---|
| protoMsg | e2ees.ProtoMsg | | The protoMsg to be delivered. |
| ignoredDeviceIdList | string | repeated | Optional ignored deviceId list. |
Top
skiserver/SubmitProtoMsgResponse.proto
SubmitProtoMsgResponse
Response for submitting protoMsg to a s2s service.
Top
skiserver/UnBlockFriendRequest.proto
UnBlockFriendRequest
Request for unblocking a friend.
| Field | Type | Label | Description |
|---|
| user_address | e2ees.E2eeAddress | | The e2ee address for user who sends this request. |
| to_user | string | | The simple e2ee address for a user to be unblocked. |
| from_user | string | | The simple e2ee address for the user who is unblocking toUser. |
Top
skiserver/UnBlockFriendResponse.proto
UnBlockFriendResponse
Response for unblocking a friend.
Top
skiserver/UpdateAuthenticatorRequest.proto
UpdateAuthenticatorRequest
Request for updating authenticator.
| Field | Type | Label | Description |
|---|
| authenticator | string | | Email (mailto:xxx@xxx) or mobile phone number (tel:xxx@xxx) to receive auth code. |
| auth_code | string | | The auth code received from authenticator. |
Top
skiserver/UpdateAuthenticatorResponse.proto
UpdateAuthenticatorResponse
Response for updating authenticator.
Top
skiserver/UpdateGroupManagersRequest.proto
UpdateGroupManagersRequest
Request for updating group managers.
| Field | Type | Label | Description |
|---|
| to_group | string | | The simple e2ee address of the updating group. |
| from_user | string | | The simple e2ee address of the user who is updating the group. |
| updating_members | e2ees.GroupMember | repeated | The list of updated group members with new roles. |
Top
skiserver/UpdateGroupManagersResponse.proto
UpdateGroupManagersResponse
Response for updating group managers.
Top
skiserver/UpdateGroupNameRequest.proto
UpdateGroupNameRequest
Request for renaming a group.
| Field | Type | Label | Description |
|---|
| to_group | string | | The simple e2ee address of the renaming group. |
| from_user | string | | The simple e2ee address of the user who is renaming the group. |
| group_name | string | | The group name. |
Top
skiserver/UpdateGroupNameResponse.proto
UpdateGroupNameResponse
Response for renaming a group.
Top
skiserver/UpdatePushIdRequest.proto
UpdatePushIdRequest
Request for updating pushId.
| Field | Type | Label | Description |
|---|
| push_id | string | | The pushId for push notification. |
| type | PushIDType | | The optional pushId type. |
PushIDType
| Name | Number | Description |
|---|
| PUSH_ID_TYPE_NORMAL | 0 | PushId for general circumstances. |
| PUSH_ID_TYPE_APNS_VOIP | 1 | PushId for apns voip. |
Top
skiserver/UpdatePushIdResponse.proto
UpdatePushIdResponse
Response for updating pushId.
Top
skiserver/UpdateUserNameRequest.proto
UpdateUserNameRequest
Request for updating user name.
| Field | Type | Label | Description |
|---|
| username | string | | The user name (max len = 12 utf-8 chars). |
Top
skiserver/UpdateUserNameResponse.proto
UpdateUserNameResponse
Response for updating user name.
Top
skiserver/UpdateUserPrivacyRequest.proto
UpdateUserPrivacyRequest
Request for updating user privacy.
| Field | Type | Label | Description |
|---|
| allow_attention | bool | | Allow being added as a friend. |
| allow_greeting | bool | | Allow receiving msg from strangers. |
| allow_auto_friend | bool | | Allow adding friend automatically when someone is adding user as friend. |
Top
skiserver/UpdateUserPrivacyResponse.proto
UpdateUserPrivacyResponse
Response for updating user privacy.
Top
skirobot/E2eeRobotService.proto
E2eeRobotService
Top
skirobot/EventNotification.proto
EventNotification
Message for event notification from subscription service.
OnFriendManagerMsgReceived
OnGroupCreated
OnGroupManagerMsgReceived
OnGroupMembersAdded
OnGroupMembersRemoved
OnGroupMsgReceived
OnInited
OnOne2oneMsgReceived
OnOtherDeviceMsgReceived
OnSystemManagerMsgReceived
OnUserRegistered
OnUserUpdated
Top
skirobot/EventSubscription.proto
EventSubscription
Top
skirobot/RobotAddFriendRequest.proto
RobotAddFriendRequest
| Field | Type | Label | Description |
|---|
| to_user | string | | |
Top
skirobot/RobotAddGroupMembersRequest.proto
RobotAddGroupMembersRequest
Top
skirobot/RobotBlockFriendRequest.proto
RobotBlockFriendRequest
| Field | Type | Label | Description |
|---|
| to_user | string | | |
Top
skirobot/RobotCreateAccountRequest.proto
RobotCreateAccountRequest
Top
skirobot/RobotCreateGroupRequest.proto
RobotCreateGroupRequest
Top
skirobot/RobotDecryptFileRequest.proto
RobotDecryptFileRequest
Request for decrypting file.
| Field | Type | Label | Description |
|---|
| passkey | bytes | | |
| in_file_path | string | | |
Top
skirobot/RobotDecryptFileResponse.proto
RobotDecryptFileResponse
Response for decrypting a file.
| Field | Type | Label | Description |
|---|
| code | e2ees.ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| url | string | | The url for decrypted file. |
Top
skirobot/RobotEncryptFileRequest.proto
RobotEncryptFileRequest
Request for encrypting file.
| Field | Type | Label | Description |
|---|
| passkey | bytes | | |
| in_file_path | string | | |
Top
skirobot/RobotEncryptFileResponse.proto
RobotEncryptFileResponse
Response for encrypting a file.
| Field | Type | Label | Description |
|---|
| code | e2ees.ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
| url | string | | The url for encrypted file. |
Top
skirobot/RobotGetFriendsRequest.proto
RobotGetFriendsRequest
Top
skirobot/RobotGetUserRequest.proto
RobotGetUserRequest
| Field | Type | Label | Description |
|---|
| user_address | string | | |
Top
skirobot/RobotInviteRequest.proto
RobotInviteRequest
| Field | Type | Label | Description |
|---|
| to_user | string | | |
Top
skirobot/RobotLoginRequest.proto
RobotLoginRequest
| Field | Type | Label | Description |
|---|
| user_address | string | | |
Top
skirobot/RobotLogoutRequest.proto
RobotLogoutRequest
Top
skirobot/RobotMemoFriendRequest.proto
RobotMemoFriendRequest
Top
skirobot/RobotMsgDTO.proto
RobotMsgDTO
| Field | Type | Label | Description |
|---|
| po_id | string | | |
Top
skirobot/RobotRemoveFriendRequest.proto
RobotRemoveFriendRequest
| Field | Type | Label | Description |
|---|
| to_user | string | | |
Top
skirobot/RobotRemoveGroupMembersRequest.proto
RobotRemoveGroupMembersRequest
Top
skirobot/RobotSendDecryptStatusRequest.proto
RobotSendDecryptStatusRequest
Top
skirobot/RobotSendDecryptStatusResponse.proto
RobotSendDecryptStatusResponse
Top
skirobot/RobotSendPlainMsgRequest.proto
RobotSendPlainMsgRequest
Send a group or one2one plainMsg.
Top
skirobot/RobotSendSyncPlainMsgRequest.proto
RobotSendSyncPlainMsgRequest
Send a sync plainMsg.
Top
skirobot/RobotSendSyncPlainMsgResponse.proto
RobotSendSyncPlainMsgResponse
Response for sending a sync plainMsg.
| Field | Type | Label | Description |
|---|
| code | e2ees.ResponseCode | | The response code given by the server. |
| msg | string | | The message given by the server. |
Top
skirobot/RobotUnBlockFriendRequest.proto
RobotUnBlockFriendRequest
| Field | Type | Label | Description |
|---|
| to_user | string | | |
Top
skirobot/RobotUpdatePushIdRequest.proto
RobotUpdatePushIdRequest
| Field | Type | Label | Description |
|---|
| push_id | string | | |
Top
skirobot/RobotUpdateUserNameRequest.proto
RobotUpdateUserNameRequest
| Field | Type | Label | Description |
|---|
| username | string | | |
Top
directory/E2eeDirectoryService.proto
E2eeDirectoryService
The directory unary grpc service.
Top
directory/E2eeDomainProfile.proto
E2eeDomainProfile
Profile of an e2ee service domain.
ServiceConnection
| Field | Type | Label | Description |
|---|
| api | string | | The api style (ex: restful, grpc, ws). |
| host | string | | The host. |
| port | int32 | | The port. |
Top
directory/LookupDomainProfileRequest.proto
LookupDomainProfileRequest
Request for looking up an e2ee service profile.
| Field | Type | Label | Description |
|---|
| domain | string | | The domain for retriving the profile. |
Top
directory/LookupDomainProfileResponse.proto
LookupDomainProfileResponse
Response for looking up an e2ee service profile.
Top
directory/RetrieveCertListRequest.proto
RetrieveCertListRequest
Request for retriving list of certificates by giving time stamp.
| Field | Type | Label | Description |
|---|
| ts | int64 | | The timestamp for retriving the certificates that is updated later. |
Top
directory/RetrieveCertListResponse.proto
RetrieveCertListResponse
Response for retrieving list of certificates.
Top
directory/RetrieveCertRequest.proto
RetrieveCertRequest
Request for retriving a certificate by domain.
| Field | Type | Label | Description |
|---|
| domain | string | | The domain for retriving the profile. |
Top
directory/RetrieveCertResponse.proto
RetrieveCertResponse
Response for retrieving a certificate.
Top
directory/ValidateCertRequest.proto
ValidateCertRequest
Request for validating a certificate by domain.
| Field | Type | Label | Description |
|---|
| domain | string | | The domain for retriving the profile. |
| cert_fingerprint | bytes | | The hash value as the fingerprint of cert that is being validated. |
Top
directory/ValidateCertResponse.proto
ValidateCertResponse
Response for validating a certificate.
Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|---|
| double | | double | double | float | float64 | double | float | Float |
| float | | float | float | float | float32 | float | float | Float |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |