Yubico Authenticator for Desktop (Windows, macOS and Linux) and Android
Go to file
Dain Nilsson 89c868ecc6
Improve RPC device path stability.
This improves "remembering" the active YubiKey, and lets FIDO reset work
with additional keys present.
2022-03-21 10:49:16 +01:00
.github/workflows android github action trigger update 2022-03-16 12:06:02 +01:00
android change name of Steam unit test 2022-03-21 08:36:19 +01:00
assets/product-images Add product images. 2021-11-24 13:28:38 +01:00
doc Update README 2021-11-19 10:55:43 +01:00
lib Improve RPC device path stability. 2022-03-21 10:49:16 +01:00
linux Update build scripts. 2022-02-10 13:38:46 +01:00
macos Update mac build for ykman-rpc. 2022-02-10 14:17:54 +01:00
pigeons simplify showDialog Api 2022-03-16 09:13:31 +01:00
resources Windows installer + resources directory 2022-03-15 15:09:39 +01:00
test Remove executable permission from files. 2021-11-19 09:19:16 +01:00
windows Update build scripts. 2022-02-10 13:38:46 +01:00
ykman-rpc Improve RPC device path stability. 2022-03-21 10:49:16 +01:00
.gitignore Remove executable permission from files. 2021-11-19 09:19:16 +01:00
.gitmodules Update ykman and replace submodule with pyproject config. 2022-02-21 10:47:33 +01:00
.metadata Remove executable permission from files. 2021-11-19 09:19:16 +01:00
analysis_options.yaml Enable lint check for unawaited_futures. 2022-01-25 12:46:51 +01:00
build-ykman.bat Update ykman and replace submodule with pyproject config. 2022-02-21 10:47:33 +01:00
build-ykman.sh Update ykman and replace submodule with pyproject config. 2022-02-21 10:47:33 +01:00
build.yaml Add start of navigation structure. 2021-11-22 14:00:23 +01:00
pubspec.lock Introduce "failed" state for apps. 2022-03-11 13:31:23 +01:00
pubspec.yaml using caret syntax for pigeon version 2022-03-04 09:17:09 +01:00
README.adoc Update README and add verison number in about. 2022-02-24 15:32:49 +01:00

== Yubico Authenticator for Desktop

=== Requirements
You will need the Flutter SDK with enabled desktop support, see:
https://flutter.dev/desktop

Development has been done using the "Install from git" method of installing the
SDK, from the "beta" channel.

You will also need to provide a compiled version of ykman-rpc, as described in
the next section.


=== Building ykman-rpc
Requirements: Python >= 3.8 and Poetry.

The GUI requires a compiled version of ykman-rpc to run, which is built from
the sources in ykman-rpc/ in this repository. This needs to be build prior to
running `flutter build` or `flutter run`, by running `build-ykman.sh` (or
`build-ykman.bat` on Windows).

NOTE: You will need to re-run `ykman-build.sh` if changes have been made to
ykman-rpc's code, or if `flutter clean` has been run.


=== Running the app
To start the app, run:

  flutter run -d <os>

where <os> is "windows", "macos", or "linux". You can add the `--release` flag
to run a release build instead of debug. Builds of the app will be create under
`build/<os>/`.


=== Running tests
Tests can be run with the command:

  flutter test


=== Packaging for MacOS
See link:doc/MacOS_Packaging.adoc[MacOS Packaging].