What is YubiHSM 2?

The YubiHSM 2 is a Hardware Security Module that is within reach of all organizations. It provides advanced cryptography, including hashing, asymmetric and symmetric key cryptography, to protect the cryptographic keys that secure critical applications, identities, and sensitive data in an enterprise for certificate authorities, databases, code signing and more.

Documentation overview

The purpose of this documentation is both to provide detailed descriptions of YubiHSM 2 concepts and to work as a reference for commands and APIs provided. Before setting up YubiHSM 2 for the first time, familiarize yourself with the basic concepts and terminology used in the product documentation contained within these pages as well as in the software itself.

  • Releases provides access to release notes, downloads, and known issues and limitations.

  • Product Overview gives a high-level description of the YubiHSM 2 offering; product specifications, contents of the SDK, and how to get help.

  • Concepts explains the foundational concepts used; understanding of these concepts is necessary in order to use YubiHSM 2.

  • Commands provides an inventory of all available commands, with yubihsm-shell usage examples.

  • Component Reference is a collection of reference materials for the components included in the SDK: the core libraries, the PKCS#11 module, the Shell, the Key Storage Provider, and more.

  • Usage Guides contains a number of guides and examples for using YubiHSM 2.

  • Backup and Restore informs about how to back up keys, and how to restore from backups.

Note
YubiHSM 2 SDK documentation and usage guides are enhanced continuously. Please check back regularly to see what’s new.

System requirements

The YubiHSM 2 SDK 1.0.1 is built and provided for the following operating systems.

Operating System Version Architecture

CentOS

6

amd64

CentOS

7

amd64

Debian

8

amd64

Debian

9

amd64

Fedora

26

amd64

Fedora

27

amd64

Ubuntu

1404

amd64

Ubuntu

1604

amd64

Ubuntu

1710

amd64

Ubuntu

1804

amd64

Windows

10

amd64

Windows

Server 2012

amd64

Windows

Server 2016

amd64

macOS

10.12 Sierra

amd64

macOS

10.13 High Sierra

amd64

License

The YubiHSM 2 SDK is intended for use in development and production environments in conjunction with YubiHSM 2, pursuant to Yubico’s terms and conditions of sale and license. By downloading and installing the SDK you agree to the terms of this license.

Third party software included in the YubiHSM 2 SDK, and their respective licenses, are listed in the licenses directory inside the SDK package.