F5 Logo MyF5
Search
  1. MyF5 Home
  2. Knowledge Centers
  3. BIG-IP LTM
  4. BIG-IP System and Thales HSM: Implementation
  5. Additional Information
Manual Chapter : Additional Information

Applies To:

Show Versions Show Versions

BIG-IP AAM

  • 13.1.5, 13.1.4, 13.1.3, 13.1.1, 13.1.0

BIG-IP APM

  • 13.1.5, 13.1.4, 13.1.3, 13.1.1, 13.1.0

BIG-IP LTM

  • 13.1.5, 13.1.4, 13.1.3, 13.1.1, 13.1.0

BIG-IP AFM

  • 13.1.5, 13.1.4, 13.1.3, 13.1.1, 13.1.0

BIG-IP DNS

  • 13.1.5, 13.1.4, 13.1.3, 13.1.1, 13.1.0

BIG-IP ASM

  • 13.1.5, 13.1.4, 13.1.3, 13.1.1, 13.1.0
Manual Chapter
Table of Contents | << Previous Chapter | Next Chapter >>

Creating a backup of the Thales RFS

Before you back up the RFS, make sure that the Thales nShield Connect Remote File System (RFS) server is installed on your network.
You back up the /shared/nfast/kmdata/local/ directory of the RFS to a secure location, so that you can recover the RFS state, if needed. The RFS contains all of the Thales nShield Connect keys.
  1. If the RFS is not installed on the BIG-IP system, rename the /shared/nfast directory to /shared/nfast.org.
    This directory can be used to recover old data, if necessary.
  2. Follow the Thales best practices for backing up the RFS server.

Upgrading the BIG-IP software when using the Thales HSM

After a BIG-IP® system software or hotfix upgrade, you must run the Thales client setup script to restore your default Thales configuration. Any local keys and certificates you loaded into the BIG-IP system before upgrading (using the command tmsh install sys crypto) appear in the upgrade partition, but they are usable only after you run the Thales client setup script. If you are restoring the Thales client on a VIPRION® system, you run the configuration script only on the primary blade, and then the system propagates the configuration to the additional active blades.

Note: If you will need CSRs, keys, or certs that were not loaded into the BIG-IP system, before you upgrade, copy the files into the /shared directory. After the upgrade, copy them back to their appropriate directories in the new partition: /config/ssl/ssl.key/, /config/ssl/ssl.crt, or /config/ssl/ssl.csr.
  1. Log in to the command-line interface of the BIG-IP system using an account with administrator privileges.
  2. Run one of these scripts, using the arguments that are appropriate for your configuration:
    • If the BIG-IP is an RFS server in addition to being a Thales client, use: nethsm-thales-rfs-install.sh and nethsm-thales-install.sh
    • If the BIG-IP is only a Thales client use: nethsm-thales-install.sh
The protected keys, which are stored in /opt/nfast/kmdata/, are available in the new partition, regardless of whether the keys and certs were loaded into the BIG-IP system.

Uninstalling Thales nShield Connect components from the BIG-IP system

If you no longer need to use the Thales nShield Connect on a BIG-IP® system, you should uninstall the files.
  1. Log in to the command-line interface of the system using an account with administrator privileges.
  2. Uninstall the client and clean up.
    nethsm-thales-install.sh -u [-v]

Replacing a broken Thales HSM without breaking existing keys

You can replace a broken Thales HSM without destroying existing keys.
  1. Turn on the new HSM, and give it an IP address, netmask, and default route.
    nethsm-thales-install.sh -u [-v]
  2. Reconfigure the RFS, so that you can point the HSM to it. If the RFS is a BIG-IP® system, use nethsm-thales-rfs-install.sh --hsm_ip_addr=<new HSM IP>. When the script asks if you want to uninstall, type yes. When the script asks if you want to overwrite the config, type yes. When the script asks if you want to use the existing Security World, type yes.
  3. Using the front panel on the HSM, configure the HSM to know its RFS. Once this is done, using the front panel again, add at least the BIG-IP system and the RFS to the HSM as clients.
  4. Using the front panel of the HSM and a quorum of the ACS, load the Security World onto the HSM.
  5. On the RFS, unenroll the old HSM, because otherwise it will still show up in enquiry results.
    nethsmenroll --force -r <old HSM IP> <old HSM ESM> <old HSM hash>
    Note that this requires the ESM and HSM hash from the broken machine. The command anonkneti will not work because the old HSM is broken or already removed from the network. This needs to be done even if the RFS is a BIG-IP system and the nethsm-thales-rfs-install.sh command was used.
  6. Rerun the install script on any BIG-IP systems that use the HSM. When that script asks if you want to uninstall, type yes. When that script asks if you want to backup, type whichever you prefer.
  7. On each BIG-IP system, unenroll the old HSM, because it will still show up in enquiry results.
    nethsmenroll --force -r <old HSM IP> <old HSM ESM> <old HSM hash>
    Note that this requires the ESM and HSM hash from the broken machine. The command anonkneti will not work, since the old HSM is broken or already removed from the network.

fipskey.nethsm utility options

The fipskey.nethsm utility includes these options:

Option Description
-o Name applied to .key, .csr, and .crt output files
Important: This parameter is required.
-c [token | module | softcard] Type of protection (default value is token)
-e [hex] Public exponent to use when generating RSA keys only.
Note: Do not provide a value for this option, unless advised to do so by F5® Technical Support.
-g [sha1] Digest used to sign key and certificate
-k [name] Key name
-m [yes | no] Store key in non-volatile RAM
-n [integer] Slot number to read cards from
-r [yes | no] Key recovery available
-s [integer] Size of key/certificate pair (in bits)
-t [RSA] Key type
-v [yes | no] Verification available
-C Country identifier
-D Domain name
-E Email address for key contact
-L Locality identifier
-N Substitute alternative name
Note: Applies only to SafeNet Luna HSM.
-O Organization identifier
-P Province identifier
-U Organization unit identifier

nethsm-thales-install.sh utility options

The nethsm-thales-install.sh utility includes these options:

Option Description
-h Displays help.
-v Prints verbose output about operations.
--hsm_ip_addr=<ip_addr> Thales HSM IP address(es). For multiple HSMs, use a double-quoted value with space-separated IP addresses (such as --hsm_ip_addr="10.10.10.100.10.10.10.101").
--rfs_interface=<interface_name> Interface identifier for the local Remote File System (RFS) server. Default is the management interface (eth0).
--protection=<protection_type> Indicates which type of key protection to use. Valid options are [m]odule, [o]cs, or [s]oftcard. When this option is not used, the protection defaults to module protection.
--verbose=<level> Indicates message verbosity level. The default value is zero, and all levels greater than zero indicate verbose output.

nethsm-thales-rfs-install.sh utility options

The nethsm-thales-rfs-install.sh utility includes these options:

Option Description
-h Displays help.
--u Uninstalls Thales software and cleans up Thales directories.
-v Prints verbose output about the executing operations.
--hsm_ip_addr=<ip_addr> Thales HSM IP address(es). For multiple HSMs, use a double-quoted value with space-separated IP addresses (such as --hsm_ip_addr="10.10.10.100.10.10.10.101").
--interface=<interface_name> Interface identifier of BIG-IP® to be used as Thales HSM Client (eth0). The default is the management interface.
--num_threads=<threads> Indicates the number of threads pkcs11d will use. The default is 20.
--rfs_interface=<interface_name> Local Remote File System (RFS) server interface name (eth0).
--rfs_ip_addr=<ip_addr> Remote RFS server IP address.
--rfs_username=<ssh_username> Remote RFS server username for SSH login.
--protection=<protection_type> Indicates which type of key protection to use. Valid options are [m]odule, [o]cs, or [s]oftcard. When this option is not used, the protection defaults to module protection.
--verbose=<level> Indicates message verbosity level. The default value is zero, and all levels greater than zero indicate verbose output.
Table of Contents | << Previous Chapter | Next Chapter >>
Contact Support Contact Support

Have a Question?

Support and Sales >

About F5

Education

F5 Sites

Support Tasks




©2023 F5 Networks, Inc. All rights reserved.


Trademarks Policies Privacy California Privacy Do Not Sell My Personal Information