Skip to content

README.md

Latest commit

 

History

History
161 lines (119 loc) · 4.74 KB

README.md

File metadata and controls

161 lines (119 loc) · 4.74 KB

Entropy-Pass 🔐

A modern, high-entropy password generator built with Tauri, Rust, and React. Features secure offline generation, cryptographic strength estimation, and a polished high-contrast UI.

Entropy-Pass License Platform

✨ Features

  • 🎲 Multi-Source Entropy: Combines crypto random, CPU usage, memory state, timing, and load averages
  • 🎨 High-Contrast UI: Modern React interface with distinct black borders for maximum visibility
  • 🔒 Ultra Secure: No network access, no password persistence, memory cleanup
  • ⚙️ Customizable: Length (8-128 chars), character types, ambiguous character exclusion
  • 📊 Strength Meter: Real-time password strength evaluation with crack time estimates
  • 📋 Clipboard Integration: One-click copy with auto-clear (60s)
  • 📜 Password History: Last 5 passwords (memory-only, click to copy)
  • 🌓 Theme Support: Dark and light modes with absolute black borders for accessibility
  • 💾 Lightweight: Small executable size (~7 MB)

🚀 Quick Start

Download

Download the latest release from the Releases page:

  • Windows Installer: Entropy-Pass_0.1_x64_en-US.msi
  • Portable: entropy-pass.exe

Installation

  1. Download the .msi installer
  2. Double-click to install
  3. Launch Entropy-Pass from Start Menu

Usage

  1. Adjust password length (8-128 characters)
  2. Select character types (uppercase, lowercase, numbers, symbols)
  3. Click "Generate Secure Password"
  4. Click "Copy" to copy to clipboard
  5. Password auto-clears from clipboard after 60 seconds

🔐 Security

  • ✅ All operations are local (no network access)
  • ✅ Passwords never persisted to disk
  • ✅ Memory cleanup after generation
  • ✅ Clipboard auto-clear after 60 seconds
  • ✅ Cryptographically secure random generation (CSPRNG)
  • ✅ Multiple entropy sources for maximum unpredictability
  • ✅ HMAC-DRBG for entropy processing

🛠️ Tech Stack

  • Frontend: React + TypeScript + Tailwind CSS
  • Backend: Rust (Tauri)
  • Testing: Vitest + Cargo Test
  • Build: Vite

📦 Development

Prerequisites

  • Node.js 18+
  • Rust 1.70+
  • npm or yarn

Setup

# Clone the repository
git clone https://github.com/yourusername/entropy-pass.git
cd entropy-pass

# Install dependencies
npm install

# Run in development mode
npm run tauri dev

Build

# Build for production
npm run tauri build

# Output will be in:
# - src-tauri/target/release/entropy-pass.exe (portable)
# - src-tauri/target/release/bundle/msi/ (installer)

Testing

# Run Rust tests
cd src-tauri
cargo test

# Run frontend tests
npm test

📁 Project Structure

entropy-pass/
├── src/                    # React frontend
│   ├── components/         # UI components
│   │   ├── StrengthMeter.tsx
│   │   ├── HistoryPanel.tsx
│   │   └── ThemeToggle.tsx
│   ├── services/          # Frontend services
│   │   ├── ClipboardManager.ts
│   │   ├── HistoryManager.ts
│   │   └── ThemeManager.ts
│   ├── types/             # TypeScript types
│   └── App.tsx            # Main app component
├── src-tauri/             # Rust backend
│   └── src/
│       ├── entropy/       # Entropy collection
│   │   ├── collector.rs
│   │   └── csprng.rs
│       ├── generator/     # Password generation
│   │   ├── password.rs
│   │   └── memorable.rs
│       ├── strength/      # Strength calculation
│   │   └── calculator.rs
│       └── commands.rs    # Tauri commands
└── .kiro/specs/           # Project specifications

🤝 Contributing

Contributions welcome! Please read the spec documents in .kiro/specs/entropy-pass/ for implementation details.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

MIT License - see LICENSE file for details

🙏 Acknowledgments

📧 Support

For help with the app, contact kenzonight. on Discord.

If you encounter bugs, please open an issue.

Made with for password security