A link to the Entrust website
nShield Documentation
Videos Contact support

nShield Security World

    • nShield Security World v13.3 Release Notes
    • nShield Security World v13.3 Security Manual
      • Supply and Transportation
      • Environment
      • Commissioning
      • Access Control
      • Operation
      • Key Management
      • Physical Security
      • Audit
      • Support and Maintenance
      • Security Incident and Response
      • Decommission and Disposal
      • Abbreviations
    • nShield Connect v13.3 Install Guide
      • Recycling and disposal information
      • Before you install the software
      • Installing the software
      • Before installing an HSM
      • Installing an HSM
      • Front panel controls
      • Top-level menu
      • Basic HSM, RFS and client configuration
      • Troubleshooting
      • HSM maintenance
      • Approved accessories
      • Uninstalling existing software
      • Software packages on the Security World software installation media
      • Valid IPv6 Addresses
    • nShield Connect v13.3 User Guide (Linux)
      • Security Worlds
      • The front panel interface
      • Physical security of the HSM
      • Software installation
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Supplied utilities
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • HSM and client configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on the HSM
      • Maintenance of nShield Hardware
      • Upgrading the image file and associated firmware
      • SNMP monitoring agent
      • Morse code error messages
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Remote File System Volumes
    • nShield Connect v13.3 User Guide (Windows)
      • Security Worlds
      • The front panel interface
      • Physical security of the HSM
      • Software installation
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Supplied utilities
      • Using silent installations
      • Using nShield commands from PowerShell
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • HSM and client configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on the HSM
      • Maintenance of nShield Hardware
      • Upgrading the image file and associated firmware
      • SNMP monitoring agent
      • Morse code error messages
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Remote File System Volumes
    • nShield 5c v13.3 Install Guide
      • Recycling and disposal information
      • Before you install the software
      • Installing the software
      • Before installing an HSM
      • Installing an HSM
      • Front panel controls
      • Top-level menu
      • Basic HSM, RFS and client configuration
      • Troubleshooting
      • HSM maintenance
      • Approved accessories
      • Uninstalling existing software
      • Software packages on the Security World software installation media
      • Valid IPv6 Addresses
    • nShield 5c v13.3 User Guide (Linux)
      • Security Worlds
      • The front panel interface
      • Physical security of the HSM
      • Software installation
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Supplied utilities
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • HSM and client configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on the HSM
      • Maintenance of nShield Hardware
      • Upgrading the image file and associated firmware
      • SNMP monitoring agent
      • Morse code error messages
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Remote File System Volumes
    • nShield 5c v13.3 User Guide (Windows)
      • Security Worlds
      • The front panel interface
      • Physical security of the HSM
      • Software installation
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Supplied utilities
      • Using silent installations
      • Using nShield commands from PowerShell
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • HSM and client configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on the HSM
      • Maintenance of nShield Hardware
      • Upgrading the image file and associated firmware
      • SNMP monitoring agent
      • Morse code error messages
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Remote File System Volumes
    • nShield Solo and Solo XC v13.3 Install Guide
      • Hardware security modules
      • Regulatory notices
      • Before installing the module
      • Installing the module
      • Before you install the software
      • Installing the software
      • Setting the system clock
      • Checking the installation
      • Status indicators
      • Uninstalling existing software
      • Software packages on the Security World installation media
      • Virtualization Remote Server
    • nShield nToken v13.3 Install Guide
      • Hardware security modules
      • Regulatory notices
      • Before installing the module
      • Installing the module
      • Before you install the software
      • Installing the software
      • Setting the system clock
      • Status indicators
      • Configuring and checking the installation
      • Uninstalling existing software
      • Software packages on the Security World installation media
    • nShield Solo and Solo XC v13.3 User Guide (Linux)
      • Security Worlds
      • Software installation
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Warrant Management for Solo and Edge
      • Supplied utilities
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • Hardserver configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on an nShield Solo module
      • Maintenance of nShield Hardware
      • Upgrading firmware
      • SNMP monitoring agent
      • Morse code error messages
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Remote File System Volumes
    • nShield Solo and Solo XC v13.3 User Guide (Windows)
      • Security Worlds
      • Software installation
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Warrant Management for Solo and Edge
      • Supplied utilities
      • Using silent installations
      • Using nShield commands from PowerShell
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • Hardserver configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on an nShield Solo module
      • Maintenance of nShield Hardware
      • Upgrading firmware
      • SNMP monitoring agent
      • Morse code error messages
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Remote File System Volumes
    • nShield 5s v13.3 Install Guide
      • Hardware security modules
      • Regulatory notices
      • Before installing the module
      • Installing the module
      • Before you install the software
      • Installing the software
      • Setting the system clock
      • Checking the installation
      • Status indicators
      • Uninstalling existing software
      • Software packages on the Security World installation media
    • nShield 5s v13.3 User Guide (Linux)
      • Security Worlds
      • Platform services and ncoreapi
      • Recovery mode
      • Software installation
      • Set up communication between host and module
      • Administration of platform services
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Warrant Management for nShield 5s
      • Supplied utilities
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • Hardserver configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on an nShield 5s module
      • Maintenance of nShield Hardware
      • Upgrading firmware
      • SNMP monitoring agent
      • Error codes
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Returning a module to factory state
      • Remote File System Volumes
      • SSH Client Key Protection
    • nShield 5s v13.3 User Guide (Windows)
      • Security Worlds
      • Platform services and ncoreapi
      • Recovery mode
      • Software installation
      • Set up communication between host and module
      • Administration of platform services
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Warrant Management for nShield 5s
      • Supplied utilities
      • Using silent installations
      • Using nShield commands from PowerShell
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • Hardserver configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on an nShield 5s module
      • Maintenance of nShield Hardware
      • Upgrading firmware
      • SNMP monitoring agent
      • Error codes
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Returning a module to factory state
      • Remote File System Volumes
      • SSH Client Key Protection
    • nShield Edge v13.3 Install Guide
      • Safety and security
      • Regulatory notices
      • Before you install the software
      • Installing the software
      • Setting up the nShield Edge
      • Using the nShield Edge
      • Troubleshooting
      • nShield Edge Windows compatibility issues and considerations
      • Dimensions and operating conditions
      • Uninstalling existing software
      • Software packages
    • nShield Edge v13.3 User Guide (Linux)
      • Security Worlds
      • Software installation
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Warrant Management for Solo and Edge
      • Supplied utilities
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • Hardserver configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on an nShield Edge
      • Upgrading firmware
      • SNMP monitoring agent
      • Morse code error messages
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Remote File System Volumes
    • nShield Edge v13.3 User Guide (Windows)
      • Security Worlds
      • Software installation
      • Client Software and module configuration
      • Enabling optional features
      • Security World Remote Administration
      • Creating and managing a Security World
      • Managing card sets and softcards
      • Application interfaces
      • Remote Operator
      • Working with keys
      • Using KeySafe
      • Warrant Management for Solo and Edge
      • Supplied utilities
      • Using silent installations
      • Using nShield commands from PowerShell
      • Preload Utility
      • Environment variables
      • Logging, debugging, and diagnostics
      • Hardserver configuration files
      • Cryptographic algorithms
      • Audit Logging
      • Key generation options and parameters
      • Checking and changing the mode on an nShield Edge
      • Upgrading firmware
      • SNMP monitoring agent
      • Morse code error messages
      • Uninstalling Security World Software
      • Application Performance Tuning
      • Merged Keys Concept
      • Product returns
      • Remote File System Volumes
    • CodeSafe v13.3 User Guide (Linux)
      • About the Secure Execution Engine SEE
      • Designing SEE machines and SEE-ready HSMs
      • Example SEE machines
      • Debugging SEE machines
      • Deploying SEE Machines
      • Utilities
      • Environment variables
      • Key generation options and parameters
      • SEElib functions
      • Differences between glibc and bsdlib (SoloXC only)
      • SEE Machines Whitelist
    • CodeSafe v13.3 User Guide (Windows)
      • About the Secure Execution Engine SEE
      • Designing SEE machines and SEE-ready HSMs
      • Example SEE machines
      • Debugging SEE machines
      • Deploying SEE Machines
      • Utilities
      • Environment variables
      • Key generation options and parameters
      • SEElib functions
      • Differences between glibc and bsdlib (SoloXC only)
      • SEE Machines Whitelist
  • Remote Administration v13.3 User Guide
    • Introduction
    • Requirements
    • Server-side preparation tasks
    • Install the Remote Administration Client (RAC) software
    • Use the Remote Administration Client (RAC) software
    • Troubleshooting
    • Uninstall the Remote Administration Client (RAC) software
    • TVD v13.3 Install and User Guide
      • Safety and security
      • Setting up the nShield Trusted Verification Device
      • Using the nShield Trusted Verification Device
      • Dimensions and operating temperatures
    • nCore v13.3 Developer Tutorial
      • nCore architecture
      • C tutorial
      • Java tutorial
      • Python 3 tutorial
      • Java examples
      • Key structures
      • NFKM Functions
      • nCore API commands
    • Microsoft CryptoAPI v13.3 Reference Guide
      • nShield Architecture
      • Microsoft CAPI CSP
      • Supported Algorithms
      • Key Generation and Storage
      • User Interface Issues
      • Key Counting
      • NVRAM-Stored Keys
      • CSP Setup and Utilities
    • Microsoft CNG v13.3 Reference Guide
      • nShield Architecture
      • CNG Architecture Overview
      • Supported Algorithms
      • Key Authorization
      • Key Use Counting
      • Using CAPI Keys
      • Utilities
      • Environment Variables for CNG Protection
    • nCipherKM JCA JCE CSP v13.3 Reference Guide
      • nShield Architecture
      • Installing the nCipherKM JCA/JCE CSP
      • System Properties
      • Compatibility
      • Architecture
      • Available Functions
      • The KeyStore API
      • Initialization
      • Loading and Storing Keys
      • keytool
      • Using Keys
    • PKCS 11 v13.3 Reference Guide
      • nShield Architecture
      • PKCS #11 Developer libraries
      • PKCS #11 with load sharing mode
      • PKCS #11 with HSM Pool mode
      • Generating and deleting NVRAM-stored keys with PKCS #11
      • PKCS #11 with key reloading
      • PKCS #11 without load-sharing or HSM Pool modes
      • PKCS #11 Security Officer
      • nShield-specific PKCS #11 API extensions
      • Compiling and linking
      • Objects
      • Mechanisms
      • Vendor annotations on P11 mechanisms
      • Vendor-defined mechanisms
      • KISAAlgorithm mechanisms
      • Attributes
      • Utilities
      • Functions
      • General purpose functions
      • Slot and token management functions
      • Standard session management functions
      • nShield session management functions
      • Object management functions
      • Encryption functions
      • Decryption functions
      • Message digesting functions
      • Signing and MACing functions
      • Functions for verifying signatures and MACs
      • Dual-purpose cryptographic functions
      • Key-management functions
      • Random number functions
      • Parallel function management functions
      • Callback functions
    • PDFs
nShield Security World v13.3
  • Application Notes
  • Cloud Integration Option Pack
    • v2.2.3
    • v2.2.2
    • v2.2.1
  • KeySafe 5
    • v1.4
    • v1.3
    • v1.2
    • v1.1
    • v1.0
  • nShield Container Option Pack
    • v1.1.3
    • v1.1.2
    • v1.1.1
  • nShield Database Security Option Pack
    • v2.1.0
  • nShield Docs
  • nShield HSM hardware regulatory and maintenance documentation
  • nShield Key Attestation
    • v1.0.2
  • nShield Monitor
    • v3.1.0
    • v3.0.0
    • v2.9.8
    • v2.9.7
    • v2.9.5
    • v2.9.0
    • v2.8.0
  • nShield Post-Quantum Software Development Kit
    • v1.1.3
    • v1.2.1
    • v1.1.0
  • nShield Security World
    • v13.6.11
    • v13.7.3
    • v13.5.1
    • v13.4.5
    • v13.3
    • v13.2.4
    • v12.81
    • v12.80
    • v12.72.4
    • v12.50.4
    • v12.40
  • nShield Security World Release Information
  • Release Notes
  • Time Stamp Option Pack
    • v8.1.0
    • 8.0.0
    • 7.20.0
  • Web Services Option Pack
    • v3.3.1
    • v3.3.0
    • v3.2.0
    • v3.1.0
    • v3.0.2
  • Web Services SQLEKM Provider
    • v1.0.0
  • nShield Security World
v13.6.11 v13.7.3 v13.5.1 v13.4.5 v13.3 v13.2.4 v12.81 v12.80 v12.72.4 v12.50.4 v12.40
Email the nShield docs team

nShield Security World

nShield Security Manual

nShield Release Notes

Install Guides

  • nShield Connect Install Guide

  • nShield 5c Install Guide

  • nShield Edge Install Guide

  • nShield Solo Install Guide

  • nShield nToken Install Guide

  • nShield 5s Install Guide

User Guides

  • nShield Connect User Guide (Linux)

  • nShield Connect User Guide (Windows)

  • nShield 5c User Guide (Linux)

  • nShield 5c User Guide (Windows)

  • nShield Edge User Guide (Linux)

  • nShield Edge User Guide (Windows)

  • nShield Solo User Guide (Linux)

  • nShield Solo User Guide (Windows)

  • nShield 5s User Guide (Linux)

  • nShield 5s User Guide (Windows)

API Guides

  • nCore v13.3 Developer Tutorial

  • Microsoft CryptoAPI v13.3 Reference Guide

  • Microsoft CNG v13.3 Reference Guide

  • nCipherKM JCA JCE CSP v13.3 Reference Guide

  • PKCS 11 v13.3 Reference Guide

nShield CodeSafe (Linux)

nShield CodeSafe (Windows)

nShield Remote Administration

nShield Trusted Verification Device

You can download these guides in PDF format here.

Other documentation

  • nShield HSM documentation, including regulatory documents

  • Release Notes for all Security World releases

©2025 Entrust Corporation. All rights reserved.

This website was last updated on