pkcs11 API

Hint

The pkcs11 API is inherited from Firefox, and its primary documentation is maintained by Mozilla at MDN. Thunderbird implements only the subset of functions, events, and types listed here. The MDN pages may provide further details and examples, but they may also reference features that are not supported in Thunderbird.

PKCS#11 module management API

Permissions

The following permissions influence the behavior of the API. Depending on which permissions are requested, additional methods might be available, or certain data may be included in responses.

Hint

Request permissions only when needed. Unnecessary requests may result in rejection during ATN review.

pkcs11

pkcs11

Grant access to some or all methods of the pkcs11 API.

Note

The permission pkcs11 is required to use messenger.pkcs11.*.

Functions

getModuleSlots(name)

– [Added in TB 58]

Enumerate a module’s slots, each with their name and whether a token is present

Parameters

name

name

(string)

Required permissions

  • pkcs11

installModule(name, [flags])

– [Added in TB 58]

Install a PKCS#11 module with a given name

Parameters

name

name

(string)

flags

[flags]

(integer, optional)

Required permissions

  • pkcs11

isModuleInstalled(name)

– [Added in TB 58]

checks whether a PKCS#11 module, given by name, is installed

Parameters

name

name

(string)

Required permissions

  • pkcs11

uninstallModule(name)

– [Added in TB 58]

Remove an installed PKCS#11 module from firefox

Parameters

name

name

(string)

Required permissions

  • pkcs11