@tdxvolt/volt-client-grpc 0.14.134 → 0.15.1

package/package.json

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

package/src/grpc-utils.js

@@ -16,7 +16,7 @@ export function createClient(
   credentials,
   noSerialise,
   voltId,
-  serviceId,
+  serviceId
 ) {
   let grpcCredentials;
   if (credentials) {
@@ -30,7 +30,7 @@ export function createClient(
       grpcCredentials = grpc.credentials.createSsl(
         tlsOptions.ca,
         tlsOptions.key,
-        tlsOptions.cert,
+        tlsOptions.cert
       );
     } else {
       // Cache has no private key, this implies we are connecting without supplying a client certificate.
@@ -92,7 +92,7 @@ const grpcWrap = (api) => {
   // Support class instances and PoJos
   const isClass = api.constructor !== Object;
   const iterate = Object.getOwnPropertyNames(
-    isClass ? api.constructor.prototype : api,
+    isClass ? api.constructor.prototype : api
   );
 
   // Wrap each method on the api.
@@ -106,7 +106,7 @@ const grpcWrap = (api) => {
         // Enforce promise results.
         if (!(resultPromise?.then && resultPromise?.catch)) {
           throw new Error(
-            `implementation methods must return a Promise [${name}]`,
+            `implementation methods must return a Promise [${name}]`
           );
         }
 
@@ -143,7 +143,7 @@ class GrpcServer {
       "grpc.http2.max_pings_without_data": 0,
       "grpc.keepalive_permit_without_calls": 1,
       "grpc.http2.min_ping_interval_without_data_ms": 250,
-      "grpc.http2.max_ping_strikes": 0,
+      "grpc.http2.max_ping_strikes": 0
     });
 
     if (tlsOptions) {
@@ -153,7 +153,7 @@ class GrpcServer {
         caList.push(tlsOption.ca);
         certChains.push({
           private_key: tlsOption.key,
-          cert_chain: tlsOption.cert,
+          cert_chain: tlsOption.cert
         });
       });
 
@@ -164,7 +164,7 @@ class GrpcServer {
         // The certificate chain(s) we present to the client.
         certChains,
         // Flag indicating if we insist on a client certificate.
-        requireClientCert,
+        requireClientCert
       );
     } else {
       this._credentials = grpc.ServerCredentials.createInsecure();
@@ -216,7 +216,7 @@ export function createServer(
   serviceDescriptors,
   routes,
   cryptoCache,
-  requireClientCert,
+  requireClientCert
 ) {
   let tlsOptions;
   if (cryptoCache) {
@@ -227,7 +227,7 @@ export function createServer(
     serviceDescriptors,
     routes,
     tlsOptions,
-    requireClientCert,
+    requireClientCert
   };
   return new GrpcServer(serverArgs);
 }

package/src/rpc-invocation.js

@@ -39,12 +39,12 @@ class RpcInvocation extends EventEmitter {
       deserialisedPayload = this.#payload;
     } else if (this.#methodDescriptor) {
       deserialisedPayload = this.#methodDescriptor.requestDeserialize(
-        this.#payload,
+        this.#payload
       );
     } else {
       log("unexpected: no method descriptor");
       throw new Error(
-        "no method descriptor - set this before accessing payload",
+        "no method descriptor - set this before accessing payload"
       );
     }
 
@@ -68,11 +68,11 @@ class RpcInvocation extends EventEmitter {
       // Decrypt the shared key and iv using the private key.
       this.#encryptKey = VoltCredential.rsaDecrypt(
         this.#voltClient.credential.cache.key,
-        this.#token.sk,
+        this.#token.sk
       );
       this.#encryptIV = VoltCredential.rsaDecrypt(
         this.#voltClient.credential.cache.key,
-        this.#token.iv,
+        this.#token.iv
       );
     }
 
@@ -103,7 +103,7 @@ class RpcInvocation extends EventEmitter {
           decryptedPayload = VoltCredential.aesDecrypt(
             invoke_request.payload,
             this.#encryptKey,
-            this.#encryptIV,
+            this.#encryptIV
           );
         } else {
           // No encryption => just use the payload.
@@ -124,9 +124,13 @@ class RpcInvocation extends EventEmitter {
           this.#payload = wrappedPayload.method_payload.payload;
           this.emit("payload", this);
         } else if (wrappedPayload.method_end) {
-          // This indicates the client has finished sending payloads.
-          // We don't need to do anything here, since we notify the client when we receive the client_end.
-          log("method_end received");
+          this.#payload = wrappedPayload.method_end;
+          if (wrappedPayload.method_end.error) {
+            // The client has sent an error.
+            this.emit("error", this);
+          } else {
+            this.emit("end", this);
+          }
         }
 
         resolve();
@@ -140,7 +144,7 @@ class RpcInvocation extends EventEmitter {
           decryptedPayload = VoltCredential.aesDecrypt(
             Buffer.from(invoke_request.json_payload, "base64"),
             this.#encryptKey,
-            this.#encryptIV,
+            this.#encryptIV
           );
         } else {
           // No encryption => just use the payload.
@@ -153,12 +157,12 @@ class RpcInvocation extends EventEmitter {
           if (wrappedPayload.method_invoke) {
             this.#methodName = wrappedPayload.method_invoke.method_name;
             this.#payload = JSON.parse(
-              wrappedPayload.method_invoke.json_request,
+              wrappedPayload.method_invoke.json_request
             );
             this.emit("payload", this);
           } else if (wrappedPayload.method_payload) {
             this.#payload = JSON.parse(
-              wrappedPayload.method_payload.json_payload,
+              wrappedPayload.method_payload.json_payload
             );
             this.emit("payload", this);
           } else if (wrappedPayload.method_end) {
@@ -187,7 +191,7 @@ class RpcInvocation extends EventEmitter {
     let responsePayload;
     if (this.#isJSON) {
       responsePayload = JSON.stringify({
-        method_payload: { json_payload: JSON.stringify(response) },
+        method_payload: { json_payload: JSON.stringify(response) }
       });
     } else {
       // We need to serialise the response, and then wrap it in a RemoteRequest.
@@ -195,7 +199,7 @@ class RpcInvocation extends EventEmitter {
         this.#methodDescriptor.responseSerialize(response);
       const tunnelMethod = this.#voltClient.getVoltAPIClient().Tunnel;
       responsePayload = tunnelMethod.requestSerialize({
-        method_payload: { payload: serialisedResponse },
+        method_payload: { payload: serialisedResponse }
       });
     }
 
@@ -204,12 +208,12 @@ class RpcInvocation extends EventEmitter {
       responsePayload = VoltCredential.aesEncrypt(
         responsePayload,
         this.#encryptKey,
-        this.#encryptIV,
+        this.#encryptIV
       );
     }
 
     const invokeResponse = {
-      invoke_id: this.#invokeId,
+      invoke_id: this.#invokeId
     };
 
     if (this.#isJSON) {
@@ -220,7 +224,7 @@ class RpcInvocation extends EventEmitter {
     }
 
     this.#voltConnection.send({
-      invoke_response: invokeResponse,
+      invoke_response: invokeResponse
     });
   }
 
@@ -230,11 +234,11 @@ class RpcInvocation extends EventEmitter {
     let endPayload;
     if (errorMessage) {
       endPayload = {
-        method_end: { error: errorMessage, ended: true },
+        method_end: { error: errorMessage, ended: true }
       };
     } else {
       endPayload = {
-        method_end: { ended: true },
+        method_end: { ended: true }
       };
     }
 
@@ -249,13 +253,13 @@ class RpcInvocation extends EventEmitter {
       endPayload = VoltCredential.aesEncrypt(
         endPayload,
         this.#encryptKey,
-        this.#encryptIV,
+        this.#encryptIV
       );
     }
 
     const invokeResponse = {
       invoke_id: this.#invokeId,
-      server_end: true,
+      server_end: true
     };
 
     if (this.#isJSON) {
@@ -265,7 +269,7 @@ class RpcInvocation extends EventEmitter {
     }
 
     this.#voltConnection.send({
-      invoke_response: invokeResponse,
+      invoke_response: invokeResponse
     });
   }
 }

package/src/utils.js

@@ -11,7 +11,7 @@ export const createSecureContextOptions = (cryptoOptions) => {
   const tlsOptions = {
     cert: Buffer.from(cryptoOptions.cert),
     ca: Buffer.from(cryptoOptions.ca),
-    key: Buffer.from(cryptoOptions.key),
+    key: Buffer.from(cryptoOptions.key)
   };
   return tlsOptions;
 };
@@ -27,7 +27,7 @@ export const getServiceAddress = (mdnsService) => {
     const ipv4 = _.find(mdnsService.addresses, (addy) => ip.isV4Format(addy));
     const serviceDetails = {
       host: ipv4,
-      port: mdnsService.port,
+      port: mdnsService.port
     };
 
     address = `${serviceDetails.host}:${serviceDetails.port}`;
@@ -103,3 +103,44 @@ export const getDIDResolutionURL = (didIn) => {
 
   return `https://${hostName}/api/identity/${didGUID}`;
 };
+
+const forgePrivateKeyToPem = (decryptedKey) => {
+  // Convert a Forge private key to an ASN.1 RSAPrivateKey
+  const asnPrivateKey = pki.privateKeyToAsn1(decryptedKey);
+
+  // Wrap an RSAPrivateKey ASN.1 object in a PKCS#8 ASN.1 PrivateKeyInfo
+  const privateKeyInfo = pki.wrapRsaPrivateKey(asnPrivateKey);
+
+  // Convert a PKCS#8 ASN.1 PrivateKeyInfo to PEM
+  return pki.privateKeyInfoToPem(privateKeyInfo);
+};
+
+export const createRSAKey = (passphrase = "") => {
+  return new Promise((resolve, reject) => {
+    pki.rsa.generateKeyPair({ bits: 2048, workers: -1 }, (err, keypair) => {
+      if (err) {
+        reject(err);
+      } else {
+        let pem;
+        if (passphrase) {
+          pem = pki.encryptRsaPrivateKey(keypair.privateKey, passphrase);
+        } else {
+          pem = forgePrivateKeyToPem(keypair.privateKey);
+        }
+
+        resolve({ keypair, pem });
+      }
+    });
+  });
+};
+
+export const sha256Base64 = (msg) => {
+  const md = forge.md.sha256.create();
+  md.update(msg);
+  return forge.util.encode64(md.digest().bytes());
+};
+
+export const decryptPrivateKey = (pem, passphrase) => {
+  const decryptedKey = pki.decryptRsaPrivateKey(pem, passphrase);
+  return forgePrivateKeyToPem(decryptedKey);
+};

package/src/volt-client-internal.js

@@ -9,7 +9,7 @@ import { join } from "path";
 import {
   createServiceProtobufFiles,
   getServiceDescriptors,
-  getServiceDescriptorsFromPath,
+  getServiceDescriptorsFromPath
 } from "./proto-utils.js";
 import { createClient as createGrpcClient } from "./grpc-utils.js";
 import * as voltUtils from "./utils.js";
@@ -28,7 +28,7 @@ const voltServices = [
   constants.serviceType.sqliteServerAPI,
   constants.serviceType.ssiAPI,
   constants.serviceType.relayAPI,
-  constants.serviceType.wireAPI,
+  constants.serviceType.wireAPI
 ];
 
 function issueBind(bindRequest, ttl) {
@@ -98,13 +98,13 @@ export async function bindInternal() {
       log("attempting to retrieve Relay information from %s", relayURL);
       this._voltConfig.relay = await fetchVoltConfig.call(
         this,
-        `${relayURL}/discovery`,
+        `${relayURL}/discovery`
       );
       if (this._voltConfig.relay.ca_pem) {
         log(
           "Auto-fetched Relay CA %s, remote address %s",
           this._voltConfig.relay.ca_pem,
-          this._voltConfig.relay.address,
+          this._voltConfig.relay.address
         );
       } else {
         throw new Error("Unable to fetch Relay CA - cannot securely connect.");
@@ -117,7 +117,7 @@ export async function bindInternal() {
 
     if (!this._credential.cache.ca) {
       throw new Error(
-        "No certificate authority found in configuration for target Volt - check configuration",
+        "No certificate authority found in configuration for target Volt - check configuration"
       );
     }
 
@@ -137,30 +137,30 @@ export async function bindInternal() {
       binding_name: this._config.client_name,
       public_key: publicKeyPem,
       host: this._credential.cache.bindIp,
-      x509_credential: [],
+      x509_credential: []
     };
 
     if (this._credential.cache.cert) {
       bindRequest.x509_credential = [
-        this._credential.cache.cert + this._credential.cache.ca,
+        this._credential.cache.cert + this._credential.cache.ca
       ];
     }
 
     if (this._voltConfig.challenge_code) {
       bindRequest.challenge = voltUtils.signBase64(
         keyPair.privateKey,
-        this._voltConfig.challenge_code,
+        this._voltConfig.challenge_code
       );
     } else {
       log(
-        "****no Volt challenge code available**** => not sending challenge signature",
+        "****no Volt challenge code available**** => not sending challenge signature"
       );
     }
 
     // For remote connections, add our cloud-issued certificate as an additional credential.
     if (this._voltConfig?.relay?.ca_pem && this._credential.cache.cloud_cert) {
       bindRequest.x509_credential = bindRequest.x509_credential.concat(
-        this._credential.cache.cloud_cert + this._voltConfig.relay.ca_pem,
+        this._credential.cache.cloud_cert + this._voltConfig.relay.ca_pem
       );
     }
 
@@ -180,7 +180,7 @@ export async function bindInternal() {
       decision = await issueBind.call(
         this,
         bindRequest,
-        this._voltConfig.bindRequestTTL,
+        this._voltConfig.bindRequestTTL
       );
       log("binding decision: %s", decision);
     } while (
@@ -241,6 +241,10 @@ export function connectInternal(helloPayload) {
       this.emit("evt", evt);
     });
 
+    this._voltConnection.on("ping", (ping) => {
+      this.emit("ping", ping);
+    });
+
     this._voltConnection.on("invoke_request", (invoke_request) => {
       const invokeId = invoke_request.invoke_id;
       if (this._activeRPC[invokeId]) {
@@ -291,7 +295,7 @@ export function getVoltAPIClientInternal() {
       this._credential,
       this.isRemote && !this.isVoltRelay,
       this._voltConfig?.relay?.cloud ? this._voltConfig.id : "",
-      this._voltConfig?.relay?.cloud ? this._voltConfig.id : "",
+      this._voltConfig?.relay?.cloud ? this._voltConfig.id : ""
     );
   }
 
@@ -316,7 +320,7 @@ export function getAPIClientInternal(service) {
       const packageDescriptors = getServiceDescriptorsFromPath(
         this._grpc,
         fullProtoPath,
-        api,
+        api
       );
       serviceDescriptors = { ...serviceDescriptors, ...packageDescriptors };
     }
@@ -328,7 +332,7 @@ export function getAPIClientInternal(service) {
       this._credential,
       this.isRemote && !this.isVoltRelay,
       this._voltConfig?.relay?.cloud ? this._voltConfig.id : "",
-      this._voltConfig?.relay?.cloud ? this._voltConfig.id : "",
+      this._voltConfig?.relay?.cloud ? this._voltConfig.id : ""
     );
   }
 
@@ -410,13 +414,13 @@ export async function fetchVoltConfig(discovery_url) {
       "ca_pem",
       "challenge_code",
       "cloud",
-      "relay",
+      "relay"
     );
 
     return voltConfig;
   } catch (err) {
     throw new Error(
-      `Failure loading config from ${discovery_url}: ${err.message}`,
+      `Failure loading config from ${discovery_url}: ${err.message}`
     );
   }
 }
@@ -432,13 +436,13 @@ export async function fetchVoltConfigFromDID(volt_did) {
     const didDocument = await getJSON(didResolution);
     const voltConfigServices = findDIDDocumentService(
       didDocument,
-      constants.didServiceType.voltConfig,
+      constants.didServiceType.voltConfig
     );
     if (voltConfigServices.length !== 1) {
       log(
         "Unexpected number of Volt configuration endpoints found in DID document for %s, services found: %d",
         volt_did,
-        voltConfigServices.length,
+        voltConfigServices.length
       );
     }
 
@@ -446,7 +450,7 @@ export async function fetchVoltConfigFromDID(volt_did) {
     return await fetchVoltConfig.call(this, serviceEndpoint);
   } catch (err) {
     throw new Error(
-      `Failure fetching Volt config from DID document ${volt_did}: ${err.message}`,
+      `Failure fetching Volt config from DID document ${volt_did}: ${err.message}`
     );
   }
 }

package/src/volt-client.js

@@ -11,7 +11,7 @@ import {
   fetchVoltConfigFromDID,
   getVoltAPIClientInternal,
   unaryCallInternal,
-  streamingCallInternal,
+  streamingCallInternal
 } from "./volt-client-internal.js";
 import fs from "fs";
 import GRPCCall from "./grpc-call.js";
@@ -64,7 +64,7 @@ export class VoltClient extends EventEmitter {
     try {
       if (!config) {
         throw new Error(
-          "configPath argument is required to be a non-empty string",
+          "configPath argument is required to be a non-empty string"
         );
       }
 
@@ -75,13 +75,13 @@ export class VoltClient extends EventEmitter {
         log("Attempt to load config from file %s", configPath);
         try {
           const configContents = await readFile(
-            new URL(configPath, import.meta.url),
+            new URL(configPath, import.meta.url)
           );
           configJSON = JSON.parse(configContents);
         } catch (err) {
           log("failure loading config file %s [%s]", configPath, err.message);
           throw new Error(
-            `failed to load configuration - check JSON format in ${configPath}`,
+            `failed to load configuration - check JSON format in ${configPath}`
           );
         }
       } else if (typeof config === "object") {
@@ -122,14 +122,14 @@ export class VoltClient extends EventEmitter {
         const didConfig = await fetchVoltConfigFromDID.call(this, voltDID);
         this._config = { ...this._config, volt: didConfig };
         log("resolved config from DID: %s", JSON.stringify(didConfig, null, 2));
-      } else if (voltHttpAddress) {
+      } else if (voltHttpAddress && !this._config?.volt?.id) {
         const discoConfig = await fetchVoltConfig.call(
           this,
-          `${voltHttpAddress}/discovery`,
+          `${voltHttpAddress}/discovery`
         );
         this._config = {
           ...this._config,
-          volt: { ...this._config.volt, ...discoConfig },
+          volt: { ...this._config.volt, ...discoConfig }
         };
       }
 
@@ -173,7 +173,7 @@ export class VoltClient extends EventEmitter {
           if (bindErr.message === "invalid arguments") {
             // This is usually the result of a missing challenge signature or credential.
             log(
-              "failure binding to Volt - did you supply a challenge code or verified credential?",
+              "failure binding to Volt - did you supply a challenge code or verified credential?"
             );
             throw bindErr;
           }
@@ -236,7 +236,7 @@ export class VoltClient extends EventEmitter {
     if (this.isRemote) {
       if (!this._voltConfig?.relay?.address) {
         throw new Error(
-          "Remote connection enabled but no Relay address - have you called start()?",
+          "Remote connection enabled but no Relay address - have you called start()?"
         );
       }
 
@@ -248,14 +248,14 @@ export class VoltClient extends EventEmitter {
         this._credential,
         false,
         service.volt_id,
-        service.id,
+        service.id
       );
     } else {
       return createGrpcClient(
         this._grpc,
         serviceDescriptors,
         service.service_description.address,
-        this._credential,
+        this._credential
       );
     }
   }
@@ -293,7 +293,7 @@ export class VoltClient extends EventEmitter {
       "METHOD_TYPE_BIDI",
       method,
       request,
-      service,
+      service
     );
   }
 
@@ -303,7 +303,7 @@ export class VoltClient extends EventEmitter {
       "METHOD_TYPE_CLIENT_STREAM",
       method,
       request,
-      service,
+      service
     );
   }
 
@@ -313,7 +313,7 @@ export class VoltClient extends EventEmitter {
       "METHOD_TYPE_SERVER_STREAM",
       method,
       request,
-      service,
+      service
     );
   }
 
@@ -324,12 +324,12 @@ export class VoltClient extends EventEmitter {
    */
   async RequestAccessBlocking(
     targetResourceId,
-    accessType = "VOLT_ACCESS_READ",
+    accessType = "VOLT_ACCESS_READ"
   ) {
     try {
       const accessRequest = {
         access: accessType,
-        resource_id: targetResourceId,
+        resource_id: targetResourceId
       };
 
       // This will block while the request is pending.
@@ -498,11 +498,19 @@ export class VoltClient extends EventEmitter {
     const downloadCall = new GRPCCall(
       this,
       "DownloadFile",
-      "METHOD_TYPE_SERVER_STREAM",
+      "METHOD_TYPE_SERVER_STREAM"
     );
     return downloadCall.start(grpcClient, request);
   }
 
+  GetFileContent(request) {
+    return unaryCallInternal.call(this, "GetFileContent", request);
+  }
+
+  SetFileContent(request) {
+    return unaryCallInternal.call(this, "SetFileContent", request);
+  }
+
   UploadFile(request) {
     const grpcClient = this.getVoltAPIClient();
 
@@ -524,7 +532,7 @@ export class VoltClient extends EventEmitter {
       const call = new GRPCCall(
         this,
         "DownloadFile",
-        "METHOD_TYPE_SERVER_STREAM",
+        "METHOD_TYPE_SERVER_STREAM"
       );
 
       call.on("data", (response) => {
@@ -561,6 +569,13 @@ export class VoltClient extends EventEmitter {
     });
   }
 
+  /**
+   * SqliteServerAPI
+   */
+  CreateDatabase(request) {
+    return unaryCallInternal.call(this, "CreateDatabase", request);
+  }
+
   /**
    * SqliteDatabaseAPI
    */
@@ -651,7 +666,7 @@ export class VoltClient extends EventEmitter {
     const subscribeCall = new GRPCCall(
       this,
       "SubscribeWire",
-      "METHOD_TYPE_BIDI",
+      "METHOD_TYPE_BIDI"
     );
     return subscribeCall.start(grpcClient, request);
   }

package/src/volt-connection.js

@@ -28,7 +28,7 @@ function _cleanUp(immediateReconnect) {
         this._reconnectTimer = 0;
         _doConnect.call(this, this._helloPayload);
       },
-      immediateReconnect ? 0 : this._reconnectInterval,
+      immediateReconnect ? 0 : this._reconnectInterval
     );
   }
 
@@ -49,10 +49,10 @@ function _doConnect(connectHello) {
   const grpcClient = this._voltClient.getVoltAPIClient();
 
   let helloPayload = connectHello;
-  if (!connectHello) {
+  if (!helloPayload) {
     log("defaulting hello payload");
     helloPayload = {
-      hello: {},
+      hello: {}
     };
   }
 
@@ -74,6 +74,8 @@ function _doConnect(connectHello) {
 
         // Schedule the next ping.
         _startPingTimer.call(this);
+
+        this.emit("ping", response.ping.timestamp);
         break;
       }
       case "acknowledge": {
@@ -90,7 +92,7 @@ function _doConnect(connectHello) {
         break;
       }
       case "evt": {
-        log("received event %s", response.evt.event_type);
+        log("received event %s", Object.keys(response.evt)[0]);
         this.emit("evt", response.evt);
         break;
       }
@@ -134,7 +136,7 @@ function _startPingTimer() {
 
     this._pingTimeoutTimer = setTimeout(
       _connectionTimeoutHandler.bind(this),
-      this._timeoutInterval,
+      this._timeoutInterval
     );
   }, this._pingInterval);
 }