3828ea354c
This makes use of git export-subst to insert the current ref names.
If git describe fails because because an extracted tarball is used
to build from source then the fallback will get called and the last
part of the ref names will be used for the version variable.
if it is a git checkout and HEAD is the current tag:
v3.00-beta
If it is a git checkout and HEAD is ahead of the latest tag:
v3.00-beta-36-g24a6095
If it is a tarball from a tag created via 'git archive HEAD --format=tar':
v3.00-beta
If it is a tarball from the master created via 'git archive HEAD --format=tar':
master
NOTE: If a tarball is manually created (without git archive) then the
version will "$Format:%D$", however before this commit it would not be
possible to build a release tarball at all (because git describe would fail)
Tarballs that you manually want to distribute on your website need to be either
downloaded from github and re-uploaded or need to be create via git-archive:
gzip:
git archive --format=tar HEAD|gzip > oclHashcat.tar.gz
bzip2:
git archive --format=tar HEAD|bzip2 > oclHashcat.tar.bz2
You can also use a tag for git archive like:
git archive --format=tar v2.01|bzip2 > oclHashcat-2.01.tar.bz2
|
||
|---|---|---|
| OpenCL | ||
| charsets | ||
| docs | ||
| extra/tab_completion | ||
| include | ||
| masks | ||
| obj | ||
| rules | ||
| src | ||
| tools | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| BUILD.md | ||
| Makefile | ||
| README.md | ||
| example.dict | ||
| example0.cmd | ||
| example0.hash | ||
| example0.sh | ||
| example400.cmd | ||
| example400.hash | ||
| example400.sh | ||
| example500.cmd | ||
| example500.hash | ||
| example500.sh | ||
| hashcat.hcstat | ||
| hashcat.hctune | ||
README.md
hashcat
hashcat is the world's fastest and most advanced password recovery utility, supporting five unique modes of attack for over 160 highly-optimized hashing algorithms. hashcat currently supports CPU's, GPU's other hardware-accelerators on Linux, Windows and OSX, and has facilities to help enable distributed password cracking.
** THE VERSION 3.00 IS CURRENTLY STILL IN BETA **
License
hashcat is licensed under the MIT license. Refer to docs/license.txt for more information.
Installation
Download the latest release and unpack it in the desired location. Please remember to use 7z x when unpacking the archive from the command line to ensure full file paths remain intact.
Usage/Help
Please refer to the Hashcat Wiki and the output of --help for usage information and general help. A list of frequently asked questions may also be found here. The Hashcat Forums also contain a plethora of information.
Building
Refer to BUILD.md for instructions on how to build hashcat from source.
Contributing
Contributions are welcome and encouraged, provided your code is of sufficient quality. Before submitting a pull request, please ensure your code adheres to the following requirements:
- Licensed under MIT license, or dedicated to public domain (BSD, GPL, etc. code is incompatible)
- Adheres to either C89, C90, or C99 standards
- Compiles cleanly with no warnings when compiled with
-W -Wall -std=c99 - Uses Allman-style code blocks & indentation
- Uses 2-spaces as indentation or a tab if it's required (for example: Makefiles)
- Uses lower-case function and variable names
- Avoids the use of
!and uses positive conditionals wherever possible (e.g.,if (foo == 0)instead ofif (!foo), andif (foo)instead ofif (foo !=0)) - Use code like array[index + 0] if you also need to do array[index + 1], to keep it aligned
You can use GNU Indent to help assist you with the style requirements:
indent -st -bad -bap -sc -bl -bli0 -ncdw -nce -cli0 -cbi0 -pcs -cs -npsl -bs -nbc -bls -blf -lp -i2 -ts2 -nut -l1024 -nbbo -fca -lc1024 -fc1
Your pull request should fully describe the functionality you are adding/removing or the problem you are solving. Regardless of whether your patch modifies one line or one thousand lines, you must describe what has prompted and/or motivated the change.
Solve only one problem in each pull request. If you're fixing a bug and adding a new feature, you need to make two separate pull requests. If you're fixing three bugs, you need to make three separate pull requests. If you're adding four new features, you need to make four separate pull requests. So on, and so forth.
If your patch fixes a bug, please be sure there is an issue open for the bug before submitting a pull request. If your patch aims to improve performance or optimizes an algorithm, be sure to quantify your optimizations and document the trade-offs, and back up your claims with benchmarks and metrics.
In order to maintain the quality and integrity of the hashcat source tree, all pull requests must be reviewed and signed off by at least two board members before being merged. The project lead has the ultimate authority in deciding whether to accept or reject a pull request. Do not be discouraged if your pull request is rejected!