A link to the Entrust website
nShield Documentation
Videos Contact support

nShield Security World

    • nShield Security World v13.6.11 Release Notes
    • nShield Security World v13.6.11 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 v13.6.11 Hardware Install and Setup Guides
      • nShield Network-Attached HSMs
        • Prerequisites and product information
        • Install a network-attached HSM into a rack
      • nShield PCIe HSMs
        • Prerequisites and product information
        • Install a PCIe HSM
      • nShield USB HSMs
        • Prerequisites and product information
        • Set up the nShield Edge
    • nShield Security World Software v13.6.11 Installation Guide
      • Before you install the software
      • Install the Security World software
      • Using silent installations
      • Problems during installation and commissioning
      • Uninstalling Security World Software
      • System upgrade
      • Software packages on the installation media
    • nShield v13.6.11 HSM User Guide
      • nShield Network-Attached HSMs
        • Physical security of the HSM
        • Front panel controls
        • Top-level menu
        • Basic HSM, RFS and client configuration
        • Client software and module configuration: network-attached HSMs
        • HSM and client configuration files
        • Checking and changing the mode on a network-attached HSM
        • Upgrading the image file and associated firmware: network-attached HSMs
        • Troubleshooting
        • HSM maintenance
        • Approved accessories
        • Resource Watchdog
        • Valid IPv6 Addresses
        • Remote File System Volumes
      • nShield PCIe HSMs
        • Client software and module configuration: PCIe and USB HSMs
        • Hardserver configuration files
        • Checking and changing the mode on an nShield Solo module
        • nShield 5s modes of operation
        • Upgrade firmware: nShield 5s
        • Upgrade firmware: nShield Solo, Solo XC, and Edge HSMs
        • Setting the system clock
        • Checking the installation
        • HSM status indicators and error codes (nShield 5s)
        • HSM Status indicators (nShield Solo and Solo XC)
        • Regulatory notices
        • Battery replacement
        • Replace the fan (Solo XC)
        • Set up communication between host and module (nShield 5s HSMs)
        • SSH Client Key Protection (nShield 5s HSMs)
        • Troubleshooting 5s
        • Virtualization Remote Server
      • nShield USB HSMs
        • Using the nShield Edge
        • Checking and changing the mode on an nShield Edge
        • nShield Edge Windows compatibility issues and considerations
        • Troubleshooting
        • Regulatory notices
      • HSM Management
        • Optional features
          • Enable features on a network-attached HSM
          • Enable features on PCIe and USB HSMs
        • Administration of platform services (nShield 5 HSMs)
        • Client cooperation
        • Morse code error messages
        • Working with CodeSafe
        • Warrant Management
        • Remote HSMs
        • Remote Operator
        • Using nShield commands from PowerShell
        • Preload Utility
        • Audit Logging
        • nShield Audit Log Service
        • Configure the hardserver to export the module for guest VM usage
        • Logging, debugging, and diagnostics
        • System logging (nShield 5 HSMs)
        • Maintenance of nShield Hardware
        • Physical security of the HSM
        • Application Performance Tuning
        • Platform services and (nShield 5 HSMs)
        • System upgrade
        • Product returns
    • nShield Security World v13.6.11 Management Guide
      • Security World infrastructure
      • Robustness
      • Security World keys
      • Security World options
      • Create a new Security World
      • Add HSMs to a Security World
      • Remove modules and delete Security Worlds
      • Security World Files
      • Managing card sets and softcards
        • View cards and softcards
        • Erase cards and softcards
        • Passphrases
        • Operator Card Sets (OCS)
        • Replace OCS and softcards
        • Softcards
        • Replace the ACS
      • Application interfaces
      • Environment variables
    • CodeSafe 5 v13.6.11 Developer Guide
      • Overview of CodeSafe 5
      • Install the CodeSafe 5 SDK on Linux
      • Install the CodeSafe 5 SDK on Windows
      • nShield 5c Codesafe 5 Configuration
      • Build CodeSafe 5 SDK apps
      • Sign and deploy CodeSafe 5 SDK apps using csadmin
      • Build and sign example SEE machines on Linux
      • Build and sign example SEE machines on Windows
      • Build and run Java examples
      • Debug CodeSafe 5 SEE machines
      • Uninstall the CodeSafe 5 SDK
      • Port existing CodeSafe application to CodeSafe 5
      • Supporting legacy CodeSafe Direct
      • SEE API documentation
      • System calls allowed by CodeSafe 5 SEE machines
    • CodeSafe v13.6.11 Developer Guide
      • 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
      • SEElib functions
      • Differences between glibc and bsdlib (SoloXC only)
      • Allowlist for SEE machines
    • Remote Administration v13.6.11 User Guide
      • 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.6.11 Install and User Guide
      • Safety and security
      • Setting up the nShield Trusted Verification Device
      • Using the nShield Trusted Verification Device
      • Dimensions and operating temperatures
    • nShield v13.6.11 Utilities Reference
      • anonkneti
      • appliance-cli
      • bondcfg
      • bondlink
      • bulkerase
      • cardpp
      • cef-audit-verify
      • cfg-mkdefault
      • cfg-dynamicslots
      • cfg-mkcardlist
      • cfg-pushnethsm
      • cfg-pushntp
      • cfg-remoteslots
      • cfg-reread
      • checkmod
      • chkserv
      • ckaesgen
      • ckariagen
      • ckcerttool
      • ckcmac-ctr
      • ckcrypt
      • ckdes3gen
      • ck_ecedwards_gen
      • ckecies
      • ck_ecmontgomery_gen
      • ckhyper
      • ckcheckinst
      • cknfkmid
      • ckshahmac
      • cksigtest
      • ckinfo
      • ckkeyloop
      • cklist
      • ckmechinfo
      • ckrestrictkey
      • ckrsagen
      • cksotool
      • ck-xfer-fix
      • config-auditlogging
      • cpioc
      • cngimport
      • cnginstall32, cnginstall
      • cnglist32, cnglist
      • cngregister
      • cngsoak, cngsoak64
      • config-serverstartup
      • configure-csp-poolmode, configure-csp-poolmode64
      • createocs
      • cryptest
      • csadmin
      • cspcheck, cspcheck64
      • cspimport, cspimport64
      • cspmigrate, cspmigrate64
      • cspnvfix, cspnvfix64
      • csptest, csptest64
      • csputils, csputils64
      • date
      • des_kat
      • display-pubkey
      • dump-marshalled
      • elftool
      • enquiry
      • esn
      • factorystate
      • fet
      • floodtest
      • fwcheck
      • fwversion
      • gateway
      • gateway6
      • generatekey
      • getrtc
      • hakever
      • help
      • hsc_configurepoolmodule
      • hsc_configureslots
      • hsc_loadseemachine
      • hsc_loadwarrants
      • hsc_nethsmexports
      • hsc_nethsmimports
      • hsc_remotefilesystem
      • hsc_serverremotecomms
      • hsc_serversettings
      • hsc_servicehosts
      • Administration of platform services (nShield 5 HSMs)
      • hsmdiagnose
      • initunit
      • killrecov
      • km-plode
      • kmfile-dump
      • kneti
      • kptest
      • keytst, keytst64
      • loadmache
      • loadrom
      • loadsee-setup
      • logout
      • sbin/logrotate-hardserver
      • logs
      • maintmode
      • makecspyuserdata
      • migrate-world
      • mkaclx
      • modstate
      • ncdate
      • ncssh
      • ncperftest
      • ncsvcdep
      • ncversions
      • ncthread-test
      • netcfg
      • netcfg6
      • netdiagnose
      • netenable
      • nethsmadmin
      • nethsmenroll
      • netlink
      • new-world
      • nfcp
      • nfdiag
      • nfkmattest
      • nfkmcheck
      • nfkminfo
      • nfkmverify
      • nfloadmon
      • nfls
      • nfrm
      • nfwarrant
      • nopclearfail
      • npkgtool
      • nshieldaudit
      • ntokenenroll
      • nvram-backup
      • nvram-sw
      • openssl
      • p11hyper
      • passwd
      • perfcheck
      • ping
      • pollbare
      • postload-bsdlib
      • postrocs
      • ppmk
      • preload
      • pubkey-find
      • push
      • raccmd
      • racgui
      • racs
      • randchk
      • reboot
      • retrievewarrants
      • rfs-setup
      • rfs-sync
      • rfsaddr
      • rocs
      • route
      • route6
      • routing
      • routing6
      • rserverperm
      • rtc
      • see-sock-serv, see-stdioe-serv, see-stdioesock-serv, see-stdoe-serv
      • setrtc
      • sigtest
      • slotinfo
      • stattree
      • sworldcheck
      • tamperlog
      • tct2
      • trial
      • uptime
      • version
    • nShield Security World v13.6.11 Key Management Guide
      • Working with keys
      • Key generation options and parameters
      • Using KeySafe
      • Key migration
      • Common Criteria CMTS Mode Assigned Keys (nShield Solo XC)
      • Merged Keys Concept
      • Cryptographic algorithms
        • Configuration
        • Functionality
        • Asymmetric Algorithms and Mechanisms
        • Symmetric Mechanisms and Algorithms
        • DeriveKey Mechanisms
        • Internal Security Mechanisms
    • nCore v13.6.11 Developer Tutorial
      • nCore architecture
      • C tutorial
      • Java tutorial
      • Python 3 tutorial
      • Java examples
      • Key structures
      • NFKM Functions
      • OpenSSL with NFKM Engine
      • nCore API commands
      • Transaction IDs
    • Microsoft CryptoAPI Guide for nShield Security World v13.6.11
      • nShield Architecture
      • Microsoft CAPI CSP
      • CSP Setup and Utilities
      • Utilities for the CAPI CSP
      • Supported Algorithms
      • Key Generation and Storage
      • User Interface Issues
      • Key Counting
      • NVRAM-Stored Keys
      • Container Storage Format
    • Microsoft CNG Guide for nShield Security World v13.6.11
      • nShield Architecture
      • CNG Architecture Overview
      • Register the nShield CNG CSP
      • Supported Algorithms
      • Migrate keys for CNG
      • Key Authorization
      • Key Use Counting
      • Using CAPI Keys
      • Utilities
      • Environment Variables for CNG Protection
    • nCipherKM JCA JCE CSP v13.6.11 API 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 Reference Guide for nShield Security World v13.6.11
      • 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 with preload
      • PKCS #11 Security Officer
      • nShield-specific PKCS #11 API extensions
      • Compiling and linking
      • nShield PKCS #11 library environment variables
      • 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
    • nShield SNMP Monitor v13.6.11 Install and User guide
      • Install and activate the nShield SNMP monitoring agent
      • Basic configuration
      • USM users
      • Traditional access control
      • VACM configuration
      • Trap Configuration
      • Using the SNMP agent with a manager application
        • MIB module overview
        • Memory usage monitoring
        • Administration sub-tree overview
        • netHSMNetwork sub-tree
        • Statistics sub-tree overview
      • SNMP agent command-line
    • PDFs
nShield Security World v13.6.11
  • 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

We continue to improve the HSM, API, and Security World Software user documents in line with the nShield Security World Software Release Policy. For information about the changes and about the timeline of the changes, see the Release Notes.

Release information

  • nShield Release Notes for this release

nShield Security World documentation

You can download these guides in PDF format here.
  • nShield Security Manual

  • nShield v13.6.11 Hardware Install and Setup Guides

  • nShield v13.6.11 HSM User Guide

  • nShield Security World Software v13.6.11 Installation Guide

  • nShield Security World v13.6.11 Management Guide

  • nShield Utilities

  • nShield Security World v13.6.11 Key Management Guide

  • nShield CodeSafe 5

  • nShield CodeSafe

  • nShield Remote Administration

  • nShield Trusted Verification Device

nShield API guides

You can download these guides in PDF format here.
  • nCore v13.6.11 Developer Tutorial

  • Microsoft CryptoAPI Guide for nShield Security World v13.6.11

  • Microsoft CNG Guide for nShield Security World v13.6.11

  • nCipherKM JCA JCE CSP v13.6.11 API Guide

  • PKCS 11 Reference Guide for nShield Security World v13.6.11

  • nShield SNMP Monitor v13.6.11 Install and User guide

Other nShield documentation

  • nShield HSM documentation, including regulatory documents

  • nShield Release Notes for all Security World releases

©2025 Entrust Corporation. All rights reserved.

This website was last updated on