x2y Authenticator

The Ultimate Privacy-First 2FA Vault by x2y devs tools

x2y Authenticator is a high-security, professional-grade Two-Factor Authentication (2FA) suite designed with privacy and robust security at its core. It provides a secure vault for all your TOTP tokens, ensuring your digital identities are protected with advanced features like stealth mode, panic backups, and local PC synchronization.

🌟 Table of Contents

• ✨ Features
• 🛡️ Security Notice
• 🛠️ Tech Stack
• 🚀 Installation
• 📖 Usage
• 🤝 Contributing
• 📄 License
• 📞 Contact

✨ Features

Experience a new level of security and convenience with x2y Authenticator's powerful features:

• Stealth Mode: Implement a dual-PIN system to create decoy vaults, providing an extra layer of plausible deniability.
• Panic Backup: Secure your 2FA data with AES-256 encrypted .x2y file exports and Master QR exports, ensuring recovery even in critical situations.
• WiFi Companion: Synchronize your 2FA tokens with your PC using a local-only web server, eliminating the need for cloud services and enhancing privacy.
• Screenshot Prevention: Benefit from OS-level blocking of screen captures, preventing unauthorized access to your sensitive 2FA codes.
• Smart Folders: Automatically organize your accounts with intelligent brand icon detection and categorization.
• Time Sync: Maintain precise TOTP generation through NTP synchronization, ensuring your codes are always accurate.

🛡️ Security Notice

This repository contains the source code for the x2y Authenticator. For production builds, it is critical that you provide your own key.properties and keystore.jks files in the /android/app folder. These files are essential for signing your application securely and are explicitly excluded from this repository for security reasons. Never commit your sensitive signing keys to a public repository.

🛠️ Tech Stack

The x2y Authenticator is built using cutting-edge technologies to ensure performance, security, and a seamless user experience.

• Framework: Flutter
• Language: Dart
• Encryption: AES-256
• Time Synchronization: NTP (Network Time Protocol)

🚀 Installation

Follow these steps to get your development environment set up and run the x2y Authenticator.

Prerequisites

Before you begin, ensure you have the following installed:

• Flutter SDK (Stable channel recommended)
• Android SDK (for building Android applications)

Build Instructions

1. Clone the Repository:

   git clone https://github.com/x2ydevs/x2y-authenticator.git
   cd x2y-authenticator

2. Get Dependencies:

   flutter pub get

3. Run in Debug Mode (Development):

   flutter run

4. Build for Production (Release): For a release build, remember the Security Notice above regarding key.properties and keystore.jks.

   flutter build appbundle --release

   This command will generate a signed Android App Bundle in build/app/outputs/bundle/release/app-release.aab.

📖 Usage

Once installed, the x2y Authenticator is intuitive to use.

1. Initial Setup: Upon first launch, you will be guided to set up your master PIN and potentially a decoy PIN for Stealth Mode.
2. Add Accounts:
   • Scan a QR code provided by your service (e.g., Google, GitHub, etc.).
   • Manually enter the secret key for services that don't provide a QR code.
3. Generate TOTP Codes: Access your vault to view and copy the time-based one-time passwords as needed.
4. Utilize Advanced Features:
   • Stealth Mode: Enter your decoy PIN to access the decoy vault, protecting your primary tokens.
   • WiFi Companion: Follow the in-app instructions to set up a local connection with your PC for cloud-free synchronization.
   • Panic Backup: Regularly export your encrypted .x2y file and Master QR to a secure location for disaster recovery.

🤝 Contributing

We welcome contributions to the x2y Authenticator! If you're passionate about privacy and security, consider helping us improve this project.

1. Fork the repository.
2. Create a new branch: git checkout -b feature/your-feature-name
3. Make your changes and commit them: git commit -m 'feat: Add some awesome feature' (Please use Conventional Commits if possible).
4. Push to the branch: git push origin feature/your-feature-name
5. Open a Pull Request describing your changes and their benefits.

Please ensure your code adheres to the existing style and includes relevant tests.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📞 Contact

For questions, feedback, or support, please visit our official website:

Website: https://www.x2ydevs.xyz

We look forward to hearing from you!