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.
Resource | Description |
---|---|
bin/libcrypto-3.dll or lib/libcrypto-3.dylib | Pre-built OpenSSL (Windows and MacOS 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}
or bin/libyubihsm.dll
|
Library binary to interact with YubiHSM 2 |
lib/yubihsm_pkcs11.{dylib,so}
or bin/yubihsm_pkcs11.dll
|
PKCS#11 module to interact with YubiHSM 2 |
python-noarch/* | Python implementation of the library |
yubihsm-cngprovider-windows-
amd64.msi
|
Installer for CNG/KSP for Windows ADCS
(Windows only)
|
yubihsm-connector-windows-
amd64.msi
|
Installer for the Connector (Windows only) |
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.
Operating System | Version | Architecture |
---|---|---|
Debian | 10 Buster | amd64 |
Debian | 11 Bullseye | amd64 |
Debian | 12 Bookworm | amd64 |
Fedora | 39 | amd64 |
Fedora | 40 | 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 | 22.04 Jammy Jellyfish | amd64 |
Ubuntu | 24.04 Noble Numbat | amd64 |
Windows | Server 2019 | x64, x86 |
Windows | Server 2022 | x64, x86 |
macOS | 14 Sonoma | amd64, arm64, universal |