package protocol
Get desktop application:
View/edit binary Protocol Buffers messages
rpc ListTunnels (, )
client_query.proto:8message
client_query.proto:16(message has no fields)
message
client_query.proto:18repeated tunnels = 1
service ConfigService
config.proto:9Each physical server provides keyed reads of its local configuration replica. Snapshot exchange is exposed only on authenticated Chord CONFIG streams.
rpc Exchange (, )
config.proto:10message
config.proto:14bytes data = 1
The shared configuration snapshot format, bounded to 8 MiB. Keeping it opaque here lets storage and replication use the same bounded codec.
rpc Get (, )
config.proto:11message
config.proto:20string name = 1
message
config.proto:24string name = 1
bytes version = 2
The opaque 48-byte version used by configuration storage and replication.
bytes value = 3
Complete document bytes, including schemas unknown to this server.
service KVService
kv.proto:9rpc Acquire (, )
kv.proto:19rpc Append (, )
kv.proto:14rpc Contains (, )
kv.proto:16rpc Delete (, )
kv.proto:12rpc Get (, )
kv.proto:11rpc Import (, )
kv.proto:23message
kv.proto:67repeated bytes keys = 1
repeated values = 2
message
kv.proto:72(message has no fields)
rpc List (, )
kv.proto:15rpc ListKeys (, )
kv.proto:25message
kv.proto:74bytes prefix = 1
message
kv.proto:89repeated keys = 1
rpc Put (, )
kv.proto:10rpc Release (, )
kv.proto:21rpc Remove (, )
kv.proto:17rpc Renew (, )
kv.proto:20
service KeylessService
keyless.proto:9rpc GetCertificate (, )
keyless.proto:10message
keyless.proto:14optional proof = 1
string hostname = 2
message
keyless.proto:19repeated bytes certificates = 1
rpc Sign (, )
keyless.proto:11message
keyless.proto:23optional proof = 1
string hostname = 2
bytes digest = 3
KeylessSignRequest.HashAlgorithm algo = 4
message
keyless.proto:37bytes signature = 1
service PKIService
pki.proto:9rpc RenewCertificate (, )
pki.proto:11message
pki.proto:18optional proof = 1
bytes current_cert_der = 2
rpc RequestCertificate (, )
pki.proto:10message
pki.proto:14optional proof = 1
service TunnelService
tunnel.proto:13rpc AcmeInstruction (, )
tunnel.proto:28message
tunnel.proto:143optional proof = 1
string hostname = 2
message
tunnel.proto:148string name = 1
string content = 2
rpc AcmeValidate (, )
tunnel.proto:29message
tunnel.proto:153optional proof = 1
string hostname = 2
message
tunnel.proto:158string apex = 1
rpc GenerateHostname (, )
tunnel.proto:20message
tunnel.proto:109(message has no fields)
message
tunnel.proto:111string hostname = 1
rpc GetHostWAF (, )
tunnel.proto:25message
waf.proto:51string hostname = 1
rpc GetNodes (, )
tunnel.proto:19message
tunnel.proto:103(message has no fields)
message
tunnel.proto:105repeated nodes = 1
rpc ListDelegations (, )
tunnel.proto:15message
tunnel.proto:187(message has no fields)
message
tunnel.proto:189repeated grants = 1
rpc MintDelegation (, )
tunnel.proto:14message
tunnel.proto:177string hostname = 1
int64 expires_at = 2
message
tunnel.proto:182optional grant = 1
string token = 2
rpc OpenDelegatedSession (, )
tunnel.proto:32message
tunnel.proto:204string token = 1
uint32 route_slot = 2
Each attachment publishes exactly one of the three numbered routes.
rpc OpenEphemeralSession (, )
tunnel.proto:31message
tunnel.proto:202(message has no fields)
rpc Ping (, )
tunnel.proto:17message
tunnel.proto:89(message has no fields)
message
tunnel.proto:91optional node = 1
string apex = 2
rpc PublishTunnel (, )
tunnel.proto:22message
tunnel.proto:121string hostname = 1
repeated servers = 2
servers are tun identities
message
tunnel.proto:127repeated published = 1
rpc RegisterIdentity (, )
tunnel.proto:18message
tunnel.proto:96(message has no fields)
message
tunnel.proto:99string apex = 2
rpc RegisteredHostnames (, )
tunnel.proto:21message
tunnel.proto:115(message has no fields)
message
tunnel.proto:117repeated string hostnames = 1
rpc ReleaseTunnel (, )
tunnel.proto:24message
tunnel.proto:137string hostname = 1
message
tunnel.proto:141(message has no fields)
rpc RevokeDelegation (, )
tunnel.proto:16message
tunnel.proto:193string id = 1
message
tunnel.proto:197bool revoked = 1
string index_error = 2
rpc SetHostWAF (, )
tunnel.proto:26message
waf.proto:55string hostname = 1
string expected_version = 2
optional policy = 3
rpc UnpublishTunnel (, )
tunnel.proto:23message
tunnel.proto:131string hostname = 1
message
tunnel.proto:135(message has no fields)
service VNodeService
chord.proto:9rpc FindSuccessor (, )
chord.proto:14message
chord.proto:42uint64 key = 1
message
chord.proto:46optional successor = 1
rpc FinishJoin (, )
chord.proto:19rpc FinishLeave (, )
chord.proto:21rpc GetPredecessor (, )
chord.proto:16message
chord.proto:50(message has no fields)
message
chord.proto:52optional predecessor = 1
rpc GetSuccessors (, )
chord.proto:15message
chord.proto:56(message has no fields)
message
chord.proto:58repeated successors = 1
rpc Identity (, )
chord.proto:10message
chord.proto:26(message has no fields)
message
chord.proto:28optional identity = 1
rpc Notify (, )
chord.proto:13message
chord.proto:36optional predecessor = 1
message
chord.proto:40(message has no fields)
rpc Ping (, )
chord.proto:11message
chord.proto:32(message has no fields)
message
chord.proto:34(message has no fields)
rpc RequestToJoin (, )
chord.proto:18message
chord.proto:62optional joiner = 1
message
chord.proto:66optional predecessor = 1
repeated successors = 2
rpc RequestToLeave (, )
chord.proto:20message
chord.proto:71optional leaver = 1
message
chord.proto:75(message has no fields)
message
pki.proto:23Used as response type in: PKIService.RenewCertificate, PKIService.RequestCertificate
bytes cert_der = 1
bytes cert_pem = 2
message
tunnel.proto:85Used in: ,
bytes token = 1
message
client_query.proto:11Used in:
string hostname = 1
string target = 2
message
transport.proto:36optional identity = 1
Connection.State cache_state = 2
Connection.Direction cache_direction = 3
string version = 5
Used in:
UNKNOWN_DIRECTION = 0
INCOMING = 1
OUTGOING = 2
Used in:
UNKNOWN_STATE = 0
CACHED = 1
FRESH = 2
message
rpc.proto:7Context.TargetType requestTarget = 1
Used in:
UNKNOWN = 0
KV_REPLICATION = 1
KV_DIRECT_TARGET = 2
message
tunnel.proto:55optional client_identity = 1
optional client_token = 2
message
transport.proto:23Datagram.Type type = 1
bytes data = 2
Used in:
UNKNOWN = 0
ALIVE = 1
DATA = 2
RTT_SYN = 3
RTT_ACK = 4
message
tunnel.proto:170Used in: ,
string id = 1
string hostname = 2
int64 expires_at = 3
bool incomplete = 4
message
tunnel.proto:162uint32 version = 1
string id = 2
optional owner = 3
string hostname = 4
int64 expires_at = 5
message
chord.proto:24(message has no fields)
message
waf.proto:45uint32 schema = 1
bytes owner = 2
optional policy = 3
message
waf.proto:61Used as response type in: TunnelService.GetHostWAF, TunnelService.SetHostWAF
string hostname = 1
string version = 2
optional policy = 3
message
kv.proto:59Used in: ,
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
message
kv.proto:78Used in:
bytes key = 1
KeyComposite.Type type = 2
Used in:
UNKNOWN = 0
SIMPLE = 1
PREFIX = 2
LEASE = 3
Used in:
UNKNOWN = 0
SHA256 = 1
SHA384 = 2
SHA512 = 3
message
kv.proto:47Used as request type in: KVService.Acquire, KVService.Release, KVService.Renew
bytes lease = 1
uint64 new_token = 2
uint64 prev_token = 3
optional ttl = 5
message
kv.proto:55Used as response type in: KVService.Acquire, KVService.Release, KVService.Renew
uint64 token = 1
message
tunnel.proto:39Link.ALPN alpn = 1
string hostname = 2
string remote = 3
Used in:
UNKNOWN = 0
SPECTER_CHORD = 1
SPECTER_CLIENT = 2
HTTP2 = 9
HTTP = 10
TCP = 11
message
chord.proto:77Used as request type in: VNodeService.FinishJoin, VNodeService.FinishLeave
bool stabilize = 1
bool release = 2
message
chord.proto:82Used as response type in: VNodeService.FinishJoin, VNodeService.FinishLeave
(message has no fields)
message
node.proto:7Used in: , , , , , , , , , , , , , , , , ,
uint64 id = 1
string address = 2
bool unknown = 3
indicate negotiation for ID is needed
bool rendezvous = 4
indicate a client connection
message
tunnel.proto:210Used as response type in: TunnelService.OpenDelegatedSession, TunnelService.OpenEphemeralSession
string hostname = 1
string apex = 2
string grant_id = 3
int64 expires_at = 4
optional node = 5
message
kv.proto:37Used as request type in: KVService.Append, KVService.Contains, KVService.List, KVService.Remove
bytes prefix = 1
bytes child = 2
message
kv.proto:42Used as response type in: KVService.Append, KVService.Contains, KVService.List, KVService.Remove
repeated bytes children = 1
bool exists = 2
message
pow.proto:7Used in: , , , , ,
bytes pub_key = 1
bytes signature = 2
string solution = 3
message
waf.proto:40string expected_version = 1
optional config = 2
message
kv.proto:28Used as request type in: KVService.Delete, KVService.Get, KVService.Put
bytes key = 1
bytes value = 2
message
kv.proto:33Used as response type in: KVService.Delete, KVService.Get, KVService.Put
bytes value = 1
message
transport.proto:9Stream.Type type = 1
optional target = 2
Used in:
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
CONFIG = 5
used for shared configuration between authenticated physical Chord peers
message
tunnel.proto:68optional chord = 1
optional tunnel = 2
message
tunnel.proto:60optional client_destination = 1
optional chord_destination = 2
optional tunnel_destination = 3
string hostname = 10
message
tunnel.proto:80TunnelStatusCode status = 2
string error = 3
Used in:
STATUS_OK = 0
UNKNOWN_ERROR = 1
NO_DIRECT = 2
message
waf.proto:7Used in:
uint32 rule_id = 1
string path = 2
Exact escaped URL path without a query string. Empty means every path.
message
waf.proto:13Used in: , ,
WAFPolicy.Mode mode = 1
repeated exclusions = 2
Used in: ,
UNKNOWN_MODE = 0
INHERIT = 1
BLOCK = 2
MONITOR = 3
OFF = 4
message
waf.proto:27Shared operator intent. Downloaders never write it.
Used in:
bool enabled = 1
WAFPolicy.Mode default_mode = 2
WAFSettings.Channel channel = 3
string pinned_version = 4
Used in:
UNKNOWN_CHANNEL = 0
LTS = 1
STABLE = 2