.. yk5-tools.rst .. _yk5-tools-label: ========================= Tools and Troubleshooting ========================= .. include:: includes/managing-applications.rst YubiKey Manager (ykman) ======================= .. include:: includes/what-is-ykman.rst Graphical User Interface (GUI) ------------------------------ The graphical user interface of the YubiKey Manager provides an easy-to-use method of performing basic configuration tasks of the YubiKey 5 Series, including: * Displaying information about the YubiKey(s) connected to the computer. * Enabling or disabling applications allowed through physical interface. * Setting or changing the FIDO2 PIN, as well as resetting the FIDO application. * Managing the credentials in the OTP application. Command Line Interface (CLI) ---------------------------- Using ykman's CLI, you can do everything that the GUI can and more. This includes, but is not limited to: * Enabling or disabling applications and prevent unauthorized changes by setting a lock code. * Managing the credentials in the PIV / Smart Card application, including resetting them. * Managing and generating OTPs from the credentials in the OATH application, including resetting the application. * Resetting the OpenPGP application and setting the OpenPGP touch policy. For usage information and examples for ykman, see the `YubiKey Manager (ykman) CLI and GUI Guide `_. Yubico Authenticator ==================== `Yubico Authenticator `_ is used to manage credentials on OATH applications and it lists OTPs generated by the YubiKey. Yubico Authenticator provides the time element for generating OTPs for OATH-TOTP credentials because the YubiKey does not have a battery and cannot track time. The Yubico Authenticator is open source, cross-platform, and runs on Windows, macOS, Linux, and Android. The Android version of Yubico Authenticator can communicate with YubiKeys over NFC or USB. YubiKey Smart Card Minidriver ============================= The YubiKey `Smart Card Minidriver `_ extends the PIV / Smart Card application for YubiKey on Windows. It facilitates deployment and management. Key benefits include: * Enroll the YubiKey using standard Windows utilities. * Auto-enrollment for self-provisioning and automatically renewing a YubiKey. * Multiple authentication certificates on one YubiKey. * Change the PIN from the Ctrl+Alt+Del menu. * Unblock the PIN using the PUK at the Windows logon screen. To get started with the YubiKey Smart Card Minidriver, see the `deployment guide `_ .. Note:: To use PIV / Smart Cards with YubiKey 5 Series, requires YubiKey Smart Card Minidriver version 4.0 or later. Troubleshooting =============== For any issues with a key from the YubiKey 5 Series, refer to the `Knowledge Base `_ and search for the issue. If your issue is not listed in the Knowledge Base, or if you have any technical questions, `submit a request `_ with Yubico Support.   ---- Click for `Yubico Support `_.