.. hsm2-tools-wrap.rst

.. _hsm2-tools-wrap-label:

YubiHSM 2 Wrap
===============

`Yubihsm Wrap <https://developers.yubico.com/yubihsm-shell/yubihsm-wrap.html>`_ is a tool that allows the creation of importable objects offline. This is useful when bootstrapping secrets, for example on an air-gapped computer.

The tool requires an unencrypted Wrap Key in binary format and uses that to wrap objects with given Type, :ref:`hsm2-concepts-objects-label`, :ref:`hsm2-concepts-algorithms-label`, :ref:`hsm2-concepts-objectid-label`, :ref:`hsm2-concepts-capability-label` and, where applicable, Delegated Capabilities.

For the resulting Object to be successfully imported on a YubiHSM 2, the Wrap Key used by ``yubihsm-wrap`` must already be present on the device.

Currently not all Object Types are supported. Refer to `Known Issues and Limitations <https://developers.yubico.com/YubiHSM2/Releases/Known_issues.html>`_ for more information.

The `yubihsm-wrap` software tool is part of the `YubiHSM Shell <https://docs.yubico.com/hardware/yubihsm-2/hsm-2-user-guide/hsm2-sdk-tools-libraries.html#yubihsm-2-shell>`_, which is installed with the `YubiHSM SDK <https://developers.yubico.com/YubiHSM2/Releases/>`_.