Microsoft CNG Guide for nShield Security World v13.6.5

Introduction

Cryptography API: Next Generation (CNG) is the successor to the Microsoft Crypto API (CAPI) and its long-term replacement. The Security World Software implementation of Microsoft CNG is supported on Microsoft Windows Server 2016 and later releases. The nShield CNG providers offer the benefits of hardware-based encryption accessed through the standard Microsoft API, and support the National Security Agency (NSA) classified Suite B algorithms.

Before using the nShield CNG providers, run the nShield CNG Configuration Wizard to:

  • configure HSM Pool mode for CNG as required.

  • create a new Security World or specify an existing Security World to use.

  • register the nShield CNG providers.

  • configure the nShield CNG providers as default CNG providers for specific tasks.

For additional information, see the Microsoft CNG documentation: http://msdn2.microsoft.com/en-us/library/aa376210.aspx.

This guide describes the Microsoft Cryptography API: Next Generation (CNG) toolkit supplied by Entrust Security to help developers write applications that use nShield modules.

This toolkit, like the application plug-ins supplied by Entrust, uses the Security World paradigm for key storage. For an introduction to Security Worlds, see nShield Security World v13.6.5 Management Guide.

Read this guide if…​

Read this guide if you want to build an application that uses an nShield key-management module to accelerate cryptographic operations and protect cryptographic keys through a standard interface rather than the full nCore API.

This guide assumes that you are familiar with the concept of the Security World. It is intended for experienced programmers and assumes that you are familiar with the following documentation:

  • The nCore Developer Tutorial, which describes how to write applications using an nShield module.

  • The nCore API Documentation (supplied as HTML), which describes the nCore API.

Additional useful documentation

Refer to nShield Security World v13.6.5 Management Guide and nShield v13.6.5 HSM User Guide for additional information about Security Worlds and nShield HSMs.

Security World Software default directories

The default locations for Security World Software and program data directories on English-language systems are summarized in the following table:

Directory Name Environment Variable Windows Server 2016 Linux

nShield Installation

NFAST_HOME

C:\Program Files\nCipher\nfast

/opt/nfast/

Key Management Data

NFAST_KMDATA

C:\ProgramData\nCipher\Key Management Data

/opt/nfast/kmdata/

Dynamic Feature Certificates

NFAST_CERTDIR

C:\ProgramData\nCipher\Feature Certificates

/opt/nfast/femcerts/

Static Feature Certificates

C:\ProgramData\nCipher\Features

/opt/nfast/kmdata/features/

Log Files

NFAST_LOGDIR

C:\ProgramData\nCipher\Log Files

/opt/nfast/log/
By default, the Windows %NFAST_KMDATA% directories are hidden directories. To see these directories and their contents, you must enable the display of hidden files and directories in the View settings of the Folder Options.

Dynamic feature certificates must be stored in the directory stated in the default directories table.

The directory shown for static feature certificates is an example location. You can store those certificates in any directory and provide the appropriate path when using the Feature Enable Tool. However, you must not store static feature certificates in the dynamic features certificates directory. For more information about feature certificates, see Optional features.

The absolute paths to the Security World Software installation directory and program data directories on Windows platforms are stored in the indicated nShield environment variables at the time of installation. If you are unsure of the location of any of these directories, check the path set in the environment variable.

The instructions in this guide refer to the locations of the software installation and program data directories by their names (for example, Key Management Data) or:

  • For Windows, nShield environment variable names enclosed in percent signs (for example, %NFAST_KMDATA%).

  • For Linux, absolute paths (for example, /opt/nfast/kmdata/).

NFAST_KMDATA cannot be a symbolic link.

If the software has been installed into a non-default location:

  • For Windows, ensure that the associated nShield environment variables are re-set with the correct paths for your installation.

  • For Linux, you must create a symbolic link from /opt/nfast/ to the directory where the software is actually installed. For more information about creating symbolic links, see your operating system’s documentation.

Utility help options

Unless noted, all the executable utilities provided in the bin subdirectory of your nShield installation have the following standard help options:

-h|--help displays help for the utility

-v|--version displays the version number of the utility

-u|--usage displays a brief usage summary for the utility.

Further information

This guide forms one part of the information and support provided by Entrust.

The nCore API Documentation is supplied as HTML files installed in the following locations:

  • Windows:

    • API reference for host: %NFAST_HOME%\document\ncore\html\index.html

    • API reference for SEE: %NFAST_HOME%\document\csddoc\html\index.html

  • Linux:

    • API reference for host: /opt/nfast/document/ncore/html/index.html

    • API reference for SEE: /opt/nfast/document/csddoc/html/index.html

The Java Generic Stub classes, nCipherKM 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 or nfast/java directory when you install these classes.

Security advisories

If Entrust becomes aware of a security issue affecting nShield HSMs, Entrust will publish a security advisory to customers. The security advisory will describe the issue and provide recommended actions. In some circumstances the advisory may recommend you upgrade the nShield firmware and or image file. In this situation you will need to re-present a quorum of administrator smart cards to the HSM to reload a Security World. Because of this, you should consider the procedures and actions required to upgrade devices in the field when deploying and maintaining your HSMs.

The Remote Administration feature supports remote firmware upgrade of nShield HSMs, and remote ACS card presentation.

We recommend that you monitor the Announcements & Security Notices section on Entrust nShield, https://nshieldsupport.entrust.com, where any announcement of nShield Security Advisories will be made.

Contacting Entrust nShield Support

To obtain support for your product, contact Entrust nShield Support, https://nshieldsupport.entrust.com.