1
0
mirror of https://github.com/hashcat/hashcat.git synced 2024-11-05 06:58:56 +00:00
Go to file
2023-06-10 19:01:35 +00:00
.github
charsets
deps
docs Merge pull request #3758 from matrix/fix_scrypt_AppleMetal 2023-06-11 23:18:10 +02:00
extra/tab_completion
include using hc_IOMasterPortDefault instead of kIOMasterPortDefault/kIOMainPortDefault 2023-06-03 22:36:40 +02:00
layouts
masks add hashcat's default mask for external use 2020-05-23 12:35:41 -08:00
modules
obj
OpenCL Fix vector datatypes usage for HIP 2023-06-10 19:01:35 +00:00
rules New rule file designed to act as a base for usage in a rule stacking runs 2023-04-14 12:11:24 +00:00
src Merge pull request #3756 from matrix/fix_sprintf_warnings_v2 2023-06-11 00:51:43 +02:00
tools Merge pull request #3753 from matrix/algo_empireCMS_AdminPassword 2023-06-08 12:47:14 +02:00
tunings
.appveyor.yml.old
.editorconfig Fix .editorconfig suggested in #3675 2023-04-10 17:23:29 +00:00
.gitattributes fallback for Makefile version if its not a git checkout (tarball) (refix) 2016-05-19 14:03:58 +02:00
.gitignore
.travis.yml add missing OpenCL path 2019-07-01 17:29:57 +02:00
BUILD_CYGWIN.md Update tested windows version and add missing package 2021-05-07 09:53:51 +02:00
BUILD_macOS.md Support building windows binaries on macOS using MinGW, updated documentation 2023-05-28 21:21:20 +02:00
BUILD_MSYS2.md Update tested windows version 2021-05-07 09:55:48 +02:00
BUILD_WSL.md Add note about tested WSL2 configuration 2021-03-29 17:43:43 +02:00
BUILD.md
example0.cmd
example0.hash
example0.sh fix example0*, skip autodetect if keyspace enabled, update help and changes.txt 2021-06-06 15:48:04 +02:00
example400.cmd
example400.hash
example400.sh
example500.cmd
example500.hash
example500.sh
example.dict
hashcat.hcstat2
Makefile
README.md Remove Appveyor status from README.md 2023-01-02 17:13:45 +00: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. If you still think you need help by a real human come to Discord.

Building

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

Tests:

Travis Coverity GitHub Actions
Hashcat Travis Build status Coverity Scan Build Status Hashcat GitHub Actions 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!