@webex/plugin-encryption 3.8.0

package/coverage/lcov-report/sorter.js

@@ -0,0 +1,196 @@
+/* eslint-disable */
+var addSorting = (function() {
+    'use strict';
+    var cols,
+        currentSort = {
+            index: 0,
+            desc: false
+        };
+
+    // returns the summary table element
+    function getTable() {
+        return document.querySelector('.coverage-summary');
+    }
+    // returns the thead element of the summary table
+    function getTableHeader() {
+        return getTable().querySelector('thead tr');
+    }
+    // returns the tbody element of the summary table
+    function getTableBody() {
+        return getTable().querySelector('tbody');
+    }
+    // returns the th element for nth column
+    function getNthColumn(n) {
+        return getTableHeader().querySelectorAll('th')[n];
+    }
+
+    function onFilterInput() {
+        const searchValue = document.getElementById('fileSearch').value;
+        const rows = document.getElementsByTagName('tbody')[0].children;
+        for (let i = 0; i < rows.length; i++) {
+            const row = rows[i];
+            if (
+                row.textContent
+                    .toLowerCase()
+                    .includes(searchValue.toLowerCase())
+            ) {
+                row.style.display = '';
+            } else {
+                row.style.display = 'none';
+            }
+        }
+    }
+
+    // loads the search box
+    function addSearchBox() {
+        var template = document.getElementById('filterTemplate');
+        var templateClone = template.content.cloneNode(true);
+        templateClone.getElementById('fileSearch').oninput = onFilterInput;
+        template.parentElement.appendChild(templateClone);
+    }
+
+    // loads all columns
+    function loadColumns() {
+        var colNodes = getTableHeader().querySelectorAll('th'),
+            colNode,
+            cols = [],
+            col,
+            i;
+
+        for (i = 0; i < colNodes.length; i += 1) {
+            colNode = colNodes[i];
+            col = {
+                key: colNode.getAttribute('data-col'),
+                sortable: !colNode.getAttribute('data-nosort'),
+                type: colNode.getAttribute('data-type') || 'string'
+            };
+            cols.push(col);
+            if (col.sortable) {
+                col.defaultDescSort = col.type === 'number';
+                colNode.innerHTML =
+                    colNode.innerHTML + '<span class="sorter"></span>';
+            }
+        }
+        return cols;
+    }
+    // attaches a data attribute to every tr element with an object
+    // of data values keyed by column name
+    function loadRowData(tableRow) {
+        var tableCols = tableRow.querySelectorAll('td'),
+            colNode,
+            col,
+            data = {},
+            i,
+            val;
+        for (i = 0; i < tableCols.length; i += 1) {
+            colNode = tableCols[i];
+            col = cols[i];
+            val = colNode.getAttribute('data-value');
+            if (col.type === 'number') {
+                val = Number(val);
+            }
+            data[col.key] = val;
+        }
+        return data;
+    }
+    // loads all row data
+    function loadData() {
+        var rows = getTableBody().querySelectorAll('tr'),
+            i;
+
+        for (i = 0; i < rows.length; i += 1) {
+            rows[i].data = loadRowData(rows[i]);
+        }
+    }
+    // sorts the table using the data for the ith column
+    function sortByIndex(index, desc) {
+        var key = cols[index].key,
+            sorter = function(a, b) {
+                a = a.data[key];
+                b = b.data[key];
+                return a < b ? -1 : a > b ? 1 : 0;
+            },
+            finalSorter = sorter,
+            tableBody = document.querySelector('.coverage-summary tbody'),
+            rowNodes = tableBody.querySelectorAll('tr'),
+            rows = [],
+            i;
+
+        if (desc) {
+            finalSorter = function(a, b) {
+                return -1 * sorter(a, b);
+            };
+        }
+
+        for (i = 0; i < rowNodes.length; i += 1) {
+            rows.push(rowNodes[i]);
+            tableBody.removeChild(rowNodes[i]);
+        }
+
+        rows.sort(finalSorter);
+
+        for (i = 0; i < rows.length; i += 1) {
+            tableBody.appendChild(rows[i]);
+        }
+    }
+    // removes sort indicators for current column being sorted
+    function removeSortIndicators() {
+        var col = getNthColumn(currentSort.index),
+            cls = col.className;
+
+        cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
+        col.className = cls;
+    }
+    // adds sort indicators for current column being sorted
+    function addSortIndicators() {
+        getNthColumn(currentSort.index).className += currentSort.desc
+            ? ' sorted-desc'
+            : ' sorted';
+    }
+    // adds event listeners for all sorter widgets
+    function enableUI() {
+        var i,
+            el,
+            ithSorter = function ithSorter(i) {
+                var col = cols[i];
+
+                return function() {
+                    var desc = col.defaultDescSort;
+
+                    if (currentSort.index === i) {
+                        desc = !currentSort.desc;
+                    }
+                    sortByIndex(i, desc);
+                    removeSortIndicators();
+                    currentSort.index = i;
+                    currentSort.desc = desc;
+                    addSortIndicators();
+                };
+            };
+        for (i = 0; i < cols.length; i += 1) {
+            if (cols[i].sortable) {
+                // add the click event handler on the th so users
+                // dont have to click on those tiny arrows
+                el = getNthColumn(i).querySelector('.sorter').parentElement;
+                if (el.addEventListener) {
+                    el.addEventListener('click', ithSorter(i));
+                } else {
+                    el.attachEvent('onclick', ithSorter(i));
+                }
+            }
+        }
+    }
+    // adds sorting functionality to the UI
+    return function() {
+        if (!getTable()) {
+            return;
+        }
+        cols = loadColumns();
+        loadData();
+        addSearchBox();
+        addSortIndicators();
+        enableUI();
+    };
+})();
+
+window.addEventListener('load', addSorting);

package/coverage/lcov.info

@@ -0,0 +1,215 @@
+TN:
+SF:src/cypher/constants.ts
+FNF:0
+FNH:0
+DA:1,1
+DA:2,1
+DA:3,1
+DA:4,1
+DA:5,1
+LF:5
+LH:5
+BRF:0
+BRH:0
+end_of_record
+TN:
+SF:src/cypher/index.ts
+FN:12,<instance_members_initializer>
+FN:25,Cypher
+FN:34,register
+FN:58,deregister
+FN:98,downloadAndDecryptFile
+FNF:5
+FNH:5
+FNDA:22,<instance_members_initializer>
+FNDA:22,Cypher
+FNDA:3,register
+FNDA:3,deregister
+FNDA:5,downloadAndDecryptFile
+DA:1,1
+DA:2,1
+DA:3,1
+DA:4,1
+DA:5,1
+DA:6,1
+DA:7,1
+DA:8,1
+DA:9,1
+DA:10,1
+DA:11,1
+DA:12,1
+DA:13,22
+DA:14,1
+DA:15,1
+DA:16,1
+DA:17,1
+DA:18,1
+DA:19,1
+DA:20,1
+DA:21,1
+DA:22,1
+DA:23,1
+DA:24,1
+DA:25,1
+DA:26,22
+DA:27,22
+DA:28,22
+DA:29,1
+DA:30,1
+DA:31,1
+DA:32,1
+DA:33,1
+DA:34,1
+DA:35,3
+DA:36,1
+DA:37,1
+DA:38,1
+DA:39,1
+DA:40,2
+DA:41,2
+DA:42,2
+DA:43,2
+DA:44,1
+DA:45,1
+DA:46,2
+DA:47,2
+DA:48,1
+DA:49,1
+DA:50,1
+DA:51,2
+DA:52,2
+DA:53,1
+DA:54,1
+DA:55,1
+DA:56,1
+DA:57,1
+DA:58,1
+DA:59,3
+DA:60,1
+DA:61,1
+DA:62,1
+DA:63,1
+DA:64,2
+DA:65,2
+DA:66,2
+DA:67,2
+DA:68,1
+DA:69,1
+DA:70,2
+DA:71,2
+DA:72,1
+DA:73,1
+DA:74,1
+DA:75,2
+DA:76,2
+DA:77,1
+DA:78,1
+DA:79,1
+DA:80,1
+DA:81,1
+DA:82,1
+DA:83,1
+DA:84,1
+DA:85,1
+DA:86,1
+DA:87,1
+DA:88,1
+DA:89,1
+DA:90,1
+DA:91,1
+DA:92,1
+DA:93,1
+DA:94,1
+DA:95,1
+DA:96,1
+DA:97,1
+DA:98,1
+DA:99,5
+DA:100,5
+DA:101,5
+DA:102,5
+DA:103,5
+DA:104,5
+DA:105,5
+DA:106,5
+DA:107,5
+DA:108,5
+DA:109,5
+DA:110,5
+DA:111,5
+DA:112,5
+DA:113,5
+DA:114,5
+DA:115,5
+DA:116,5
+DA:117,5
+DA:118,5
+DA:119,5
+DA:120,5
+DA:121,5
+DA:122,0
+DA:123,0
+DA:124,0
+DA:125,0
+DA:126,0
+DA:127,5
+DA:128,5
+DA:129,5
+DA:130,2
+DA:131,2
+DA:132,2
+DA:133,5
+DA:134,5
+DA:135,5
+DA:136,1
+DA:137,1
+DA:138,1
+DA:139,1
+DA:140,4
+DA:141,4
+DA:142,4
+DA:143,4
+DA:144,3
+DA:145,3
+DA:146,3
+DA:147,5
+DA:148,1
+DA:149,1
+DA:150,1
+DA:151,1
+DA:152,1
+DA:153,1
+DA:154,1
+DA:155,1
+DA:156,5
+DA:157,1
+DA:158,1
+DA:159,1
+LF:159
+LH:154
+BRDA:12,0,0,22
+BRDA:25,1,0,22
+BRDA:34,2,0,3
+BRDA:35,3,0,1
+BRDA:39,4,0,2
+BRDA:43,5,0,1
+BRDA:47,6,0,1
+BRDA:58,7,0,3
+BRDA:59,8,0,1
+BRDA:63,9,0,2
+BRDA:67,10,0,1
+BRDA:71,11,0,1
+BRDA:98,12,0,5
+BRDA:119,13,0,2
+BRDA:120,14,0,2
+BRDA:121,15,0,0
+BRDA:129,16,0,3
+BRDA:129,17,0,2
+BRDA:135,18,0,4
+BRDA:135,19,0,1
+BRDA:139,20,0,4
+BRDA:143,21,0,3
+BRDA:147,22,0,1
+BRF:23
+BRH:22
+end_of_record

package/developer-quickstart.md

@@ -0,0 +1,104 @@
+# Webex Encryption Kitchen Sink
+
+This project demonstrates how to interact with the Webex encryption service using the Webex JS SDK. It includes examples of how to authenticate, initialize the SDK, and decrypt files.
+
+## Getting Started
+
+### Prerequisites
+
+- An access token from the Webex developer portal with the spark:kms
+- This token can also be obtained from the agent desktop by using developer tools and inspecting the local storage for access token
+
+### Installation
+
+1. Clone the repository.
+2. yarn build:local
+3. yarn samples:build && yarn samples:serve
+
+### Usage
+
+#### Authentication
+
+1. Navigate to [https://localhost:8000/samples/plugin-encryption](https://localhost:8000/samples/plugin-encryption)
+2. Get an access token from either the developer portal or from the agent desktop
+3. Make sure to select the environment to be integration or production
+4. Enter your access token in the "Access Token" field.
+5. Click the "Initialize Webex" button to initialize the Webex SDK.
+
+#### Initialize Webex SDK
+
+The Webex SDK is initialized using the access token provided by the user. The initialization process registers the Webex JS SDK as a device.
+
+```typescript
+function initializeWebex(accessToken) {
+  const webex = Webex.init({
+    credentials: {
+      access_token: accessToken,
+    },
+  });
+
+  return new Promise((resolve) => {
+    webex.once('ready', () => {
+      localStorage.setItem('access-token', accessToken);
+      localStorage.setItem('date', new Date().getTime() + 60 * 60 * 1000); // 1 hour expiration
+      webex.cypher.register().then(() => {
+        resolve(webex);
+      });
+    });
+  });
+}
+```
+
+### Decrypt Files
+
+To decrypt a file, provide the encrypted file URL, the desired file name, and the MIME type.
+
+```typescript
+async function decryptFile(webex, encryptedFileUrl, options, decryptedFileName, mimeType) {
+  try {
+    const decryptedFileBuf = await webex.cypher.downloadAndDecryptFile(encryptedFileUrl, options);
+    const file = new File([decryptedFileBuf], decryptedFileName, { type: mimeType });
+    const url = window.URL.createObjectURL(file);
+    const a = document.createElement('a');
+    a.style.display = 'none';
+    a.href = url;
+    a.download = decryptedFileName;
+    document.body.appendChild(a);
+    a.click();
+    window.URL.revokeObjectURL(url);
+    console.log('File decrypted and downloaded successfully');
+  } catch (error) {
+    console.error('Error decrypting file:', error);
+  }
+}
+
+const attachmentURL = 'https:/myfileurl.xyz/zzz/fileid?keyUri=somekeyuri&JWE=somejwe';
+const options = {
+  useFileService: false,
+  jwe: somejwe, // Provide the JWE here if not already present in the attachmentURL
+  keyUri: someKeyUri // Provide the keyURI here if not already present in the attachmentURL
+};
+
+await decryptFile(webex, attachmentURL, options, 'MyFile.png', 'image/png');
+```
+
+### Example Usage
+
+```typescript
+const accessToken = 'YOUR_ACCESS_TOKEN';
+const encryptedFileUrl = 'https://example.com/encrypted-file';
+const decryptedFileName = 'my-decrypted-file.jpeg';
+const mimeType = 'image/jpeg';
+
+initializeWebex(accessToken).then((webex) => {
+  decryptFile(webex, encryptedFileUrl, decryptedFileName, mimeType);
+});
+```
+
+### Additional Information
+
+For more information on the Webex JS SDK, please visit the [developer portal](https://developer.webex.com/).
+
+### License
+
+This project is licensed under the Cisco General Terms - see the [LICENSE](https://github.com/webex/webex-js-sdk/blob/next/LICENSE.md) for details.

package/dist/config.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  cypher: {}
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+null

package/dist/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+null

package/dist/cypher/constants.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DECRYPTION_SUCCESS = exports.DECRYPTION_IN_PROGRESS = exports.DECRYPTION_FAILED = exports.DECRYPTION = exports.CYPHER = void 0;
+const CYPHER = exports.CYPHER = 'cypher';
+const DECRYPTION = exports.DECRYPTION = 'decryption';
+const DECRYPTION_FAILED = exports.DECRYPTION_FAILED = 'decryptionFailed';
+const DECRYPTION_IN_PROGRESS = exports.DECRYPTION_IN_PROGRESS = 'decryptionInProgress';
+const DECRYPTION_SUCCESS = exports.DECRYPTION_SUCCESS = 'decryptionSuccess';
+//# sourceMappingURL=constants.js.map

package/dist/cypher/constants.js.map

@@ -0,0 +1 @@
+null

package/dist/cypher/cypher.types.js

@@ -0,0 +1,6 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+//# sourceMappingURL=cypher.types.js.map

package/dist/cypher/cypher.types.js.map

@@ -0,0 +1 @@
+null

package/dist/cypher/index.js

@@ -0,0 +1,141 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _webexCore = require("@webex/webex-core");
+var _constants = require("./constants");
+/**
+ * @description Encryption APIs for KMS
+ * @class
+ */
+class Cypher extends _webexCore.WebexPlugin {
+  namespace = _constants.CYPHER;
+  registered = false;
+
+  /**
+   * Constructs an instance of the class.
+   *
+   * @param {...any[]} args - The arguments to pass to the superclass constructor.
+   *
+   * @remarks
+   * This constructor calls the superclass constructor with the provided arguments.
+   * It also assigns the `webex` property to the `$webex` property, ignoring TypeScript errors.
+   */
+  constructor(...args) {
+    super(...args);
+    this.$webex = this.webex;
+  }
+
+  /**
+   * Registers the device to WDM. This is required for metrics and other services.
+   * @returns {Promise<void>}
+   */
+  async register() {
+    if (this.registered) {
+      this.$webex.logger.info('Cypher: webex.internal.device.register already done');
+      return Promise.resolve();
+    }
+    return this.$webex.internal.device.register().then(() => {
+      this.$webex.logger.info('Cypher: webex.internal.device.register successful');
+      this.registered = true;
+    }).catch(error => {
+      this.$webex.logger.error(`Error occurred during device.register() ${error}`);
+      throw error;
+    });
+  }
+
+  /**
+   * Deregisters the device.
+   * @returns {Promise<void>}
+   */
+  async deregister() {
+    if (!this.registered) {
+      this.$webex.logger.info('Cypher: webex.internal.device.deregister already done');
+      return Promise.resolve();
+    }
+    return this.$webex.internal.device.unregister().then(() => {
+      this.$webex.logger.info('Cypher: webex.internal.device.deregister successful');
+      this.registered = false;
+    }).catch(error => {
+      this.$webex.logger.error(`Error occurred during device.deregister() ${error}`);
+      throw error;
+    });
+  }
+
+  /**
+   * Downloads and decrypts a file from the given URI.
+   *
+   * @param {string} fileUri - The URI of the file to be decrypted.
+   * @param {FileDownloadOptions} options - The options for file download.
+   * @returns {Promise<ArrayBuffer>} A promise that resolves to the decrypted ArrayBuffer.
+   * @throws {Error} If the file download or decryption fails.
+   *
+   * @example
+   * ```typescript
+   * const attachmentURL = 'https:/myfileurl.xyz/zzz/fileid?keyUri=somekeyuri&JWE=somejwe';
+   * const options: FileDownloadOptions = {
+   *   useFileService: false,
+   *   jwe: somejwe, // Provide the JWE here if not already present in the attachmentURL
+   *   keyUri: someKeyUri, // Provide the keyURI here if not already present in the attachmentURL
+   * };
+   * const decryptedBuf = await webex.cypher.downloadAndDecryptFile(attachmentURL, options);
+   * const file = new File([decryptedBuf], "myFileName.jpeg", {type: 'image/jpeg'});
+   * ```
+   */
+  async downloadAndDecryptFile(fileUri, {
+    useFileService = false,
+    ...options
+  } = {}) {
+    // Sample fileUri: https://someserver.com/3cc29537-7f39-4cce-b204-a529960997fcab9375d8-4fd4-4788-bb12-18426674e95b.jpg?keyUri=kms://kms.wbx2.com/keys/79be16-a4dd-4195-93ef-a72604509aca&JWE=eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0..EHYI5SmnFisaOJgv.6Ie3Zui7LFtAr4eWMSnxXAzfi8Cgixcy2b9jy9cImDWvBjjvJQfwik7qvZewCaq-u8lhtTbjEzsJLeVtOKhW_9RoZt3U0RQ-cKaSh2RaK3N_mvuH7_BsoXCMf5zxaqP1HD-3jXUtVSnqFYvEGdGRWxTCWK-PK9BoIUjX6v5t22CUNYbBQBuHizLWvrGAM0UkSvFNRX5n07Xd3WVJ7OnIhYi0JvOb50lbZIrBn27AQL-_CIKoOQxQLkW9zmVACsVpHxLZx9wIo9XYsBYADRTZaw_l_uTiosAd2P1QAGHgLr_Q_qf1wGUn3eGhmptpPx-YCSJikvs2DttwWOg_-vg4jI3EiIXlc0gGsDnleeNRguCLtrks0PMz5hOp5_w9Z5EW05Cx2UAztnp1hE9_nCvPP9wTzdHsG3flkK82HMbPpeVStWvWmAlzp24vTw2KzYrCemdS2AkrShWsNt6_G7_G8nB4RhUnZ11MKaduE5jYpCXNcTx84RBYwA.vqYHCx8uIn-IMQAsPvrw
+    // KeyUri: An attachment level unique ID generated by Webex KMS post encryption of an attachment. In order to
+    // decrypt an attachment, KeyUri is a required parameter.
+    // JWE: JWE can be decrypted using KMS key to obtain the SCR key.
+    // Decrypting an attachment requires the SCR key parameter.
+    // We need to download the encrypted file from the given URI and then decrypt it using the SCR key.
+    // The decrypted file is then returned.
+
+    // step 1: parse the fileUri to get the keyUri and JWE
+    // step 2: if keyUri and JWE are not present in the fileUri, use the options
+    // step 3: use the keyUri to decrypt the JWE to get the SCR
+    // step 4: download the file from the fileUri and decrypt it using the SCR
+
+    let keyUri;
+    let JWE;
+    try {
+      const url = new URL(fileUri);
+      keyUri = url.searchParams.get('keyUri') ?? undefined;
+      JWE = url.searchParams.get('JWE') ?? undefined;
+    } catch (error) {
+      this.$webex.logger.error(`Cypher: Invalid fileUri: ${error.message}`);
+      throw new Error(`Failed to decrypt the JWE: ${error.message}\nStack: ${error.stack}`);
+    }
+
+    // Check if the keyUri and JWE are present, else take it from options
+    if (!keyUri || !JWE) {
+      keyUri = options.keyUri;
+      JWE = options.jwe;
+    }
+
+    // Check if the keyUri and JWE are present, else throw an error
+    if (!keyUri || !JWE) {
+      throw new Error('KeyUri and JWE are required to decrypt the file. Either provide them in the fileUri or in the options.');
+    }
+    try {
+      // Decrypt the JWE to get the SCR
+      const scr = await this.$webex.internal.encryption.decryptScr(keyUri, JWE);
+
+      // Start the download and decryption process, returning a promise
+      return this.$webex.internal.encryption.download(fileUri, scr, {
+        useFileService
+      });
+    } catch (error) {
+      const enhancedError = new Error(`Failed to decrypt or download the file: ${error.message}\nStack: ${error.stack}`);
+      enhancedError.cause = error;
+      throw enhancedError;
+    }
+  }
+}
+var _default = exports.default = Cypher;
+//# sourceMappingURL=index.js.map