Table of Contents

Advertisement

Quick Links

nShield Security World
nToken
v12.40 Installation Guide
04 March 2024

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Summary of Contents for Entrust nShield nToken v12.40

  • Page 1 nShield Security World nToken v12.40 Installation Guide 04 March 2024...
  • Page 2: Table Of Contents

    Contents Chapter 1: Introduction About this guide Model Numbers Additional documentation Typographical conventions Chapter 2: Hardware security modules Power requirements Handling modules Environmental requirements Module operational temperature and humidity specifications Cooling requirements Physical location considerations Chapter 3: Regulatory notices FCC class A notice Canadian certification - CAN ICES-3 (A) /NMB- 3(A) Recycling and disposal information Avis juridiques...
  • Page 3 Información de desecho y reciclaje Chapter 4: Before installing the module Module pre-installation steps Fitting a module bracket Chapter 5: Installing the module After installing the module Chapter 6: Before you install the software Preparatory tasks before installing software Windows environments Unix Environments All environments Firewall settings...
  • Page 4 Uninstalling on HP-UX Uninstalling on Linux Appendix B: Components on Security World Software installation media (Windows and Unix) Security World for nShield User installation media Component bundles Individual components CipherTools installation media Component bundles Individual components CodeSafe installation media Component bundles Individual components Common component bundles Common component bundles...
  • Page 5: Chapter 1: Introduction

    Chapter 1: Introduction Chapter 1: Introduction The nToken increases the security of the connection between the client computer and an HSM, by proving to the HSM that the client is in possession of a hardware token that cannot be cloned. About this guide This guide includes: Installing the nToken.
  • Page 6: Additional Documentation

    Additional documentation Additional documentation You can find additional documentation in the directory of the installation media for your document product. For information about using the software, see the nShield Connect User Guide. See the User Guide for a glossary of terms. nCipher strongly recommends that you read the release notes in the directory of your release...
  • Page 7: Chapter 2: Hardware Security Modules

    Chapter 2: Hardware security modules Chapter 2: Hardware security modules Power requirements Maximum Module power PCIe 9.9W Note: Ensure that the power supply in your computer is rated to supply the required electric power. The PCIe card intended for installation into a certified personal computer, server or similar equipment. If your computer can supply the required electric power and sufficient cooling, you can install multiple modules in your computer.
  • Page 8: Environmental Requirements

    Chapter 2: Hardware security modules Environmental requirements When you install the module, ensure that there is good air flow around it. To maximize air flow, use a PCIe slot with no neighboring modules if possible. If air flow is limited, consider fitting extra cooling fans to your computer case.
  • Page 9: Cooling Requirements

    Cooling requirements Cooling requirements Adequate cooling of the module is essential for trouble-free operation and a long operational life. During operation you can use the supplied utility to check the actual and maximum stattree temperature of the module. It is advised to do this directly after installing the module in its normal working environment.
  • Page 10: Chapter 3: Regulatory Notices

    Chapter 3: Regulatory notices Chapter 3: Regulatory notices FCC class A notice This nShield Solo HSM complies with Part 15 of the FCC rules. Operation is subject to the following two conditions: 1. This device may not cause harmful interference, and 2. This device must accept any interference received, including interference that may cause undesired operation.
  • Page 11: Avis Juridiques

    Avis juridiques Avis juridiques 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 12: Rechtliche Informationen

    Rechtliche Informationen Rechtliche Informationen 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 13: Notificaciones Reglamentarias

    Notificaciones reglamentarias Notificaciones reglamentarias 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 14: Chapter 4: Before Installing The Module

    Chapter 4: Before installing the module Chapter 4: Before installing the module Module pre-installation steps Check the module to ensure that there is no sign of damage or tampering: Check the epoxy resin security coating or metal lid of the module for obvious signs of damage. Fitting a module bracket Do not touch the nShield Solo connector pins, or the exposed area of the module without taking ESD precautions.
  • Page 15: Chapter 5: Installing The Module

    Chapter 5: Installing the module Chapter 5: Installing the module To install the module: 1. Power off the system and while taking ESD precautions, remove the PCIe card. 2. Open the computer case and locate an empty PCIe slot. If necessary, follow the instructions that your computer manufacturer supplied.
  • Page 16: Chapter 6: Before You Install The Software

    Chapter 6: Before you install the software Chapter 6: Before you install the software Uninstall any older versions of Security World Software. See Appendix A: Uninstalling existing software on page Preparatory tasks before installing software Perform any of the necessary preparatory tasks described in this section before installing the Security World Software.
  • Page 17: All Environments

    Chapter 6: Before you install the software All environments 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: Java5 (or Java 1.5x) Java6 (or Java 1.6x) Java7 (or Java 1.7x) Java8 (or Java 1.8x).
  • Page 18: Firewall Settings

    Firewall settings 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 19: Chapter 7: Installing The Software

    Chapter 7: Installing the software Chapter 7: 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 20: Installing On Aix

    Chapter 7: Installing the software 3. To install the Security World Software server, run the command: /usr/sbin/pkgadd -d /cdrom/disc-name/solaris/ver/type/nfast/nfast.pkg In this example, is the mount point of the installation media, is the version of disc-name Solaris (for example, use 11 for Solaris version 11) and is amd64 for Solaris x86 and sparc type for Solaris Sparc.
  • Page 21: Installing On Hp-Ux

    Installing on HP-UX 6. Press Enter to confirm the file set selection. When additional installation options are displayed, leave the default settings enabled. Press Enter to confirm these settings, and then press Enter again to begin the installation. 7. After software installation is complete, run the install script with the following command: /opt/nfast/sbin/install 8.
  • Page 22: Installing On Linux

    Chapter 7: Installing the software 10. Run the install script by using the following command: /opt/nfast/sbin/install 11. Add to your system variable: /opt/nfast/bin PATH If you use the Bourne shell, add these lines to your system or personal profile: PATH=/opt/nfast/bin:$PATH export PATH If you use the C shell, add this line to your system or personal profile: setenv PATH /opt/nfast/bin:$PATH...
  • Page 23 Installing on Linux 5. To use an nShield module with your Linux system, you must build a kernel driver. nCipher supplies the source to the nCipher PCI kernel driver ( ) and a makefile for building the driver as a loadable module. The kernel level driver is installed as part of the bundle.
  • Page 24 Chapter 7: Installing the software 8. Add to your system variable: /opt/nfast/bin PATH If you use the Bourne shell, add these lines to your system or personal profile: PATH=/opt/nfast/bin:$PATH export PATH If you use the C shell, add this line to your system or personal profile: setenv PATH /opt/nfast/bin:$PATH N-019025-X nToken-Installation Guide...
  • Page 25: Chapter 8: Status Indicators

    Chapter 8: Status indicators Chapter 8: Status indicators Figure 2. Back panel: PCIe module Label Description Status LED Recessed reset button Status LED The blue Status LED indicates the operational status of the module. Status LED Description Status: Power off Off. There is no power supply to the module.
  • Page 26: Chapter 9: Configuring And Checking The Installation

    Chapter 9: Configuring and checking the installation Chapter 9: Configuring and checking the installation This section describes how to: Configure the nShield Connect so that it can recognize the nToken installed on the client computer. Check that the nToken is installed and configured correctly on the client. Note: For more information about configuring an nShield Connect to use clients, see the nShield Connect User Guide.
  • Page 27 Chapter 9: Configuring and checking the installation 8. Retrieve the ESN and authentication key hash of the nToken: a. Open a command window on the client. Navigate to the directory where the Security World Software has been installed, and enter the following command: ntokenenroll -H c.
  • Page 28: Checking The Installation

    Checking the installation Checking the installation To check that the module is installed and configured correctly on the client: 1. Log in as a user and open a command window. 2. Run the command: enquiry 3. The following is an example of the output following a successful command: enquiry Module ##:...
  • Page 29: 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. The automated Security World Software installers do not delete other components or any key data and Security World data that you have created.
  • Page 30: Uninstalling Unix Software

    Appendix A: Uninstalling existing software Uninstalling Unix software 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 31: Uninstalling On Aix

    Uninstalling on AIX 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 32: Uninstalling On Hp-Ux

    Appendix A: Uninstalling existing software 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 33 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 Note: Deleting all the files and subdirectories in also deletes the /opt/nfast...
  • Page 34: 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 35: Individual Components

    Appendix B: Components on Security World Software installation media (Windows and Unix) Individual components Unix Package Description (Windows and Unix) - 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 CryptoAPI CSP GUI and console installers...
  • Page 36: Individual Components

    Individual components 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 Net-SNMP monitoring agent, utilities with nCipher MIB functionality...
  • Page 37: Individual Components

    Appendix B: Components on Security World Software installation media (Windows and Unix) Individual components Unix Description (Windows and Unix) Package - Windows only nCipher CAPI-NG providers and tools csdref nCore CodeSafe API Documentation devref nCore API Documentation gccsrc Prebuilt arm-gcc for Codesafe/C gccsrc Prebuilt powerpcm-gcc for Codesafe/C hwcrhk...
  • Page 38: Common Component Bundles

    Common component bundles 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 39 Appendix B: Components on Security World Software installation media (Windows and Unix) 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 Package Description (WIndows and Unix) convrt Command line key conversions nftcl...
  • Page 40: Additional Component Bundles

    Additional component bundles Remote Administration Service The Remote Administration Service bundle contains the Remote Administration Service installation and configuration. When installed, the Remote Administration Service starts automatically. Remote Administration Client Graphical User Interface and command line versions of the Remote Administration Client. nShield Connect firmware files Firmware image files for the nShield Connect.
  • Page 41 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. CipherTools Developer The CipherTools Developer bundle contains components supplied with the CipherTools Developer Kit: Unix Package Description (Windows and Unix) emvspj JNI library for payShield Java...
  • Page 42 Additional component bundles CodeSafe Developer The CodeSafe Developer bundle contains components supplied with the CodeSafe Developer Kit: Unix Package Description (Windows and Unix) 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 43: Components Required For Particular Functionality

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

    KeySafe KeySafe To use KeySafe, install the Core Tools and the Java Support (including KeySafe) bundles. 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 Microsoft Cryptography API: Next Generation (CNG) If you require the Microsoft CNG, you must install the CNG component: nCipher CAPI-NG providers and tools...
  • Page 45: Ncipherkm Jca/Jce Cryptographic Service Provider

    Appendix B: Components on Security World Software installation media (Windows and Unix) 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...

This manual is also suitable for:

Xc2021e-000Xc2023e-000

Table of Contents