NCipher-nShield Administrator Guide Windows

nShield/payShield Administrator

Guide Windows

nShield/payShield Administrator Guide Windows v5.5 2

Version: 5.5

Date: 03 November 2005

Copyright 2005 nCipher Corporation Limited, Cambridge, United Kingdom.

Neither the whole nor any part of the information contained in this document may be adapted orreproduced in any material or electronic form without the prior written consent of the copyright holder.

nCipher, nForce, nShield, payShield, nCore, nToken, nFast Ultra, nForce Ultra,netHSM, KeySafe, CipherTools, CodeSafe, keyAuthority, SEE, and the SEE logo aretrademarks of nCipher Corporation Limited.

nFast and the nCipher logo are registered trademarks of nCipher Corporation Limited.

All other trademarks are the property of the respective trademark holders.

Information in this document is subject to change without notice.

nCipher Corporation Limited makes no warranty of any kind with regard to this information, including,but not limited to, the implied warranties of merchantability and fitness for a particular purpose. nCipherCorporation Limited shall not be liable for errors contained herein or for incidental or consequentialdamages concerned with the furnishing, performance or use of this material.

Commercial Computer Software - proprietary

This computer software and documentation is Commercial Computer Software and Computer SoftwareDocumentation, as defined in sub-paragraphs (a)(1) and (a)(5) of DFAR 252.227-7014, "Rights inNoncommercial Computer Software and Noncommercial Computer Software Documentation". Use,duplication or disclosure by the Government is subject to nCipher's standard US Terms And Conditionsfor the Product.

Patents

UK Patent GB9714757.3. Corresponding patents/applications in USA, Canada, South Africa, Japan andInternational Patent Application PCT/GB98/00142.


Contents

Chapter 1: Introduction 10

General information 10

Audience 11

Contents of this guide 11

Conventions 13

Additional Documentation 16

Further information 16

Chapter 2: nCipher security worlds 18

Security 20

Application independence 24

Platform independence 25

Flexibility 25

Robustness 31

Scalability 34

KeySafe and security worlds 35

Applications and the security world 37

The nCipher PKCS #11 library and security worlds 37

Risks 38

Chapter 3: Getting the module working 39

Determining module requirements 39


Prerequisites to software installation 40

Software installation procedure 43

After software installation 46

Configuring the module 51

Creating and configuring a security world 56

Creating and configuring a payShield installation 64

Creating the Operator Card Set 71

Chapter 4: Changing the module state 76

Entering the pre-maintenance state 76

Entering the pre-initialization state 78

Entering the operational state 79

Chapter 5: Uninstalling 82

Uninstalling the nCipher support software 82

Chapter 6: Configuring the hardserver 83

Remote module connections 83

Hardserver settings 84

Hardserver start-up settings 84

Remote slots 84

SEE machines 85

Hardserver configuration file 85

Payments configuration file 96

Chapter 7: Using multiple modules 98

Identifying modules 98

Multiple modules and Remote Operator 99

Adding a module 100


Module fail over 100

Chapter 8: Feature Enabling nCipher Modules 101

Available Features 101

payShield features 103

Ordering features for your module 104

Enabling features 105

Chapter 9: Using CodeSafe Applications 108

CodeSafe/C applications 108

Chapter 10: Using KeySafe 109

Starting KeySafe 109

The KeySafe window 111

Errors 120

Chapter 11: Managing security worlds 123

Security world files 123

Security world options 125

Creating a security world 129

After you have created a security world 154

Adding or restoring a module to the security world 155

Erasing a module from a security world 162

Deleting the security world 165

Displaying information about your security world 166

Windows Cryptographic Services Provider (CSP) 179

Transferring keys between security worlds 185


Chapter 12: About payShield installations 187

About payShield Card Sets 187

Supported payShield Key Types 190

payShield security world properties 191

Chapter 13: Remote Operator Card Sets 193

About Remote Operator 193

Configuring Remote Operator 194

Chapter 14: Administration tasks with cards and softcards 200

Replacing an Operator Cards pass phrase 200

Replacing Operator Card Sets 202

Changing pass phrases with cardpp 218

Changing pass phrases with ppmk 220

Replacing the Administrator Card Set 221

Chapter 15: nShield Administrator Utilities 226

Help options 226

anonkneti 227

cfg-reread 228

enquiry 229

floodtest 238

hardserver 242

initunit 244

loadkeys 246

key-xfer-im 250

loadrom 253

mk-reprogram 255


ncversions 257

new-world 259

nvram-backup 266

nvram-sw 272

payshield-config 278

payshield-info 280

payshield-install 283

postrocs 286

ppmk 287

preload 290

racs 301

rfs-setup 302

rfs-sync 304

rtc 307

slotinfo 310

sppupgradekeys 312

stattree 314

Appendix A: Upgrading module firmware 323

Version Security Number 323

Firmware on the CD-ROM 324

What must I do? 325

Key data 325

Firmware installation overview 326

PCI modules 327

After firmware installation 329


Appendix B: Components on nCipher CD-ROMs 330

nCipher component bundles 330

nCSS User CD-ROM 335

CipherTools CD-ROM 335

CodeSafe CD-ROM 336

Components Required for Particular Functionality 337

PKCS #11 applications 338

Cryptographic Hardware Interface Library applications 338

nCipherKM JCA/JCE cryptographic service provider 338

nCipher SNMP monitoring agent 339

Appendix C: Environment variables 340

Appendix D: Logging and debugging 343

Environment variables to control logging 343

Logging from the nCipher CSP 348

Logging and debugging information for PKCS #11 349

Hardserver debugging 350

Debugging information for payShield 350

Debugging information for Java 352

Appendix E: Installed Utilities 354

Appendix F: The nCipher SNMP monitoring agent 361

Activating the nCipher SNMP agent 362

Default settings 363

Do you already have an SNMP agent running? 363

Activation of the SNMP agent 363

Further Information 364


Using the nCipher SNMP agent with a manager application 367

Useful nCipher SNMP agent command-line switches 382

Using the SNMP command line tools 385


Chapter 1: Introduction

General information

This guide describes how to use an nShield, payShield or payShield Ultra hardware security module (or HSM) to protect and accelerate the performance of the longterm cryptographic keys that are used by your applications, including payment and related applications on payShield modules.

In this guide, the term nShield refers to any of the nShield, payShield or payShield Ultra modules. Information specific to the payShield and payShield Ultra modules is clearly marked.

nCipher modules use the security world paradigm to provide a secure environment with both application independence and platform independence for all your module and key management operations. Security worlds have the flexibility and scalability to suit your needs, while also providing the robustness that is needed for every day operation as a key component in your IT infrastructure.

Standard nCipher security worlds need to be prepared for use with payShield applications. Although it is possible to convert an existing security world for use with payShield, nCipher recommends that you create a new security world and then follow the instructions in payShield security world properties on page 191. Be sure to create back up copies of any existing data in your kmdata directory before creating a new security world, or attempting to convert an existing security world.

All nCipher modules support standard cryptography frameworks and can be quickly integrated with many standards based products.


1 Introduction Audience

Audience

Read this guide if you need to configure or administer an nShield or payShield module, and you use or require an nCipher security world to protect your keys.

This guide assumes that you are familiar with the basic concepts of cryptography and Public Key Infrastructure (PKI).This guide assumes that you have read the Hardware Installation Guide and that you have installed your nShield or payShield module.

Contents of this guide

Chapter 1: Introduction, this chapter, describes the purpose and intended audience of this guide.

Chapter 2: nCipher security worlds describes the concept of security worlds.

Chapter 3: Getting the module working describes the steps involved in getting the module working.

Chapter 4: Changing the module state describes how to change the state of the module.

Chapter 5: Uninstalling describes how to uninstall nCipher software.

Chapter 6: Configuring the hardserver describes how to configure the hardserver software, which controls communication between applications and nCipher modules.

Chapter 7: Using multiple modules describes how to install additional modules on a system where at least one module and the server software have already been installed.

Chapter 8: Feature Enabling nCipher Modules describes how to order and enable new features purchased from nCipher.


1 Introduction Contents of this guide

Chapter 9: Using CodeSafe Applications describes CodeSafe applications.

Chapter 10: Using KeySafe introduces KeySafe, nCiphers security world management tool.

Chapter 11: Managing security worlds contains detailed information about working with security worlds, including adding a module to an existing security world.

Chapter 12: About payShield installations describes how to configure a payShield installation.

Chapter 13: Remote Operator Card Sets describes the use of Remote Operator card sets.

Chapter 14: Administration tasks with cards and softcards describes how to perform card-management tasks that require an Administrator Card Set.

Chapter 15: nShield Administrator Utilities describes the utilities that are used in this manual.

Appendix B: Components on nCipher CD-ROMs lists the contents of the standard bundles and the additional software supplied on your nCipher CD-ROM.

Appendix A: Upgrading module firmware describes how to upgrade your nCipher module if nCipher has supplied updated firmware.

Appendix E: Installed Utilities lists all the utilities installed with the nCipher software.

Appendix F: The nCipher SNMP monitoring agent describes how to use the supplied Simple Network Management Protocol (SNMP) agent with your nCipher module.


1 Introduction Conventions

Conventions

nCipher modules

The following terms are used to distinguish different module versions:

In this table, n is any integer.

Term Model number Used for

nCipher PCI module nCnnnnP-nnn Any nCipher module with a PCI interface.

nCipher nToken module nC2022p-000 or nC2023p-000

an nCipher nToken module (PCI interface).

nCipher netHSM module nHnnnn Any nCipher netHSM module (netHSM 300/800/1600, payShield net, or payShield Ultra net).

acceleration-only module nC10nnX-nnn Any nCipher module that does not support key management (nFast module).

key-management module nC30nnX-nnn,nC40nnX-nnn, ornHnnnn

Any nCipher module that supports key management (nForce, nShield, payShield, netHSM 300/800/1600, payShield net, or payShield Ultra net).

OEM PCI 1600 key-management module

nC3033P-1600 The OEM PCI 1600 modules are supplied to OEM customers only.



Version numbers

The version number shown on the copyright page and at the bottom of each page in this guide is the version number of this document. Please quote this version number if you contact Support at nCipher with queries about nCipher documentation.

nCipher software

The hardserver software controls communication between applications and nCipher modules, which may be installed locally or remotely. It runs as a service on the host computer.

The nCipher support software is a collection of programs and utilities, including the hardserver, supplied by nCipher to install and maintain your nCipher security system.

Default directory

By default, nCipher software is installed in the /opt/nfast/ (Unix) or C:\nfast (Windows) directory, referred to as the nCipher directory. Instructions in this guide are given on the assumption that nCipher software was installed in this location. If you install the software in another directory, you must set the environment variable NFAST_HOME to point to the directory where the software is installed. You can choose to install nCipher software in another location, in which case you must substitute your location accordingly. An environment variable, NFAST_HOME, is used to specify the default location for nCipher software. For further information on setting environment variables, refer to Setting the environment variables on page 49.



Typographical conventions

Note The word Note in the margin indicates the appearance of important supplemental information.If there is a danger of static damage, this is indicated by the reaching hand symbol in the margin.

If there is a danger of loss or exposure of key material (or any other security risk), this is indicated by a security triangle in the margin.

If there is a danger of damage to the hardware, this is indicated by a caution triangle in the margin. If you see this symbol on the product itself, please refer to the Hardware Installation Guide.If there is a danger of electric shock to the user, this is indicated by a warning triangle in the margin.

Examples of onscreen terminal display, both of data returned and of your input, are represented in a form like this:

install

Keyboard keys that you must type are represented like this: , - .

EnterCtrl C


1 Introduction Additional Documentation

Additional Documentation

This guide forms one part of the information and support provided by nCipher. The following documents are produced to support nCipher products, and the guides for your product can be found in the document directory of the CD-ROM for that product:

Further information

Release notes containing the latest information about the nCipher products are available in the release directory of the CD-ROM.

Guide PDF file

Hardware Installation Guide, for information on hardware installation and troubleshooting; a printed copy is also supplied with nCipher modules (part number N-001027).

Hardware_Installation.pdf

nShield/payShield Operator Guide, for information on managing keys and other tasks with an nShield/payShield module that do not require an Administrator Card.

nShield_Operator.pdf

CodeSafe/C Developers Guide, for reference material about developing in C for the Secure Execution Environment.

CodeSafe_C_Developer.pdf

Integration Guide, for information on developing applications with an nCipher module using industry standard interfaces.

Integration_Guide.pdf

nCore Developers Guide, for information on developing applications with an nCipher module using the nCipher API and NFKM library.

nCore_Developer_Guide.pdf

nCore Developers Reference, for reference material covering nCipher API, C generic stub, and NFKM libraries.

nCore_Developer_Ref.pdf

payShield Developer Reference, for payShield developer reference material

payShield_Developer_Ref.pdf

Key-loading Solution Guide, for information about nCiphers key-loading solution.

Key-loading_Solution.pdf


1 Introduction Further information

The Java Generic Stub classes, nCipher KM JCA/JCE provider classes, and Java Key Management classes are supplied with HTML documentation in standard Javadoc format, which is installed in the appropriate nfast/java directory when you install these classes.nCipher also supplies a performance tool that you can use to test Web server performance both with and without an nCipher module in order to confirm performance. This tool is supplied separately. If you require a copy, contact your nCipher sales representative.

All nCipher product documentation, including a range of guides that describe how to configure popular third-party applications, is available from the nCipher web site: http://active.ncipher.com/documentation/.

If you would like to receive security advisories from nCipher, please subscribe to the low volume nCipher security-announce mailing list. To do this, send a mail with the single word subscribe in the message body to [email protected].

If you cannot find the information you need or you are unable to solve a problem with your nCipher module, contact Support at nCipher by sending E-mail to [email protected].


Chapter 2: nCipher security worlds

Key management is the hardest part of cryptography. Although designing secure cryptographic algorithms and protocols is not easy, there is a large body of academic research upon which to rely. Keeping the keys secret is much harder. nCipher has developed its security world technology to provide an infrastructure for secure life-cycle management of keys.

Key management involves the procedures and protocols, both manual and automated, that are used throughout the entire life cycle of cryptographic keys. These procedures and protocols include the generation, distribution, use, storage, destruction, and optional archiving and disaster recovery of cryptographic keys.

The security world concept and its infrastructure enable nCipher to offer several important features in a simple and intuitive, yet secure, way, where all keys can be made available to all modules in the security world.

These features include: security application independence platform independence flexibility robustness scalability.

The security world infrastructure lets you perform and control all these activities under your chosen security policy.

A security world consists of: one or more nCipher payShield, nForce, nShield, or netHSM

modules


2 nCipher security worlds nCipher security worlds

a set of Administrator smart cards used to control access to security world configuration and recovery operations. (Security worlds compliant with the Federal Information Processing Standards (FIPS) 140-2 at level 3 require the use of smart cards to authorize most operations; see FIPS 140-2 compliance on page 23 for more information about nCipher and FIPS.)

an optional set or sets of Operator smart cards used to control access to application keys. (Security worlds compliant with the Federal Information Processing Standards (FIPS) 140-2 at level 3 require the use of smart cards to authorize most operations; see FIPS 140-2 compliance on page 23 for more information about nCipher and FIPS.)

some cryptographic key and certificate data that is encrypted using the security world key and stored on a host computer or computers.

Figure 1 shows how these components are related to one another. Cards, keys, and even modules can be added or removed at any time. These elements are linked by the security world key, which is unique to each world.

Distributing the keys used for different tasks within the security world over different storage media means that a security world can recover from the loss of any one element. It also increases the difficulties faced by an attacker, who needs to obtain all the elements before gaining any information.


2 nCipher security worlds Security

Figure 1 The security world

Security

Most importantly, a key-management system must store keys securely. Security must be designed into the system from the start; it cannot be added later.

The nCipher security world has been designed to ensure that keys remain secure throughout their life cycle. The security world uses multiple interlocking keys, and because of this, each key is always protected by another key, even during recovery operations.



Because the security world is built around nCipher key-management modules, keys are only ever available in plain text in secure hardware.

The security world uses smart cards for two different purposes: one set of cards forms an Administrator Card Set that is used to

control access to recovery functions one or more sets of cards referred to as Operator Card Sets that

are used to control access to application keys.Note In strict FIPS 140-2 Level 3 security worlds, the Administrator Card

Set or an Operator Card Set is needed to authorize most operations, including the creation of keys and Operator Card Sets.Each card set consists of a number of smart cards, N, of which a smaller number, K, is required to authorize an action. The required number is sometimes referred to as the threshold.

Note The value for K is intended to be less than N. Although it is possible for K to equal N, this is not recommended because an error on one card renders the whole card set unusable. If this happens with your Administrator Card Set, you are forced to replace your security world and generate new keys.

An Administrator Card Set is used to authorize several different actions, and each of these can have a different value for K. All the card sets are distinct; an individual smart card can only belong to the Administrator Card Set or to one Operator Card Set.

Each user can access the keys protected by the security world and the keys protected by their Operator Card Set. They cannot access keys that are protected by other Operator Card Sets.

The smart cards that are used as Operator Cards employ the security world key to perform a challenge-response protocol with the module. This means that Operator Cards can only be used by a module belonging to the same security world that they do.

Note An individual smart card can be used as either a part of the Administrator Card Set or as part of an Operator Card Set, but not as part of both.



Security worlds and Remote Operator

The Remote Operator feature makes it possible for the contents of a smart card inserted into the slot of one module, the attended module, to be securely transmitted and loaded onto another module, the unattended module. Only Operator Cards can be loaded to remote slots in this way. Both the attended module and the unattended module must be in the same security world.

The Remote Operator feature is useful such circumstances as when you need to load a key protected by an Operator Card Set onto a machine to which you do not have physical access (for example, because it is in secure area).Secure communication channels between the attended and unattended modules are achieved using an impath (an abbreviation of intermodule path), which is the secure protocol that nCipher modules use for communication over IP networks. An impath is a cryptographically secure channel between two nCipher nC-series hardware security modules. Data sent through such a channel is secure against both eavesdroppers and active adversaries. The channel can carry arbitrary user data as well as module-protected secrets, such as share data, to be passed directly between modules.

Security worlds shared with netHSM modules

Previously, in order to maintain data consistency in security worlds that included both netHSMs/payShield net modules and other types of nCipher modules, you had to copy files manually between the netHSM remote file systems and non-netHSM client machines. However, the client cooperation mechanism now allows client computers for non-netHSM module types to automatically update the security world and key data stored on the remote file system. See Setting up client cooperation on page 53 for more information.



FIPS 140-2 compliance

All nCipher security worlds are compliant with the Federal Information Processing Standards 140-2. The default setting for nCipher security worlds is FIPS 140-2 at level 2.

A security world that complies with the roles and services section of FIPS 140-2 level 2 does not require any authorization to create an Operator Card Set or an application key. All security worlds rely on the security features of your operating system to control which users can write data to the host.

FIPS 140-2 level 3 compliance

When you create a security world, you can choose whether you want the security world to comply with the roles and services section of FIPS 140-2 at level 2 or level 3. The FIPS 140-2 level 3 option is included for those customers who have a regulatory requirement for compliance with FIPS 140-2 at level 3.

A security world that complies with FIPS 140-2 level 3 requires authorization from any smart card that is part of the security worlds Administrator Card Set, or an Operator Card Set, before you can create or erase an Operator Card Set.

Note A security world only provides a complete level 3 compliant system when used with nShield and payShield modules, which have the additional physical security coating required by the FIPS 140-2 level 3.

If you choose to create a security world that complies with FIPS 140-2 level 3, the module initializes in strict FIPS mode. This option ensures that the module complies with the roles and services, key management, and self-test sections of FIPS 140-2 at level 3, as described in its validation certificate.

For more details of the nShield/Payshield FIPS 140-2 validation see http://csrc.nist.gov/cryptval/140-2.htm


2 nCipher security worlds Application independence

Application independence

A security world can protect keys for any nCipher-aware software. Each key belongs to a specific application and is only ever used by that application. However, within a single security world, every key can belong to a different application. Keys are stored along with any additional data that is required by the application.

You do not need to specify which applications you will use. You can add a key for any supported application at any time.

The security world requires no knowledge of how the key will be used by an application. A security world controls the protection for the key; the application determines how it is used.

Although keys belong to a specific application, Operator Card Sets do not. If a user requires keys for different applications, they can all be protected under the same Operator Card Set.

Figure 2 illustrates this.

Figure 2 Operator Card Sets, keys, and applications


2 nCipher security worlds Platform independence

Card Set 1 protects keys for use with Application 1 and Application 2.

Card Set 2 protects a single key for use with Application 2. Card Set 3 protects keys for use with Application 2 and

Application 3. The security world protects a key for use with Application 3.

Platform independence

A security world is completely platform independent. All key information is stored in nCipher's proprietary format. This format can be read by any computer supported by nCipher, regardless of the native format used by that computer. This means that you can safely move a security world between platforms, even between platforms with differing native formats. For example, you can move a security world between Windows and UNIX platforms. You can also include hosts running different operating systems in the same security world.

Note When copying host data between computers using different Operating Systems or disk formats, use a mechanism that preserves the original data format and line endings (such as .tar file archives).

Flexibility

Within a security world, you can choose the relevant level of protection for each application key that you create.

When you create a security world, a cryptographic key is generated that protects the application keys and Operator Card Sets in the created security world. You can choose to make this security world key can be a Triple DES (Data Encryption Standard) or an AES (Advanced Encryption Standard) key.


2 nCipher security worlds Flexibility

Using the security world key: module-protected keys

If you have an application key that must be available to all your users at all times, it can be protected by the security world key. This is called a module-protected key. Application keys protected by the security world key have no pass phrase. Module-protected keys can be used by any instance of the application for which they were created, provided that it is running on a server fitted with a module belonging to the correct security world.

This level of protection is suitable for high-availability Web servers that you want to recover immediately if the computer resets.

Using Operator Card Sets: card-set protected keys

If you want to restrict key access to a particular user, you can create a set of smart cards known as an Operator Card Set. There is no limit to the number of Operator Card Sets that you can create within a security world.

An Operator Card Set belongs to a specific security world. It cannot be read, erased, or even formatted except in a module from its security world.

An Operator Card Set stores a number of symmetric keys that are used to protect the working keys. These keys are Triple DES keys.

Each card in an Operator Card Set stores only a fragment of the Operator Card Set keys. These keys can only be re-created if you have access to enough of their fragments. Because cards sometimes fail or are lost, the number of fragments required to re-create the key (K) should usually be less than the total number of fragments (N).



Using card sets for extra security

If you want to create a card set for extra security, you need to make K large and N less than twice K (for example 3 of 5, or 5 of 9). This practice ensures that if you have a set of K cards that can be used to recreate the key, you can be certain that there is no other such set in existence.

Note Some applications restrict K to 1.

Using card sets to share keys

You can use card sets that enable the same keys to be used in a number of different modules at any one time, but you must leave one of the cards in each module.

If you want to use keys protected by the card set across multiple modules, you may want to make K equal to 1 and N equal to the number of modules. You can then insert a card into each module.

If you want to issue the same key to a set of users, again you would want to make K equal to 1 and N equal to the number of users, giving one card to each user.

If a card becomes damaged, the cardset can be recovered using the Administrator Card Set.

Note You can only recover card sets that were created with the recovery option explicitly set.

Using card sets for high availability

You may have some keys to which you must have access at all times and with which you cannot afford to risk the failure of a smart card. In such a case, you can create a 1-of-2 card set. Use the first card as the working card and store the spare second card in a safe. If the



working card fails, retrieve the spare card from the safe and use it until you re-create a new set of two cards, as described in Replacing an Operator Card Set or recovering keys to softcards on page 32.

Note You can only recover card sets that were created with the recovery option explicitly set.

Using pass phrases

Each Operator Card can be given a pass phrase. The pass phrases are independent. You can choose to give only some cards in a card set pass phrases.

You can change the pass phrase on a card at any time. For information on changing pass phrases, see Changing pass phrases with cardpp on page 218 or the appropriate Operator Guide for your module. This requires the card, the existing pass phrase, and a module that belongs to the security world.

Note Some applications do not support the use of pass phrases.There is no absolute limit on the length of pass phrases. However, some applications may not accept pass phrases longer than 255 characters. Likewise, the security world does not impose restrictions on which characters you can use, although some applications may not accept certain characters.

Using persistent Operator Card Sets

If you create a standard Operator Card Set, the keys protected by a card can only be used while that card, or the last card loaded in the case of card sets, is in the nCipher modules smart card reader. The keys protected by this card are removed from the memory of the module as soon as the card is removed from the smart card reader.

Although this feature provides added security, it means that only one user can load keys at any time because there is only one smart card reader on the module.



Keys that are protected by a given Operator Card Set cannot be shared simultaneously between a large pool of modules.

Therefore, the security world architecture gives you the option of making an Operator Card Set persistent. This means that the keys protected by a card persist after the card has been removed. This enables you to use the same smart card in several modules simultaneously. It also means that several users can load keys onto the same module at the same time. The nCipher support software maintains strict separation between the keys loaded by each user, and each user only has access to the keys protected by their Operator Card Set.

Keys protected by a persistent card are automatically removed from the module: when the application that loaded the Operator Card Set closes the

connection to the module. after a time limit that may be specified when the card set is

created. when an application chooses to remove a key.

Note Some applications automatically remove a key after each use, reloading it only when required. Such applications do not benefit from persistent Operator Cards. The only way of sharing keys between modules for these applications is by having multiple smart cards in an Operator Card Set.

Although the module stores the key, the key is only available to the application that loaded it. If you want to use keys protected by this card in another application, you must re-insert the card, and enter its pass phrase if it has one. Certain applications are designed to allow only one user to be logged in at a time, in which case they remove any previously loaded persistent Operator Card Set used in that application before allowing the user to log into with a new Operator Card Set.



You can manually remove all keys protected by persistent cards by pressing the modules Clear button or by turning off power to the module. Either process removes all keys protected by Operator Card Sets from the module, including the card in the reader. In such cases, all users of any applications using the module must log in again.

You are offered a choice as to whether or not to make an Operator Card Set persistent when you create the card set. Once you have made the decision, you cannot change it. Persistence is a property of the card set.

A security world can contain a mix of persistent and non-persistent card sets.

Using softcard-protected keys

If you want to use pass phrases to restrict key access but avoid using physical tokens (as required by smart-card protection), you can create a softcard-protected key. A softcard is a file containing a logical token that cannot be loaded without a pass phrase; its logical token must be loaded in order to authorize the loading of any key that is protected by the softcard. Softcard files are stored in the kmdata directory and have names of the form softcard_hash (where hash is the hash of the logical token share).Softcard-protected keys offer greater security than module-protected keys and also have greater availability than keys protected by operator card sets (albeit without the greater security obtained through the requirement of physical tokens to authorize key-loading).

A softcard's pass phrase is set when you generate it, and you can use a single softcard to protect multiple keys. Softcards function as persistent 1-of-1 logical tokens, and after a softcard is loaded, it remains valid for loading its keys until its KeyID is destroyed.


2 nCipher security worlds Robustness

Robustness

If you are using cryptography in a production environment, you need to know that it will work 24 hours a day, 7 days a week. If something goes wrong, you must be able to recover without compromising your security. An nCipher security world offers all of these features.

Backup and recovery

The nCipher security world data stored on the host is encrypted using your choice of either Triple DES or AES encryption.

You should regularly back up the data stored in the kmdata directory safely with your normal backup procedures.

It would not matter if an attacker were to obtain this data because it is worthless without the encryption keys, stored in your module, and the Administrator cards for that security world.

When you create a security world, it automatically creates recovery data for the security world key. As with all host data, this is encrypted with Triple DES. The cryptographic keys that protect this data are stored on a set of smart cards called the Administrator Card Set. The keys are split among the cards in the Administrator Card Set using the same K-of-N mechanism as for an Operator Card Set. The Administrator Card Set protects several keys that are used for different operations.

The cards in the Administrator Card Set are only used for recovery operations and adding extra modules to a security world. At all other times, these cards should be stored in a safe.

Note In strict FIPS 140-2 Level 3 security worlds, the Administrator Card Set or an Operator Card Set is needed to control many operations, including the creation of keys and Operator Card Sets.



Replacing a module

If you have a problem with a module, you can replace it with a new module by using the Administrator Card Set and the recovery data to load the security world key securely. Use the same mechanism to reload the security world key if you need to upgrade the firmware in the module or if you need to add extra modules to the security world.

Replacing the Administrator Card Set

If you lose one of the smart cards from the Administrator Card Set, or if the card fails, you must immediately create a replacement set using the KeySafe Replace Administrator Card Set option or the racs utility. The module does not store recovery data for the Administrator Card Set. It relies on the fact that K is less than N; therefore, it can re-create all the keys on the module even if the information from one of the cards is missing.

You cannot replace the Administrator Card Set unless you have the required number of current cards and access to their pass phrases. Therefore, as soon as you lose one card, or as soon as one card fails, you should replace the set.Although replacing the Administrator Card Set deletes the copy of the recovery data on your host, the old Administrator Card Set can still be used with the old host data, which may be on backup tapes and other hosts. To protect against this risk, you must immediately erase the old Administrator Cards after you create a new Administrator Card Set.

Replacing an Operator Card Set or recovering keys to softcards

If you lose an Operator Card, you lose all the keys that are protected by that card. In order to prevent this, a security world can optionally store a second copy of the working key that is protected by a recovery key.



Similarly, you can recover keys protected by one softcard to another softcard.

Note The ability to recover an Operator Card Set is an option that is enabled by default during security world creation. To disable recoverability, you must explicitly choose to do so during the security world creation process. Once set during security world creation, the ability (or inability) to recover an Operator Card Set can never be altered.

Note Keys protected by an Operator Card Set can only be recovered to another Operator Card Set, and not to a softcard. Likewise, softcard-protected keys can only be recovered to another softcard, and not to an Operator Card Set.

You can use the rocs command-line utility or KeySafe to create new working copies of your keys protected by the key on a given card set. To recover keys protected by one softcard to another softcard, you must use the rocs command-line utility.

Replacing Operator Card Sets and softcards requires authorization. Otherwise, an attacker could simply duplicate a set or softcard without your knowledge. Therefore, the recovery keys are protected by the Administrator Card Set.

Storing any key recovery data introduces some extra risk, because an attacker with the Administrator Card Set and a copy of the recovery data could re-create your security world. You may have some keys that you consider to be especially sensitive. In this case, if you lose the Operator Card Set that protects the key, you may choose to issue a new key. Therefore, you can turn off the key recovery feature for the security world or for a specific key.

Recovery data can only be generated when you create the security world or key. If you choose not to create recovery data when you generate the security world or key, it cannot be added later. If you have not selected the recovery feature for the security world, it cannot be enabled for any key in the security world.


2 nCipher security worlds Scalability

Similarly, if you choose to create recovery data when you generate the security world or key, it cannot be removed later in a secure manner.

The recovery data for application keys is kept separate from the recovery data for the security world key. The security world always creates recovery data for the security world key. It is only the recovery of application keys that is optional.

Scalability

A security world is scalable. You can add multiple modules to a server and share a security world across multiple servers. You can also add Operator Card Sets and application keys at any time. You do not need to make any decisions about the size of the security world when you create it.

To share a security world across multiple servers: ensure each server has at least one module fitted copy the host data to each server or make it available on a shared

disk use the recovery data and the Administrator Card Set to load the

required cryptographic keys securely onto every module.

If you want to have access to the same keys on every server, you must ensure that all changes to the data are propagated to the remaining servers. If your are part of a cluster, then the tools provided by the cluster should synchronize the data. If the servers are connected by a network, then they could all access the same copy of the data. There is no risk of an attacker obtaining information by snooping on the network, as the data is only ever decrypted inside a module. Alternatively, you can maintain copies of the data on different servers.

It is now possible to allow non-netHSM modules to automatically access the remote file system (RFS) used by netHSM and payShield NET modules and to share security world and key data stored in the


2 nCipher security worlds KeySafe and security worlds

kmdata directory. Client modules that access data in this way are described as cooperating clients. See Setting up client cooperation on page 53 for more information.

Load sharing

If you have more than one module on your system and you load the same key onto each module, your nCipher-aware applications can make use of the load sharing features in the nCipher server to share the cryptography between them.

Note It is up to the application to implement load sharing. Some applications may not be able to make use of this feature.

KeySafe and security worlds

KeySafe provides an intuitive and easy-to-use graphical interface for managing security worlds. KeySafe manages the security world and the keys protected by it. See the Operator Guide for full information about KeySafe.

Note Most applications store only their long-term keys in the security world. Session keys are short term keys generated by the application which are not normally loaded into the security world.

Although you use KeySafe to generate keys, it is your chosen application that actually uses them. You do not need KeySafe to make use of the keys that are protected by the security world. For example, if you share a security world across several host computers, you do not need to install KeySafe on every computer. If you want to manage the security world from a single computer, you can install KeySafe on just that one computer even though you are using the security world data on other machines.

KeySafe enables you to:


2 nCipher security worlds KeySafe and security worlds

create a security world and its Administrator Card Set, either FIPS 140-2 level 2 or level 3

Note This option provides compliance with the roles and services of the FIPS 140- 2 level 3 standard. It is included for those customers who have a regulatory requirement for compliance. add a module to a security world remove a module from a security world replace an Administrator Card Set create Operator Card Sets list the Operator Card Sets in the current security world change the pass phrase on an Operator Card remove a lost Operator Card Set from a security world replace Operator Card Sets erase an Operator Card add a new key to a security world import a key into a security world list the keys in the current security world delete a key from a security world.

KeySafe does not provide tools to back up and restore the host data or update module firmware, nor does KeySafe provide tools to synchronize host data between servers. These functions can be performed with your standard system utilities.

In addition to KeySafe, nCipher also supplies command-line utilities to manage the security world. Current versions of these tools can be used interchangeably with the current version of KeySafe.


2 nCipher security worlds Applications and the security world

Applications and the security world

The security world can protect keys for a range of industry standard applications. See the nCipher web site (http://www.ncipher.com) for details of applications that are currently supported.

nCipher has produced Application Guides for many supported applications. These Application Guides contain information about installing and configuring the application to work with nCipher modules and security worlds.

For information on the range of Application Guides available, either visit the nCipher web site (http://www.ncipher.com) or contact Support at nCipher ([email protected]).

The nCipher PKCS #11 library and security worlds

Many applications use a PKCS (Public Key Cryptography Standard) #11 library to generate and manage cryptographic keys. nCipher has produced a version of the PKCS #11 library that uses the security world to protect keys.

Enabling a PKCS #11 based application to use nCipher hardware key protection involves configuring the application to use the nCipher PKCS #11 library.

A PKCS #11 token created by the nCipher PKCS #11 library is a security world Operator Card Set.

The current PKCS #11 standard only supports tokens that are part of a 1-of-N card set.

A security world does not make any distinction between different applications that use the nCipher PKCS #11 library. Therefore, you can create a key in one PKCS #11 compliant application and make use of it in a different PKCS #11 compliant application.


2 nCipher security worlds Risks

Risks

Even the best-designed tools cannot offer security against every risk. Although a security world can control which user has access to which keys, it cannot prevent a user from using a key fraudulently. For example, a security world can only determine whether a user is authorized to use a particular key; it cannot determine whether the message being sent with that key is accurate.

A security world can only manage keys that were created inside the security world; keys created outside a security world, even if imported into the security world, may remain exposed to a security risk.

Most failures of security systems are not the result of inherent flaws in the system, but result from carelessness on the part of the users. The following basic rules apply to any security system: Keep your smart cards safe. Always obtain smart cards from a trusted source: from nCipher

or directly from Gemplus. Never insert a smart card used with nCipher key management

into an untrusted smart card reader. Never insert any untrusted smart card into your module. Never tell anyone your pass phrase.

Never write down your pass phrase. Never use a pass phrase that is easy to guess. Only use the Administrator Card Set in modules connected to

trusted hosts.Note If you have any doubts about the security of a key and/or security

world, you should replace that key and/or security world with a newly generated one.


Chapter 3: Getting the module working

This chapter describes the steps involved in setting up the nCipher software to work with the module for the first time. These steps must be performed in the following order:1. Determine the requirements for the module, as described in

Determining module requirements on page 39.2. Complete any prerequisites to installing nCipher support

software, as described in Prerequisites to software installation on page 40.

3. Install the software, as described in Software installation procedure on page 43.

4. Perform post-installation tests and software environment configurations, as described in After software installation on page 46.

5. Configure the hardserver, as described in Configuring the hardserver on page 51. Also, if necessary, set up client configuration, as described in Setting up client cooperation on page 53

6. Create and configure the security world, as described in Creating and configuring a security world on page 56.

7. Configure the payShield installation, as described in Creating and configuring a payShield installation on page 64.

8. Create the Operator Card Set, as described in Creating the Operator Card Set on page 71.

Determining module requirements

Before you start to set up the module, you must identify the specific requirements of your installation. You (or your security policy officer) should have determined the following:


3 Getting the module working Prerequisites to software installation

which optional components of the nCipher software you need to install. To do this you need to know:- the applications that are to use the module.- any constraints on installing software on your computer.

the security requirements for the security world (see Determining module requirements on page 39 for details of these options).

if you want to use payShield, the requirements for the payShield installation, including the functions to be enabled (see About payShield Card Sets on page 187 for details of these options).

Do not start the installation procedure until you have this information.

Prerequisites to software installation

This section describes various steps you may need to take before installing the nCipher support software. These are: Installing and connecting the module on page 40 Removing existing installations on page 41 Installing Java patches on page 41 Identifying which components to install on page 42.

Installing and connecting the module

Before you install the nCipher support software on the host, the module must be connected as described in the Hardware Installation Guide.



Removing existing installations

nCipher recommends that you uninstall older versions of support software before you install new support software. If the installer detects an existing nCipher installation, it asks you if you want to install the new components. These components replace your existing installation.

Instructions for uninstalling nCipher support software are provided in Chapter 5: Uninstalling.

The automated nCipher installers do not delete other components or any key data and security world data that you have created.

Note Because the nCipher server is installed as a service, it is only possible to have one nCipher installation on any given computer.

Installing Java patches

nCipher currently supports JRE/JDK version 1.4.x.

If you intend to use KeySafe, Suns Java run-time environment version 1.4.x or the equivalent developer kit must be installed. It is recommended that you install Java before you install the nCipher components. The Java executable must be on your path.

The DSE200s Web-based interface requires JRE/JDK version 1.3.x, which is installed with the DSE200 support software.

Java software is available from http://java.sun.com/products/. If your security policy does not allow the use of downloaded software, these components can be obtained on CD-ROM from Sun or your operating system vendor.

In order to use nCipher Java components, you may need to install patches supplied by your operating system manufacturer. Refer to the Sun documentation supplied with your Java installation.



The nCipher Windows install wizard determines whether you have a Java Runtime Environment (JRE) installed by examining the registry. Any warnings displayed by the installer apply to this JRE. If you intend to use a JRE not defined in the registry (for example, if you have multiple JREs installed), check that this JRE version is compatible with nCipher support software.

Identifying which components to install

nCipher supplies standard component bundles that contain many of the necessary components for your installation and, in addition, individual components for use with supported applications. To be sure that all component dependencies are satisfied, you can install all the software components supplied, or you can choose to install only those you need.

During the installation process, you are asked to choose which bundles and components to install. Your choice depends on a number of considerations, among them the following: the types of application that will be using the module the amount of disk space available for the installation your companys policy on installing software. For example,

although it may be simpler to choose all software components, your company might have a policy of not installing any software that is not required.

You must install the hwsp Hardware Support bundle. If the hwsp Hardware Support bundle is not installed, your module cannot function.

Note The nfdrv Windows device drivers component, required if you are using an nCipher PCI card, is installed as part of the hwsp Hardware Support bundle.


3 Getting the module working Software installation procedure

Additionally, nCipher recommends that you always install the ctls Core Tools bundle, which contains all the nCipher command-line utilities, including generatekey, low level utilities, and test programs.

Note The Core Tools bundle includes the tclsrc Tcl run time component that installs a run-time Tcl installation within the nCipher directories. This is used by nCiphers tools for creating the security world, by KeySafe, and by the new-world utility. This does not affect any other installation of Tcl on your computer.See Appendix B: Components on nCipher CD-ROMs for details of the optional components. Ensure that you have identified those that you require before you start the installation.

Software installation procedure

You should have removed any nCipher installation on the computer before starting this installation. See Chapter 5: Uninstalling for more information on uninstalling your software. If the installer detects an existing nCipher installation, it asks you if you want to install the new components. These components replace your existing installation, but the installer does not delete other components that you have created.

Note Because the nCipher server is installed as a service, it is only possible to have one nCipher installation on any given computer.

nCipher supplies the nCipher client software as bundles of standard packages that provide much of the required software for your installation. In addition to the standard bundles, nCipher provides individual packages for use with specific applications and features supported by the module. Ensure you have determined which bundles or packages you require before beginning the installation. (See Identifying which components to install on page 42; further details about the contents of bundles and packages are provided in Appendix B: Components on nCipher CD-ROMs.)

Note Visit the nCipher Web site support section to download Application Guides that give advice on installing nCipher modules with a range of third party applications.



nCipher supplies Windows 2000 Plug and Play drivers for the nCipher module. These drivers have also been tested with Windows 2003 Server.

Take the following steps to install the nCipher server and associated software:

1. Log in as Administrator or as a user with local administrator rights.

2. Place the CD-ROM in the CD-ROM drive. If Autorun is enabled, the installer runs automatically, detecting the version of Windows and launching the appropriate installation program. You can launch the installer (setup.exe, on the top level of the CD-ROM) manually if Autorun is not enabled.The installer displays the version number of the nCipher support software that is to be installed.

Note If you have an earlier installation of nCipher support software, the installer detects this and gives you the option to uninstall the earlier installation or quit the installer. The installer cannot install the current release of nCipher support software unless any earlier installation has been uninstalled. Uninstalling requires a reboot before a new installation of the current software can commence.

Follow the onscreen instructions.

3. The installer displays the nCipher license agreement. Accept the license terms by clicking the Yes button for the installation to continue.

4. The installer displays a list of installable components. You must install the hwsp Hardware Support bundle, and nCipher strongly recommends installing the ctls Core Tools bundle. Otherwise, choose to install all components, or select the components that



you require. See Appendix B: Components on nCipher CD-ROMs for more information about choosing which components to install.By default, the installer places files in the C:\nfast directory, but you are given the option of selecting a different directory. If the installer detects an existing installation in a different directory, it offers this other directory as the default.

5. Click the Next button, and the installer installs and performs basic configuration of the selected components.

Note If the installer detects an existing installation of the current release of support software, it advises you of this. Click the Yes button to continue.

6. The installer advises you that it will create an icon on your desktop for the nCipher CSP installation wizard.

Note Do not run the nCipher CSP installation wizard before you have successfully installed the module.

When run, this wizard:

a. installs the correct nCipher CSPb. makes the nCipher CSP the default SChannel provider, if

requested.After you have completed the rest of the module installation process, double click the nCipher CSP installation wizard icon to install the nCipher CSP.

Note You must install this version of the nCipher CSP to work with this version of the nCipher software, even if you have a previous version of the nCipher CSP installed.

For more information on using the nCipher CSP with IIS (Internet Information Service) and Microsoft Certificate Server, see the appropriate Operator Guide for your module and the relevant application guide.Click the Next button to continue the installation.


3 Getting the module working After software installation

7. If you chose to install the nCipher SNMP agent, the installer advises you that it does not run by default. Click the Next button to continue.

8. If you chose to install the nCipher PKCS #11 library and have an existing PKCS #11 installation, the installer advises you of this. The installer asks whether you want to configure the PKCS #11 library for use with Check Point VPN-1/Firewall-1. You can choose to do one of the following:a. Select Yes, and then follow the steps in the Check Point

configuration dialog. See Check Points product documentation for further information.

b. Select No to continue the installation process without configuring Check Point VPN-1/Firewall-1. You can configure the PKCS #11 library for use with Check Point VPN 1/Firewall 1 later by running the ConfigPKCS11onCP.exe utility in the C:\nfast\toolkits\\pkcs11 directory.

Note If you choose to configure the PKCS #11 library for use with Check Point VPN-1/Firewall-1, install the PKCS #11 module only after Check Point VPN-1/Firewall-1 is installed.9. When the installation is complete, click the Finish button.

After you have installed the software, perform post-installation tests and software environment configurations as described in After software installation on page 46.

After software installation

Testing the installation

To check that the software has been installed correctly:1. Log in as a normal user.2. Open a command window.



3. Verify that the server is running by using the following test command (assuming that you installed the nCipher server in the default directory):

C:\nfast\bin\enquiry

A successfully completed enquiry command returns output of a form similar to the following:

server:

enquiry reply flags noneenquiry reply level Fourserial number ####-####-####mode operationalversion #.#.#speed index ###rec. queue ##..##...

module #1:...

mode operationalversion #.#.#...

connection status OK

The enquiry utility returns information on the nCipher server and on each module.

- The serial number returned is the electronic serial number. This number is unique to each module. Keep a record of the electronic serial number: you must quote it if you ever need to contact Support at nCipher.

- The version number for the server is the nCipher internal release number of the server software.

- The version number for the module is the nCipher internal release number of the firmware.

If the enquiry utility returns an error message, refer to the troubleshooting chapter in the Hardware Installation Guide.



Testing the smart card reader

On external smart card readers fitted to an nCipher PCI module, the LED lights up red when the computer is switched on. If the LED does not light up, check the connection. The LED changes color to green whenever a card is inserted. If it does not change, check that you have fully inserted the card.

Note The LED is triggered by a mechanical switch that indicates only that the card is inserted. It does not indicate that the card is a valid smart card or that it is the correct way up.

The LED flashes briefly when you reset the module and when the module changes state.

Note Always insert the smart card with the contacts facing up.You can check that the card reader of any module is working correctly by inserting an nCipher smart card and using the following test command (assuming that you installed the server in the default directory):

C:\nfast\bin slotinfo -m MODULE [-s SLOT]

In this command, MODULE is the number of the module and SLOT is the number of the slot. If you have only one module, MODULE is 1, and if you do not specify a slot number, slotinfo returns information about all slots.

This command should return either:

Module n slot 0: Token not formatted



or

Module n slot 0: Authentication key: 00000000-00000000-00000000-00000000-00000000 No data on token 3698 bytes free

Note The authentication key and data size may vary.

Monitoring the module using Performance Monitor

You can monitor the performance of the nCipher modules that are connected to a Windows host by using Microsofts Performance Monitor.

When you install the nCipher server software it adds three new objects to the Performance Monitor:

nCipher Connections

This provides statistics for each connection to the server with an instance for each connection.

nCipher PerModule

This provides statistics for each nCipher module with an instance for each module, identified by ModuleID.

nCipher ServerGlobals

This provides statistics for the nCipher server.Note To preserve security, connection instances are identified by a number.

This number is a simple counter and is not related to the ClientID .

Setting the environment variables

You can set nCipher specific environment variables as follows: 1. Open the System dialog box by clicking the System icon in the

Control Panel.



2. Select the Advanced tab and click the Environment Variables button.

3. To add a variable, click New. Alternatively, to edit an existing variable select an entry in the System Variables list and click Edit.

4. In the Variable Name text box, type or edit the name of the environment variable (for example, NFAST_HOME).

5. In the Variable Value text box, type or edit the value to use.6. Click the OK button to set the value, and then click the OK button

to close the dialog box.7. Restart the nFast Server service.

See Appendix C: Environment variables for detailed information on the environment variables used by nCipher software.

Note You must ensure that KeySafe and the hardserver are communicating on the same sockets. If you have set the environment variables NFAST_SERVER_PORT or NFAST_SERVER_PRIVPORT in the server environment, they must also be set to the same value in the KeySafe environment. The port on which the hardserver listens for local privileged TCP connections (priv_port) must be set to 9001 and the port on which the hardserver listens for local nonprivileged TCP connections (nonpriv_port) must be set to 9000.

Logging and debugging

Note The current release of nCipher support software uses controls for logging and log files, as well as debugging, that differ from those used in previous releases. However, settings you made in previous releases to control logging, log files, and debugging are still generally supported in the current release, although in some situations the output is now formatted differently.The nCipher Support Software generates logging information that is configured through a set of four environment variables: NFLOG_FILE


3 Getting the module working Configuring the module

NFLOG_SEVERITY

NFLOG_DETAIL

NFLOG_CATEGORIES

Note If none of these logging environment variables are set, the default behaviour is to log nothing, unless this is overridden by any individual library. If any of the four logging variables are set, all unset variables are given default values.Some components of the nCipher Support Software generate separate debugging information which you can manage differently. If you are setting up the module in order to develop software that uses it, you should configure debugging at this point. Otherwise, you should proceed to Creating and configuring a security world on page 56.

Detailed information about controlling logging information by means of these environment variables is supplied in Appendix D: Logging and debugging.

Configuring Java support for KeySafe

In order to use KeySafe, you must add the nfjava, kmjava, and keysafe classes to your Java class path after nCipher support software installation is complete. See the Operator Guide for more information about KeySafe.

Configuring the module

Configuring the hardserver

The hardserver handles secure transactions between the modules connected to the host computer and applications that run on the host computer. In addition, the hardserver controls any remote slots that the module uses and loads any SEE (Secure Execution Engine) machines that are to run on the module.



The hardserver can handle transactions for multiple modules. This does not require configuration of the hardserver; see Chapter 7: Using multiple modules for information.

The hardserver must be configured to control: the way the hardserver communicates with remote modules the way the hardserver communicates with local modules the import and export of remote slots the loading of SEE machines on to the module when the

hardserver starts up.

The hardserver configuration file defines the configuration of the hardserver. It is stored in the directory %NFAST_HOME%\kmdata\config, which by default is C:\nfast\kmdata\config. A default version of this file is created when the nCipher support software is installed. See Chapter 6: Configuring the hardserver for full information about the hardserver configuration file.

Note In some previous releases of nCipher support software, hardserver configuration was controlled by environment variables. The use of these variables has been deprecated. If any of these environment variables are still set, they override the settings in the configuration file.You must load the configuration file for the changes to the configuration to take effect.

To configure the hardserver, follow these steps:1. Save a copy of the configuration file

C:\nfast\kmdata\config\config so that the configuration can be restored if necessary.

2. Edit the configuration file C:\nfast\kmdata\config\config to contain the required configuration. (See Hardserver configuration file on page 85 for descriptions of the options in the configuration file.)



3. Run the cfg-reread command-line utility to load the new configuration. See cfg-reread on page 228 for details.

4. Test that the hardserver is configured correctly by running the enquiry command-line utility. (See enquiry on page 229 for full details of the enquiry command-line utility and its output.)Check that a module with the correct characteristics appears in the output.

5. Test that the client has access to the security world data. To do this, run the nfkminfo command-line utility.Check that a module with the correct ESN appears in the output and has the state 0x2 Usable.

Setting up client cooperation

It is now possible to allow non-netHSM modules to automatically access the remote file system (RFS) used by netHSM and payShield NET modules and to share security world and key data stored in the kmdata directory. Client modules that access data in this way are described as cooperating clients.

To configure client cooperation for modules that are not netHSM or payShield modules, complete the following steps:1. Configure the remote file system used by your netHSM module

to accept access by cooperating clients. For information about how to do this see the netHSM Administrator Guide.

2. On each client that is to be a cooperating client (that is, that is to access the remote file system in order to share key data), you must run the rfs-sync command with appropriate options:



- For clients that use a local KNETI (the nCipher integrity key, which is installed when the module is shipped) for authorization and which are to be given write access to the remote file system, run the command:

rfs-sync --setup rfs.rfs.rfs.rfs

- For clients that do not have a local KNETI and require write access, run the command:

rfs-sync --setup --no-authenticate rfs.rfs.rfs.rfs

In these commands, rfs.rfs.rfs.rfs is the IP address of the machine where the remote file system is located.

Note The rfs-sync utility uses lock files to ensure that updates are made in a consistent fashion. If a rfs-sync --commit operation (the operation that writes data to the remote file system) fails due to a crash or other problem, it is possible for a lock file to be left behind. This would cause all subsequent operations to fail with a lock timeout error.rfs-sync has options for querying the current state of the lock file, and for deleting the lock file; however, these should only be used if necessary to resolve this problem. Clients without write access cannot delete the lock file. To remove a cooperating client so the remote file system no longer recognizes it, you must: know the IP address of cooperating client you want to remove



manually update the remote_file_system section of the hardserver configuration file by removing the following entries for that particular client:

remote_ip=ccc.ccc.ccc.cccremote_esn=keyhash=0000000000000000000000000000000000000000native_path=c:\nfast\kmdata\localvolume=kmdata-localallow_read=yesallow_write=yesallow_list=yesis_directory=yesis_text=no

and

remote_ip=ccc.ccc.ccc.cccremote_esn=keyhash=0000000000000000000000000000000000000000native_path=c:\nfast\kmdata\localsync-storevolume=kmdata-backupallow_read=yesallow_write=yesallow_list=yesis_directory=yesis_text=no

In these commands, ccc.ccc.ccc.ccc is the IP address of the client.

Useful utilities

To find out the ESN and the hash of the KNETI key for a given IP address, use the anonkneti command-line utility. A manual double-check is recommended for security.

A client can use rfs-sync --show to display the current configuration, or rfs-sync --remove to revert to a stand-alone configuration. Reverting to a stand-alone configuration leaves the current contents of the kmdata directory in place. See rfs-sync on page 304 for more information.


3 Getting the module working Creating and configuring a security world

Creating and configuring a security world

Before you can use the module to manage keys, you must create a security world. A security world can only be created with a single module. If you have more than one module, you must choose one with which to create the new security world. You can add additional modules to an existing security world later (as described in Adding or restoring a module to the security world on page 155).Before you start to create a security world: The modules that you wish to add to the security world must be

in pre-initialization state, as described in Entering the pre-initialization state on page 78.

You must be logged in to the host computer as a user who is permitted to create privileged connections. See hardserver on page 242.You must have set the NFAST_HOME environment variable.

You should know what the security policy for the module is, and in particular the number and quorum of administrator and operator cards to be used.

You must have enough smart cards to form the security worlds card sets.

On some internal modules, you must access the initialization link or switch on the module. With such modules, always shut down your computer and turn off the power before opening the case. Replace the case before reconnecting the power.You normally create a security world when you first install the module. If you wish use the module to protect a different set of keys, you can replace the security world with another one.

The process of creating a security world: erases the module creates a new module key for this security world creates a new Administrator Card Set to protect this module key



stores the security world information on the computers hard disk, or in the case of netHSM, the operating systems filesystem and the remote filesystem. The information is encrypted using the secrets stored on the Administrator Card Set.

Any Operator Cards created in a previous security world cannot be used in the new security world. If you are replacing a security world, you must erase all the Operator Cards created in the previous security world before you create the new world.You can create a security world from the command line with the new-world utility, as described here. Alternatively, you can use KeySafe (as described in Creating a security world with KeySafe on page 131), or the nCipher CSP wizard, as described in Creating the security world using the CSP wizard on page 139.

Creating a security world by using new-world

Follow the directions in this section to create a security world from the command line with the new-world utility.

Running the new-world command-line utility

Open a command window and type the command:

new-world [-i|--initialize] [-S|--no-remoteshare-cert] [-o|--overwrite] [-F|--strict-fips-140-2-level-3] [-R|--no-recovery] [-tTIMEOUT|--nso-timeout=TIMEOUT] [-m|--module=MODULE] [-Q|--acs-quorum=K/N] [FEATURES]

In this command:



-i, --initialize

These options tell new-world to initialize a new security world, replacing any existing kmdata directory.

Note Replacing an existing security world in this way does not delete the security worlds host and recovery data, but renames the existing kmdata directory in which these reside as kmdata_nn (where nn is an integer, 0 or greater, depending on how many security worlds have been previously saved during overwrites).-S, --no-remoteshare-cert

These options tell new-world to not to make the module a target for remote shares.

-o, --overwrite

These options tell new-world to overwrite smart cards without prompting. Any existing data will be erased. If a value for this flag is not specified, new-world will prompt you if a card contains data. This option does not enable you to reuse Operator Cards from other security worlds.

-F, --strict-fips-140-2-level-3

These options tell new-world to create a security world that conforms to the FIPS 140-2 requirements for roles and services at level 3. If you do not specify this flag, new-world creates a security world that complies with FIPS 140-2 requirements for level 2.

Note This option provides compliance with the roles and services of the FIPS 140-2 level 3 standard. It is included for those customers who have a regulatory requirement for compliance.-R, --no-recovery

These options tell new-world to disable Operator Card Set recovery. The effect of setting this flag is the same as for specifying the feature !r.



By default, new-world creates key-recovery material that is protected by the cryptographic keys on the Administrator Card Set. This option does not give nCipher or any other third party access to your keys. Keys can only be recovered by using the Administrator Cards. nCipher recommends that you leave Operator Card Set recovery enabled.

If you set the --no-recovery option, you will not be able to replace lost or damaged Operator Card Sets and therefore will not be able to access the keys that are protected by such cards. Key recovery cannot be enabled later without reinitializing your security world and discarding all your existing keys.

Note All keys are recoverable unless otherwise specified at key generation, even PKCS #11 keys that have the sensitive flag set to TRUE or extractable flag set to FALSE.-tTIMEOUT, --nso-timeout=TIMEOUT

These options allows you to specify the time-out (TIMEOUT) for new security worlds. By default, an integer given for TIMEOUT is interpreted in seconds, but you can supply values for TIMEOUT in the form Ns, Nh, or Nd where N is an integer and s specifies second, h specifies hours, and d specifies days.

-m, --module=MODULE

These options specify the ModuleID to use. new-world initializes only one module at a time. If you have multiple modules, you must run new-world with --initialize for the first module, and then run new-world with --program for the other modules; see new-world on page 259.

-Q, --acs-quorum=K/N

In these options, K specifies the minimum number of smart cards needed from the Administrator Card Set in order to authorize a feature. You can specify lower K values for a particular feature. All the K values must be less than or equal



to the total number of cards in the set. If a value for K is not specified, new-world creates an Administrator Card Set that requires a single card for authorization.

Note Some applications do not have mechanisms for requesting that cards be inserted. Therefore any Operator Card Sets that you create for use with these applications must have K=1.

Note If you are creating an Administrator Card Set for a payShield installation, K must be greater than 1. N must therefore be greater than 2.

N specifies the total number of smart cards to be used in the Administrator Card Set. This value must be less than or equal to 64. If a value for this option is not specified, new-world creates an Administrator Card Set that contains a single card.

Note You should not create an Administrator Card Set for which the required number of cards is equal to the total number of cards because you will not be able to replace the Administrator Card Set if even a single card is lost or damaged.

This option only takes effect if you are creating a new security world.

new-world command-line utility features

Security world features can be specified on the command line.



You can specify multiple features as a comma-separated list of terms. Each term consists of a feature name, optionally preceded by either a dash (-) or an exclamation point (!) to turn off the feature and can optionally be followed by an equals sign (=) and the threshold for this feature.

Note The ! character is interpreted by some shells as history expansion and must be escaped with a backslash, \\!. The dash may be interpreted as being the start of an command-line option unless you have used the -f option or specified a module without including the -m flag.

Note If you set the !fto flag, that is, turn off FTO, you will not be able to use smart cards to import keys even if you set the --allow-smartcard-imports option in the payshield-install utility.

Note If you want to use extended debugging from the module, you must set the dseeall flag.The following feature names are available:

m

This feature specifies module programming (and

Date post:	25-Nov-2015
Category:	Documents
Upload:	nohemi-arias
View:	1,275 times
Download:	107 times

NCipher-nShield Administrator Guide Windows

Documents