pkcs11.installModule()

Installs the named PKCS #11 module, making it available to Firefox.

This is an asynchronous function that returns a Promise.

Syntax

js
let installing = browser.pkcs11.installModule(
  name,              // string
  flags              // integer
)

Parameters

name

string. Name of the module to install. This must match the name property in the PKCS #11 manifest for the module.

flags Optional

integer. Flags to pass to the module.

Return value

A Promise that will be fulfilled with no arguments once the module is installed.

If the module could not be found or some other error occurs, the promise will be rejected with an error message.

Examples

Installs a module, then lists its slots and list the tokens they contain:

js
function onInstalled() {
  return browser.pkcs11.getModuleSlots("my_module");
}

function onGotSlots(slots) {
  for (const slot of slots) {
    console.log(`Slot: ${slot.name}`);
    if (slot.token) {
      console.log(`Contains token: ${slot.token.name}`);
    } else {
      console.log("Is empty");
    }
  }
}

browser.pkcs11.installModule("my_module").then(onInstalled).then(onGotSlots);

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
installModule
Chrome – No support
Chrome
footnote No support
Edge – No support
Edge
footnote No support
Firefox – Full support
Firefox 58 (Release date: 2018-01-23)
footnote Full support
Opera – No support
Opera
footnote No support
Safari – No support
Safari
footnote No support
Firefox for Android – No support
Firefox for Android
footnote No support
Safari on iOS – No support
Safari on iOS
footnote No support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support