.. index.rst


============================
Yubico Product Documentation
============================


.. toctree::
   :maxdepth: 3
   :caption: CONTENTS


YubiKeys
==========

.. image:: graphics/hardware.png
   :width: 60

*YubiKeys* are hardware authentication devices that protect user access to computers, networks, and online accounts and services through phishing-resistant multi-factor authentication and passwordless login.

* **YubiKey Technical Manual** [`HTML <./hardware/yubikey/yk-tech-manual/index.html>`_] [`PDF <./hardware/yubikey/yk-tech-manual/webdocs.pdf>`_]
* **YubiKey Technical Data Sheet** [`PDF <./hardware/yubikey/datasheet/_static/YubiKey_technical_data_sheet.pdf>`_]
* **YubiKey FIPS 4 Series Technical Manual** [`HTML <./hardware/yubikey/yk-fips-4/index.html>`_] [`PDF <./hardware/yubikey/yk-fips-4/webdocs.pdf>`_]
* **Yubico Object ID (OID) Reference Guide** [`HTML <./hardware/oid/index.html>`_] [`PDF <./hardware/oid/webdocs.pdf>`_]
* **Implementation Guidance and Support: Yubico Best Practices** [`HTML <./hardware/yubikey-guidance/best-practices/index.html>`_]  [`PDF <./hardware/yubikey-guidance/best-practices/webdocs.pdf>`_]


-------------------------


YubiEnterprise Services
========================

.. image:: graphics/services-icon.png
   :width: 90

*YubiEnterprise Services* enable organizations to order and distribute YubiKeys efficiently and rapidly. Includes the *YubiEnterprise Console* user interface and the *YubiEnterprise API* for managing orders and delivery of YubiKeys to end users.

*Yubico FIDO Pre-reg* and *YubiEnroll* are part of the Yubico Enrollment Suite which empowers organizations to streamline management of pre-registered and pre-enrolled YubiKeys for end users, on their path to stronger security. 

* **YubiEnterprise Services User Guide & Release Notes** [`HTML <./cloud-services/yubienterprise/delivery/>`_] `[PDF <./cloud-services/yubienterprise/delivery/webdocs.pdf>`_]
* **YubiEnterprise API Reference** [`HTML <https://console.yubico.com/apidocs/>`_]
* **Yubico FIDO Pre-reg** [`HTML <./cloud-services/yubienterprise/delivery/prereg-shipments.html#>`_]
* **YubiEnroll User Guide & Release Notes** [`HTML <./software/yubikey/tools/yubienroll/>`_] [`PDF <./software/yubikey/tools/yubienroll/webdocs.pdf>`_]

.. * **YubiEnroll with Okta - Quick Start Guide** [PDF]
.. * **YubiEnroll with Microsoft - Quick Start Guide** `[PDF]


-------------------------

Apps & Tools
==============

.. image:: graphics/apps-tools-icon.png
   :width: 80

*Yubico Authenticator* is a desktop and mobile application that allows end users to manage their YubiKeys and perform common operations, such as generating and displaying OATH two-factor authentication codes, managing the FIDO PIN, and performing a factory reset.

The *ykman CLI* is an advanced command line tool for desktop that provides comprehensive YubiKey management and configuration capabilities across all YubiKey applications.

The *YubiKey Minidriver* (YKMD) enables integration of the YubiKey's PIV smart card capabilities with Windows, unlocking functionality such as certificate enrollment, management of YubiKey smart card PINs, and smart card authentication on Windows devices.

* **Yubico Authenticator User Guide** [`HTML <./software/yubikey/tools/authenticator/auth-guide/index.html>`_] [`PDF <./software/yubikey/tools/authenticator/auth-guide/webdocs.pdf>`_]
* **YubiKey Manager (ykman) CLI User Guide** [`HTML <./software/yubikey/tools/ykman/>`_] `[PDF <./software/yubikey/tools/ykman/webdocs.pdf>`_]
* **YubiKey Minidriver User Guide** [`HTML <./software/yubikey/tools/minidriver/index.html>`_] [`PDF <./software/yubikey/tools/minidriver/webdocs.pdf>`_]

-------------------------

YubiHSM
=========

.. image:: graphics/yubi-hsm-icon.png
   :width: 80

*YubiHSM* is a Hardware Security Module (HSM) device that secures modern infrastructure, including servers. It provides advanced protection for sensitive data, like cryptographic keys, digital certificates, and passwords, as well as code signing operations.

* **YubiHSM 2 User Guide** [`HTML <./hardware/yubihsm-2/hsm-2-user-guide/index.html>`_] `[PDF <./hardware/yubihsm-2/hsm-2-user-guide/webdocs.pdf>`_]
* **YubiHSM 2 Technical Data Sheet** [`PDF <./hardware/yubihsm-2/datasheet/_static/YubiHSM_2_Technical_Data_Sheet.pdf>`_]

-------------------------


SDKs & Libraries
==================

.. image:: graphics/sdk-icon.png
   :width: 90

Yubico provides a range of desktop and mobile SDKs that allow developers to build YubiKey functionality into custom applications. 

*java-webauthn-server* is a server-side WebAuthn library for Java that provides implementations of relying party operations for developers wanting to create their own FIDO2/WebAuthn server.

*python-fido2* is a server-side and client-side library for Python that provides functionality for communicating with FIDO devices over USB and verifying attestation and assertion signatures.

* **YubiKey SDK for Desktop (.NET)** [`HTML <https://docs.yubico.com/yesdk/index.html>`_]
* **YubiKey SDK for iOS** [`HTML <https://developers.yubico.com/Mobile/iOS/>`_]
* **YubiKey SDK for Android** [`HTML <https://developers.yubico.com/Mobile/Android/>`_]
* **Java WebAuthn Server-side Library** [`HTML <https://developers.yubico.com/java-webauthn-server/>`_]
* **Python WebAuthn/FIDO2 Server-side and Client-side Library** [`HTML <https://developers.yubico.com/python-fido2/>`_]

-------------------------

Other Documentation
=====================

* `Yubico Developer Program <https://developers.yubico.com/>`_
* `Yubico Support <https://support.yubico.com/hc/en-us>`_




|document update date|

..