Table of Contents

Advertisement

Quick Links

nShield Security World
nShield Connect v12.50.4
Installation Guide
4 March 2024

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the nShield Connect v12.50.4 and is the answer not in the manual?

Questions and answers

Summary of Contents for Entrust nShield Connect v12.50.4

  • Page 1 Security World nShield Connect v12.50.4 Installation Guide 4 March 2024...
  • Page 2: Table Of Contents

    Contents 1 Introduction 1.1 About this guide 1.1.1 Model numbers 1.1.2 Power and safety requirements 1.2 Additional documentation 1.2.1 Terminology 1.3 Typographical conventions 1.4 Avertissements relatifs à la sécurité pour le nShield Connect 1.5 nShield Connect- Sicherheitswarnungen 1.6 Handling an nShield Connect 1.6.1 Weight and Dimensions 1.7 Environmental requirements 1.7.1 Temperature and humidity recommendations...
  • Page 3 Notificaciones reglamentarias 2.10 Notificación clase A de la FCC 2.11 Certificación de Canadá - CAN ICES-3 (A)/NMB- 3(A) 2.12 Información de desecho y reciclaje 3 Before you install the software 3.1 Preparatory tasks before installing software 3.1.1 Windows environments 3.1.1.1 Install Microsoft security updates 3.1.2 Unix Environments 3.1.2.1 Install operating environment patches 3.1.2.2 Users and Groups...
  • Page 4 6.1 Connecting Ethernet and power cables 6.2 Connecting the optional USB keyboard 6.2.1 Configuring an nShield Connect for your keyboard type 6.3 Checking the installation 7 Front panel controls 8 Top-level menu 8.1 System 8.2 HSM 8.3 Security World mgmt 9 Basic nShield Connect, RFS and client configuration 9.1 About nShield Connect and client configuration 9.1.1 Remote file system (RFS)
  • Page 5 9.2.4.1 Set default gateway for IPv4 9.2.4.2 Set default gateway for IPv6 9.2.5 Set up Routing 9.2.5.1 Set up routing for IPv4 9.2.5.2 Set up routing for IPv6 9.2.6 Edit route entry 9.2.6.1 Edit IPv4 route entry 9.2.6.2 Edit IPv6 route entry 9.2.7 Remove route entry 9.2.8 Enable IPv6 SLAAC 9.2.9 Configuring the Remote File System (RFS)
  • Page 6 10.1.6 Display screen 10.1.7 Power button 10.1.8 Ethernet LEDs 10.2 Module overheating 10.3 Log messages for the module 10.3.1 Information 10.3.2 Notice 10.3.3 Client 10.3.4 Serious error 10.3.5 Serious internal error 10.3.6 Start-up errors 10.3.7 Fatal errors 10.4 Utility error messages 10.4.1 BadTokenData error in nShield modules 11 nShield Connect maintenance 11.1 Flash testing the module...
  • Page 7 B.2.2 Individual components B.3 CodeSafe installation media B.3.1 Component bundles B.3.2 Individual components B.4 Common component bundles B.4.1 Common component bundles B.4.1.1 Hardware support B.4.1.2 Core tools B.4.1.3 Java Support (including KeySafe) B.4.1.4 Remote Administration Service B.4.1.5 Remote Administration Client B.4.1.6 nShield Connect firmware files B.4.2 Additional component bundles B.4.2.1 CipherTools Developer B.4.2.2 CodeSafe Developer...
  • Page 8: Introduction

    1 Introduction 1 Introduction ® Connect is a Hardware Security Module (HSM) that provides secure cryptographic The nShield processing within a tamper-resistant casing. Each nShield Connect is configured to communicate with one or more client computers over an Ethernet network. A client is a computer using the nShield Connect for cryptography.
  • Page 9: Model Numbers

    1 Introduction 1.1.1 Model numbers The table below shows the different versions of the module. Model number Used for NH2047 nShield Connect 6000 NH2040 nShield Connect 1500 NH2033 nShield Connect 500 NH2068 nShield Connect 6000+ NH2061 nShield Connect 1500+ NH2054 nShield Connect 500+ NH2075-B nShield Connect XC Base...
  • Page 10: Typographical Conventions

    1.3 Typographical conventions 1.3 Typographical conventions The word Note indicates important supplementary information. Pay particular attention to any warnings and cautions accompanied by the following symbols: Risk of electric Risk of damage Risk of static Risk of losing shock to the user to the module damage to the critical security...
  • Page 11: Nshield Connect- Sicherheitswarnungen

    1 Introduction 1.5 nShield Connect- Sicherheitswarnungen Beachten Sie bei Verwendung des nShield Connect stets folgende Sicherheitsvorkehrungen: Nur mit geerdeten Anschlussbuchsen verbinden. Das nShield Connect hat die Bauklasse 1 und muss geerdet werden. Nur mit Steckdosen verbinden, deren elektrische Spannung der Angabe auf dem Leistungsschild entspricht.
  • Page 12: Weight And Dimensions

    1.6.1 Weight and Dimensions 1.6.1 Weight and Dimensions Weight:  11.5kg Dimensions: 43.4mm x 430mm x 690mm The module is compatible with 1U 19” rack systems. Measurements given are height x width x length/depth. If the inner slide rails are attached, the width of the unpackaged module is 448mm.
  • Page 13: Physical Location Considerations

    1 Introduction In the unlikely event that the internal encryption module overheats, the module shuts down (see Module overheating on page 67). If the whole nShield Connect overheats, the orange warning LED Orange warning LED on page on the front panel illuminates (see 65) and a critical error message is shown on the display.
  • Page 14: Regulatory Notices

    2 Regulatory notices 2 Regulatory notices 2.1 FCC class A notice The nShield Solo and nShield Solo XC HSMs comply with Part 15 of the FCC rules. Operation is subject to the following two conditions: 1. The device may not cause harmful interference, and 2.
  • Page 15: Avis Juridiques

    Avis juridiques Avis juridiques 2.4 Classe A de la FCC Ce HSM Solo nShield répond aux exigences de la partie 15 du règlement de la FCC. Le fonctionnement est soumis aux deux conditions suivantes: 1. Cet appareil ne peut pas causer d'interférence nuisible, et 2.
  • Page 16: Rechtliche Informationen

    Rechtliche Informationen Rechtliche Informationen 2.7 Hinweis FCC-Klasse A Das nShield Solo-HSM erfüllt die Anforderungen von Teil 15 der FCC-Bestimmungen. Der Betrieb des Geräts unterliegt den folgenden zwei Bedingungen: 1. Das Gerät darf keine störenden Interferenzen verursachen, und 2. Dieses Gerät muss störenden Interferenzen, die auf das Gerät auftreffen, widerstehen (einschließlich Interferenzen, die einen ungewollten Betrieb verursachen).
  • Page 17: Notificaciones Reglamentarias

    Notificaciones reglamentarias Notificaciones reglamentarias 2.10 Notificación clase A de la FCC Este HSM nShield Solo cumple con la parte 1 5 de la reglamentación de la Comisión Federal de Comunicaciones (Federal Communications Commission, FCC) La operación está sujeta a las dos siguientes condiciones: 1.
  • Page 18: Before You Install The Software

    3 Before you install the software 3 Before you install the software Before you install the software, you should: If required, install an optional nToken in the client computer, see nToken Installation Guide for more information about the installation steps. Uninstall any older versions of Security World Software.
  • Page 19: All Environments

    3 Before you install the software 3.1.3 All environments 3.1.3.1 Install Java with any necessary patches The following versions of Java have been tested to work with, and are supported by, your nCipher Security World Software: Java6 (or Java 1.6x) Java7 (or Java 1.7x) Java8 (or Java 1.8x).
  • Page 20: Planning To Use The Remote Administration Service

    3.1.4 Planning to use the Remote Administration Service The types of application that are to use the module The amount of disc space available for the installation Your company’s policy on installing software. For example, although it may be simpler to choose all software components, your company may have a policy of not installing any software that is not required.
  • Page 21: The Remote Administration Service With An Nshield Connect Or Nshield Connect Xc

    3 Before you install the software 3.1.4.1 The Remote Administration Service with an nShield Connect or nShield Connect Figure 1. Deploying the Remote Administration Service with an nShield Connect and nShield Connect XC The Remote Access Server can be on a different client to the one where the Remote Administration Service is installed.
  • Page 22: Firewall Settings

    3.2 Firewall settings Remote Administration Cards cannot be used until their serial numbers have been added to the Authorized Card List. See the User Guide for further details. 3.2 Firewall settings When setting up your firewall, you should ensure that the port settings are compatible with the HSMs and allow access to the system components you are using.
  • Page 23: Installing The Software

    4 Installing the software 4 Installing the software This chapter describes how to install the Security World Software on the computer , client, or RFS associated with your nShield HSM. After you have installed the software, you must complete further Security World creation, configuration and setup tasks before you can use your nShield environment to protect and manage your keys.
  • Page 24 4 Installing the software Components on 4. Select all the components required for installation, and then click Next. See Security World Software installation media (Windows and Unix) on page 77 for more about the component bundles and the additional software supplied on your installation media. The selected components are installed in the default directory.
  • Page 25: Installing Security World Software In A Unix Linux Environment

    4.3 Installing Security World Software in a Unix Linux environment 4.3 Installing Security World Software in a Unix Linux environment 4.3.1 Installing on Solaris To install the Security World Software for Solaris: 1. Log in as a user with root privileges. 2.
  • Page 26: Installing On Hp-Ux

    4 Installing the software 3. Start the software management tool by running the command: smit install_latest 4. Select List to display the input device or directory for the software, and select the location that contains the installation image. 5. For SOFTWARE to install, select List, and then select all required file sets See Components on Security World Software installation media (Windows and Unix) on page 77 for more about the...
  • Page 27: Installing On Linux

    4.3.4 Installing on Linux 3. Open a terminal window, and start the software management tool by running a command of the form: swinstall -s disc-name/hpux/ver/nfast/nfast.dep In this example, is the mount point of the installation media and is the version of disc-name HP-UX (for example, use 11_31 for HP-UX version 11.31).
  • Page 28 4 Installing the software 4. Extract the required files to install all the software bundles by running commands of the form: .tar tar xf disc-name/linux/ver/nfast/bundle/file.tar In this command, ver is the version of the operating system (for example, ), bundle is the libc6_11 directory name of a given bundle (for example, ), and file...
  • Page 29: Before Installing An Nshield Connect

    5 Before installing an nShield Connect 5 Before installing an nShield Connect 5.1 Carefully unpack the nShield Connect Retain all parts of the nShield Connect packaging, including the outer (brown) shipping carton, in case you have to return the HSM. Your warranty or maintenance agreement does not cover returned modules that are damaged due to shipping in non-approved packaging.
  • Page 30: Installing An Nshield Connect In A Rack, Cabinet, Or Shelf

    6 Installing an nShield Connect in a rack, cabinet, or shelf 6 Installing an nShield Connect in a rack, cabinet, or shelf This chapter describes how to install the nShield Connect. For more information about connecting the nShield Connect to the network, and configuring it for connection to one or more clients on the network, see the nShield Connect User Guide .
  • Page 31: Connecting Ethernet And Power Cables

    6 Installing an nShield Connect in a rack, cabinet, or shelf 6.1 Connecting Ethernet and power cables The nShield Connect is an Ethernet network device capable of supporting up to 100m of Ethernet cable. You must use a CAT5e UTP cable or better when connecting the HSM to a 100Mbit or 1Gbit Ethernet device.
  • Page 32: Connecting The Optional Usb Keyboard

    6.2 Connecting the optional USB keyboard Ensure all power cables are routed to avoid sharp bends, hot surfaces, pinches, and abrasion. 6.2 Connecting the optional USB keyboard Figure 3. Connecting the optional USB keyboard Instead of using the controls on the front panel to configure the nShield Connect, you can use a US or UK keyboard (see Figure 3).
  • Page 33: Front Panel Controls

    7 Front panel controls 7 Front panel controls Figure 4. Front panel controls Description Power button Warning LED (orange) Display screen Touch wheel Status indicator LED (blue) Display navigation button (left) Display navigation button (right) Select button Slot for smart cards Clear button USB connector For more information about the user interface, including the front panel controls, see the nShield...
  • Page 34: Top-Level Menu

    8 Top-level menu 8 Top-level menu The tables below list all the menu options. If you select an option, the module displays the menu options in the level below. If you cancel a selected option, you return to level above. Top-level menu Submenus 1-1 System configuration...
  • Page 35: System

    8 Top-level menu 8.1 System System menu Submenus 1-1-1 Network config 1-1-1-1 Set up interface #1 1-1-1-2 Set up interface #2 1-1-1-3 Set default gateway 1-1-1-4 Set up routing * 1-1-1-5 Show routing table 1-1-1-6 Ping remote host 1-1-1-7 Trace route to host 1-1-1-8 Set IPv6 compliance 1-1-2 Hardserver config 1-1-3 Remote file system...
  • Page 36 8.1 System System menu Submenus 1-2-1 View system log 1-2-2 View hardserver log 1-2-3 View IPv6 addresses 1-2-4 Display tasks 1-2-5 Component versions 1-2 System information 1-2-6 View h/w diagnostics 1-2-6-1 View power readings 1-2-6-2 View other readings 1-2-6-3 Critical Errors 1-2-7 View tamper log 1-2-8 View unit id 1-3-1 Enable UI Lockout...
  • Page 37: Hsm

    8 Top-level menu 8.2 HSM HSM menu Submenus 2-1-1 Display details 2-1-2 Display secure RTC 2-1 HSM information 2-1-3 Speed test 2-1-4 Display statistics 2-2 HSM reset 2-3-1 Read FEM from card 2-3-2 Read from a file 2-3 HSM feature enable 2-3-3 View current state 2-3-4 Write state to file 2-4-1 Operational...
  • Page 38 8.3 Security World mgmt Security World mgmt menu Submenus 3-8 Set up remote slots * 3-9-1 Dynamic Slots 3-9 Set up dynamic slots 3-9-2 Slot mapping * Submenus depend on the settings of the module. nShield® Connect - Installation Guide Page 39...
  • Page 39: Basic Nshield Connect, Rfs And Client Configuration

    9 Basic nShield Connect, RFS and client configuration 9 Basic nShield Connect, RFS and client configuration This chapter describes the initial nShield Connect, RFS and client computer configuration steps. For more about: Security World Software installation and options, see Installing the software on page 24 Installing the optional nToken and software, see the nToken Installation Guide The menu options, see Top-level menu on page 35...
  • Page 40: Nshield Connect Configuration

    9 Basic nShield Connect, RFS and client configuration 9.1.2 nShield Connect configuration The current configuration files for the hardserver of an nShield Connect are stored in its local file system. These files are automatically: Updated when the nShield Connect is configured Exported to the appropriate RFS directory.
  • Page 41: Ipv4 And Ipv6

    9.2.1.1 IPv4 and IPv6 Network routes Network speed. If the nShield Connect is already configured, you can update the displayed values. If you ever change any of the IP addresses on the nShield Connect, you must update the configuration of all the clients that work with it to reflect the new IP addresses. By default, the hardserver listens on all interfaces.
  • Page 42: Ipv6 Compliance

    9 Basic nShield Connect, RFS and client configuration 1234:2345:3456:4567:5678:6789:789a:89ab 1234:5678:0:0:0:0:9abc:abcd/64 2. If one or more consecutive fields are 0 then they can be replaced by . For example: 1234:5678:0:0:0:0:9abc:abcd/64 can be written as 1234:5678::9abc:abcd/64 can only appear once in an IPv6 address. The nShield Connect front panel only allows lower case hexadecimal characters (a-f) in an IPv6 address.
  • Page 43 9.2.1.1.4 Acceptable IPv6 Address by Use Case Use Case Acceptable Addrss Type Global Unicast Static IPv6 Address Entry IPv4 Mapped Local Unicast Global Unicast IPv4 Mapped IPv6 Default Gateway Local Unicast Link-local Unknown Loopback Global Unicast IPv4 Mapped Local Unicast Link local IPv6 Route Entry - IP Range Teredo...
  • Page 44: Stateless Address Auto Configuration (Ipv6 Only)

    9 Basic nShield Connect, RFS and client configuration Use Case Acceptable Addrss Type Global Unicast Push Client Address IPv4 Mapped Local Unicast Unknown Loopback Global Unicast IPv4 Mapped Local Unicast Link-local Ping Teredo Benchmarking Orchid 6to4 Documentaion Multicast Unknown Loopback Global Unicast IPv4 Mapped Local Unicast...
  • Page 45: Configure Ethernet Interface #1

    9.2.2 Configure Ethernet Interface #1 SLAAC is disabled by default in an nShield Connect, but can be selectively enabled for each Ethernet interface either using the nShield Connect front panel or by setting the appropriate configuration item and pushing an nShield Connect configuration file. 9.2.2 Configure Ethernet Interface #1 To set up Ethernet interface #1 (default): 9.2.2.1 Enable/disable IPv4...
  • Page 46: Enable/Disable Ipv6

    9 Basic nShield Connect, RFS and client configuration 9.2.2.3 Enable/disable IPv6 To enable/disable IPv6: 1. From the front panel menu, select System > System configuration > Network config > Set up interface #1 > Configure #1 IPv6 > IPv6 Enable/Disable. The following screen displays: Network configuration IPv6 enable/disable:...
  • Page 47: Set The Link Speed For Interface #1

    9.2.2.5 Set the link speed for Interface #1 5. You are asked whether you wish to accept the new interface. To accept, press the right-hand navigation button. 6. From the front panel, select System > System configuration > Network config > Set up interface #1 >...
  • Page 48: Default Gateway

    9 Basic nShield Connect, RFS and client configuration 1. From the front panel menu, select System > System configuration > Network config > Set up interface #2. 2. Enter the details for interface #2 in the same manner that you entered the details for interface 3.
  • Page 49: Set Up Routing

    9.2.5 Set up Routing 1. From the front panel menu, select System > System configuration > Network config > Set default gateway > IPv6 gateway. The following screen is displayed: Gateway configuration Enter IPv6 address of the default gateway: CANCEL NEXT Enter the address for the gateway.
  • Page 50: Set Up Routing For Ipv6

    9 Basic nShield Connect, RFS and client configuration 9.2.5.2 Set up routing for IPv6 To set a new route entry for IPv6: 1. From the front panel menu, select System > System configuration > Network config > Set up routing > New IPv6 route entry. The following screen is displayed: Edit route entry Enter the IP range...
  • Page 51: Edit Route Entry

    9.2.6 Edit route entry 9.2.6 Edit route entry 9.2.6.1 Edit IPv4 route entry To edit a route entry for IPv4: 1. From the front panel menu, select System > System configuration > Network config > Set up routing > Edit route entry. The following screen is displayed: ►...
  • Page 52 9 Basic nShield Connect, RFS and client configuration Edit route entry ► 1. 1. 1. 1/ 1 3. 3. 3. 3/ 3 1111:1111:1111:1111: 1111:1111:1111:1111 /128 BACK SELECT 2. Select the IPv6 route to be edited. Press the right-hand navigation button. The following screen is displayed: Edit route entry Enter the IP range...
  • Page 53: Remove Route Entry

    9.2.7 Remove route entry 9.2.7 Remove route entry To remove a route entry: 1. From the front panel menu, select System > System configuration > Network config > Set up routing > Remove route entry. The following screen is displayed: ►...
  • Page 54 9 Basic nShield Connect, RFS and client configuration See the User Guide for more about the RFS and its contents. The nShield Connect must be able to connect to TCP port 9004 of the RFS. If necessary, modify the firewall configuration to allow this connection on either the RFS itself, or on a router between the RFS and the nShield Connect, or both.
  • Page 55: Systems Configured For Remote Administration

    9.2.9.1 Systems configured for Remote Administration 2. On the nShield Connect display screen, use the right-hand navigation button to select System > System configuration > Remote file system > Define IPv4 RFS and enter the IP address of the client computer on which you set up the RFS. Leave the port number at the default setting of 9004.
  • Page 56: Config-Serverstartup

    9 Basic nShield Connect, RFS and client configuration nethsmenroll [Options] --privileged <nShield Connect IP><nShield Connect ESN><nShield Connect KNETI HASH> Options : Specifies the local module number that should be used (default is for dynamic configuration --module=MODULE by hardserver). Makes the hardserver request a privileged connection to the nShield Connect (default --privileged unprivileged...
  • Page 57: Configuring A Client To Communicate Through An Ntoken

    9.3.2 Configuring a client to communicate through an nToken config-serverstartup --help 9.3.2 Configuring a client to communicate through an nToken You can configure a client to use its nToken to communicate with an nShield Connect, if it has one installed. When this happens, the nShield Connect: Examines the IP address of the client Requires the client to identify itself using a signing key If an nToken is installed in a client, it can be used to both generate and protect a key that is...
  • Page 58: Configure The Tcp Sockets On The Client For Java Applications (For Example, Keysafe)

    9 Basic nShield Connect, RFS and client configuration 3. Do one of the following: a. If you are enrolling a client with an nToken installed, run the command: nethsmenroll --ntoken-esn <nToken ESN> [Options] --privileged <Unit IP> <Unit ESN> <Unit KNETI HASH> b.
  • Page 59 9.4 Basic configuration of an nShield Connect to use a client 2. Enter the IP address of the client, and press the right-hand navigation button. You are asked to choose the permissions for the client: Client configuration Please choose the client permissions Unprivileged BACK...
  • Page 60: Restarting The Hardserver

    9 Basic nShield Connect, RFS and client configuration a. To enroll the client with nToken authentication, you must first confirm the nToken authentication key. On the client, open a command line window, and run the command: ntokenenroll -H The following is an example of the output: nToken module #1 nToken ESN: 3138-147F-2D64...
  • Page 61: Checking The Installation

    9.6 Checking the installation 1. Do one of the following to stop and restart the hardserver, according to your operating system: a. Windows: net stop "nfast server" net start "nfast server" b. Unix-based: /opt/nfast/sbin/init.d-ncipher restart 9.6 Checking the installation To check that the module is installed and configured correctly on the client: 1.
  • Page 62: Troubleshooting

    10 Troubleshooting 10 Troubleshooting This chapter describes what to do if you have an issue with your HSM, or your Security World Software. 10.1 Checking operational status Use the following methods to check the operational status of the module. 10.1.1 Enquiry utility Run the utility to check that your module is working correctly.
  • Page 63: Status Led

    10 Troubleshooting 10.1.2 Status LED The blue Status LED indicates the operational status of the module. Status LED Description Status: Power off or Standby mode There is either no power supply to the module or the module is in Standby mode. If you suspect that there is Off.
  • Page 64: Audible Warning

    10.1.3 Audible warning 10.1.3 Audible warning An audible warning sounds for some critical errors relating to the PSUs on the module. The orange warning LED (see Orange warning LED on page 65) accompanies the audible warning. The warning sounds when only one of the two PSUs is powered and turned on. Check that: The rocker switch on both PSUs is in the position Both PSUs are connected to the mains supply...
  • Page 65: Power Button

    10 Troubleshooting The blue Status LED flashes to indicate the status of the internal security module. 10.1.7 Power button The Power button, in combination with the display screen, indicates the general status of the module. The display screen turns off automatically if the front panel buttons are inactive for more than three minutes.
  • Page 66: Module Overheating

    10.2 Module overheating 10.2 Module overheating If the internal module of the nShield Connect exceeds the safe operating temperature, the unit stops Status LED on page 64 operating and displays the error message on the Status LED. See SOS-T details of the error message.
  • Page 67: Serious Error

    10 Troubleshooting 10.3.4 Serious error This type of message indicates a serious error, such as a communications or memory failure: nFast server: Serious error, trying to continue: message If you receive a serious error, even if you are able to recover, contact Support. 10.3.5 Serious internal error This type of message indicates that the server has detected a serious error in the reply from the module.
  • Page 68: Utility Error Messages

    10.4 Utility error messages 10.4 Utility error messages This type of message might indicate an error status when you run a command line utility. 10.4.1 error in nShield modules BadTokenData Some nShield modules are equipped with a rechargeable backup battery for maintaining Real Time Clock (RTC) operation when the module is powered down.
  • Page 69: Nshield Connect Maintenance

    11 nShield Connect maintenance 11 nShield Connect maintenance The nShield Connect contains only two user-replaceable parts: The PSUs The fan tray module Replacing a PSU or fan tray module does not affect FIPS 140-2 validations for the nShield Connect, or result in a tamper event.
  • Page 70: Approved Accessories

    12 Approved accessories 12 Approved accessories The following parts can be ordered with the HSM or separately. Part Part number Comments Optional slide rail assembly and fixing Slide rail assembly AC2050 kit. For details of contents, see the nShield Connect Slide Rails Instructions . For more information about using a USB keyboard with the HSM, see USB keyboard...
  • Page 71: Appendix A Uninstalling Existing Software

    Appendix A Uninstalling existing software Appendix A Uninstalling existing software nCipher recommends that you uninstall any existing older versions of Security World Software before you install new software. In Windows environments, if the installer detects an existing Security World Software installation, it asks you if you want to install the new components. These components replace your existing installation.
  • Page 72: Uninstalling Unix Software

    Appendix A Uninstalling existing software A.2 Uninstalling Unix software A.2.1 Uninstalling on Solaris To uninstall the Security World Software from Solaris: 1. Assume the nFast Administrator privileges or root privileges by running the command: $ su - 2. Type your password, then press Enter. 3.
  • Page 73: Uninstalling On Aix

    A.2.2 Uninstalling on AIX A.2.2 Uninstalling on AIX To uninstall the Security World Software from AIX: 1. Log in as a user with root privileges. 2. To remove drivers, install fragments, and scripts and to stop services, run the command: /opt/nfast/sbin/install -u 3.
  • Page 74: Uninstalling On Hp-Ux

    Appendix A Uninstalling existing software A.2.3 Uninstalling on HP-UX To uninstall the Security World Software from HP-UX: 1. Assume the nFast Administrator privileges or root privileges by running the command: su - 2. Type your password, then press Enter. 3. To remove drivers, install fragments, and scripts and to stop services, run the command: /opt/nfast/sbin/install -u 4.
  • Page 75 A.2.4 Uninstalling on Linux 3. To remove drivers, install fragments, and scripts and to stop services, run the command: /opt/nfast/sbin/install -u 4. Delete all the files (including those in subdirectories) in by running /opt/nfast /dev/nfast/ the following commands: rm -rf /opt/nfast Deleting all the files and subdirectories in also deletes the /opt/nfast...
  • Page 76: Appendix B Components On Security World Software Installation Media (Windows And Unix)

    Appendix B Components on Security World Software installation media (Windows and Unix) Appendix B Components on Security World Software installation media (Windows and Unix This appendix lists the contents of the component bundles and the additional software supplied on your Security World Software installation media.
  • Page 77: Individual Components

    Appendix B Components on Security World Software installation media (Windows and Unix) B.1.2 Individual components Unix Description (Windows and Unix) Package - Windows only nCipher CAPI-NG providers and tools hwcrhk Crypto Hardware Interface (CHIL) plugin jcecsp nCipherKM JCA/JCE provider classes - Windows only CSP Console utilities - Windows only...
  • Page 78: Individual Components

    B.2.2 Individual components B.2.2 Individual components Unix Description (Windows and Unix) Package - Windows only nCipher CAPI-NG providers and tools devref nCore API Documentation hwcrhk Crypto Hardware Interface (CHIL) plugin jcecsp nCipherKM JCA/JCE provider classes - Windows only CSP Console utilities - Windows only CryptoAPI CSP GUI and console installers ncsnmp...
  • Page 79: Codesafe Installation Media

    Appendix B Components on Security World Software installation media (Windows and Unix) B.3 CodeSafe installation media The following component bundles and additional components are supplied on the CodeSafe installation media: B.3.1 Component bundles Unix Description (Windows and Unix) Contents of bundle Package Hardware support (mandatory)
  • Page 80: Common Component Bundles

    B.4 Common component bundles B.4 Common component bundles nCipher supply component bundles containing many of the necessary components for your installation. Certain standard component bundles are offered for installation on all standard Security World Software installation media, while additional component bundles are found on CipherTools and CodeSafe installation media.
  • Page 81: Core Tools

    Appendix B Components on Security World Software installation media (Windows and Unix) B.4.1.2 Core tools The Core Tools (recommended) bundle contains all the Security World Software command-line utilities, including , low level utilities, and test programs: generatekey Unix Description (WIndows and Unix) Package convrt Command line key conversions...
  • Page 82: Remote Administration Service

    B.4.1.4 Remote Administration Service B.4.1.4 Remote Administration Service The Remote Administration Service bundle contains the Remote Administration Service installation and configuration. When installed, the Remote Administration Service starts automatically. B.4.1.5 Remote Administration Client Graphical User Interface and command line versions of the Remote Administration Client. B.4.1.6 nShield Connect firmware files Firmware image files for the nShield Connect.
  • Page 83: Ciphertools Developer

    Appendix B Components on Security World Software installation media (Windows and Unix) nCipher supply the following additional component bundles on CodeSafe installation media: Code safe Java developer. B.4.2.1 CipherTools Developer The CipherTools Developer bundle contains components supplied with the CipherTools Developer Kit: Unix Description (Windows and Unix)
  • Page 84: Codesafe Developer

    B.4.2.2 CodeSafe Developer B.4.2.2 CodeSafe Developer The CodeSafe Developer bundle contains components supplied with the CodeSafe Developer Kit: Unix Description (Windows and Unix) Package csee Codesafe-C moduleside example code csee Codesafe-C hostside example code module Firmware test scripts Generic stub libraries and headers, and example C source for utility nflibs functions nfuser...
  • Page 85: Java Developer

    Appendix B Components on Security World Software installation media (Windows and Unix) B.4.2.3 Java Developer The Java Developer bundle contains components to support development of Java applications: Unix Description (Windows and Unix) Package jcecsp Java Key Management developer jutils Java utilities source and javadocs kmjava Java Key Management developer nfjava...
  • Page 86: Components Required For Particular Functionality

    B.5 Components required for particular functionality B.5 Components required for particular functionality Some functionality requires particular component bundles or individual components to be installed. If you are planning to use Security World Software with an nShield Edge, ensure that the optional Edge Monitor Controller feature is selected during installation.
  • Page 87: Keysafe

    Appendix B Components on Security World Software installation media (Windows and Unix) B.5.1 KeySafe To use KeySafe, install the Core Tools and the Java Support (including KeySafe) bundles. B.5.2 Microsoft CAPI CSP If you require the Microsoft CAPI CSP, you must install the CSP components: CSP console utilities CryptoAPI CSP GUI and console installers B.5.3 Microsoft Cryptography API: Next Generation (CNG)
  • Page 88: Ncipherkm Jca/Jce Cryptographic Service Provider

    B.7 nCipherKM JCA/JCE cryptographic service provider B.7 nCipherKM JCA/JCE cryptographic service provider If you want to use the nCipherKM JCA/JCE cryptographic service provider, you must install both: The Java Support (including KeySafe) bundle The nCipherKM JCA/JCE provider classes component An additional JCE provider is supplied that is required for RSA encryption nCipherRSAPrivateEncrypt with a private key.
  • Page 89: Appendix C Valid Ipv6 Addresses

    Appendix C Valid IPv6 Addresses Appendix C Valid IPv6 Addresses This appendix provides a list of valid IPv6 addresses for each of the types of addresses recognized by the system. For information on setting up IPv6 addresses, see Acceptable IPv6 Address by Use Case on page Address Range (inclusive)  Address...

Table of Contents