Plugin Library (PL) is a feature of the Fortanix Self-Defending KMS that allows users to view a list of frequently used plugins from a commonplace. Fortanix Self-Defending KMS users can create local copies of the plugins in the library that they intend to use and then they can start invoking them.
The Fortanix Self-Defending KMS PL is backed by a Git repository that contains the plugin code. As this repository is updated by Fortanix with new plugins, Fortanix Self-Defending KMS users will be able to see the updated and new plugins available for use.
Accessing Fortanix Self-Defending KMS Plugin Library
The Fortanix Self-Defending KMS PL can be accessed by going to the Plugins page in the Fortanix Self-Defending KMS GUI, and then clicking the Plugin Library tab on this page. This page contains a list of all the available plugins with a short description of their functionality.
When a user clicks on any of the plugin tiles from the Plugin Library, the associated plugin page will be displayed with detailed information about the plugin, common use cases, setup, and format of the plugin inputs and outputs.
Installing a Plugin from the Plugin Library
To install a plugin from the PL, a user needs to click the Get Plugin button as shown in Figure 2 to go to the plugin creation page. From this page the user needs to follow the creation of plugin workflow as described below:
- Click the GET PLUGIN
- Review the plugin name and assign it to a group, and then click Save.
Review Plugin Source Code Before Installation
The user can review the plugin source code before installing it by clicking the link provided in the “Plugin page”. The user is redirected to the official Fortanix Inc. Plugin Library repository currently hosted in GitHub (https://github.com/fortanix/sdkms-plugin-registry).
Review / Modify Plugin Source Code After Installation
Once a plugin is installed, the management of the plugin is identical to plugins created by writing the source code in the Create/Import New Plugin page. Thus, after plugin creation, the user is able to modify the original code to meet specific requirements. As an example, the following image displays the source code of the “HD Wallet” that was installed from the PL.
Upgrading Plugins to New Versions
Plugin Library plugins are versioned. When a new version of the plugin becomes available an option to upgrade to the latest version will become available both in the Plugin Library list page and in the plugin main view page. For example, the following figure shows a plugin that is in version 1.0 and can be upgraded to version 2.0 by clicking the link UPGRADE TO V 2.0 on the mid-right of the screen.
When upgrading a plugin, the user can see a list of release notes for the new version and is given the option to keep a backup copy of the version of the plugin that is currently installed as shown in the following figure.
NOTE: If a plugin source code is modified, then the option to upgrade will not be displayed. This is to avoid the possibility that the user loses the changes made to the plugin source code. In the case that the user wishes to have another instance of the latest version of the plugin, the user can navigate to the PL main page and install the latest version of the plugin.
Plugins that are created before Fortanix Self-Defending KMS version 3.16 are called Legacy plugins. For backward compatibility, these legacy plugins will be marked with a special icon that denotes that they are legacy plugins.
Fortanix has applied new security restrictions which will be applicable for plugins created in Fortanix Self-Defending KMS version 3.16 and above.
These new security restrictions will not be enforced on plugins that are marked “legacy”.
The following screenshots show a table view of legacy plugins.
Figure 8: Legacy Plugins