rulecat

README

Rulecat is a multi-tool for working with text streams for password cracking.

Rulecat (cat rule) focuses on the conversion of text to rules or specialized output and features several functions:

• Creates append rules from stdin
• Creates prepend rules from stdin
• Creates blank lines from stdin
• Create the cartesian product of a file and stdin
• Creates custom rules per character from stdin
• Creates insert rules from stdin
• Creates overwrite rules from stdin
• Creates toggle rules from stdin
• Creates URL, HTML, & Unicode escape encoded text from stdin
• Creates combinations of multiple modes to create unique rules from stdin

Rulecat fits into a small tool ecosystem for password cracking and is designed for lightweight and easy usage with its companion tools:

• maskcat
• rulecat

Getting Started

Usage information and other documentation can be found below:

• Usage documentation:
  • Append and Prepend Rules
  • Insert and Overwrite Rules
  • Toggle and Character to Rules
  • Cartesian Product and Combo Rules
  • Blank Lines and Encoding Text

Install from Go

go install github.com/jakewnuk/rulecat@latest

go install github.com/jakewnuk/rulecat@v1.5.0

Install from Source

git clone https://github.com/JakeWnuk/rulecat && cd rulecat && go build ./main.go && mv ./main ~/go/bin/rulecat

Current Version 1.5.0:

Modes for rulecat (version 1.5.0):

  append        Creates append rules from text
                Example: stdin | rulecat append
                Example: stdin | rulecat append remove
                Example: stdin | rulecat append shift

  prepend       Creates prepend rules from text
                Example: stdin | rulecat prepend
                Example: stdin | rulecat prepend remove
                Example: stdin | rulecat prepend shift

  blank         Creates blank lines from text
                Example: stdin | rulecat blank

  [RULE-FILE]   Create cartesian product of a file and text
                Example: stdin | rulecat [FILE]

  chars         Creates custom rules per character from text
                Example: stdin | rulecat chars [RULE]

  insert        Creates insert rules from from text
                Example: stdin | rulecat insert [START-INDEX]

  overwrite     Creates overwrite rules from from text
                Example: stdin | rulecat overwrite [START-INDEX]

  toggle        Creates toggle rules from from text
                Example: stdin | rulecat toggle [START-INDEX]

  encode        URL, HTML, and Unicode escape encodes input and prints new output
                Example: stdin | rulecat encode

  combo         Combines multiple modes into one rule per line (toggle, prepend, append, insert)
                Example: stdin | rulecat combo [MODE-A] [MODE-B]

Documentation

Overview

Package that contains the primary logic for rulecat and the CLI