.. hsm2-sdk.rst

.. _hsm2-sdk-label:


=========================================
YubiHSM 2 Software Development Kit (SDK)
=========================================


YubiHSM 2 SDK can be downloaded from https://developers.yubico.com/YubiHSM2/Releases/ and contains the following tools and libraries to interface with YubiHSM 2.

.. table::

  +-------------------------------+---------------------------------------------+
  | Resource                      | Description                                 |
  +===============================+=============================================+
  | bin/libcrpto-1_1-x64.dll      | Pre-built OpenSSL (Windows only)            |
  +-------------------------------+---------------------------------------------+
  | bin/yubihsm-setup             | Deployment tool for YubiHSM 2               |
  +-------------------------------+---------------------------------------------+
  | bin/yubihsm-wrap              || A tool to create wrapped importable        |
  |                               || objects offline                            |
  +-------------------------------+---------------------------------------------+
  | bin/yubihsm-connector         || The connector, a tool for providing a      |
  |                               || common interface to the device             |
  +-------------------------------+---------------------------------------------+
  | bin/yubihsm-shell             || The shell, a REPL-style tool for           |
  |                               || interacting with YubiHSM 2 (and the        |
  |                               || connector) See Note (1)                    |
  +-------------------------------+---------------------------------------------+
  | include/pkcs11/pkcs11.h       || Common and standard PKCS#11 functions and  |
  |                               || constants definitions                      |
  +-------------------------------+---------------------------------------------+
  | include/pkcs11/pkcs11y.h      || Yubico-specific PKCS#11 functions and      |
  |                               || constants definitions                      |
  +-------------------------------+---------------------------------------------+
  | include/yubihsm.h             | Library functions and constants definitions |
  +-------------------------------+---------------------------------------------+
  || lib/libyubihsm.{dylib,so}    | Library binary to interact with YubiHSM 2   |
  || or in/libyubihsm.dll         |                                             |
  +-------------------------------+---------------------------------------------+
  || lib/yubihsm_pkcs11.{dylib,so}| PKCS#11 module to interact with ubiHSM 2    |
  || or bin/yubihsm_pkcs11.dll	  |                                             |
  +-------------------------------+---------------------------------------------+
  | python-noarch/*               | Python implementation of the library        |
  +-------------------------------+---------------------------------------------+
  || yubihsm-cngprovider-windows- || Installer for CNG/KSP for Windows ADCS     |
  || amd64.msi	                  || (Windows only)                             |
  +-------------------------------+---------------------------------------------+
  || yubihsm-connector-windows-   | Installer for the connector (Windows only)  |
  || amd64.msi	                  |                                             |
  +-------------------------------+---------------------------------------------+


Details on these tools and libraries can be found in the later sections of this document.


System Requirements
=====================

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

.. table::

  +-------------------+-----------------------------+--------------------------+
  | Operating System  | Version	                    | Architecture             |
  +===================+=============================+==========================+
  | CentOS            | 7                           | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | CentOS            | 8                           | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Debian            | 9 Stretch (stable)          | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Debian            | 10 Buster                   | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Debian            | 11 Bullseye                 | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Fedora            | 33                          | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Fedora            | 34                          | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Ubuntu            | 14.04 Trusty Tahr           | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Ubuntu            | 16.04 Xenial Xerus          | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Ubuntu            | 18.04 Bionic Beaver         | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Ubuntu            | 20.04 Focal Fossa           | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Ubuntu            | 21.04 Hirsute Hippo         | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Ubuntu            | 21.10 Impish Indri          | amd64                    |
  +-------------------+-----------------------------+--------------------------+
  | Windows           | Server 2019                 | x64, x86                 |
  +-------------------+-----------------------------+--------------------------+
  | macOS             | 10.15 Catalina, 11 Big Sur  | amd64, arm64, universal  |
  +-------------------+-----------------------------+--------------------------+