Skip to content

PicoShot/CrossAuth

Repository files navigation

CrossAuth

CrossAuth Logo

A secure, cross-platform authenticator app for managing your two-factor authentication codes

Platforms License Tauri

🔐 Features

  • Secure Storage: All your authenticator tokens are encrypted with AES-256
  • Password Protection: Set a master password to secure your account data
  • Streamer Mode: Hide your codes when streaming or screen sharing
  • Cross-Platform: Available for Windows, macOS, and Linux
  • Intuitive UI: Clean, modern interface with dark mode
  • QR Code Scanning: Quickly add accounts by scanning QR codes
  • Backup & Restore: Export and import your accounts securely
  • Google Authenticator Import: Support for Google Authenticator export QR codes

📥 Installation

Windows

  1. Download the latest .exe or .msi installer from the Releases page
  2. Run the installer and follow the on-screen instructions
  3. Launch CrossAuth from your Start menu

macOS

  1. Download the latest .dmg file for your Mac (Intel or Apple Silicon) from the Releases page
  2. Open the DMG file and drag the app to your Applications folder
  3. You may need to right-click the app and select "Open" the first time to bypass Gatekeeper

Linux

  1. Download the appropriate package for your distribution from the Releases page:
    • .AppImage: Universal format that works on most distributions
    • .deb: For Debian/Ubuntu-based distributions
    • .rpm: For Red Hat/Fedora-based distributions
  2. Install using your preferred method:
    • For AppImage: Make executable with chmod +x CrossAuth*.AppImage and run it
    • For Debian/Ubuntu: sudo dpkg -i CrossAuth*.deb
    • For Red Hat/Fedora: sudo rpm -i CrossAuth*.rpm

Building from source

If you prefer to build from source, follow the steps in the Development section.

🖼️ Screenshots

Main Screen Add Account

🚀 Getting Started

Adding Your First Account

  1. Launch CrossAuth
  2. Click the menu button in the top-right corner
  3. Select "Scan QR Code" or "Manual Entry"
  4. If scanning, point your camera at the QR code provided by the service
  5. If entering manually, enter the secret key and account details
  6. Your new account will appear in the main view with a generated authentication code

Setting a Password

For additional security, you can set a master password:

  1. Click the menu button in the top-right corner
  2. Select "Settings"
  3. In the Security section, click "Set" next to Password Protection
  4. Enter and confirm your password
  5. Click "Set Password"

🛠️ Development

Prerequisites

  • Rust
  • Node.js
  • pnpm

Setup

# Clone the repository
git clone https://github.com/PicoShot/CrossAuth.git
cd CrossAuth

# Install dependencies
pnpm install

# Start the development server
pnpm tauri dev

# Build for production
pnpm tauri build

🔒 Security

CrossAuth takes your security seriously:

  • All account data is encrypted using AES-256 encryption
  • Your master password is never stored directly but used as an encryption key
  • The app runs locally on your computer - your authentication tokens never leave your device
  • Auto-lock feature can lock the app after a period of inactivity

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📝 License

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

🙏 Acknowledgements


Made with ❤️ by PicoShot

About

A secure, cross-platform authenticator app for managing your two-factor authentication codes

Resources

License

Stars

Watchers

Forks

Packages

No packages published