Wordlist Generator for Password Candidates

Overview

This Wordlist Generator is a powerful tool designed to create wordlists that can be used for password cracking and security testing. It's a versatile and customizable utility that can assist penetration testers, security professionals, and ethical hackers in their efforts to test and improve the security of various systems and applications.

Features

• Dictionary-Based Generation: Combine dictionaries and transform words to create complex candidates.
• Leet (1337) Speak: Convert characters to their leet (1337) speak equivalents for enhanced password variation.
• Prefix and Suffix: Add custom prefixes and suffixes to words, increasing password complexity.
• Case Transformation: Transform words to uppercase, lowercase, or mixed case for password diversity.
• Seamless Integration: Designed for easy integration into password-cracking tools like Hashtopolis, and more.

Usage

Installation

To install the library, use npm:

 npm install wordpolis

General Usage

Import the library into your project:

const { generateCandidates } = require('wordpolis');

Example Usage

const names = ['Alice', 'Bob'];
const specialdates = 'dd/mm/yyyy'; // Use valid date format
const sparetext = ['Petname', 'Hiking' ,'Mothers maiden name'];

const options = {
  useSpecialchars: true,
  usePermutations: false,
  isCapitalize: true,
  isAlternated: false,
  isUppercasse: false,
  isLowercasse: false,
  isSimilarVowels: false,
  isSimilarConsonant: false,
  isSimilarSpecialchars: false,
  filename: 'custom-wordlist.txt', // Optional
};

generateCandidates(names, specialdates, sparetext, options);

Usage in Angular Component

Assuming you have an Angular component where you want to use your library, you can import and use it as follows:

import { Component } from '@angular/core';
import { generateCandidates, GenerateCandidatesOptions } from 'wordpolis';

@Component({
  selector: 'app-password-generator',
  template: `
    <button (click)="generatePasswords()">Generate Passwords</button>
  `,
})
export class PasswordGeneratorComponent {

  generatePasswords() {
    const names = ['John', 'Doe'];
    const specialdates = 'dd/mm/yyyy'; // Use valid date format
    const sparetext = ['Petname', 'Hiking' ,'Mothers maiden name'];

    const options = {
      useSpecialchars: true,
      usePermutations: false,
      isCapitalize: true,
      isAlternated: false,
      isUppercasse: false,
      isLowercasse: false,
      isSimilarVowels: false,
      isSimilarConsonant: false,
      isSimilarSpecialchars: false,
      filename: 'custom-wordlist.txt', // Optional
    };

    generateCandidates(names, specialdates, sparetext, options);
  }
}

Note:

• Ensure that your Angular project is set up with the necessary TypeScript configurations.
• Make sure the library's types are correctly exported/imported.

This example assumes a simple Angular component that generates passwords when a button is clicked. If you want to see a fully integrated example go to Hashtopolis web-ui.

Options

The generateCandidates function takes the following options:

• useSpecialchars: Include special characters in generated passwords.
• usePermutations: Generate permutations of elements instead of combinations.
• isCapitalize: Capitalize the first letter of each word.
• isAlternated: Alternate the case of characters in the generated passwords.
• isUppercasse: Use uppercase letters.
• isLowercasse: Use lowercase letters.
• isSimilarVowels: Include variations with similar vowels.
• isSimilarConsonant: Include variations with similar consonants.
• isSimilarSpecialchars: Include variations with similar special characters.
• filename: Specify a custom filename for the generated wordlist (default: 'wordlist.txt').

Hints

• namehint: Guidance on how to structure names in the input array.
• specialdatehint: Guidance on formatting special dates.
• specialhint: Suggestions for the spare text array.
• filenamehint: Default filename for the generated wordlist.

Feel free to customize the options based on your library's specific functionality and user requirements. Additionally, you can provide more examples and use cases in your documentation to help users understand how to integrate and leverage your library in their projects.

Support

If you encounter any issues or have questions, please open an issue or reach out to us at [email protected].

License

This project is licensed under Creative Commons Attribution (CC BY).

Disclaimer: This tool is intended for legal and ethical use, such as security testing and penetration testing on systems and applications you have the right to assess. Unauthorized use for malicious purposes is prohibited. The creators and contributors of this tool are not responsible for any illegal or unethical activities. Always respect the law and obtain proper authorization for your actions.