openwall / openwall/john

work or documentation changes needed for rule eX and e?C

Open
#3,708 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation notes/external issues portability regression
Dominant language
C
Stars
13.6k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

This follows along with https://github.com/hashcat/hashcat/issues/1970

Right now, there is some ambiguity on things, which have caused the 2 projects to return different values for the eX rule (HC does not have the e?C rule as it does not do classes).

At a minimum, we should document FULLY exactly how these rules work. We may need to change some code in rules, IF the user base expects certain behaviors.

FOR NOW, lets hold off on this, and see just where the logic is expected to go. Once that is finalized, then we can document EXACTLY what is to be expected, and if there are any changes needed to the rules.c, make them. It should hopefully be trivial changes. The CLASS macro suite has the framework done. We just have to get the 'true' and 'false' parts being passed into the macro working the way people expect the logic to be.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the linked issue 1970 first, then inspect rules.c and the existing CLASS macro suite. The expected true and false behavior for the eX and e?C rules still needs to be finalized before implementation. Done means the behavior is agreed, documented fully, and any required rules.c changes are identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
security
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.