Add some less brief tips'n'tricks to eg. doc/TRICKS
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C
- Stars
- 13.6k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/openwall/john/issues/4403#issuecomment-706755482
This file would be for tips'n'tricks regarding actual use of Jumbo, as opposed to building it etc.
Candidates for this doc file (please fill in! Just amend this post if you've got the privileges):
- Using FIFOs: Pros, cons, caveats.
- Piping
john -stdout | john -stdin. Why, when? - Advanced use of
--formatoption (https://github.com/openwall/john/pull/4395#issuecomment-703144071). - Advanced use of
--saltoption (also mentionNoLoaderDupeCheckwhich might be relevant for that situation). - Advanced use of
--singlemode (many sparsely documented options available). - There might be some other good tricks mentioned in #1706 or linked from it (the context at the time was trying to handle the Ashley Madison leak, a hefty number of super slow and correctly salted hashes).
- Perhaps some stuff from the Openwall wiki.
- Introduce
pass_gen.plfor creating datasets for testing. - Difference (in order) between eg.
?dand[0-9]in masks.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with doc/TRICKS and review the linked discussion in #4403, plus the candidates from #1706, the Openwall wiki, and PR #4395. Select and document practical Jumbo usage tips such as FIFOs, piping, advanced options, pass_gen.pl, and mask syntax, with the completed document covering the agreed topics.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100