@webex/plugin-encryption

@webex/plugin-encryption

Encryption plugin for the Cisco Webex JS SDK.

• Install
• Usage
• Development
• Sample Code
• Contribute
• Maintainers
• License

WARNING: This plugin is currently under active development

Install

npm install --save @webex/plugin-encryption

Usage

This is a plugin for the Cisco Webex JS SDK . Please see our developer portal and the API reference for full details.

API Docs and Sample App

• API Reference: https://webex.github.io/webex-js-sdk/plugin-encryption/
• Hosted Sample App: https://webex.github.io/webex-js-sdk/samples/plugin-encryption/
• See https://github.com/webex/webex-js-sdk/tree/next/docs/samples/plugin-encryption for a reference implementation

Sample Code

import Webex from 'webex/plugin-encryption';

const webex = Webex.init({
  credentials: {
    access_token
  }
});

webex.once('ready', () => {
  webex.cypher.register().then(() => {
    try {
      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
      };
      const decryptedFileBuf = await webex.cypher.downloadAndDecryptFile(attachmentURL, options);
      // Do something with the decrypted file buffer
    } catch (error) {
      // Handle error
    }
  }).catch((err) => {
    // Handle error
  });
});

webex.cypher.deregister().then(() => {
// Do deregistration at your App's teardown
});

Development

To use webpack-dev-server to load this package, run yarn run samples:serve.

Files placed in the docs/samples/plugin-encryption folder will be served statically.

Files in the src/@webex/plugin-encryption folder will be compiled, bundled, and served as a static asset at encryption.js inside that directory.

Maintainers

This package is maintained by Cisco Webex for Developers.

Contribute

Pull requests welcome. Please see CONTRIBUTING.md for more details.

License

This project is licensed under the Cisco General Terms - see the LICENSE for details.

© 2016-2025 Cisco and/or its affiliates. All Rights Reserved.