Yubico Authenticator for Desktop (Windows, macOS and Linux) and Android
Go to file
2024-08-13 16:35:10 +02:00
.github don't build yubikit-android in CodeQL action 2024-08-12 17:24:12 +02:00
android [Android] remove mavenLocal() 2024-08-12 17:28:00 +02:00
assets changed colors for text objects, corrected bold fonts, buttons, paddings, dialog overlays and minor fixes here and there 2024-01-19 15:09:14 +01:00
doc Update README 2024-04-29 09:41:52 +02:00
helper Rename side_effects to flags 2024-07-10 15:45:25 +02:00
integration_test Fix some deprecation issues 2024-07-03 12:44:20 +02:00
lib Ensure content does not overflow scrollbar 2024-08-13 16:35:10 +02:00
lint Ignore deprecations for lint 2024-07-03 15:27:42 +02:00
linux Bump Flutter version and dependencies 2024-07-03 12:32:53 +02:00
macos Bump Podfile.lock 2024-07-03 15:57:13 +02:00
resources bump version to 7.0.2-dev.0 2024-05-30 09:15:39 +02:00
test refactor widget tests 2023-10-20 11:38:36 +02:00
windows Change default window size 2024-04-16 16:09:03 +02:00
.flake8 Update ykman-rpc and fix set_mode. 2022-05-06 15:40:51 +02:00
.gitignore Create report of untranslated strings. 2023-03-02 11:14:03 +01:00
.gitmodules Update ykman and replace submodule with pyproject config. 2022-02-21 10:47:33 +01:00
.metadata Re-generate Windows files. 2023-01-26 15:02:10 +01:00
.pre-commit-config.yaml update android string res from arb files 2023-12-04 16:23:53 +01:00
analysis_options.yaml improve KeyCustomization serialization 2024-01-24 12:35:09 +01:00
arb_reformatter.py Re-format arb files on commit. 2023-11-30 15:15:59 +01:00
build-helper.bat Fail the build if build-helper fails. 2022-11-18 10:12:14 +01:00
build-helper.sh Use prebuild wheel for zxing-cpp 2024-04-30 12:04:21 +02:00
build.yaml Add start of navigation structure. 2021-11-22 14:00:23 +01:00
check_strings.py Increase allowed length for French short strings 2024-04-11 14:48:24 +02:00
create-dmg.sh macOS release fixes 2022-11-10 11:48:39 +01:00
crowdin.yaml updated french and japanese translations 2024-04-26 19:06:05 +02:00
dart_test.yaml update test tags 2024-02-12 08:32:47 +01:00
l10n.yaml Create report of untranslated strings. 2023-03-02 11:14:03 +01:00
LICENSE add Apache 2.0 license 2022-10-04 13:15:09 +02:00
NEWS update NEWS 2024-05-28 14:21:44 +02:00
pubspec.lock Ignore deprecations for lint 2024-07-03 15:27:42 +02:00
pubspec.yaml Change OATH pinned icon color 2024-08-13 16:34:37 +02:00
README.adoc Update README 2024-04-29 09:41:52 +02:00
run-mypy.sh Add hook for running mypy from poetry. 2023-11-30 14:32:53 +01:00
set-version.py Add MSI version number to set-version.py 2023-01-25 10:18:33 +01:00
splash.png Add image to README. 2022-11-11 13:43:59 +01:00
testrunner.sh Cleaning up some documentation. 2023-11-29 17:43:52 +01:00
update_android_strings.py Escape Android strings 2024-04-11 13:30:50 +02:00

== 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
* Display information about your YubiKey such as serial number, firmware version,
  and supported capabilities
* Manage and access OATH one-time passwords stored securely on your YubiKey
* Configure PIN, fingerprints, and manage passkeys for WebAuthn/FIDO
* Configure PIN/PUK/Management key, and manage private keys and certificates for PIV
* Provision Yubico OTP, static passwords, and other YubiKey slot-based credentials
* Configure enabled features, and factory reset YubiKey data
* Compatible with any USB or NFC-enabled YubiKey

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