EasyAuth

A 2FA secrets manager and TOTP generator for the desktop with a focus on ease of use for beginners.

Download     Website     Quick Start     User Manual

Features

• Stores your secret keys encrypted in a vault on your local machine (doesn't rely on third-party cloud services).

• Automatically finds QR codes displayed on the screen. No need to scan QR codes with your phone.

• QR codes can be read from an image file.

• Generates Time-based One-time Passwords from your secret keys.

• The vault is displayed as a scrollable list with a search feature.

• Website icons are displayed for easily identifying each entry.

• The list can be sorted alphabetically, by usage frequency, or by most recently used.

• The list can be manually reordered to achieve a custom ordering.

• Vault entries can be displayed as QR codes for migration to other applications.

• Export and Import vault to plain-text JSON file or otpauth URI format.

• Familiar easy-to-navigate desktop GUI.

• GUI includes light and dark themes.

• Preferences dialog has useful customization settings.

• Verifying with TOTP in three easy steps:

  1. Open the application.
  2. Click the TOTP code for the website you are logging in to.
  3. Paste into verification form.

  No text messages to your phone, no email to check. Quick and hassle-free.

Status

All features above are implemented, but still in active development.
Expect breaking changes, features to be added and removed, and non-backwards compatibility. A production release is available for download but no support is provided.

Website, User Manual, and Video tutorial are available.

Download

Binaries for Windows and Linux are available under Releases.

Screenshots

Screenshot Gallery

Limitations

Currently tested on Linux Mint and Windows 10.

Uses only TOTP codes with SHA1, 6-digit, 30-second parameters.

Warning

As with any form of two-factor authentication, if the second-factor is compromised (e.g., your phone is lost or stolen) you may lose access to your online accounts unless you have saved the recover codes you were issued initially. This software is issued with no guarantee. There is a risk of data loss, including loss of your secret keys.

Usage

Practice storing a new secret key using the sample QR code below.

1. Launch the application.
2. Make sure the QR code below is visible on the screen. Click 'Scan QR code".
3. Observe the new entry in the main window.

A Quick Start guide is available, or view the complete User Manual.

---

Installation from Source (Linux)

Dependencies

3.8 <= Python < 3.13

PyQt5
pyotp
pyperclip
pyzbar
cryptography
qrcode
qdarktheme Markdown py-machineid

Prerequisites

• Ensure you have Python 3.8+ installed on your system.

1. Download the Repository

1. Click the "Code" button and select "Download ZIP".
2. Extract the downloaded ZIP file to a directory of your choice.

Alternatively, you can clone the repository using Git:

git clone https://github.com/jdalbey/EasyAuth.git
cd EasyAuth

2: Create a Virtual Environment

python -m venv venv
source venv/bin/activate  

3: Install Dependencies

pip install -r requirements.txt

4: Launch the Application

python src/main.py

Additional Information

• Logging: The application uses logging to provide debug information. You can configure the logging settings in the main.py file.
• HiDPI Support: The application uses qdarktheme to enable HiDPI support.

Installation from Source (Windows)

Prerequisites

• Ensure you have Python 3.8+ installed on your system.

1. Download the Repository

1. Click the "Code" button and select "Download ZIP".
2. Extract the downloaded ZIP file to a directory of your choice.
3. Start Powershell
4. cd to EasyAuth-master folder

2: Create a Virtual Environment

python -m venv venv
venv\Scripts\Activate.ps1  

3: Install Dependencies

pip install -r requirements.txt

4: Launch the Application

python src/main.py

Troubleshooting

If you encounter any issues, please check the following:

• Ensure all dependencies are installed correctly.
• Check the console output for any error messages.
• Turn on debugging output (See User Manual)

For further assistance, you can open an Issue.

---