A high-performance, multi-threaded rule processor for wordlists. procrule
applies hashcat/JtR-compatible rules to wordlists, generating candidate
passwords or matching against known targets. Only candidates that differ
from the original input word are emitted — if a rule produces no change
(e.g., l applied to an already-lowercase word), the word is suppressed.
- Multi-threaded rule application with configurable thread count
- Supports multiple rule files in a single invocation
- Match mode: compare generated candidates against a target word list
- Automatic deduplication of output via Bloom filter and Judy arrays
- Handles
$HEX[]encoded words transparently - Base64 conversion support via rules
- Rule match statistics and per-rule hit tracking
- Benchmark mode for measuring rule processing throughput
- Streaming I/O — reads wordlists in chunks for constant memory usage
- Supports stdin/stdout as input/output
Requires Judy arrays library
(libJudy-dev on Debian/Ubuntu, judy via MacPorts or Homebrew).
make
procrule [options] wordlist
| Option | Description |
|---|---|
-r file |
Rule file to apply (may be specified multiple times) |
-m file |
Match file — only output candidates found in this file (may be specified multiple times) |
-o file |
Redirect output to file (default: stdout) |
-l file |
Line match log: writes word:rule:candidate for each match |
-s file |
Output rule match statistics to file |
-t num |
Maximum number of threads |
-M size |
Set memory cache size (supports K/M/G suffixes) |
-p num |
Set hash prime for deduplication |
-B count |
Benchmark mode — apply rules N times and report throughput |
-x |
Disable $HEX[] encoding on output |
-v |
Verbose mode (repeat for more detail) |
Generate all candidates from a wordlist with a rule file (only words actually changed by a rule appear in the output):
procrule -r rules.txt wordlist.txt > candidates.txt
Find which words in a wordlist can produce known passwords:
procrule -r rules.txt -m passwords.txt wordlist.txt
Apply multiple rule files with match logging:
procrule -r best64.rule -r toggles.rule -m targets.txt -l matches.log wordlist.txt
Benchmark rule processing throughput:
procrule -r rules.txt -B 100 wordlist.txt
procrule implements hashcat/JtR-compatible rules. Positions are encoded as
0–9 for 0–9 and A–Z for 10–35.
| Rule | Description |
|---|---|
l |
Lowercase all characters |
u |
Uppercase all characters |
c |
Capitalize first letter, lowercase rest |
C |
Lowercase first letter, uppercase rest |
t |
Toggle case of all characters |
TN |
Toggle case at position N |
E |
Title case (capitalize after each space) |
eX |
Title case with custom separator X |
| Rule | Description |
|---|---|
$X |
Append character X |
^X |
Prepend character X |
[ |
Delete first character |
] |
Delete last character |
DN |
Delete character at position N |
iNX |
Insert character X at position N |
oNX |
Overwrite character at position N with X |
'N |
Truncate word at length N |
xNM |
Extract M characters starting at position N |
ONM |
Delete M characters starting at position N |
| Rule | Description |
|---|---|
d |
Duplicate entire word (pass → passpass) |
f |
Reflect — append reversed copy (abc → abccba) |
pN |
Append duplicated word N times |
q |
Duplicate every character (abc → aabbcc) |
zN |
Duplicate first character N times |
ZN |
Duplicate last character N times |
yN |
Duplicate first N characters, prepend them |
YN |
Duplicate last N characters, append them |
| Rule | Description |
|---|---|
r |
Reverse the word |
{ |
Rotate left — move first character to end |
} |
Rotate right — move last character to front |
k |
Swap first two characters |
K |
Swap last two characters |
*NM |
Swap characters at positions N and M |
| Rule | Description |
|---|---|
sXY |
Replace all occurrences of X with Y |
@X |
Purge — remove all occurrences of X |
+N |
Increment ASCII value at position N |
-N |
Decrement ASCII value at position N |
.N |
Replace character at N with character at N+1 |
,N |
Replace character at N with character at N-1 |
LN |
Bit-shift left character at position N |
RN |
Bit-shift right character at position N |
vNX |
Insert character X every N characters |
| Rule | Description |
|---|---|
Ctrl-B (\x02) |
Base64 encode the word |
h |
Hex-encode each byte (lowercase) |
H |
Hex-encode each byte (uppercase) |
| Rule | Description |
|---|---|
M |
Memorize current word state |
4 |
Append memorized word |
6 |
Prepend memorized word |
Q |
Reject word if it equals the memorized word |
XNMI |
Insert M characters from memorized word at offset N, at position I |
| Rule | Description |
|---|---|
<N |
Reject if word length is less than N |
>N |
Reject if word length is greater than N |
_N |
Reject unless original word length equals N |
!X |
Reject if word contains character X |
/X |
Reject if word does not contain character X |
(X |
Reject if first character is not X |
)X |
Reject if last character is not X |
: |
No-op — pass word through unchanged |
# |
Stop processing remaining rules for this word |
procrule supports a base64 encoding rule via the Control-B (0x02)
character. When this rule is encountered, the current candidate is
base64-encoded in place. To create a rule file that base64-encodes
every word, write a single Control-B as the rule:
printf '\x02\n' > b64.rule
procrule -r b64.rule wordlist.txt
password → cGFzc3dvcmQ=
hello → aGVsbG8=
This can be combined with other rules. For example, to append "123" and then base64-encode the result:
printf '$1$2$3\x02\n' > append123-b64.rule
procrule -r append123-b64.rule wordlist.txt
password → cGFzc3dvcmQxMjM=
hello → aGVsbG8xMjM=
To base64-encode and strip the trailing = padding, combine Control-B
with the @= purge rule:
printf '\x02@=\n' > b64-nopad.rule
procrule -r b64-nopad.rule wordlist.txt
password → cGFzc3dvcmQ
hello → aGVsbG8
Benchmarks were run using the hashcat best64.rule ruleset (77 active rules)
against a 29,012,354-line wordlist (304 MB), producing 2,141,402,915 deduplicated
candidates. Output was redirected to /dev/null to measure pure rule-processing
and deduplication throughput independent of downstream I/O.
| System | CPU | Cores / Threads | RAM |
|---|---|---|---|
| macOS (arm64) | Apple M1 | 8 / 8 | 8 GB |
| Linux (x86_64) | AMD Ryzen 7 1800X | 8 / 16 | 32 GB |
| Linux (x86_64) | 2x Intel Xeon E5-2697 v4 @ 2.30 GHz | 36 / 72 | 992 GB |
| Linux (ppc64le) | IBM POWER8 | 80 / 80 | 128 GB |
procrule -r best64.rule 29m.pass > /dev/null
| System | Wall Time | User Time | Sys Time | Peak RSS | Candidates/sec |
|---|---|---|---|---|---|
| Apple M1 (8 cores) | 49.5 s | 225.4 s | 106.4 s | 1,171 MB | 43.3 M/s |
| AMD Ryzen 7 1800X (16 threads) | 48.7 s | 728.5 s | 2.5 s | 1,172 MB | 44.0 M/s |
| 2x Xeon E5-2697 v4 (72 threads) | 45.6 s | 418.8 s | 43.2 s | 1,203 MB | 46.9 M/s |
| IBM POWER8 (80 cores) | 23.2 s | 1,489.9 s | 10.3 s | 1,201 MB | 92.5 M/s |
Memory usage is dominated by the Bloom filter and Judy deduplication structures, which scale with the number of unique input words rather than the rule count. All four systems used approximately 1.2 GB peak RSS for the 29M-word input.
The M1's elevated system time reflects memory pressure on an 8 GB system with a 1.2 GB working set.
| File | Description |
|---|---|
procrule.c |
Main program — I/O, threading, match/dedup logic |
ruleproc.c |
Rule parsing and application engine (shared with mdxfind) |
mdxfind.h |
Shared header for ruleproc |
yarn.c / yarn.h |
Thread pool library (shared with rling) |
xxh3.h / xxhash.h |
xxHash — fast non-cryptographic hash (header-only) |
Copyright (c) Waffle — Cynosureprime