package protocol

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ListTunnels (ListTunnelsRequest, ListTunnelsResponse)

  client_query.proto:8

  message ListTunnelsRequest

  client_query.proto:16

  (message has no fields)

  message ListTunnelsResponse

  client_query.proto:18

  • repeated ClientTunnel tunnels = 1

• rpc Acquire (LeaseRequest, LeaseResponse)

  kv.proto:19

• rpc Append (PrefixRequest, PrefixResponse)

  kv.proto:14

• rpc Contains (PrefixRequest, PrefixResponse)

  kv.proto:16

• rpc Delete (SimpleRequest, SimpleResponse)

  kv.proto:12

• rpc Get (SimpleRequest, SimpleResponse)

  kv.proto:11

• rpc Import (ImportRequest, ImportResponse)

  kv.proto:23

  message ImportRequest

  kv.proto:67

  • repeated bytes keys = 1

  • repeated KVTransfer values = 2

  message ImportResponse

  kv.proto:72

  (message has no fields)

• rpc List (PrefixRequest, PrefixResponse)

  kv.proto:15

• rpc ListKeys (ListKeysRequest, ListKeysResponse)

  kv.proto:25

  message ListKeysRequest

  kv.proto:74

  • bytes prefix = 1

  message ListKeysResponse

  kv.proto:89

  • repeated KeyComposite keys = 1

• rpc Put (SimpleRequest, SimpleResponse)

  kv.proto:10

• rpc Release (LeaseRequest, LeaseResponse)

  kv.proto:21

• rpc Remove (PrefixRequest, PrefixResponse)

  kv.proto:17

• rpc Renew (LeaseRequest, LeaseResponse)

  kv.proto:20

• rpc GetCertificate (KeylessGetCertificateRequest, KeylessGetCertificateResponse)

  keyless.proto:10

  message KeylessGetCertificateRequest

  keyless.proto:14

  • optional ProofOfWork proof = 1

  • string hostname = 2

  message KeylessGetCertificateResponse

  keyless.proto:19

  • repeated bytes certificates = 1

• rpc Sign (KeylessSignRequest, KeylessSignResponse)

  keyless.proto:11

  message KeylessSignRequest

  keyless.proto:23

  • optional ProofOfWork proof = 1

  • string hostname = 2

  • bytes digest = 3

  • KeylessSignRequest.HashAlgorithm algo = 4

  message KeylessSignResponse

  keyless.proto:37

  • bytes signature = 1

• rpc RenewCertificate (CertificateRenewalRequest, CertificateResponse)

  pki.proto:11

  message CertificateRenewalRequest

  pki.proto:18

  • optional ProofOfWork proof = 1

  • bytes current_cert_der = 2

• rpc RequestCertificate (CertificateRequest, CertificateResponse)

  pki.proto:10

  message CertificateRequest

  pki.proto:14

  • optional ProofOfWork proof = 1

• rpc AcmeInstruction (InstructionRequest, InstructionResponse)

  tunnel.proto:25

  message InstructionRequest

  tunnel.proto:140

  • optional ProofOfWork proof = 1

  • string hostname = 2

  message InstructionResponse

  tunnel.proto:145

  • string name = 1

  • string content = 2

• rpc AcmeValidate (ValidateRequest, ValidateResponse)

  tunnel.proto:26

  message ValidateRequest

  tunnel.proto:150

  • optional ProofOfWork proof = 1

  • string hostname = 2

  message ValidateResponse

  tunnel.proto:155

  • string apex = 1

• rpc GenerateHostname (GenerateHostnameRequest, GenerateHostnameResponse)

  tunnel.proto:19

  message GenerateHostnameRequest

  tunnel.proto:106

  (message has no fields)

  message GenerateHostnameResponse

  tunnel.proto:108

  • string hostname = 1

• rpc GetNodes (GetNodesRequest, GetNodesResponse)

  tunnel.proto:18

  message GetNodesRequest

  tunnel.proto:100

  (message has no fields)

  message GetNodesResponse

  tunnel.proto:102

  • repeated Node nodes = 1

• rpc ListDelegations (ListDelegationsRequest, ListDelegationsResponse)

  tunnel.proto:14

  message ListDelegationsRequest

  tunnel.proto:184

  (message has no fields)

  message ListDelegationsResponse

  tunnel.proto:186

  • repeated DelegationGrant grants = 1

• rpc MintDelegation (MintDelegationRequest, MintDelegationResponse)

  tunnel.proto:13

  message MintDelegationRequest

  tunnel.proto:174

  • string hostname = 1

  • int64 expires_at = 2

  message MintDelegationResponse

  tunnel.proto:179

  • optional DelegationGrant grant = 1

  • string token = 2

• rpc OpenDelegatedSession (OpenDelegatedSessionRequest, OpenSessionResponse)

  tunnel.proto:29

  message OpenDelegatedSessionRequest

  tunnel.proto:201

  • string token = 1

  • uint32 route_slot = 2

    Each attachment publishes exactly one of the three numbered routes.

• rpc OpenEphemeralSession (OpenEphemeralSessionRequest, OpenSessionResponse)

  tunnel.proto:28

  message OpenEphemeralSessionRequest

  tunnel.proto:199

  (message has no fields)

• rpc Ping (ClientPingRequest, ClientPingResponse)

  tunnel.proto:16

  message ClientPingRequest

  tunnel.proto:86

  (message has no fields)

  message ClientPingResponse

  tunnel.proto:88

  • optional Node node = 1

  • string apex = 2

• rpc PublishTunnel (PublishTunnelRequest, PublishTunnelResponse)

  tunnel.proto:21

  message PublishTunnelRequest

  tunnel.proto:118

  • string hostname = 1

  • repeated Node servers = 2

    servers are tun identities

  message PublishTunnelResponse

  tunnel.proto:124

  • repeated Node published = 1

• rpc RegisterIdentity (RegisterIdentityRequest, RegisterIdentityResponse)

  tunnel.proto:17

  message RegisterIdentityRequest

  tunnel.proto:93

  (message has no fields)

  message RegisterIdentityResponse

  tunnel.proto:96

  • string apex = 2

• rpc RegisteredHostnames (RegisteredHostnamesRequest, RegisteredHostnamesResponse)

  tunnel.proto:20

  message RegisteredHostnamesRequest

  tunnel.proto:112

  (message has no fields)

  message RegisteredHostnamesResponse

  tunnel.proto:114

  • repeated string hostnames = 1

• rpc ReleaseTunnel (ReleaseTunnelRequest, ReleaseTunnelResponse)

  tunnel.proto:23

  message ReleaseTunnelRequest

  tunnel.proto:134

  • string hostname = 1

  message ReleaseTunnelResponse

  tunnel.proto:138

  (message has no fields)

• rpc RevokeDelegation (RevokeDelegationRequest, RevokeDelegationResponse)

  tunnel.proto:15

  message RevokeDelegationRequest

  tunnel.proto:190

  • string id = 1

  message RevokeDelegationResponse

  tunnel.proto:194

  • bool revoked = 1

  • string index_error = 2

• rpc UnpublishTunnel (UnpublishTunnelRequest, UnpublishTunnelResponse)

  tunnel.proto:22

  message UnpublishTunnelRequest

  tunnel.proto:128

  • string hostname = 1

  message UnpublishTunnelResponse

  tunnel.proto:132

  (message has no fields)

• rpc FindSuccessor (FindSuccessorRequest, FindSuccessorResponse)

  chord.proto:14

  message FindSuccessorRequest

  chord.proto:42

  • uint64 key = 1

  message FindSuccessorResponse

  chord.proto:46

  • optional Node successor = 1

• rpc FinishJoin (MembershipConclusionRequest, MembershipConclusionResponse)

  chord.proto:19

• rpc FinishLeave (MembershipConclusionRequest, MembershipConclusionResponse)

  chord.proto:21

• rpc GetPredecessor (GetPredecessorRequest, GetPredecessorResponse)

  chord.proto:16

  message GetPredecessorRequest

  chord.proto:50

  (message has no fields)

  message GetPredecessorResponse

  chord.proto:52

  • optional Node predecessor = 1

• rpc GetSuccessors (GetSuccessorsRequest, GetSuccessorsResponse)

  chord.proto:15

  message GetSuccessorsRequest

  chord.proto:56

  (message has no fields)

  message GetSuccessorsResponse

  chord.proto:58

  • repeated Node successors = 1

• rpc Identity (IdentityRequest, IdentityResponse)

  chord.proto:10

  message IdentityRequest

  chord.proto:26

  (message has no fields)

  message IdentityResponse

  chord.proto:28

  • optional Node identity = 1

• rpc Notify (NotifyRequest, NotifyResponse)

  chord.proto:13

  message NotifyRequest

  chord.proto:36

  • optional Node predecessor = 1

  message NotifyResponse

  chord.proto:40

  (message has no fields)

• rpc Ping (PingRequest, PingResponse)

  chord.proto:11

  message PingRequest

  chord.proto:32

  (message has no fields)

  message PingResponse

  chord.proto:34

  (message has no fields)

• rpc RequestToJoin (RequestToJoinRequest, RequestToJoinResponse)

  chord.proto:18

  message RequestToJoinRequest

  chord.proto:62

  • optional Node joiner = 1

  message RequestToJoinResponse

  chord.proto:66

  • optional Node predecessor = 1

  • repeated Node successors = 2

• rpc RequestToLeave (RequestToLeaveRequest, RequestToLeaveResponse)

  chord.proto:20

  message RequestToLeaveRequest

  chord.proto:71

  • optional Node leaver = 1

  message RequestToLeaveResponse

  chord.proto:75

  (message has no fields)

Used as response type in: PKIService.RenewCertificate, PKIService.RequestCertificate

• bytes cert_der = 1

• bytes cert_pem = 2

Used in: CustomHostname, DelegationRecord

• bytes token = 1

Used in: ListTunnelsResponse

• string hostname = 1

• string target = 2

• optional Node identity = 1

• Connection.State cache_state = 2

• Connection.Direction cache_direction = 3

• string version = 5

Used in: Connection

• UNKNOWN_DIRECTION = 0

• INCOMING = 1

• OUTGOING = 2

Used in: Connection

• UNKNOWN_STATE = 0

• CACHED = 1

• FRESH = 2

• Context.TargetType requestTarget = 1

Used in: Context

• UNKNOWN = 0

• KV_REPLICATION = 1

• KV_DIRECT_TARGET = 2

• optional Node client_identity = 1

• optional ClientToken client_token = 2

• Datagram.Type type = 1

• bytes data = 2

Used in: Datagram

• UNKNOWN = 0

• ALIVE = 1

• DATA = 2

• RTT_SYN = 3

• RTT_ACK = 4

Used in: ListDelegationsResponse, MintDelegationResponse

• string id = 1

• string hostname = 2

• int64 expires_at = 3

• bool incomplete = 4

• uint32 version = 1

• string id = 2

• optional ClientToken owner = 3

• string hostname = 4

• int64 expires_at = 5

(message has no fields)

Used in: proto.Mutation, ImportRequest

• optional bytes simple_value = 1

  Presence distinguishes an empty simple value from no simple value, even when a prefix or lease shares the key. Keep tag 1 for legacy readers.

• repeated bytes prefix_children = 2

• uint64 lease_token = 3

Used in: ListKeysResponse

• bytes key = 1

• KeyComposite.Type type = 2

Used in: KeyComposite

• UNKNOWN = 0

• SIMPLE = 1

• PREFIX = 2

• LEASE = 3

Used in: KeylessSignRequest

• UNKNOWN = 0

• SHA256 = 1

• SHA384 = 2

• SHA512 = 3

Used as request type in: KVService.Acquire, KVService.Release, KVService.Renew

• bytes lease = 1

• uint64 new_token = 2

• uint64 prev_token = 3

• optional google.protobuf.Duration ttl = 5

Used as response type in: KVService.Acquire, KVService.Release, KVService.Renew

• uint64 token = 1

• Link.ALPN alpn = 1

• string hostname = 2

• string remote = 3

Used in: Link

• UNKNOWN = 0

• SPECTER_CHORD = 1

• SPECTER_CLIENT = 2

• HTTP2 = 9

• HTTP = 10

• TCP = 11

Used as request type in: VNodeService.FinishJoin, VNodeService.FinishLeave

• bool stabilize = 1

• bool release = 2

Used as response type in: VNodeService.FinishJoin, VNodeService.FinishLeave

(message has no fields)

Used in: ClientPingResponse, Connection, CustomHostname, FindSuccessorResponse, GetNodesResponse, GetPredecessorResponse, GetSuccessorsResponse, IdentityResponse, NotifyRequest, OpenSessionResponse, PublishTunnelRequest, PublishTunnelResponse, RequestToJoinRequest, RequestToJoinResponse, RequestToLeaveRequest, Stream, TunnelDestination, TunnelRoute

• uint64 id = 1

• string address = 2

• bool unknown = 3

  indicate negotiation for ID is needed

• bool rendezvous = 4

  indicate a client connection

Used as response type in: TunnelService.OpenDelegatedSession, TunnelService.OpenEphemeralSession

• string hostname = 1

• string apex = 2

• string grant_id = 3

• int64 expires_at = 4

• optional Node node = 5

Used as request type in: KVService.Append, KVService.Contains, KVService.List, KVService.Remove

• bytes prefix = 1

• bytes child = 2

Used as response type in: KVService.Append, KVService.Contains, KVService.List, KVService.Remove

• repeated bytes children = 1

• bool exists = 2

Used in: CertificateRenewalRequest, CertificateRequest, InstructionRequest, KeylessGetCertificateRequest, KeylessSignRequest, ValidateRequest

• bytes pub_key = 1

• bytes signature = 2

• string solution = 3

Used as request type in: KVService.Delete, KVService.Get, KVService.Put

• bytes key = 1

• bytes value = 2

Used as response type in: KVService.Delete, KVService.Get, KVService.Put

• bytes value = 1

• Stream.Type type = 1

• optional Node target = 2

Used in: Stream

• UNKNOWN_TYPE = 0

• RPC = 1

  used for rpc between nodes and between client/server

• DIRECT = 2

  used for establishing the reverse proxy from the tunneling node to client

• PROXY = 3

  used when client is not directly connected to the tunneling node

• INTERNAL = 4

  used for /_internal endpoint proxying between nodes

• optional Node chord = 1

• optional Node tunnel = 2

• optional Node client_destination = 1

• optional Node chord_destination = 2

• optional Node tunnel_destination = 3

• string hostname = 10

• TunnelStatusCode status = 2

• string error = 3

Used in: TunnelStatus

• STATUS_OK = 0

• UNKNOWN_ERROR = 1

• NO_DIRECT = 2