Protocol Documentation

api/api.proto
rpc/rpc.proto
schema/loghead.proto
- LogHead
schema/logleaf.proto
- LogLeaf
schema/mapentry.proto
- MapEntry
schema/queue.proto
- SubmitQueue
Scalar Value Types

api/api.proto

GetLogAuditProofRequest

Get log audit proof for a given tree

Field	Type	Label	Description
LogID	string	required	Log identifier
Index	uint64	required	Tree node index
TreeSize	uint64	required	Tree size (proof reference)

GetLogConsistencyProofRequest

Get a consistency proof between two given log sizes

Field	Type	Label	Description
LogID	string	required	Log identifier
FirstSize	uint64	required	From tree size
SecondSize	uint64	required	To tree size

GetLogEntriesRequest

Field	Type	Label	Description
LogID	string	required	Log identifier
Start	uint64	required	Get entries from
Finish	uint64	required	Get entries to

GetMapValueRequest

Field	Type	Label	Description
LogID	string	required	Log identifier
Key	bytes	required	Map key
MapRoot	bytes	required	Map root hash to derive proof from

KeyValuePair

Field	Type	Label	Description
Key	bytes	required	Map key
Value	bytes	required	Map value

Log

Field	Type	Label
LogID	string	required
Mode	Log.LogModes	required
Protocol	string	required
Signer	LogSigner	required
Meta	Log.MetaEntry	repeated

Log.MetaEntry

Field	Type	Label	Description
key	string	optional
value	string	optional

LogEntriesResponse

Field	Type	Label	Description
Leaves	trustix_schema.v1.LogLeaf	repeated

LogHeadRequest

Request a signed head for a given log

Field	Type	Label	Description
LogID	string	required	Log identifier

LogSigner

Field	Type	Label	Description
KeyType	LogSigner.KeyTypes	required
Public	string	required

LogsRequest

Field	Type	Label	Description
Protocols	string	repeated	Allow to filter logs response based on the protocol identifier

LogsResponse

Field	Type	Label	Description
Logs	Log	repeated

MapValueResponse

Field	Type	Label	Description
Value	bytes	required	Note that the Value field is actually a MapEntry but we need to return the marshaled version as that's what the proof is created from
Proof	SparseCompactMerkleProof	required

ProofResponse

Field	Type	Label	Description
Proof	bytes	repeated

SparseCompactMerkleProof

Sparse merkle tree proof

Field	Type	Label
SideNodes	bytes	repeated
NonMembershipLeafData	bytes	optional
BitMask	bytes	required
NumSideNodes	uint64	required

ValueRequest

Field	Type	Label	Description
Digest	bytes	required

ValueResponse

Field	Type	Label	Description
Value	bytes	required

Log.LogModes

Name	Number	Description
Log	0

LogSigner.KeyTypes

Name	Number	Description
ed25519	0

LogAPI

LogAPI is a logical grouping for RPC methods that are specific to a given log.

Method Name	Request Type	Response Type	Description
GetHead	LogHeadRequest	.trustix_schema.v1.LogHead	Get signed head
GetLogConsistencyProof	GetLogConsistencyProofRequest	ProofResponse
GetLogAuditProof	GetLogAuditProofRequest	ProofResponse
GetLogEntries	GetLogEntriesRequest	LogEntriesResponse
GetMapValue	GetMapValueRequest	MapValueResponse
GetMHLogConsistencyProof	GetLogConsistencyProofRequest	ProofResponse
GetMHLogAuditProof	GetLogAuditProofRequest	ProofResponse
GetMHLogEntries	GetLogEntriesRequest	LogEntriesResponse

NodeAPI

NodeAPI is a logical grouping for RPC methods that are for the entire node rather than individual logs.

Method Name	Request Type	Response Type	Description
Logs	LogsRequest	LogsResponse	Get a list of all logs published by this node
GetValue	ValueRequest	ValueResponse	Get values by their content-address

Top

rpc/rpc.proto

DecideRequest

Field	Type	Label	Description
Key	bytes	required
Protocol	string	required

DecisionResponse

Field	Type	Label	Description
Decision	LogValueDecision	required
Mismatches	LogValueResponse	repeated	Non-matches (hash mismatch)
Misses	string	repeated	Full misses (log ids missing log entry entirely)

EntriesResponse

Field	Type	Label	Description
Key	bytes	required
Entries	EntriesResponse.EntriesEntry	repeated

EntriesResponse.EntriesEntry

Field	Type	Label	Description
key	string	optional
value	trustix_schema.v1.MapEntry	optional

FlushRequest

Field	Type	Label	Description
LogID	string	required

FlushResponse

LogValueDecision

Field	Type	Label
LogIDs	string	repeated
Digest	bytes	required
Confidence	int32	required
Value	bytes	required

LogValueResponse

Field	Type	Label	Description
LogID	string	required
Digest	bytes	required

SubmitRequest

Field	Type	Label	Description
LogID	string	required
Items	trustix_api.v1.KeyValuePair	repeated

SubmitResponse

Field	Type	Label	Description
status	SubmitResponse.Status	required

SubmitResponse.Status

Name	Number	Description
OK	0

LogRPC

RPCApi are "private" rpc methods for an instance related to a specific log. This should only be available to trusted parties.

Method Name	Request Type	Response Type
GetHead	.trustix_api.v1.LogHeadRequest	.trustix_schema.v1.LogHead
GetLogEntries	.trustix_api.v1.GetLogEntriesRequest	.trustix_api.v1.LogEntriesResponse
Submit	SubmitRequest	SubmitResponse
Flush	FlushRequest	FlushResponse

RPCApi

RPCApi are "private" rpc methods for an instance. This should only be available to trusted parties.

Method Name	Request Type	Response Type	Description
Logs	.trustix_api.v1.LogsRequest	.trustix_api.v1.LogsResponse	Get a list of all logs published/subscribed by this node
Decide	DecideRequest	DecisionResponse	Decide on an output for key based on the configured decision method
GetValue	.trustix_api.v1.ValueRequest	.trustix_api.v1.ValueResponse	Get values by their content-address

Top

schema/loghead.proto

LogHead

Log

Field	Type	Label	Description
LogRoot	bytes	required
TreeSize	uint64	required
MapRoot	bytes	required
MHRoot	bytes	required
MHTreeSize	uint64	required
Signature	bytes	required	Aggregate signature

Top

schema/logleaf.proto

LogLeaf

Leaf value of a merkle tree

Field	Type	Label
Key	bytes	optional
ValueDigest	bytes	optional
LeafDigest	bytes	required

Top

schema/mapentry.proto

MapEntry

Field	Type	Label	Description
Digest	bytes	required	Value digest of tree node
Index	uint64	required	Index of value in log

Top

schema/queue.proto

SubmitQueue

This type is internal only and not guaranteed stable

Field	Type	Label	Description
Min	uint64	required	Min is the current (last popped) ID
Max	uint64	required	Max is the last written item

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)

Trustix Doc