.. hsm2-tools-downloads.rst

.. _hsm2-tools-downloads-label:

YubiHSM 2 SDK Downloads
========================

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/libcrypto-3.dll           | Pre-built OpenSSL (Windows and MacOS only)  |
   | or lib/libcrypto-3.dylib      |                                             |
   +-------------------------------+---------------------------------------------+
   | 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 bin/libyubihsm.dll        |                                             |
   +-------------------------------+---------------------------------------------+
   || lib/yubihsm_pkcs11.{dylib,so}| PKCS#11 module to interact with YubiHSM 2   |
   || or bin/yubihsm_pkcs11.dll    |                                             |
   +-------------------------------+---------------------------------------------+
   | python-noarch (**1**)         | 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                    |                                             |
   +-------------------------------+---------------------------------------------+

**(1)**  python-noarch is a separate download. See `python-yubihsm <https://developers.yubico.com/python-yubihsm/>`_.

For YubiHSM 2 SDK Library components see:

* `yubihsm-connector <https://developers.yubico.com/yubihsm-connector/>`_

* `yubihsm-setup <https://developers.yubico.com/yubihsm-setup/>`_

* `yubihsm-shell <https://developers.yubico.com/yubihsm-shell/>`_

   * `yubihsm-auth <https://developers.yubico.com/yubihsm-shell/yubihsm-auth.html>`_
   * `yubihsm-pkcs11 <https://developers.yubico.com/yubihsm-shell/yubihsm-pkcs11.html>`_
   * `yubihsm-wrap <https://developers.yubico.com/yubihsm-shell/yubihsm-wrap.html>`_
   * `libyubihsm <https://developers.yubico.com/yubihsm-shell/libyubihsm.html>`_

* `python-yubihsm <https://developers.yubico.com/python-yubihsm/>`_

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