Excrypt Manager
Perform the following steps on Excrypt Manager to create an application partition:1
Go to the Application Partitions menu and select [ Add ].
2
In the Basic Information tab, configure all of the fields as follows:
| Option | Required configuration |
|---|---|
| Role Name | Specify any name that you would like for this new application partition. |
| Logins Required | Set to 1 If the HSM is in FIPS mode, set Logins Required to 2. The Futurex PKCS #11 library then logs in two identities. For details, see the next section. |
| Ports | Set to Prod. |
| Connection Sources | Set to Ethernet. |
| Managed Roles | Leave blank because you specify the exact Permissions, Key Slots, and Commands for this application partition or role to have access to. |
| Use Dual Factor | Set to Never. |
| Upgrade Permissions | Leave unchecked. |
3
In the Permissions tab, select the following key permissions:
| Permission | Description |
|---|---|
| Keys | Top-level permission |
| Authorized | Allows for keys that require login |
| Import PKI | Allows trusting an external PKI. Generally not recommended, but some applications use this option for PKI symmetric key wrapping. |
| No Usage Wrap | Enables interoperable key wrapping without defining key usage as part of the wrapped key. Use this only if you want to exchange keys with external entities or use the HSM to wrap externally used keys. |
4
In the Key Slots tab, Futurex recommends you create a range of 1000 total keys that do not overlap with another application partition. Within the specified range, you should have ranges for both symmetric and asymmetric keys. If the application requires more keys, configure it accordingly.
5
To use the HSM functionality, you must enable particular functions on the application partition based on application requirements. Enable the following commands under Commands:PKCS #11 Communication Commands:
Key Operations Commands:
Interoperable Key Wrapping:
Data Encryption Commands:
Signing Commands:
| Command | Description |
|---|---|
| ECHO | Communication Test/Retrieve Version |
| PRMD | Retrieve HSM restrictions |
| RAND | Generate random data |
| HASH | Retrieve device serial |
| GPKM | Retrieve key table information |
| GPKS | General-purpose key settings get/change |
| GPKR | General-purpose key settings get (read-only) |
| Command | Description |
|---|---|
| APFP | Generate PKI Public Key from Private Key |
| ASYL | Load asymmetric key into key table |
| GECC | Generate an ECC Key Pair |
| GPCA | General-purpose add certificate to key table |
| GPGS | General-purpose generate symmetric key |
| GPKA | General-purpose key add |
| GPKD | General-purpose key slot delete/clear |
| GRSA | Generate RSA Private and Public Key |
| LRSA | Load key into RSA Key Table |
| RPFP | Get public components from RSA private key |
| Command | Description |
|---|---|
| GPKU | General-purpose key unwrap (unrestricted) |
| GPUK | General-purpose key unwrap (preserves key usage) |
| GPKW | General-purpose key wrap (unrestricted) |
| GPWK | General-purpose key wrap (preserves key usage) |
| Command | Description |
|---|---|
| ADPK | PKI Decrypt Trusted Public Key |
| GHSH | Generate a Hash (Message Digest) Starting in firmware version 7.x, this function is enabled by default and does not need to be specified. |
| GPED | General-purpose symmetric encrypt and decrypt (used by default) |
| GPSE | General-purpose Symmetric Encrypt (used when GPED-EXPAND is YES) |
| GPSD | General-purpose Symmetric Decrypt (used when GPED-EXPAND is YES) |
| GPGC | General-purpose generate cryptogram from key slot |
| GPMC | General-purpose MAC (Message Authentication Code) |
| GPSR | General-purpose RSA encrypt/decrypt or sign/verify with recovery |
| HMAC | Generate a hash-based message authentication code |
| RDPK | Get Clear Public Key from Cryptogram |
| Command | Description |
|---|---|
| ASYS | Generate a signature using a PKI private key |
| ASYV | Verify a signature using a public key |
| GPSV | General-purpose data sign and verify |
| RSAS | Generate a Ssgnature using a RSA private key |
FXCLI
Run the following role FXCLI commands to create the new application partition and enable all needed functions. Replace[role_name] with the name of the application partition and [first_slot] and [last_slot] with a key slot range that doesn’t overlap another application partition.
FXCLI
FXCLI
On firmware 7.x, every role has GHSH enabled by default, so the command doesn’t include it. Adding
Excrypt:GHSH causes the whole command to fail with Invalid permission 'Excrypt:GHSH'.role modify, because role add ignores the --logins option for application partitions:
FXCLI
role get --name [role_name] and confirm the loginsRequired value, key slot range, and permissions.
FXCLI doesn’t set the Ports or Connection Sources of an application partition. A new application partition uses the Ethernet and Serial connection sources. To restrict it to Ethernet only, use Excrypt Manager.

