1
0
mirror of https://github.com/hashcat/hashcat.git synced 2024-10-31 20:48:57 +00:00
Go to file
2017-02-11 13:39:03 +01:00
charsets
deps/OpenCL-Headers
docs Commandline: Do some checks related to custom-charset options if user specifies them 2017-02-10 09:08:19 +01:00
extra/tab_completion
include Add a warning message if old hccap file is detected and abort 2017-02-08 20:25:04 +01:00
masks
obj
OpenCL
rules Removed duplicate rule 'cl' & 'l' 2016-06-19 18:59:37 +03:00
src Renamed some variables which 'shadow' another variable or function 2017-02-11 12:19:34 +01:00
tools tests: added support for .hccapx to the tests 2017-02-07 19:00:36 +01:00
.appveyor.yml cleaned up the .appveyor.yml file and implemented the test_script(s) #1032 2017-02-10 14:02:43 +01:00
.editorconfig Add an .editorconfig file enforcing some of the code style. See 2015-12-10 17:11:36 +01:00
.gitattributes
.gitignore
.gitmodules
.travis.yml travis: a special case for sed on OSX is needed 2017-02-11 13:39:03 +01:00
BUILD.md cleanup git submodule command 2017-02-09 15:17:09 -08:00
example0.cmd
example0.hash
example0.sh
example400.cmd
example400.hash
example400.sh
example500.cmd
example500.hash
example500.sh
example.dict
hashcat.hcstat
hashcat.hctune
Makefile Initial commit 2015-12-04 15:47:52 +01:00
README.md readme: added appveyor badges to README.md 2017-02-10 13:58:10 +01:00

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 and other hardware-accelerators on Linux, Windows and OSX, and has facilities to help enable distributed password cracking.

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.

Tests:

Travis Appveyor
Hashcat Travis Build status Hashcat Appveyor Build status

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:

  1. Licensed under MIT license, or dedicated to public domain (BSD, GPL, etc. code is incompatible)
  2. Adheres to either C89, C90, or C99 standards
  3. Compiles cleanly with no warnings when compiled with -W -Wall -std=c99
  4. Uses Allman-style code blocks & indentation
  5. Uses 2-spaces as indentation or a tab if it's required (for example: Makefiles)
  6. Uses lower-case function and variable names
  7. Avoids the use of ! and uses positive conditionals wherever possible (e.g., if (foo == 0) instead of if (!foo), and if (foo) instead of if (foo !=0))
  8. 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!

Happy Cracking!