1
0
mirror of https://github.com/hashcat/hashcat.git synced 2024-11-05 23:10:00 +00:00
Go to file
Jens Steube aff5a25f32
Merge pull request #2557 from philsmd/license_libs_miniz
add miniz license terms to docs/license_libs too
2020-09-28 10:18:43 +02:00
charsets hcchr: rename some .charset files into .hcchr files 2020-07-26 18:07:27 +02:00
deps No need for this (object) reference in -m 23800 2020-09-11 10:12:02 +02:00
docs add miniz license terms to docs/license_libs too 2020-09-26 16:29:13 +02:00
extra/tab_completion hashcat 6.1.1 2020-07-29 12:16:53 +02:00
include Display possible NVIDIA CUDA/RTC library loading error message only in case a NVIDIA device was found using OpenCL 2020-09-06 13:29:32 +02:00
layouts
masks
modules
obj
OpenCL minor: use correct buffer size for AES decryption 2020-09-26 16:13:52 +02:00
rules
src Merge pull request #2548 from philsmd/7z_hook_init_term 2020-09-22 10:43:45 +02:00
tools use unix2dos also for libs licenses in the package script 2020-09-26 16:24:49 +02:00
.appveyor.yml fixes #2516: MSYS2/Appveyor building problem fixed 2020-08-15 17:32:17 +02:00
.editorconfig
.gitattributes
.gitignore
.travis.yml
BUILD_CYGWIN.md Link BUILD_CYGWIN.md in BUILD.md 2019-03-29 19:23:41 +01:00
BUILD_MSYS2.md
BUILD_WSL.md
BUILD.md added WSL build documentation 2020-05-27 21:15:36 +02:00
example0.cmd
example0.hash Prepare to rename project into hashcat 2016-05-10 19:07:07 +02:00
example0.sh
example400.cmd
example400.hash
example400.sh
example500.cmd
example500.hash
example500.sh
example.dict
hashcat.hcstat2
hashcat.hctune
Makefile
README.md update number of supported hash types in README 2020-02-18 10:40:00 +01:00

hashcat

hashcat is the world's fastest and most advanced password recovery utility, supporting five unique modes of attack for over 300 highly-optimized hashing algorithms. hashcat currently supports CPUs, GPUs, and other hardware accelerators on Linux, Windows, and macOS, 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 Forum also contains a plethora of information.

Building

Refer to BUILD.md for instructions on how to build hashcat from source.

Tests:

Travis Appveyor Coverity
Hashcat Travis Build status Hashcat Appveyor Build status Coverity Scan 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 the public domain (BSD, GPL, etc. code is incompatible)
  2. Adheres to gnu99 standard
  3. Compiles cleanly with no warnings when compiled with -W -Wall -std=gnu99
  4. Uses Allman-style code blocks & indentation
  5. Uses 2-spaces as the 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 optimize 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!