@eluvio/elv-client-js 4.0.85 → 4.0.87

package/src/client/LiveConf.js

@@ -157,7 +157,7 @@ class LiveConf {
           recordingBitrate: Math.max(this.probeData.streams[index].bit_rate, 128000),
           recordingChannels: this.probeData.streams[index].channels,
           playoutLabel: `Audio ${index}`
-        }
+        };
       }
     }
     return audioStreams;
@@ -232,13 +232,13 @@ class LiveConf {
     return seg;
   }
 
- /*
+  /*
   * Calculate output timebase from the encoder (codec) timebase. The videoTimeBase parameter
   * represents the encoder timebase. The format muxer will change it so it is greater than 10000.
   */
   calcOutputTimebase(codecTimebase) {
     let outputTimebase = codecTimebase;
-    while (outputTimebase < 10000)
+    while(outputTimebase < 10000)
       outputTimebase = outputTimebase * 2;
     return outputTimebase;
   }
@@ -382,36 +382,36 @@ class LiveConf {
     return sync_id;
   }
 
- /*
+  /*
   * Generate audio streams recording configuration based on the optional custom settings.
   * If no custom "audio" section is present, record all the acceptable audio streams found in the probe
   */
   generateAudioStreamsConfig({customSettings}) {
 
     let audioStreams = {};
-    if (customSettings && customSettings.audio) {
-      for (let i = 0; i < Object.keys(customSettings.audio).length; i ++) {
+    if(customSettings && customSettings.audio) {
+      for(let i = 0; i < Object.keys(customSettings.audio).length; i ++) {
         let audioIdx = Object.keys(customSettings.audio)[i];
         let audio = customSettings.audio[audioIdx];
         audioStreams[audioIdx] = {
           recordingBitrate: audio.recording_bitrate || 192000,
           recordingChannels: audio.recording_channels || 2,
         };
-        if (audio.playout) {
-          audioStreams[audioIdx].playoutLabel = audio.playout_label || `Audio ${audioIdx}`
+        if(audio.playout) {
+          audioStreams[audioIdx].playoutLabel = audio.playout_label || `Audio ${audioIdx}`;
         }
       }
     }
 
     // If no audio streams specified in custom config, set up all the suitable audio streams in the probe
-    if (!customSettings.audio) {
+    if(!customSettings.audio) {
       audioStreams = this.getAudioStreamsFromProbe();
     }
 
     return audioStreams;
   }
 
- /*
+  /*
   * Generate the live recording config as required by QFAB, based on defaults and optional custom settings.
   */
   generateLiveConf({customSettings}) {
@@ -439,7 +439,7 @@ class LiveConf {
     conf.live_recording.recording_config.recording_params.xc_params.enc_height = videoStream.height;
     conf.live_recording.recording_config.recording_params.xc_params.enc_width = videoStream.width;
 
-    for (let i =0; i < Object.keys(audioStreams).length; i ++) {
+    for(let i =0; i < Object.keys(audioStreams).length; i ++) {
       conf.live_recording.recording_config.recording_params.xc_params.audio_index[i] = parseInt(Object.keys(audioStreams)[i]);
     }
 
@@ -549,7 +549,7 @@ class LiveConf {
     let globalAudioBitrate = 0;
     let nAudio = 0;
 
-    for (let i = 0; i < Object.keys(audioStreams).length; i ++ ) {
+    for(let i = 0; i < Object.keys(audioStreams).length; i ++ ) {
       let audioLadderSpec = {...LadderSpecAudio};
       const audioIndex = Object.keys(audioStreams)[i];
       const audio = audioStreams[audioIndex];
@@ -561,7 +561,7 @@ class LiveConf {
       audioLadderSpec.stream_label = audio.playoutLabel ? audio.playoutLabel : null;
 
       conf.live_recording.recording_config.recording_params.ladder_specs.push(audioLadderSpec);
-      if (audio.recordingBitrate > globalAudioBitrate) {
+      if(audio.recordingBitrate > globalAudioBitrate) {
         globalAudioBitrate = audio.recordingBitrate;
       }
       nAudio ++;

package/src/client/LiveStream.js

@@ -10,6 +10,7 @@ const fs = require("fs");
 const HttpClient = require("../HttpClient");
 const Fraction = require("fraction.js");
 const {ValidateObject, ValidatePresence} = require("../Validation");
+const ContentObjectAudit = require("../ContentObjectAudit");
 
 const MakeTxLessToken = async({client, libraryId, objectId, versionHash}) => {
   const tok = await client.authClient.AuthorizationToken({libraryId, objectId,
@@ -29,18 +30,18 @@ const CueInfo = async ({eventId, status}) => {
     const lroStatusResponse = await this.utils.ResponseToJson(
       await HttpClient.Fetch(status.lro_status_url)
     );
-    console.log("lroStatusResponse", lroStatusResponse)
+    console.log("lroStatusResponse", lroStatusResponse);
     cues = lroStatusResponse.custom.cues;
-  } catch (error) {
+  } catch(error) {
     console.log("LRO status failed", error);
     return {error: "failed to retrieve status", eventId};
   }
 
   let eventStart, eventEnd;
-  for (const value of Object.values(cues)) {
-    for (const event of Object.values(value.descriptors)) {
-      if (event.id == eventId) {
-        switch (event.type_id) {
+  for(const value of Object.values(cues)) {
+    for(const event of Object.values(value.descriptors)) {
+      if(event.id == eventId) {
+        switch(event.type_id) {
           case 32:
           case 16:
             eventStart = value.insertion_time;
@@ -56,7 +57,7 @@ const CueInfo = async ({eventId, status}) => {
   }
 
   return {eventStart, eventEnd, eventId};
-}
+};
 
 /**
  * Set the offering for the live stream
@@ -445,7 +446,7 @@ exports.StreamStatus = async function({name, stopLro=false, showParams=false}) {
     let videoLastFinalizationTimeEpochSec = -1;
     let videoFinalizedParts = 0;
     let sinceLastFinalize = -1;
-    if (period.finalized_parts_info && period.finalized_parts_info.video && period.finalized_parts_info.video.last_finalization_time) {
+    if(period.finalized_parts_info && period.finalized_parts_info.video && period.finalized_parts_info.video.last_finalization_time) {
       videoLastFinalizationTimeEpochSec = period.finalized_parts_info.video.last_finalization_time / 1000000;
       videoFinalizedParts = period.finalized_parts_info.video.n_parts;
       sinceLastFinalize = Math.floor(new Date().getTime() / 1000) - videoLastFinalizationTimeEpochSec;
@@ -733,7 +734,7 @@ exports.StreamCreate = async function({name, start=false}) {
 */
 exports.StreamStartOrStopOrReset = async function({name, op}) {
   try {
-    let status = await this.StreamStatus({name})
+    let status = await this.StreamStatus({name});
     if(status.state != "stopped") {
       if(op === "start") {
         status.error = "Unable to start stream - state: " + status.state;
@@ -860,7 +861,7 @@ exports.StreamStopSession = async function({name}) {
         return {
           state: status.state,
           error: "The stream must be stopped before terminating"
-        }
+        };
       }
 
       await this.DeleteWriteToken({
@@ -1355,7 +1356,10 @@ exports.StreamConfig = async function({name, customSettings={}, probeMetadata})
     status.error = "No node matching stream URL " + streamUrl.href;
     return status;
   }
-  const node = nodes[0];
+  const node = {
+    endpoints: nodes[0].services.fabric_api.urls,
+    id: nodes[0].id
+  };
   status.node = node;
   let endpoint = node.endpoints[0];
 
@@ -1547,7 +1551,7 @@ exports.StreamListUrls = async function({siteId}={}) {
           url,
           active: activeUrlMap[url] || false
         };
-      })
+      });
     });
 
     return streamUrlStatus;
@@ -1934,3 +1938,27 @@ exports.StreamAddWatermark = async function({
 
   return response;
 };
+
+/**
+ * Audit the specified live stream against several content fabric nodes
+ *
+ * @methodGroup Live Stream
+ * @namedParams
+ * @param {string=} objectId - Object ID of the live stream
+ * @param {string=} versionHash - Version hash of the live stream -- if not specified, latest version is returned
+ * @param {string=} salt - base64-encoded byte sequence for salting the audit hash
+ * @param {Array<number>=} samples - list of percentages (0.0 - <1.0) used for sampling the content part list, up to 3
+ *
+ * @returns {Promise<Object>} - Response describing audit results
+ */
+exports.AuditStream = async function({objectId, versionHash, salt, samples}) {
+  return await ContentObjectAudit.AuditContentObject({
+    client: this,
+    libraryId,
+    objectId,
+    versionHash,
+    salt,
+    samples,
+    live: true
+  });
+};

package/src/walletClient/index.js

@@ -395,7 +395,15 @@ class ElvWalletClient {
    *
    * @methodGroup Login
    */
-  LogOut() {
+  async LogOut() {
+    if(this.__authorization.nonce) {
+      try {
+        await this.client.signer.ReleaseCSAT({accessToken: this.AuthToken()});
+      } catch(error) {
+        this.Log("Failed to release token", true, error);
+      }
+    }
+
     this.__authorization = {};
     this.loggedIn = false;
 
@@ -410,6 +418,14 @@ class ElvWalletClient {
     }
   }
 
+  async TokenStatus() {
+    if(!this.__authorization || !this.__authorization.nonce) {
+      return true;
+    }
+
+    return await this.client.signer.CSATStatus({accessToken: this.AuthToken()});
+  }
+
   /**
    * Authenticate with an ElvWalletClient authorization token
    *
@@ -457,7 +473,7 @@ class ElvWalletClient {
    * - signingToken - Identical to `authToken`, but also includes the ability to perform arbitrary signatures with the custodial wallet. This token should be protected and should not be
    * shared with third parties.
    */
-  async AuthenticateOAuth({idToken, tenantId, email, signerURIs, shareEmail=false}) {
+  async AuthenticateOAuth({idToken, tenantId, email, signerURIs, shareEmail=false, extraData={}, nonce, createRemoteToken=true, force=false}) {
     let tokenDuration = 24;
 
     if(!tenantId && this.selectedMarketplaceInfo) {
@@ -466,13 +482,21 @@ class ElvWalletClient {
       tenantId = this.selectedMarketplaceInfo.tenantId;
     }
 
-    await this.client.SetRemoteSigner({idToken, tenantId, signerURIs, extraData: { share_email: shareEmail }, unsignedPublicAuth: true});
+    await this.client.SetRemoteSigner({idToken, tenantId, signerURIs, extraData: { ...extraData, share_email: shareEmail }, unsignedPublicAuth: true});
 
-    const expiresAt = Date.now() + tokenDuration * 60 * 60 * 1000;
-    const fabricToken = await this.client.CreateFabricToken({
-      duration: tokenDuration * 60 * 60 * 1000,
-      //context: email ? {usr: {email}} : {}
-    });
+    let fabricToken, expiresAt;
+    if(createRemoteToken && this.client.signer.remoteSigner) {
+      expiresAt = Date.now() + 24 * 60 * 60 * 1000;
+      const tokenResponse = await this.client.signer.RetrieveCSAT({email, nonce, force});
+      fabricToken = tokenResponse.token;
+      nonce = tokenResponse.nonce;
+    } else {
+      expiresAt = Date.now() + tokenDuration * 60 * 60 * 1000;
+      fabricToken = await this.client.CreateFabricToken({
+        duration: tokenDuration * 60 * 60 * 1000,
+        context: email ? {usr: {email}} : {}
+      });
+    }
     const address = this.client.utils.FormatAddress(this.client.CurrentAccountAddress());
 
     if(!email) {
@@ -496,7 +520,8 @@ class ElvWalletClient {
         signerURIs,
         walletType: "Custodial",
         walletName: "Eluvio",
-        register: true
+        register: true,
+        nonce
       }),
       signingToken: this.SetAuthorization({
         clusterToken: this.client.signer.authToken,
@@ -507,7 +532,8 @@ class ElvWalletClient {
         expiresAt,
         signerURIs,
         walletType: "Custodial",
-        walletName: "Eluvio"
+        walletName: "Eluvio",
+        nonce
       })
     };
   }
@@ -568,7 +594,7 @@ class ElvWalletClient {
     return this.__authorization.fabricToken;
   }
 
-  SetAuthorization({clusterToken, fabricToken, tenantId, address, email, expiresAt, signerURIs, walletType, walletName, register=false}) {
+  SetAuthorization({clusterToken, fabricToken, tenantId, address, email, expiresAt, signerURIs, walletType, walletName, nonce, register=false}) {
     address = this.client.utils.FormatAddress(address);
 
     this.__authorization = {
@@ -578,7 +604,8 @@ class ElvWalletClient {
       email,
       expiresAt,
       walletType,
-      walletName
+      walletName,
+      nonce
     };
 
     if(clusterToken) {
@@ -1328,7 +1355,7 @@ class ElvWalletClient {
 
           if(op === "nft-claim-entitlement") {
             let [op, marketplace, sku, purchaseId ] = status.op.split(":");
-            confirmationId = purchaseId
+            confirmationId = purchaseId;
             if(status.extra && status.extra["0"]) {
               address = status.extra["0"].token_addr;
               tokenId = status.extra["0"].token_id;

package/src/ContentObjectVerification.js

@@ -1,210 +0,0 @@
-const CBOR = require("cbor");
-const SJCL = require("sjcl");
-const MultiHash = require("multihashes");
-const DeepEqual = require("deep-equal");
-const Utils = require("./Utils");
-
-const ContentObjectVerification = {
-  async VerifyContentObject({client, libraryId, objectId, versionHash}) {
-    let response = {
-      hash: versionHash
-    };
-
-    const partHash = Utils.DecodeVersionHash(versionHash).partHash;
-
-    const qpartsResponse = await client.QParts({libraryId, objectId, partHash, format: "arrayBuffer"})
-      .then(response => Buffer.from(response));
-    const partVerification = ContentObjectVerification._VerifyPart({partHash: partHash, qpartsResponse: qpartsResponse});
-
-    if(partVerification.valid) {
-      response.qref = { valid: true };
-    } else {
-      response.qref = { valid: false, error: partVerification.error.message };
-    }
-
-    response.qref.hash = partHash;
-
-    if(response.qref.valid) {
-      // Validate Metadata
-      const qmdHash = partVerification.cbor.QmdHash.value;
-      const metadataPartHash = "hqp_" + MultiHash.toB58String(qmdHash.slice(1, qmdHash.length));
-      const metadataPartResponse = await client.QParts({libraryId, objectId, partHash: metadataPartHash, format: "arrayBuffer"})
-        .then(response => Buffer.from(response));
-
-      const metadataVerification = ContentObjectVerification._VerifyPart({partHash: metadataPartHash, qpartsResponse: metadataPartResponse});
-
-      if(metadataVerification.valid) {
-        response.qmd = { valid: true };
-      } else {
-        response.qmd = { valid: false, error: metadataVerification.error.message };
-      }
-
-      response.qmd.hash = metadataPartHash;
-
-      if(response.qmd.valid && libraryId) {
-        // If the library ID is provided, compare some metadata in the CBOR response
-        // to the metadata from the /meta endpoint
-        const metadata = await client.ContentObjectMetadata({
-          libraryId: libraryId,
-          objectId,
-          versionHash: partHash.replace("hqp_", "hq__")
-        });
-
-        response.qmd.check = ContentObjectVerification._VerifyMetadata({metadataCbor: metadataVerification.cbor, metadata: metadata});
-      }
-
-      // Validate Qstruct
-
-      const qstructHash = partVerification.cbor.QstructHash.value;
-      const structPartHash = "hqp_" + MultiHash.toB58String(qstructHash.slice(1, qstructHash.length));
-      const structPartResponse = await client.QParts({libraryId, objectId, partHash: structPartHash, format: "arrayBuffer"})
-        .then(response => Buffer.from(response));
-      const structVerification = ContentObjectVerification._VerifyPart({partHash: structPartHash, qpartsResponse: structPartResponse});
-
-      if(structVerification.valid) {
-        response.qstruct = { valid: true };
-      } else {
-        response.qstruct = { valid: false, error: structVerification.error.message };
-      }
-
-      response.qstruct.hash = structPartHash;
-
-      if(response.qstruct.valid) {
-        response.qstruct.parts = ContentObjectVerification._FormatQStruct(structVerification.cbor.Parts);
-      }
-    }
-
-    response.valid =
-      response.qref.valid &&
-      response.qmd.valid &&
-      response.qstruct.valid &&
-      (!response.qmd.check || response.qmd.check.valid);
-
-    return response;
-  },
-
-  // Content verification methods //
-
-  _FormatQStruct(structParts) {
-    if(!structParts) { return []; }
-
-    return structParts.map(structPart => {
-      return {
-        hash: "hqp_" + MultiHash.toB58String(structPart.Hash.value.slice(1, structPart.Hash.length)),
-        size: structPart.Size
-      };
-    });
-  },
-
-  _Hash(thing) {
-    function fromBits(arr) {
-      var out = [], bl = SJCL.bitArray.bitLength(arr), i, tmp;
-      for(i=0; i<bl/8; i++) {
-        if((i&3) === 0) {
-          tmp = arr[i/4];
-        }
-        out.push(tmp >>> 24);
-        tmp <<= 8;
-      }
-      return out;
-    }
-
-    function toBits(bytes) {
-      var out = [], i, tmp=0;
-      for(i=0; i<bytes.length; i++) {
-        tmp = tmp << 8 | bytes[i];
-        if((i&3) === 3) {
-          out.push(tmp);
-          tmp = 0;
-        }
-      }
-      if(i&3) {
-        out.push(SJCL.bitArray.partial(8*(i&3), tmp));
-      }
-      return out;
-    }
-
-    let digest = SJCL.hash.sha256.hash(toBits(thing));
-    let bytes = fromBits(digest);
-    let out = Buffer.from(bytes, "binary");
-
-    return MultiHash.toB58String(MultiHash.encode(out, "sha2-256"));
-  },
-
-  _ParseCBOR(cborResponse) {
-    let buffer = cborResponse.slice(7, cborResponse.length);
-    let hex = buffer.toString("hex");
-    return CBOR.decodeFirstSync(hex);
-  },
-
-  _VerifyPart({partHash, qpartsResponse}) {
-    try {
-      if(ContentObjectVerification._Hash(qpartsResponse) !== partHash.replace("hqp_", "")) {
-        throw Error("Hashes do not match");
-      }
-
-      let cbor = ContentObjectVerification._ParseCBOR(qpartsResponse);
-
-      return {
-        valid: true,
-        cbor: cbor
-      };
-    } catch(error) {
-      return {
-        valid: false,
-        error: error
-      };
-    }
-  },
-
-  _VerifyMetadata({metadataCbor, metadata}) {
-    if(!metadataCbor) { metadataCbor = {}; }
-    if(!metadata) { metadata = {}; }
-
-    let response = {
-      valid: true,
-      invalidValues: []
-    };
-
-    const cborKeys = Object.keys(metadataCbor);
-    const metadataKeys = Object.keys(metadata);
-
-    // Find any difference between top level keys
-    const differentKeys = cborKeys
-      .filter(x => !metadataKeys.includes(x))
-      .concat(metadataKeys.filter(x => !cborKeys.includes(x)));
-
-    for(const key of differentKeys) {
-      const cborValue = metadataCbor[key];
-      const metadataValue = metadata[key];
-
-      response.invalidValues.push({
-        key: key,
-        cborValue: cborValue,
-        metadataValue: metadataValue
-      });
-    }
-
-    // Deep comparison of up to 5 keys
-    for(const fieldToValidate of Object.keys(metadataCbor).slice(0, 5)) {
-      const cborValue = metadataCbor[fieldToValidate];
-      const metadataValue = metadata[fieldToValidate];
-
-      if(!DeepEqual(cborValue, metadataValue)) {
-        response.invalidValues.push({
-          key: fieldToValidate,
-          cborValue: cborValue,
-          metadataValue: metadataValue
-        });
-      }
-    }
-
-    if(response.invalidValues.length !== 0) {
-      response.valid = false;
-    }
-
-    return response;
-  },
-};
-
-module.exports = ContentObjectVerification;