1
0
mirror of https://github.com/hashcat/hashcat.git synced 2025-07-19 13:08:19 +00:00
Go to file
Jens Steube ed10e6a913 Autotune and Benchmark refactoring
This change affects three key areas, each improving autotuning:

- Autotune refactoring itself

The main autotune algorithm had become too complex to maintain and has
now been rewritten from scratch. The engine is now closer to the old
v6.0.0 version, using a much more straightforward approach.

Additionally, the backend is now informed when the autotune engine runs
its operations and runs an extra invisible kernel invocation. This
significantly improves runtime accuracy because the same caching
mechanisms which kick in normal cracking sessions now also apply during
autotuning. This leads to more consistent and reliable automatic
workload tuning.

- Benchmarking and '--speed-only' accuracy bugs fixed

Benchmark runtimes had become too short, especially since the default
benchmark mask changed from '?b?b?b?b?b?b?b' to '?a?a?a?a?a?a?a?a'. For
very fast hashes like NTLM, benchmarks often stopped immediately when
base words needed to be regenerated, producing highly inaccurate
results.

This issue also misled users tuning '-n' values, as manually
oversubscribing kernels could mask the problem, creating the impression
that increasing '-n' had a larger impact on performance than it truly
does. While '-n' still has an effect, it’s not as significant. With this
fix, users achieve the same speed without needing to tune '-n' manually.

The bug was fixed by enforcing a minimum benchmark runtime of 4 seconds,
regardless of kernel runtime or kernel type. This ensures more stable
and realistic benchmark results, but typically increasing the benchmark
duration by up to 4 seconds.

- Kernel-Threads set to 32 and plugin configuration cleanup

Some plugin configurations existed solely to work around the old
benchmarking bug and can now be removed. For example,
'OPTS_TYPE_MAXIMUM_THREADS' is no longer required and has been removed
from all plugins, although the parameter itself remains to avoid
breaking custom plugins.

Because increasing threads beyond 32 no longer offers meaningful
performance gains, the default is now capped at 32 (unless overridden
with '-T'). This simplifies GPU memory management. Currently, work-item
counts are indirectly limited by buffer sizes (e.g., 'pws_buf[]'), which
must not exceed 4 GiB (a hard-coded limit). This buffer size depends on
the product of 'kernel-accel', 'kernel-threads', and the device’s
compute units. By reducing the default threads from 1024 to 32, there is
now more space available for base words.
2025-06-22 20:17:52 +02:00
.github The Assimilation Bridge (Python plugins -m 72000 and -m 73000) 2025-06-02 10:15:34 +02:00
bridges The Assimilation Bridge (Framework) 2025-05-29 15:38:13 +02:00
charsets Added full charset for romanian language 2023-07-26 10:13:18 +03:00
deps - Replace naive 32 bit rotate with funnelshift on CUDA/HIP 2025-06-02 11:50:08 +02:00
docker - Add CPU SIMD detection at runtime, relevant for bridge plugins 2025-06-04 10:09:44 +02:00
docs Merge pull request #4256 from DhruvTheDev1/patch-1 2025-06-20 14:54:26 +02:00
extra/tab_completion Added option --backend-devices-keepfree to configure X percentage of device memory available to keep free 2025-06-04 10:13:29 +02:00
include Autotune and Benchmark refactoring 2025-06-22 20:17:52 +02:00
layouts Create da.hckmap 2023-06-28 11:23:39 +02:00
masks add hashcat's default mask for external use 2020-05-23 12:35:41 -08:00
modules The Assimilation Bridge (Framework) 2025-05-29 15:38:13 +02:00
obj The Assimilation Bridge (Framework) 2025-05-29 15:38:13 +02:00
OpenCL Further simplified the use of inc_hash_scrypt.cl without any speed regression, and updated all affected plugin kernels. Use m08900-pure.cl as a template. 2025-06-21 17:41:26 +02:00
Python Refactor Python bridge to load source files as scripts instead of modules. 2025-06-18 20:16:08 +02:00
rules Optimized old "dive.rule" with ruleprocessorY 2023-10-12 11:07:26 +03:00
src Autotune and Benchmark refactoring 2025-06-22 20:17:52 +02:00
tools Removed shared-memory based optimization for SCRYPT on HIP, because the shared-memory buffer is incompatible with TMTO, which is limiting SCRYPT-R to a maximum of 8. This change also simplifies the code, allowing removal of large sections of duplicated code. Removed the section in scrypt_module_extra_tuningdb_block() that increased TMTO when there was insufficient shared memory, as this is no longer applicable. 2025-06-21 07:09:20 +02:00
tunings Improvements to SCRYPT autotuning strategy 2025-06-09 11:02:34 +02:00
.appveyor.yml.old Test disable Appveyor 2022-12-30 18:45:40 +00:00
.editorconfig Fix .editorconfig suggested in #3675 2023-04-10 17:23:29 +00:00
.gitattributes Prevent the git autocrlf option from messing files 2023-09-27 20:53:36 -07:00
.gitignore add .so/.dll from bridges directory in .gitignore 2025-06-07 22:52:11 +02:00
.travis.yml add missing OpenCL path 2019-07-01 17:29:57 +02:00
BUILD_CYGWIN.md update BUILD_CYGWIN: add python3.12 to dependencies 2025-06-08 17:08:11 +02:00
BUILD_Docker.md Add build Dockerfiles for binary compilation. 2025-05-30 07:37:19 +02:00
BUILD_macOS.md - Remove old iconv patches (replaced by cmake) 2025-06-05 06:56:38 +02:00
BUILD_MSYS2.md update BUILD_MSYS2: add python3 to dependencies 2025-06-08 14:10:22 +02:00
BUILD_WSL.md - Remove old iconv patches (replaced by cmake) 2025-06-05 06:56:38 +02:00
BUILD.md Update BUILD.md 2025-06-07 13:21:31 +02:00
example0.cmd Fix CRLF for windows scripts 2023-09-25 16:57:01 +00:00
example0.hash Prepare to rename project into hashcat 2016-05-10 19:07:07 +02:00
example0.sh fix example0*, skip autodetect if keyspace enabled, update help and changes.txt 2021-06-06 15:48:04 +02:00
example400.cmd Fix CRLF for windows scripts 2023-09-25 16:57:01 +00:00
example400.hash Prepare to rename project into hashcat 2016-05-10 19:07:07 +02:00
example400.sh Fix sed call in Makefile 2016-06-11 11:39:49 +02:00
example500.cmd Fix CRLF for windows scripts 2023-09-25 16:57:01 +00:00
example500.hash Prepare to rename project into hashcat 2016-05-10 19:07:07 +02:00
example500.sh Fix sed call in Makefile 2016-06-11 11:39:49 +02:00
example.dict Removed duplicated words in example.dict 2018-08-20 11:58:21 +02:00
hashcat.hcstat2 LZMA compress version of hashcat.hcstat2 2017-06-23 14:37:45 +02:00
Makefile Initial commit 2015-12-04 15:47:52 +01:00
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!