Yubico / yubioath-flutter

Yubico Authenticator for Desktop (Windows, macOS and Linux) and Android
https://developers.yubico.com/yubioath-flutter/
Apache License 2.0
951 stars 129 forks source link
fido flutter oath totp yubikey

== Yubico Authenticator for Desktop and Android

image:splash.png[]

Manage your YubiKey and access one-time passwords with this full-featured companion app to the YubiKey.

=== Features include

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 accounts vulnerable to takeovers. With the YubiKey and Yubico Authenticator you can raise the bar for security. No connectivity needed!

Experience security the modern way with the Yubico Authenticator. Visit https://yubico.com to learn more.

=== 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].