Entrust NShield Solo Manuel utilisateur

nShield® Solo and nShield®

Solo XC

Installation Guide

12.80

17 Nov 2021

Contents

1. Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê4

1.1. About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê4

1.2. Additional documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê5

2. Hardware security modules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê6

2.1. Power requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê6

2.2. Handling modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê6

2.3. Environmental requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê6

2.4. Module operational temperature and humidity specifications. . . . . . . . . . . . . . . . . . Ê7

2.5. Cooling requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê8

2.6. Physical location considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê8

3. Regulatory notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê9

3.1. FCCÊclass AÊnotice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê9

3.2. Canadian certification - CAN ICES-3 (A)/NMB- 3(A) . . . . . . . . . . . . . . . . . . . . . . . . . Ê9

3.3. Battery cautions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê9

3.4. Hazardous substance caution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê9

3.5. Recycling and disposal information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê9

4. Before installing the module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê10

4.1. Back panel and jumper switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê10

4.2. Module pre-installation steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê11

4.3. Fitting a module bracket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê11

4.4. Replace Solo XC Fan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê12

4.5. Replace Solo XC Battery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê13

5. Installing the module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê15

5.1. Fitting a smart card reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê15

5.2. After installing the module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê15

6. Before you install the software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê16

6.1. Preparatory tasks before installing software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê16

6.2. Firewall settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê19

7. Installing the software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê20

7.1. Installing the Security World Software on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . Ê20

7.2. Installing the Security World Software on Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê21

8. Checking the installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê24

8.1. Checking operational status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê24

8.2. Mode switch and jumper switches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê26

8.3. Log message types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê26

8.4. Utility error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê28

9. Status indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê29

Appendix A: Uninstalling existing software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê31

nShield® Solo and nShield® Solo XC Installation Guide 2 of 49

A.1. Uninstalling the Security World Software on Windows . . . . . . . . . . . . . . . . . . . . . . . Ê32

A.2. Uninstalling the Security World Software on Linux . . . . . . . . . . . . . . . . . . . . . . . . . . Ê32

Appendix B: Software packages on the Security World installation media . . . . . . . . . . . . Ê34

B.1. Security World installation media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê34

B.2. Components required for particular functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê35

B.3. nCipherKM JCA/JCE cryptographic service provider . . . . . . . . . . . . . . . . . . . . . . . . Ê36

B.4. SNMP monitoring agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê37

Appendix C: Virtualization Remote Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê38

C.1. Virtualization and Hyper-V. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê38

C.2. Virtualization and XenServer/VMware vSphere hypervisor, ESXi . . . . . . . . . . . . . . Ê39

C.3. ESXi environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê39

C.4. XenServer environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê41

C.5. Hyper-V environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê44

nShield® Solo and nShield® Solo XC Installation Guide 3 of 49

1. Introduction

The Entrust nShield Solo and Solo XC are Hardware Security Modules (HSM) for servers

and appliances.

1.1. About this guide

This guide includes:

•Installing the nShield Solo and nShield Solo XC. See Installing the module.

•Installing the Security World Software. See Installing the software.

•Steps to check the installation. See Checking the installation.

•A description of the module status indicators. See Status indicators.

•Instructions about removing existing software. See Uninstalling existing software.

See the User Guide for more about, for example:

•Creating and managing a Security World

•Creating and using keys

•Card sets

•The advanced features of an nShield Solo and nShield Solo XC.

For information on integrating Entrust nShield products with third-party enterprise

applications, see https://www.entrust.com/digital-security/hsm.

1.1.1. Model Numbers

The table below shows the different versions of the module. The letter xrepresents any

single-digit integer. Model number

Model number Used for

xC3xxxE-xxx

xC4xxxE-xxx

nShield Solo PCIe

xC30x5E-xxx

xC40x5E-xxx

nShield Solo XC PCIe

nShield® Solo and nShield® Solo XC Installation Guide 4 of 49

1.2. Additional documentation

You can find additional documentation in the documentation directory of the installation

media for your product. For information about using the software and enabling

additional features (such as client licenses), see the nShield Solo, nShield Solo XC and

nShield Edge - User Guide. Entrust strongly recommends that you read the release notes

at https://nshieldsupport.entrust.com. These notes contain the latest information about

your product.

1.2.1. Terminology

The nShield Solo and nShield Solo XC are referred to as a the nShield Solo and nShield

Solo XC, the hardware security module, or the HSM in this guide.

nShield® Solo and nShield® Solo XC Installation Guide 5 of 49

2. Hardware security modules

2.1. Power requirements

Module Maximum

power

Solo 9.9W

Solo XC 24W

Make sure that the power supply in your computer is rated to supply

the required electric power.

The Solo and Solo XC nToken modules are 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.

2.2. Handling modules

The module contains solid-state devices that can withstand normal handling. However,

do not drop the module or expose it to excessive vibration.



Before installing hardware you must disconnect your computer from

the power supply. Ensure that a grounded (earthed) contact remains.

Perform the installation with care, and follow all safety instructions in

this guide and from your computer manufacturer.

Static discharge can damage modules. Do not touch the module

connector pins, or the exposed area of the module.

Leave the module in its anti-static bag until you are ready to install it. Always wear an

anti-static wrist strap that is connected to a grounded metal object. You must also

ensure that the computer frame is grounded while you are installing or removing an

internal module.

2.3. Environmental requirements

When you install the module, ensure that there is good air flow around it. To maximize air

nShield® Solo and nShield® Solo XC Installation Guide 6 of 49

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.

Failure to provide adequate cooling can result in damage to the module

or the computer into which the module is fitted.

Always handle the module correctly. For more information, see Handling modules.

2.4. Module operational temperature and humidity

specifications

The Solo modules operate within the following environmental conditions.

Solo environmental conditions Operating range Comments

Min. Max.

Ambient operating temperature 10°C 35°C Subject to sufficient air flow

Storage temperature -20°C 70°C -

Operating humidity 10% 90% Relative. Non-condensing at

35°C

Storage humidity 0 85% Relative. Non-condensing at

35°C

The Solo XC module operates within the following environmental conditions.

Solo XC environmental

conditions

Operating range Comments

Min. Max.

Ambient operating temperature 5°C 55°C -

Storage temperature -5°C 60°C -

Transportation temperature -40°C 70°C -

Operating humidity 5% 85% Relative. Non-condensing at

30°C

Storage humidity 5% 93% Relative. Non-condensing at

30°C

nShield® Solo and nShield® Solo XC Installation Guide 7 of 49

Transportation humidity 5% 93% Relative. Non-condensing at

30°C



The Solo and Solo XC nToken modules are designed to operate in

moderate climates only. Never operate the modules in dusty, damp, or

excessively hot conditions. Never install, store, or operate the Solo and

Solo XC nToken modules at locations where it may be subject to

dripping or splashing liquids.

2.5. 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 stattree utility to check the actual and

maximum temperature of the module. It is advised to do this directly after installing the

module in its normal working environment. Monitor the temperature of the module over

its first few days of operation. If the module exceeds the safe operating temperature, it

stops operating and displays the SOS-T error message on the Status LED (see Status

indicators).

2.6. Physical location considerations

Entrust nShield HSMs are certified to NIST FIPS 140-2 Level 2 and 3. In addition to the

intrinsic protection provided by an nShield HSM, customers must exercise due diligence

to ensure that the environment within which the nShield HSMs are deployed is

configured properly and is regularly examined as part of a comprehensive risk mitigation

program to assess both logical and physical threats. Applications running in the

environment shall be authenticated to ensure their legitimacy and to thwart possible

proliferation of malware that could infiltrate these as they access the HSMs’

cryptographic services. The deployed environment must adopt 'defense in depth'

measures and carefully consider the physical location to prevent detection of

electromagnetic emanations that might otherwise inadvertently disclose cryptographic

material.

nShield® Solo and nShield® Solo XC Installation Guide 8 of 49

3. Regulatory notices

3.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. The device must accept any interference received, including interference that may

cause undesired operation.

This equipment has been tested and found to comply with the limits for a Class A digital

device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide

reasonable protection against harmful interference when the equipment is operated in a

commercial environment. This equipment generates, uses, and can radiate radio

frequency energy and, if not installed and used in accordance with the instruction

manual, may cause harmful interference to radio communications. Operation of this

equipment in a residential area is likely to cause harmful interference in which case the

users will be required to correct the interference at their own expense.

3.2. Canadian certification - CAN ICES-3 (A)/NMB- 3(A)

3.3. Battery cautions

Danger of Explosion if the battery is incorrectly replaced. The battery may only be

replaced with the same or equivalent type. Dispose of the used battery in accordance

with your local disposal instructions.

3.4. Hazardous substance caution

This product contains a lithium battery and other electronic components and materials

which may contain hazardous substances. However, this product is not hazardous

providing it is used in the manner in which it is intended to be used.

3.5. Recycling and disposal information

For recycling and disposal guidance, see the nShield product’s Warnings and Cautions

documentation.

nShield® Solo and nShield® Solo XC Installation Guide 9 of 49

4. Before installing the module

4.1. Back panel and jumper switches

Label Description

A Status LED

B Recessed clear button

C Physical mode switch

D Physical mode override jumper switch, in the off position. When set to on, the

mode switch (C) is deactivated. See the User Guide for more information.

E Remote mode override jumper switch, in the off position. When set to on,

remote mode switching is disabled. See the User Guide for more information.

F A mini-DIN connector for connecting a smart card reader.

The configuration of connectors varies between modules and might not

be as in the image.

nShield® Solo and nShield® Solo XC Installation Guide 10 of 49

Autres manuels pour nShield Solo

Ce manuel convient aux modèles suivants

Table des matières

Autres manuels Entrust Unité de contrôle

Entrust

Entrust nShield 5s Manuel utilisateur

Entrust

Entrust nShield Manuel utilisateur

Entrust

Entrust Sigma DS4 Manuel utilisateur

Entrust

Entrust nShield Edge Manuel utilisateur

Entrust

Entrust nShield Manuel utilisateur

Manuels Unité de contrôle populaires d'autres marques

Festo

Festo Compact Performance CP-FB6-E Manuel de la liste des pièces

Elo TouchSystems

Elo TouchSystems DMS-SA19P-EXTME Manuel utilisateur

JS Automation

JS Automation MPC3034A Manuel utilisateur

JAUDT

JAUDT SW GII 6406 Series Guide rapide

Spektrum

Spektrum Air Module System Manuel utilisateur

BOC Edwards

BOC Edwards Q Series Manuel utilisateur

KHADAS

KHADAS BT Magic Manuel utilisateur

Etherma

Etherma eNEXHO-IL Manuel utilisateur

PMFoundations

PMFoundations Attenuverter Manuel utilisateur

GEA

GEA VARIVENT Manuel utilisateur

Walther Systemtechnik

Walther Systemtechnik VMS-05 Manuel utilisateur

Altronix

Altronix LINQ8PD Instructions de montage

Eaton

Eaton Powerware Series Manuel utilisateur

WAGO

WAGO 750-407/040-000 Manuel utilisateur

Sony

Sony CCU-590 Manuel utilisateur

Graco

Graco 25D614 Manuel utilisateur

Task Force Tips

Task Force Tips YE-RF-900 Manuel de programmation

Shini

Shini SPV-U Series Manuel utilisateur

Entrust nShield Solo Manuel utilisateur

Manuels Unité de contrôle populaires d'autres marques