mirror of
https://github.com/Yubico/yubioath-flutter.git
synced 2024-11-22 08:22:16 +03:00
96 lines
3.6 KiB
Plaintext
96 lines
3.6 KiB
Plaintext
== Yubico Authenticator for Desktop and Android
|
|
|
|
image:splash.png[]
|
|
|
|
Store your unique credential on a hardware-backed security key and take it
|
|
wherever you go from mobile to desktop. No more storing sensitive secrets on
|
|
your mobile phone, leaving your account vulnerable to takeovers. With the
|
|
Yubico Authenticator you can raise the bar for security.
|
|
|
|
* The Yubico Authenticator will work with any USB or NFC-enabled YubiKeys
|
|
|
|
The Yubico Authenticator securely generates a code used to verify your identity
|
|
as you are logging into various services. No connectivity needed!
|
|
|
|
=== Features include
|
|
* Secure - Hardware-backed strong two-factor authentication with secret stored
|
|
on the YubiKey, not on your phone or computer
|
|
* Portable - Get the same set of codes across our other Yubico Authenticator
|
|
apps for desktops as well as for all leading mobile platforms
|
|
* Flexible - Support for time-based and counter-based code generation
|
|
* USB or NFC usage - Insert the YubiKey into the USB port, or use the YubiKey
|
|
with NFC with a mobile phone that is NFC-enabled or a desktop NFC reader to
|
|
store your credential on the YubiKey
|
|
* Easy Setup - QR codes available from the services you wish to protect with
|
|
strong authentication
|
|
* User Presence - Require a touch on the YubiKey sensor to generate new codes
|
|
for sensitive accounts
|
|
* Compatible - Secure all the services currently compatible with other
|
|
Authenticator apps
|
|
* Versatile - Support for multiple work and personal accounts
|
|
|
|
Experience security the modern way with the Yubico Authenticator.
|
|
Visit https://yubico.com to learn more.
|
|
|
|
NOTE: Yubico Authenticator 6 uses a new codebase built using the Flutter
|
|
framework. The previous Qt codebase can be found in the `legacy` branch.
|
|
|
|
=== Supported platforms
|
|
|
|
*Supported* - these are platforms we build and test on and commit to supporting.
|
|
|
|
*Best-effort* - the app is expected to work, but development is supported through community testing and full functionality cannot be guaranteed.
|
|
|
|
|===
|
|
||Supported|Best-effort
|
|
|
|
|Windows
|
|
|Windows 10 & above, x64
|
|
|Windows 10 & above, x64
|
|
|
|
|macOS
|
|
|macOS 11 (Big Sur) & above
|
|
|macOS 10.15 (Catalina)
|
|
|
|
|Linux
|
|
|Ubuntu 22.04 & above
|
|
|Ubuntu 20.04 (or equivalent)
|
|
|
|
|Android
|
|
|Android 11 & above
|
|
|Android 5 (Lollipop)
|
|
|===
|
|
|
|
=== Installation
|
|
Downloads for all supported operating systems are available
|
|
https://www.yubico.com/products/yubico-authenticator/[here].
|
|
|
|
==== Linux
|
|
On Linux platforms you will need pcscd installed and running to be able to
|
|
communicate with a YubiKey over the SmartCard interface. Additionally, you may
|
|
need to set permissions for your user to access YubiKeys via the HID
|
|
interfaces. The relevant permissions are described
|
|
https://developers.yubico.com/yubikey-manager/Device_Permissions.html[here].
|
|
|
|
For some configurations running Wayland, copying an OTP to clipboard only works
|
|
when the app has focus. If you are unable to reliably copy to clipboard from
|
|
the systray icon, you can use a separate binary which take the payload to stdin
|
|
by defining the environment variable `_YA_TRAY_CLIPBOARD`. Note that this must
|
|
be an absolute path to a binary owned by root:root, and should not be
|
|
world-writable.
|
|
For example: `_YA_TRAY_CLIPBOARD=/usr/bin/wl-copy`.
|
|
|
|
NOTE: Only use a trusted binary, OTPs will be sent to this when copied to clipboard from the systray!
|
|
|
|
=== Command line interface
|
|
Looking for a command line option? Try our
|
|
https://github.com/Yubico/yubikey-manager/[YubiKey Manager CLI] tool.
|
|
|
|
=== iOS
|
|
The iOS version of this app is available
|
|
https://github.com/Yubico/yubioath-ios[here].
|
|
|
|
=== Build instructions (for developers)
|
|
Instructions on building and packaging the app is available
|
|
link:doc/Development.adoc[here].
|