== YubiHSM 2

This archive contains the necessary tools to use the YubiHSM 2.

The content of the archive and the description of each component is given below:

[options="header"]
|===
|Resource | Description
|bin/libcrpto-3-x64.dll, bin/libcrpto-3.dll or lib/libcrypto.3.dylib | Pre-built OpenSSL. Found inside yubihsm-shell installer (Windows only)
|bin/getopt.dll | Pre-built getopt library. Found inside yubihsm-shell installer (Windows only)
|bin/zlib1.dll or lib/libz.1.dylib | Pre-built zlib library. Found inside yubihsm-shell installers (Windows and MacOS) only)
|bin/yubihsm-setup | Deployment tool for YubiHSM 2
|bin/yubihsm-connector | The connector, a tool for providing a common interface to the device
|bin/yubihsm-wrap | A tool to create wrapped importable objects offline. Found inside yubihsm-shell installers for Windows and MacOS
|bin/yubihsm-shell | The shell, a https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop[REPL]-style tool for interacting with YubiHSM 2 (and the connector). Found inside yubihsm-shell installer on Windows
|bin/yubihsm-auth | The shell, a https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop[REPL]-style tool for interacting with a YubiKEY for the purpose of storing YubiHSM 2 credentials. Found inside yubihsm-shell installers for Windows and MacOS
|include/pkcs11/pkcs11.h | Common and standard PKCS#11 functions and constants definitions. Found inside yubihsm-shell installer on Windows
|include/pkcs11/pkcs11y.h | Yubico-specific PKCS#11 functions and constants definitions. Found inside yubihsm-shell installer on Windows
|include/yubihsm.h | Library functions and constants definitions. Found inside yubihsm-shell installer on Windows
|include/ykhsmauth.h | Library functions and constants definitions for interacting with a YubiKey for the purpose of storing YubiHSM 2 credentials. Found inside yubihsm-shell installers for Windows and MacOS
|lib/libyubihsm.lib | Library binary to interact with YubiHSM 2. Found inside yubihsm-shell installer (Windows only)
|lib/ykhsmauth.lib | Library binary to interact with a YubiKEY for the purpose of storing YubiHSM 2 credentials. Found inside yubihsm-shell installer (Windows only)
|lib/libyubihsm.{dylib,so} or bin/libyubihsm.dll | Library binary to interact with YubiHSM 2. Found inside yubihsm-shell installer on Windows
|lib/libyhsmauth.{dylib,so} or bin/ykhsmauth.dll | Library binary to interact with  a YubiKEY for the purpose of storing YubiHSM 2 credentials. Found inside yubihsm-shell installer on Windows
|lib/yubihsm_pkcs11.{dylib,so} or bin/yubihsm_pkcs11.dll | PKCS#11 module to interact with YubiHSM 2. Found inside yubihsm-shell installer on Windows
|yubihsm-cngprovider-windows-amd64.msi | Installer for CNG/KSP for Windows ADCS (Windows only)
|yubihsm-cngprovider-windows-x86.msi | Installer for CNG/KSP for Windows ADCS (Windows only)
|yubihsm-connector-windows-amd64.msi | Installer for the connector (Windows only)
|yubihsm-shell-x64.msi | Installer for libyubihsm (Windows only)
|yubihsm-shell-x86.msi | Installer for libyubihsm (Windows only)
|yubihsm-setup-x64.msi | Installer for YubiHSM Setup (Windows only)
|===

== Documentation

The latest version of the documentation for each component can be found at
https://developers.yubico.com/YubiHSM2

== License

The YubiHSM 2 SDK is intended for use in development and production environments in conjunction with YubiHSM 2, pursuant to  https://www.yubico.com/support/terms-conditions/yubico-license-agreement/[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.