Protocol Documentation

Table of Contents

• directory/E2eeDirectoryService.proto
  • E2eeDirectoryService
• directory/E2eeDomainProfile.proto
  • E2eeDomainProfile
  • ServiceConnection
• directory/LookupDomainProfileRequest.proto
  • LookupDomainProfileRequest
• directory/LookupDomainProfileResponse.proto
  • LookupDomainProfileResponse
• directory/RetrieveCertListRequest.proto
  • RetrieveCertListRequest
• directory/RetrieveCertListResponse.proto
  • RetrieveCertListResponse
• directory/RetrieveCertRequest.proto
  • RetrieveCertRequest
• directory/RetrieveCertResponse.proto
  • RetrieveCertResponse
• directory/RetrieveDomainListRequest.proto
  • RetrieveDomainListRequest
• directory/RetrieveDomainListResponse.proto
  • RetrieveDomainListResponse
• directory/ValidateCertRequest.proto
  • ValidateCertRequest
• directory/ValidateCertResponse.proto
  • ValidateCertResponse
• Scalar Value Types

Top

directory/E2eeDirectoryService.proto

E2eeDirectoryService

The directory unary grpc service.

Method Name	Request Type	Response Type	Description
LookupDomainProfile	LookupDomainProfileRequest	LookupDomainProfileResponse
RetrieveCert	RetrieveCertRequest	RetrieveCertResponse
RetrieveCertList	RetrieveCertListRequest	RetrieveCertListResponse
ValidateCert	ValidateCertRequest	ValidateCertResponse
RetrieveDomainList	RetrieveDomainListRequest	RetrieveDomainListResponse

Top

directory/E2eeDomainProfile.proto

E2eeDomainProfile

Profile of an e2ee service domain.

Field	Type	Label	Description
api_server_grpc	ServiceConnection		The grpc api server host:port.
api_server_http	ServiceConnection		The http api server host:port.
file_server_grpc	ServiceConnection		The reserved grpc file server host:port.
file_server_http	ServiceConnection		The http file server host:port.
backup_server_grpc	ServiceConnection		The optional grpc backup server host:port.
backup_server_http	ServiceConnection		The optional http backup server host:port.
streaming_server	ServiceConnection		The optional streaming server url.

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.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
profile	E2eeDomainProfile		The returned e2ee service profile.

Top

directory/RetrieveCertListRequest.proto

RetrieveCertListRequest

Request for retrieving 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.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
certificate_list	e2ees.Certificate	repeated	The returned list of certificates.

Top

directory/RetrieveCertRequest.proto

RetrieveCertRequest

Request for retrieving 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.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
certificate	e2ees.Certificate		The returned certificate.

Top

directory/RetrieveDomainListRequest.proto

RetrieveDomainListRequest

Request for retrieving a list of e2ee server domains.

Top

directory/RetrieveDomainListResponse.proto

RetrieveDomainListResponse

Response for retrieving list of e2ee server domains.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
domain_list	string	repeated	The returned list of e2ee server domains.

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.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

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)