Screenshots

Add screenshots or GIFs here to illustrate the UI and workflow.

Java Engine (Integration & CLI)

1. Compile the Java sources (JDK 8+ required):

   javac *.java
   

2. Run the demo CLI (optional):

   java PasswordAnalysisEngine
   

   This will analyze sample passwords and print reports to the console.
3. Integrate in your Java project:
   • Import the relevant classes (PasswordAnalysisEngine, PasswordPatternChecker, etc.).
   • Use the API to analyze passwords and retrieve findings, risk scores, and recommendations.

Example (Java)

PasswordAnalysisEngine engine = new PasswordAnalysisEngine();
PasswordAnalysisEngine.AnalysisOptions opts = PasswordAnalysisEngine.AnalysisOptions.defaults().withCompany("Acme Corp, 2010, tech");
PasswordAnalysisEngine.AnalysisResult result = engine.analyze("Password123!", "j.doe", "Finance", opts);
System.out.println(result.toReport());

🛠️ Troubleshooting & FAQ

Q: The web app doesn't load or analyze passwords.

• Make sure you are opening LeakHunter.html with a modern browser.
• If you see CORS or file access errors, try using "Open with" and select your browser directly.

Q: Can I use LeakHunter on mobile?

• The UI is responsive, but best experience is on desktop.

Q: Are my passwords sent anywhere?

• No. All analysis is performed locally in your browser or Java process. Nothing is sent or stored externally.

Q: How do I add new pattern checkers?

• Implement the PasswordPatternChecker interface in Java and register your checker in the engine.

Q: Can I use this for compliance or audits?

• Yes, LeakHunter is suitable for internal audits, awareness training, and compliance reporting.

🌐 Useful Links

• Official OWASP Passwords Cheat Sheet
• NIST SP 800-63B Guidelines
• Have I Been Pwned?

💡 Example Usage

Web

No installation required. Just open the HTML file in your browser.

Java

PasswordAnalysisEngine engine = new PasswordAnalysisEngine();
List<Finding> findings = engine.analyze("Password123!", "j.doe", "Acme Corp");
for (Finding f : findings) {
    System.out.println(f);
}

⚙️ Requirements

• Web: Any modern browser (Chrome, Firefox, Edge, Safari)
• Java: JDK 8+ (JDK 26 included for reference)

🔒 Security & Privacy

• All analysis is performed locally in the browser or Java process.
• No passwords are sent or stored anywhere.

📄 License

MIT License. See LICENSE file if present.

👤 Authors

• Developed by Eliad and contributors.

For questions, suggestions, or contributions, open an issue or pull request.