README.md

   1 ## *hashcat* ##
   2
   3 **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.
   4
   5 ### License ###
   6
   7 **hashcat** is licensed under the MIT license. Refer to [docs/license.txt](docs/license.txt) for more information.
   8
   9 ### Installation ###
  10
  11 Download the [latest release](https://hashcat.net/hashcat/) 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.
  12
  13 ### Usage/Help ###
  14
  15 Please refer to the [Hashcat Wiki](https://hashcat.net/wiki/) and the output of `--help` for usage information and general help. A list of frequently asked questions may also be found [here](https://hashcat.net/wiki/doku.php?id=frequently_asked_questions). The [Hashcat Forums](https://hashcat.net/forum/) also contain a plethora of information.
  16
  17 ### Building ###
  18
  19 [![Hashcat Build status](https://travis-ci.org/hashcat/hashcat.svg?branch=master)](https://travis-ci.org/hashcat/hashcat)
  20
  21 Refer to [BUILD.md](BUILD.md) for instructions on how to build **hashcat** from source.
  22
  23 ### Contributing ###
  24
  25 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:
  26
  27 1. Licensed under MIT license, or dedicated to public domain (BSD, GPL, etc. code is incompatible)
  28 2. Adheres to either C89, C90, or C99 standards
  29 3. Compiles cleanly with no warnings when compiled with `-W -Wall -std=c99`
  30 4. Uses [Allman-style](https://en.wikipedia.org/wiki/Indent_style#Allman_style) code blocks & indentation
  31 5. Uses 2-spaces as indentation or a tab if it's required (for example: Makefiles)
  32 6. Uses lower-case function and variable names
  33 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)`)
  34 8. Use code like array[index + 0] if you also need to do array[index + 1], to keep it aligned
  35
  36 You can use GNU Indent to help assist you with the style requirements:
  37
  38 ```
  39 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
  40 ```
  41
  42 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.
  43
  44 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.
  45
  46 If your patch fixes a bug, please be sure there is an [issue](https://github.com/hashcat/hashcat/issues) 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.
  47
  48 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](https://github.com/orgs/hashcat/people) before being merged. The [project lead](https://github.com/jsteube) has the ultimate authority in deciding whether to accept or reject a pull request. Do not be discouraged if your pull request is rejected!
  49
  50 ### Happy Cracking!