.. YubiHSM_Commands.rst

.. _yubihsm-commands-label:


================
YubiHSM Commands
================


For a full description of YubiHSM Auth, see the *YubiKey 5 Series Technical Manual*,  `Protocols and Applications > YubiHSM Auth <https://docs.yubico.com/hardware/yubikey/yk-tech-manual/yk5-apps.html#yubihsm-auth>`_ chapter.

Enable or Disable YubiHSM Auth on a YubiKey
============================================

This section includes the expected output and testing methods.

YubiHSM Auth is available as of firmware version 5.4.X and is disabled by default.


**Enable** YubiHSM Auth by running:

.. code-block::

   ykman config usb --enable HSMAUTH
   YubiHSM Auth successfully enabled.

**Test enablement** by connecting to the YubiHSM with YubiHSM-Shell:

.. code-block::

   yubihsm> session ykopen 1 "default key" "my secret"
   Session authenticated to YubiHSM2.

**Disable** YubiHSM Auth by running:

.. code-block::

   ykman config usb --disable HSMAUTH
   YubiHSM Auth successfully disabled.

**Test disablement** by connecting to the YubiHSM with YubiHSM-Shell:

.. code-block::

   yubihsm> session ykopen 1 "default key" "my secret"
   No access to the YubiKey application YubiHSM Auth.



----

Click for `Yubico Support <http://yubi.co/support>`_.