== SecuX Authenticator for Desktop and Android

Manage your SecuX PUFido Key and access one-time passwords with this full-featured
companion app.

Based on Yubico Authenticator, licensed under Apache 2.0.

=== Features include
* Display information about your SecuX PUFido Key such as serial number, firmware version,
  and supported capabilities
* Manage and access OATH one-time passwords stored securely on your key
* Configure PIN, fingerprints, and manage passkeys for WebAuthn/FIDO
* Configure PIN/PUK/Management key, and manage private keys and certificates for PIV
* Configure enabled features, and factory reset key data
* Compatible with USB SecuX PUFido Key

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.

Experience security the modern way with SecuX Authenticator.
Visit https://secuxtech.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 13 (Ventura) & above
|macOS 10.15 (Catalina)

|Linux
|Ubuntu 22.04 & above
|Ubuntu 20.04 (or equivalent)

|Android
|Android 13 & above
|Android 7 (Nougat)
|===

=== Installation
Downloads for all supported operating systems are available at https://secuxtech.com

==== Linux
On Linux platforms you will need pcscd installed and running to be able to
communicate with a key over the SmartCard interface. Additionally, you may
need to set permissions for your user to access keys via the HID interfaces.

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!

=== Build instructions (for developers)
Instructions on building and packaging the app is available
link:doc/Development.adoc[here].

=== License
This project is based on Yubico Authenticator and is licensed under the Apache License 2.0.
See the LICENSE file for details.
