mirror of
https://github.com/Yubico/yubioath-flutter.git
synced 2025-01-07 11:20:47 +03:00
89 lines
3.1 KiB
Plaintext
89 lines
3.1 KiB
Plaintext
== Yubico Authenticator
|
|
image:https://travis-ci.org/Yubico/yubioath-desktop.svg?branch=master["Build Status", link="https://travis-ci.org/Yubico/yubioath-desktop"]
|
|
image:https://ci.appveyor.com/api/projects/status/tddss2exet3ysypt?svg=true["Appveyor Status", link="https://ci.appveyor.com/project/Yubico53275/yubioath-desktop-xfr6h/"]
|
|
|
|
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
|
|
* Keep your OATH secrets safe by storing them on a YubiKey and generate the codes with this application.
|
|
* Add a credential by scanning a QR code on the screen.
|
|
* Supports 6, 7 or 8 digit codes.
|
|
* Supports TOTP credentials with any time period.
|
|
* Require touch on YubiKey to generate code.
|
|
* Protect your credentials with a device password.
|
|
|
|
=== Supported devices
|
|
Usage of this software requires a compatible YubiKey device. Yubico
|
|
Authenticator is capable of provisioning and using both slot-based credentials
|
|
(compatible with any YubiKey that supports OTP) as well as the more powerful
|
|
standalone OATH functionality found on the NEO and YubiKey 4 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
|
|
|
|
==== Windows and macOS
|
|
Installers are available https://developers.yubico.com/yubioath-desktop/Releases/[here].
|
|
|
|
==== Ubuntu
|
|
|
|
$ sudo apt-add-repository ppa:yubico/stable
|
|
$ sudo apt update
|
|
$ sudo apt install yubioath-desktop
|
|
|
|
|
|
==== Other Linux/Unix - Build from source
|
|
|
|
To build from source, you need the following tools and dependencies:
|
|
|
|
|
|
- `g++`
|
|
- `make`
|
|
- Python 3
|
|
- Qt 5 development tools, including `qmake`
|
|
- Qt QML development tools
|
|
|
|
With these installed, the build procedure is:
|
|
|
|
$ git clone --recurse-submodules https://github.com/Yubico/yubioath-desktop.git
|
|
$ cd yubioath-desktop
|
|
$ qmake && make
|
|
|
|
From version 4.3.0 forward, you can also use the source tarball which now also
|
|
bundles source dependencies:
|
|
|
|
$ wget https://developers.yubico.com/yubioath-desktop/Releases/yubioath-desktop-4.3.0.tar.gz,.sig}
|
|
$ gpg --verify yubioath-desktop-4.3.0.tar.gz.sig
|
|
$ tar xf yubioath-desktop-4.3.0.tar.gz
|
|
$ cd yubioath-desktop-4.3.0
|
|
$ qmake && make
|
|
|
|
The runtime dependencies are:
|
|
|
|
- QML modules:
|
|
- PyOtherSide
|
|
- Qt Labs Settings
|
|
- Qt Quick Controls
|
|
- Qt Quick Dialogs
|
|
|
|
With these installed, you can just run the program:
|
|
|
|
$ ./yubioath-desktop
|
|
|
|
|
|
==== Packaging
|
|
|
|
The files you need to include in a distribution package are:
|
|
|
|
- The `yubioath-desktop` binary
|
|
- The icon `resources/icons/yubioath.png`, installed as `yubioath.png` somewhere
|
|
on the
|
|
https://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html#directory_layout[Qt]
|
|
or
|
|
https://doc.qt.io/qt-5/appicon.html#setting-the-application-icon-on-common-linux-desktops[Freedesktop]
|
|
icons search path, for example as `/usr/share/pixmaps/yubioath.png`
|
|
- (Optional) The Desktop Application descriptor
|
|
`resources/yubioath-desktop.desktop`
|