@tdxvolt/volt-client-grpc 0.11.8 → 0.14.60

package/lib/index.cjs

@@ -603,6 +603,7 @@ class VoltCredential {
       aud: audience,
       iat: Math.floor(Date.now() / 1000) - ttl,
       exp: Math.floor(Date.now() / 1000) + ttl,
+      sub: this._cryptoCache.client_id,
     };
 
     let sharedKey;
@@ -1082,50 +1083,55 @@ class GRPCCall extends EventEmitter__default["default"] {
 const log$2 = debug__default["default"]("volt-client-grpc:volt-connection");
 
 function _cleanUp(immediateReconnect) {
-	this._session = false;
-
-	if (this._pingTimer) {
-		clearTimeout(this._pingTimer);
-		this._pingTimer = 0;
-	}
-
-	if (this._pingTimeoutTimer) {
-		clearTimeout(this._pingTimeoutTimer);
-		this._pingTimeoutTimer = 0;
-	}
-
-	if (
-		!this._dying &&
-		(immediateReconnect || (this._autoRetry && !this._reconnectTimer))
-	) {
-		this._reconnectTimer = setTimeout(
-			() => {
-				this._reconnectTimer = 0;
-				_doConnect.call(this);
-			},
-			immediateReconnect ? 0 : this._reconnectInterval,
-		);
-	}
-
-	if (this.call?.writable) {
-		this.call.end();
-	}
+  this._connectionId = "";
+
+  if (this._pingTimer) {
+    clearTimeout(this._pingTimer);
+    this._pingTimer = 0;
+  }
+
+  if (this._pingTimeoutTimer) {
+    clearTimeout(this._pingTimeoutTimer);
+    this._pingTimeoutTimer = 0;
+  }
+
+  if (
+    !this._dying &&
+    (immediateReconnect || (this._autoRetry && !this._reconnectTimer))
+  ) {
+    this._reconnectTimer = setTimeout(
+      () => {
+        this._reconnectTimer = 0;
+        _doConnect.call(this, this._helloPayload);
+      },
+      immediateReconnect ? 0 : this._reconnectInterval,
+    );
+  }
+
+  if (this.call?.writable) {
+    this.call.end();
+  }
 }
 
 function _connectionTimeoutHandler() {
-	log$2("server timed out");
-	this.emit("connected", false);
-	_cleanUp.call(this);
+  log$2("server timed out");
+  this.emit("connected", false);
+  _cleanUp.call(this);
 }
 
-function _doConnect() {
-	this.call = new GRPCCall(this._voltClient, "Connect", "METHOD_TYPE_BIDI");
+function _doConnect(connectHello) {
+  this.call = new GRPCCall(this._voltClient, "Connect", "METHOD_TYPE_BIDI");
+
+  const grpcClient = this._voltClient.getVoltAPIClient();
+
+  let helloPayload = connectHello;
+  if (!connectHello) {
+    log$2("defaulting hello payload");
+    helloPayload = {
+      hello: {},
+    };
+  }
 
-	const grpcClient = this._voltClient.getVoltAPIClient();
-	const helloPayload = {
-		hello: {},
-	};
-  
   this.call.on("error", (err) => {
     log$2("error on connection stream [%s]", err.message);
     _cleanUp.call(this);
@@ -1146,10 +1152,11 @@ function _doConnect() {
         _startPingTimer.call(this);
         break;
       }
-      case "hello": {
-        if (!this._session) {
-          this._session = true;
-          this.emit("connected", this._session);
+      case "acknowledge": {
+        if (!this._connectionId) {
+          this._connectionId = response.acknowledge.connection_id;
+          log$2("connection id is %s", this._connectionId);
+          this.emit("connected", this._connectionId);
         }
         break;
       }
@@ -1165,74 +1172,76 @@ function _doConnect() {
   });
 
   this.call.on("end", () => {
-    if (this._session) {
+    if (this._connectionId) {
       this.emit("connected", false);
     }
     _cleanUp.call(this);
   });
 
-	this.call.start(grpcClient, helloPayload);
+  this.call.start(grpcClient, helloPayload);
 
-	_startPingTimer.call(this);
+  _startPingTimer.call(this);
 }
 
 function _startPingTimer() {
-	if (this._pingTimer) {
-		log$2("ping timer running");
-		return;
-	}
-
-	this._pingTimer = setTimeout(() => {
-		// Send next ping to server.
-		const request = { ping: { timestamp: Date.now() } };
-
-		log$2("pinging Volt");
-		this.call.write(request);
-
-		this._pingTimer = 0;
-
-		// Schedule a timeout if we don't hear back from the server.
-		if (this._pingTimeoutTimer) {
-			clearTimeout(this._pingTimeoutTimer);
-		}
-
-		this._pingTimeoutTimer = setTimeout(
-			_connectionTimeoutHandler.bind(this),
-			this._timeoutInterval,
-		);
-	}, this._pingInterval);
+  if (this._pingTimer) {
+    log$2("ping timer running");
+    return;
+  }
+
+  this._pingTimer = setTimeout(() => {
+    // Send next ping to server.
+    const request = { ping: { timestamp: Date.now() } };
+
+    log$2("pinging Volt");
+    this.call.write(request);
+
+    this._pingTimer = 0;
+
+    // Schedule a timeout if we don't hear back from the server.
+    if (this._pingTimeoutTimer) {
+      clearTimeout(this._pingTimeoutTimer);
+    }
+
+    this._pingTimeoutTimer = setTimeout(
+      _connectionTimeoutHandler.bind(this),
+      this._timeoutInterval,
+    );
+  }, this._pingInterval);
 }
 
 class VoltConnection extends EventEmitter__default["default"] {
-	constructor(voltClient, grpc) {
-		super();
-
-		const config = voltClient.config;
-		this._grpc = grpc;
-		this._autoRetry =
-			config.autoReconnect === undefined ? true : !!config.autoReconnect;
-		this._dying = false;
-		this._voltClient = voltClient;
-		this._pingTimer = 0;
-		this._pingTimeoutTimer = 0;
-		this._session = false;
-		this._pingInterval = config.pingInterval || 10000;
-		this._reconnectInterval = config.reconnectInterval || 5000;
-		this._timeoutInterval = config.timeoutInterval || 60000;
-	}
-
-	connect(throwOnFail) {
-		if (throwOnFail) {
-			return _doConnect.call(this);
-		} else {
-			return Promise.resolve(_cleanUp.call(this, true));
-		}
-	}
-
-	disconnect() {
-		this._dying = true;
-		_cleanUp.call(this);
-	}
+  constructor(voltClient, grpc) {
+    super();
+
+    const config = voltClient.config;
+    this._grpc = grpc;
+    this._autoRetry =
+      config.autoReconnect === undefined ? true : !!config.autoReconnect;
+    this._dying = false;
+    this._voltClient = voltClient;
+    this._pingTimer = 0;
+    this._pingTimeoutTimer = 0;
+    this._connectionId = "";
+    this._pingInterval = config.pingInterval || 10000;
+    this._reconnectInterval = config.reconnectInterval || 5000;
+    this._timeoutInterval = config.timeoutInterval || 60000;
+    this._helloPayload = undefined;
+  }
+
+  connect(helloPayload, throwOnFail) {
+    this._helloPayload = helloPayload;
+    if (throwOnFail) {
+      return _doConnect.call(this, this._helloPayload);
+    } else {
+      return Promise.resolve(_cleanUp.call(this, true));
+    }
+  }
+
+  disconnect() {
+    this._dying = true;
+    _cleanUp.call(this);
+  }
 }
 
 /* eslint-disable no-underscore-dangle */
@@ -1268,10 +1277,10 @@ function issueBind(bindRequest, ttl) {
           // This is the certificate assigned to us by the volt.
           this._credential.cache.cert = bindResponse.cert;
 
-          // This is the signing CA used by the volt (don't ov)
+          // This is the signing CA used by the volt.
           this._credential.cache.ca = bindResponse.chain;
 
-          // Resource id is assigned by the volt.
+          // Identity resource id is assigned by the volt.
           this._credential.cache.client_id = bindResponse.identity_id;
           this._credential.saveCache();
           break;
@@ -1413,7 +1422,7 @@ async function bindInternal() {
   }
 }
 
-function connectInternal() {
+function connectInternal(helloPayload) {
   try {
     if (this._voltConnection) {
       log$1("connectInternal - Volt connection already exists");
@@ -1443,7 +1452,7 @@ function connectInternal() {
       if (!this._connected) {
         onDisconnected();
       }
-      this.emit("connected", !!session);
+      this.emit("connected", session);
     });
 
     this._voltConnection.on("error", (err) => {
@@ -1459,7 +1468,7 @@ function connectInternal() {
       this.emit("evt", evt);
     });
 
-    return this._voltConnection.connect();
+    return this._voltConnection.connect(helloPayload);
   } catch (err) {
     log$1("connect - error [%s]", err.message);
     throw err;
@@ -1758,10 +1767,10 @@ class VoltClient extends EventEmitter__default["default"] {
     }
   }
 
-  initialiseAndConnect(configPath, extras = {}) {
+  initialiseAndConnect(configPath, helloPayload = undefined, extras = {}) {
     return this.initialise(configPath, extras)
       .then(() => {
-        return connectInternal.call(this);
+        return connectInternal.call(this, helloPayload);
       })
       .catch((err) => {
         log("initialiseAndConnect failure: %s", err.message);
@@ -1834,8 +1843,8 @@ class VoltClient extends EventEmitter__default["default"] {
     return this.isRemote && !this._voltConfig?.relay.cloud;
   }
 
-  connect() {
-    return connectInternal.call(this);
+  connect(helloPayload) {
+    return connectInternal.call(this, helloPayload);
   }
 
   disconnect() {

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.11.8",
+  "version": "0.14.60",
   "description": "tdx Volt library for nodejs clients",
   "type": "module",
   "exports": {

package/protobuf/tdx/volt_api/data/v1/sqlite_database_api.proto

@@ -16,6 +16,9 @@ service SqliteDatabaseAPI {
   rpc Execute(stream SqlExecuteRequest) returns (stream SqlExecuteResponse);
 
   // Import CSV data into a table.
+  // The import handler will inspect the incoming CSV data, infer the columns and data types required, and create and populate the SQL table.
+  // The CSV must contain a header row containing the column names and at least one row of data so that the types can be inferred.
+  // The importer assumes all data in any given CSV file relates to a single table.
   // The data can either be streamed in chunks or retrieved from an existing resource.
   // If the data is streamed in chunks, the client must call the Close() method on the stream to indicate that it has finished.
   rpc ImportCSV(stream SqlImportCSVRequest) returns (stream SqlImportCSVResponse);
@@ -51,7 +54,7 @@ message SqlExecuteRequest {
   // This field is only relevant to 'query' databases, i.e. those with kind `tdx:sqlite-query`.
   // The values in the list should be in the same order as the parameters defined by the query attributes.
   // A query may have no parameters defined, in which case leave this field empty.
-  repeated tdx.volt_api.volt.v1.AttributeValue parameter = 4;
+  map<string, tdx.volt_api.volt.v1.AttributeValue> parameter = 4;
 }
 
 // One of the following fields will be present in any given message.
@@ -88,6 +91,7 @@ message SqlImportCSVConfiguration {
   uint32 progress_interval = 5;
 }
 
+// Each message must contain one and only one of the following fields.
 message SqlImportCSVRequest {
   oneof payload {
     // The initial request must contain the configuration parameters for the import.

package/protobuf/tdx/volt_api/relay/v1/relay_api.proto

@@ -7,7 +7,7 @@ import "tdx/volt_api/volt/v1/remote.proto";
 import "tdx/volt_api/volt/v1/volt.proto";
 
 service RelayAPI {
-  // Retrieve the list of Volts available on the Relay Volt or cloud-based tunnel.
+  // Retrieve the list of Volts available on the Relay Volt.
   rpc GetVoltEndpoint(GetVoltEndpointRequest) returns (GetVoltEndpointResponse);
 
   // This is the actual tunnel stream.

package/protobuf/tdx/volt_api/volt/v1/file_api.proto

@@ -8,7 +8,7 @@ import "tdx/volt_api/volt/v1/file.proto";
 // The File API exposes basic file management functions.
 service FileAPI {
 
-  // Download from file resource.
+  // A server-stream to download contents from a file resource.
   rpc DownloadFile(DownloadFileRequest) returns (stream DownloadFileResponse);
 
   // Get file resource metadata.

package/protobuf/tdx/volt_api/volt/v1/remote.proto

@@ -48,7 +48,6 @@ message MethodInvoke {
   string service_id = 2;
   string method_name = 3;
   MethodType method_type = 4;
-  string token = 5;
   oneof invoke_request {
     bytes request = 6;
     string json_request = 7;

package/protobuf/tdx/volt_api/volt/v1/volt.proto

@@ -53,8 +53,7 @@ enum ShareMode {
 
 // Represents an outbound connection from a Volt to a remote service that will act as a proxy for that Volt.
 // This enables Volts to bypass firewall and NATs.
-// Example 1 - connection from a Volt to the cloud-based Volt tunnel at cloud.tdxvolt.com
-// Example 2 - connection from a Volt to Relay Volt running on the public internet, such as tdxvolt.com
+// Example - connection from a Volt to a Relay Volt running on the public internet, such as tdxvolt.com
 message ProxyConnection {
   // Unique connection id.
   string id = 1;
@@ -74,9 +73,6 @@ message ProxyConnection {
   // Indicates this connection is currently in use.
   bool connected = 6;
 
-  // Indicates this is a connection to a cloud-based tunnel, rather than to a Relay Volt.
-  bool is_cloud_connection = 7;
-
   // Indicates that this connection will handle HTTP proxying as well as GRPC.
   bool enable_http_proxy = 8;
 
@@ -196,12 +192,15 @@ message VoltParameters {
   // The certificate authority of the Relay if this is a remote connection via a Relay.
   string relay_ca_pem = 33;
 
-  // Set to indicate this is a remote connection to a Volt via a cloud tunnel.
-  bool is_cloud_relay = 34;
-
   // An optional alias that can be used to refer to the Volt rather than the `id` field.
   // This alias must be unique within the scope of the Battery in which the Volt is stored.
   string alias = 35;
+
+  // The runtime version this Volt is running.
+  Version version = 36;
+
+  // If set, indicates that any client that provides the correct challenge in the bind phase will automatically be approved to access the Volt.
+  bool approve_on_challenge = 37;
 }
 
 message VoltEndpoint {
@@ -260,28 +259,54 @@ message ProtoFile {
   repeated string service_name = 3;
 }
 
+enum ServiceHostType {
+  SERVICE_HOST_TYPE_UNKNOWN = 0;
+  SERVICE_HOST_TYPE_BUILTIN = 1;
+  SERVICE_HOST_TYPE_SERVER = 2;
+  SERVICE_HOST_TYPE_RELAYED = 3;
+}
+
 // Describes a Volt service.
 message ServiceDescription {
+  ServiceHostType host_type = 1;
+
   // The id of the server resource that is hosting this service.
-  string server_id = 1;
+  // For built-in services, i.e. those hosted by the Volt, this will set to the Volt id.
+  string host_service_id = 2;
+
+  // The identity of the client that is exposing the service via a relay connection.
+  // This will be empty if the service is exposed via a grpc server.
+  string host_client_id = 3;
 
   // The address of the grpc server hosting this service.
-  string address = 2;
+  // This will be empty if the service is hosted by a relay client (see `relay_public_key` below).
+  string host_address = 4;
+
+  // The certificate authority (chain) that signed the service server certificate.
+  // This is only relevant to grpc-hosted services.
+  string host_ca_pem = 5;
+
+  // The public key of the service host, which is used to encrypt payloads.
+  // This may change as the service comes and goes online.
+  string host_public_key = 6;
+
+  // The fingerprint derived from `host_public_key`, included for convenience.
+  string host_fingerprint = 7;
+
+  // The connection id currently used to host this service.
+  string host_connection_id = 8;
 
   // The discovery mode.
-  DiscoveryMode discoverable = 4;
+  DiscoveryMode discoverable = 10;
 
   // The ping timestamp of the server hosting this service.
-  int64 ping_timestamp = 5;
+  int64 ping_timestamp = 11;
 
   // The protobuf definitions of the APIs exposed by this service.
-  repeated ProtoFile proto_file = 6;
+  repeated ProtoFile proto_file = 12;
 
   // The fully qualified names of the protobuf services, for example tdx.volt_api.webcam.v1.WebcamControlAPI.
-  repeated string service_api = 7;
-
-  // The certificate authority (chain) that signed the service server certificate.
-  string ca_pem = 8;
+  repeated string service_api = 13;
 
   // Internal use only.
   repeated MethodDescription method = 100;
@@ -376,7 +401,7 @@ message Resource {
   repeated string kind = 110;
 
   // The online status.
-  // For most kinds of resource this indicates that the server hosting the resource is online, the exception being identity resources, in which case the status reflects whether or not the identity has a live session.
+  // For most kinds of resource this indicates that the server hosting the resource is online, the exception being identity resources, in which case the status reflects whether or not the identity has a live connection.
   // All built-in resources are hosted by the Volt itself and are therefore always online when the Volt is running.
   // Resources hosted by external servers are online if the server itself is online and has registered the resource as online using `setServiceStatus`.
   OnlineStatus online_status = 111;
@@ -403,28 +428,6 @@ enum IdentityType {
   IDENTITY_TYPE_GROUP = 3;
 }
 
-enum IdentityAliasType {
-  IDENTITY_ALIAS_TYPE_UNKNOWN = 0;
-  IDENTITY_ALIAS_TYPE_PUBLIC_KEY = 1;
-  IDENTITY_ALIAS_TYPE_COMMON_NAME = 2;
-}
-
-enum IdentityAliasSubType {
-  IDENTITY_ALIAS_SUB_TYPE_UNKNOWN = 0;
-
-  // Identifies email common name aliases.
-  IDENTITY_ALIAS_SUB_TYPE_EMAIL = 1;
-
-  // Identifies phone number common name aliases.
-  IDENTITY_ALIAS_SUB_TYPE_PHONE = 2;
-
-  // Identifies DNS common name aliases.
-  IDENTITY_ALIAS_SUB_TYPE_DNS = 3;
-
-  // Identifies public key aliases that originate from owner credentials rather than the identity itself.
-  IDENTITY_ALIAS_SUB_TYPE_OWNER = 4;
-}
-
 message IdentityAlias {
   // The corresponding identity id.
   string identity_id = 1;
@@ -432,15 +435,15 @@ message IdentityAlias {
   // The actual alias, e.g. a common name or key fingerprint.
   string alias = 2;
 
-  // This will only be populated if alias_type == PUBLIC_KEY
+  // This will only be populated if alias_type == tdx:public-key
   string public_key = 3;
 
-  // This will only be populated if alias_type == PUBLIC_KEY
+  // This will only be populated if alias_type == tdx:public-key
   string private_key = 4;
 
-  IdentityAliasType alias_type = 5;
+  string alias_type = 5;
 
-  IdentityAliasSubType alias_sub_type = 6;
+  string issuer_id = 6;
 
   // Indicates if this alias has an 'authenticate' policy decision assigned.
   PolicyDecision authenticate = 7;
@@ -561,6 +564,29 @@ message Access {
   uint32 request_count = 17;
 }
 
+enum SessionStatus {
+  SESSION_STATUS_UNKNOWN = 0;
+  SESSION_STATUS_PENDING = 1;
+  SESSION_STATUS_ESTABLISHED = 2;
+  SESSION_STATUS_REJECTED = 3;
+}
+
+message Session {
+  string id = 1;
+
+  string identity_id = 2;
+
+  string identity_name = 3;
+
+  string ip = 4;
+
+  uint64 created = 5;
+
+  uint64 modified = 6;
+
+  SessionStatus status = 7;
+}
+
 message VerifiableCredential {
   string encoded = 1;
 }