Yubico Authenticator for Desktop (Windows, macOS and Linux) and Android
Go to file
Dag Heyman 88adf77dd1
Merge pull request #610 from Yubico/nfc-flow
initial improved NFC flow
2020-06-09 13:11:09 +02:00
.github Actions: bumped python to 3.8.3 and fix for mergemodules 2020-05-26 13:32:25 +02:00
doc Update various documents for 5.0.0 2019-09-11 10:30:37 +02:00
docker/xenial-appimage actions: bump qt and python in appimage 2020-05-11 00:47:38 -07:00
fonts fonts: include all roboto variants 2019-10-02 13:22:46 +02:00
images macos: update menu bar icon 2020-05-08 10:13:28 +02:00
py nfc: improve error msgs a bit 2020-06-08 12:41:45 +02:00
qml nfc: improve error handling 2020-06-09 13:00:54 +02:00
resources Actions: DPI awareness to Win 2020-05-19 09:58:08 +02:00
snap snap: bump qt and python 2020-05-11 03:32:48 -07:00
.gitattributes Add .gitattributes 2017-11-24 17:13:46 +01:00
.gitignore add pymodules to .gitignore 2018-11-05 09:59:20 +01:00
.pre-commit-config.yaml Update pre-commit hook 2018-04-19 09:27:54 +02:00
build_qrc.py Sort qrc input file list 2018-03-09 22:04:05 +01:00
COPYING Add a new license file 2017-03-15 10:10:04 +01:00
deployment.pri Rewrite repo with new .gitattributes 2017-11-24 17:13:47 +01:00
main.cpp Make sure the application is always visible on a monitor 2020-02-18 11:41:35 +01:00
NEWS Update NEWS and versions 2020-05-13 22:05:56 -07:00
README updated Win 7 to Win 8.1 2020-05-20 12:18:52 -07:00
README.adoc Added README.adoc symlink for Github. 2015-06-10 16:47:03 +02:00
requirements.txt yubikey: adjust isNfc criteria 2020-05-25 14:09:13 +02:00
resources.json fonts: add roboto font 2019-10-02 13:22:46 +02:00
screenshot.h Use std::vector instead of dynamic-length array 2018-01-22 14:09:00 +01:00
screenshot.png changed key in screenshot 2019-10-15 13:59:46 +02:00
yubioath-desktop.pro Update NEWS and versions 2020-05-13 22:05:56 -07:00

== Yubico Authenticator
Cross-platform application for generating Open Authentication (OATH) time-based TOTP and event-based HOTP one-time password codes, with the help of a YubiKey that protects the shared secrets.

image:screenshot.png[]

=== Features
* Add a credential by scanning a QR code on the screen
* Favorite your most frequently used credentials for easy access
* Keep your secret seeds safe by storing them on a YubiKey
* Require a touch on the YubiKey to generate the code
* Protect your credentials with a device password
* Connect an external smart card reader and use the YubiKey over NFC

=== Supported devices
Usage of this software requires a compatible YubiKey. Yubico Authenticator is capable of provisioning and using both slot-based credentials
(compatible with any YubiKey that supports OTP) and the more powerful standalone OATH functionality found on the NEO, YubiKey 4 and YubiKey 5 series.
To use the standalone OATH functionality your YubiKey must have the CCID mode enabled, which can be done by using the https://developers.yubico.com/yubikey-manager-qt/[YubiKey Manager].

=== Installation
Downloads for all supported operating systems are available on the https://developers.yubico.com/yubioath-desktop/Releases/[Yubico Authenticator release page].


=== System Requirements
The following operating systems are supported. The application may still run on other platforms.

* Windows 8.1 or later
* macOS High Sierra 10.13 or later
* Ubuntu 16.04 LTS or later

On Linux systems, make sure the `pcscd` service is installed and running.


=== CLI
Looking for a command line option? That is available in the https://developers.yubico.com/yubikey-manager/[YubiKey Manager CLI] with the `ykman oath` commands.