package protos

Get desktop application:
View/edit binary Protocol Buffers messages

ViewService provides support to view management

• rpc ProcessCommand (SignedCommand, SignedCommandResponse)

  service.proto:21

  ProcessCommand processes the passed command ensuring proper access control. The returned response allows the client to understand if the operation was successfully executed and if not, the response reports the reason of the failure.

• rpc StreamCommand (stream SignedCommand, stream SignedCommandResponse)

  service.proto:23

CallView runs the view registered under fid on input and returns its result.

Used in: Command

• string fid = 1

• bytes input = 2

CallViewResponse carries the result of a CallView: the view's return value, as raw bytes when the view returns []byte and JSON otherwise. On a stream, it also frames the messages the view and the client exchange.

Used in: CommandResponse

• bytes result = 1

Command describes the type of operation that a client is requesting.

• optional Header header = 1

  Header is the header of this command

• oneof payload

  Payload is the payload of this command.

  • CallView callView = 3

A CommandResponse is returned from a server to the command submitter.

• optional CommandResponseHeader header = 1

  Header of the response.

• oneof payload

  Payload of the response.

  • Error err = 2

  • CallViewResponse callViewResponse = 4

Used in: CommandResponse

• optional google.protobuf.Timestamp timestamp = 1

  Timestamp is the time that the message was created as defined by the sender

• bytes command_hash = 2

  CommandHash is the hash computed on the concatenation of the SignedCommand's command and signature fields. If not specified differently, SHA256 is used The hash is used to link a response with its request, both for bookkeeping purposes on an asynchronous system and for security reasons (accountability, non-repudiation)

• bytes creator = 3

  Creator is the identity of the party creating this message

Error reports an application error

Used in: CommandResponse

• string message = 1

  Message associated with this response.

• bytes payload = 2

  Payload that can be used to include metadata with this response.

Header is a generic replay prevention and identity message to include in a signed command

Used in: Command

• optional google.protobuf.Timestamp timestamp = 1

  Timestamp is the local time when the message was created by the sender

• bytes nonce = 3

  Nonce is a sufficiently long random value used to ensure the request has enough entropy.

• bytes creator = 4

  Creator of the message.

• bytes tls_cert_hash = 5

  TlsCertHash is the SHA-256 of the client's TLS certificate. The view service requires it to match the connection's client certificate whenever the listener verified one.

SignedCommand is a command that carries the signature of the command's creator.

Used as request type in: ViewService.ProcessCommand, ViewService.StreamCommand

• bytes command = 1

  Command is the serialised version of a Command message

• bytes signature = 2

  Signature is the signature over command

SignedCommandResponse is a signed command response

Used as response type in: ViewService.ProcessCommand, ViewService.StreamCommand

• bytes response = 1

  Response is the serialised version of a CommandResponse message

• bytes signature = 2

  Signature is the signature over command