User's Guide: Plugin Library

Introduction

Plugin Library (PL) is a feature of the Fortanix Data Security Manager (DSM) that allows users to view a list of frequently used plugins from a commonplace. Fortanix DSM 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 DSM PL is stored in a Git repository that contains the plugin code. Fortanix DSM users will be able to access updated and new plugins when the repository is updated by Fortanix.

Creating a Plugin

You can add a new plugin by uploading a file with a plugin code or type the code inline. The Fortanix DSM PL can be accessed by going to the Plugins 1.png page in the Fortanix DSM GUI, and then clicking the New Plugin tab on this page.  

The following are the steps to create a new plugin: 

  1. In the New Plugin page, click Create/Import a new plugin.
    NewPlugin.png Figure 1: New Plugin Page NewPlugin1.png Figure 2: Create a New Plugin
  2. Fill in the Plugin Name field and using the ‘Assigning the new plugin to groups’ box, assign the new plugin to a group and click Next. You can also create a new group by clicking  CREATE NEW GROUP button and assign the plugin to the new group.
    NewPluginFullPage1.png Figure 3: Adding New Plugin
  3. Provide the source code for your plugin. Use the editor to type in your source to the template on the EDIT INLINE tab. You can also upload the source code as a file and then edit it using the UPLOAD A FILE tab and click Create. AddPluginCodeFullPage.png Figure 4: Add Plugin Code

Accessing Fortanix Data Security Manager Plugin Library

The Fortanix DSM PL can be accessed by going to the Plugins 1.png page in the Fortanix DSM 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.

2.png Figure 5: Plugin Library

When a user clicks on a plugin tile in 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.

3.png Figure 6: Plugin Detailed View

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:

  1. Click the GET PLUGIN
  2. Review the plugin name and assign it to a group, and then click Save. 4.png
    Figure 7: Review Plugin Details

Review Plugin Source Code Before Installation

Plugin source code may be reviewed before installing by clicking the link provided on the “Plugin page”. This link redirects to the official Fortanix Inc. Plugin Library repository hosted by GitHub

(https://github.com/fortanix/sdkms-plugin-registry).

5.png
Figure 8: Review Plugin Code Before Installation

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.

6.png
Figure 9: Modify Plugin Code After Installation

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.

ss-1.png
Figure 10: Upgrade Plugin

When upgrading a plugin, a list of release notes for the new version is displayed along with the option to keep a backup copy of the currently installed version of the plugin, as shown in the following figure.

ss-5.png
Figure 11: Plugin Upgrade Screen

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.

Legacy Plugins

Plugins that are created before Fortanix DSM version 3.16 are called Legacy plugins. For backward compatibility, these legacy plugins will be marked with a special icon legacyapps-01.svgthat denotes that they are legacy plugins.

Fortanix has applied new security restrictions which will be applicable for plugins created in Fortanix DSM version 3.16 and above.

WARNING
These new security restrictions will not be enforced on plugins that are marked “legacy”.

The following screenshots show a table view of legacy plugins. Plugin.png
Figure 12: Legacy Plugins

Was this article helpful?
0 out of 0 found this helpful