1
0
mirror of https://github.com/hashcat/hashcat.git synced 2025-07-08 15:48:15 +00:00
hashcat/tools
Jens Steube d9918d7e44 Add Argon2 support for OpenCL and HIP
=====================================

This patch modifies the existing Argon2 plugin, which was initially
designed to work only with CUDA. Supporting OpenCL and HIP required
broader architectural changes.

1. The tmps[] structure no longer holds the "large buffer". This
buffer stored the scratch areas for all password candidates in one
chunk. But we do not need to hold scratch areas for all candidates
simultaneously. All we need to do is hold chunks large enough
per password.

To simplify logic, the buffer is not divided by password count, but
divided by four, which fits within the "1/4 global memory" limit on
some OpenCL runtimes.

Hashcat already had logic to support this, but the buffer needed to be
moved to a different buffer type. It has now been relocated from the
"tmp buffer" to the "extra tmp buffer", following the same strategy
used in newer SCRYPT plugins.

This improves handling across several subcomponents:

  - Hashcat backend divides into four asymmetric buffers, hence the
    name "4-buffer strategy"
  - If the candidate count isn't divisible by 4, leftover candidates are
    assigned to the first (and possibly second and third) buffer
  - No code in the plugin is required, as this was designed for exactly
    such cases where future algorithms require a lot of memory
  - Plugin was rewritten to report the size needed in
    module_extra_tmp_size(), which triggers the "4-buffer" strategy
  - The split is not even, but each part is large enough to hold
    a multiple of a full scratch buffer for a password
  - The kernel code in m34000_init/loop/comp now uses a code block
    that finds its buffer by doing "group_id % 4"
  - Prevents the need to over-allocate memory to avoid OOB access
  - The original "tmps buffer" now holds a small dummy state buffer

2. Replaced warp shuffle instruction

The instruction __shfl_sync() is not available in runtimes
other than CUDA. Some have alternatives, some do not.

To prevent branching per backend runtime, the new general macro
hc__shfl_sync() replaces all calls to __shfl_sync().
This allows us to implement runtime-specific solutions and
take effect at compile time to prevent regressions.

- CUDA:
  We simply map to the original __shfl_sync()

- HIP:
  We map to shfl(), a built-in intrinsic. This instruction doesn't
  support masks like __shfl_sync() does, but masks are not needed
  in Argon2 anyway. It requires an additional parameter, the wavefront
  size. This is natively 64, but we hardcode this to 32 so it aligns
  with NVIDIA's warp size.

- OpenCL:
  - AMD: We have access to the instruction __builtin_amdgcn_ds_bpermute().
    This instruction only supports 32-bit integers, requiring us to
    pack and unpack the 64-bit values manually
  - NVIDIA: We use inline assembly with "shfl.sync.idx.b32". Same as
    with AMD, we need to pack and unpack 32-bit integers. The 64-bit
    support in CUDA is just overloaded and internally does the same thing.
  - Others: We use a shared memory pool and combine it with a barrier.
    This LOCAL_VK pool must be sized at compile time and transported to
    the Argon2 code in "inc_hash_argon2.cl". This required changing all
    function declarations that use shuffles slightly.

Unlock full threading for init and comp kernels
===============================================

This is implemented using a new flag:
  OPTS_TYPE_THREAD_MULTI_DISABLE

Behavior is similar to:
  OPTS_TYPE_MP_MULTI_DISABLE

It simply disables the multiplier normally applied to password batch size.

But attention, this change completely unbinds this effect from the
real threads spawned on the compute device. If the thread count is not
set to 1 in the plugin, it will start autotuning it.

In the case of Argon2, we hard-code it to 32 instead, which also changes
how "warp size" was used in the original implementation, and which is not
compatible with HIP and/or OpenCL. However, we need to maintain this thread
size to utilize warp shuffle and its alternatives in other runtimes.

Benefits:

  - Enables full threading for init and comp kernels (1667 H/s to 1722 H/s)
  - Allows future algorithms to enable parallel processing of single
    password candidates, if supported

Plugin changes:

  - Removed the "hack" where thread count = 1 disabled the multiplier
  - Removed per-device warp count detection code and struct changes
  - Removed warp handling and "num_elements / thread_count" division in
    the run_kernel() function

Simplified autotune logic for Argon2
====================================

The goal is to calculate the maximum number of password candidates that
can run in parallel, constrained only by device memory.

  - Removed all code related to Argon2 from autotune
  - Implemented in "module_extra_tuningdb_block()" (like SCRYPT)
  - We create a tuningdb entry at runtime!
  - Still allows override via tuningdb or CLI
  - Considers register spilling (read at startup)
  - Prevents global-to-host memory swap performance issues

Add Argon2I and ArgonD support
==============================

The kernel prepared from NFI already had support for the different Argon
types. No change was needed.

To support the other Argon2 types, the tokenizer had to be improved to
support a variety of different signatures in the same hash-mode.

Bugfixes
========

- Fixed missing entries in "switch_buffer_by_offset_8x4_le_S()"
- Fixed benchmark hash misdetection for scrypt. This was due to
  outdated logic used in scrypt to detect whether the plugin was
  called from a benchmark session or a regular one
- Fixed a bug in "module_hash_encode()" where Base64 padding '=' was
  retained
- Fixed missing "GLOBAL_AS" / "PRIVATE_AS" casts for OpenCL
- Fixed compiler warnings (e.g., "index_u32x4()", "get_group_id()")
  by adding return values
- Fixed a bug in token.len_max[6], which was allowing decoding
  of a 256-byte data into a 16-byte buffer (digest)

Other improvements
==================

- Added unit test module for automated testing
- Added support to the tokenizer to allow multiple signatures.
  Leave out TOKEN_ATTR_FIXED_LENGTH to enable this in your plugins
- Updated "hc_umulhi()", also exists for HIP
- Renamed "gid" to "bid" when using "get_group_id()" for clarity
- Removed "#ifdef IS_CUDA" as all backends are now supported
- Removed deprecated "OPTS_TYPE_MAXIMUM_ACCEL" attribute

Performance note
================

For testing, I used the self-test hash configured according to the
RFC 9106 recommendation: m=65536, t=3, p=1.

In my benchmarks, the AMD RX 7900 XTX achieved 1401 H/s using the same
hash that was used to test NVIDIA's RTX 4090. The RTX 4090 reached
1722 H/s, making it faster in absolute terms. However, at the time of
writing, it is more than three times as expensive as the 7900 XTX.

It's also worth noting that an older NVIDIA GTX 1080 Ti still reached
565 H/s with the same test vector, and may be found at significantly
lower cost.

Across all tested Argon2 configurations, the performance gap between
the RX 7900 XTX and the RTX 4090 remained proportionally consistent,
indicating a clear linear scaling relationship between the two GPUs.
2025-07-02 11:02:57 +02:00
..
2hashcat_tests Fix some file modes 2023-09-18 07:19:23 +00:00
cl_tests cryptoapi opts (2) and test unit 2021-05-08 02:06:05 +02:00
code_generators perl scripts: add license and chmod +x 2020-06-10 12:02:33 +02:00
gpg_tests Move test scripts for 17040 to tools/gpg_tests, similar to what we do with TC/VC. 2023-07-20 20:03:58 +00:00
pdf_tests m25400 can now recover both a owner-password and user-password (when set) based on a pdf's o-value 2021-08-20 10:16:14 +02:00
protobuf Create wallet_pb2.py 2022-09-16 21:41:44 +02:00
tc_tests
test_modules Add Argon2 support for OpenCL and HIP 2025-07-02 11:02:57 +02:00
vc_tests Add some VeraCrypt boot-mode test header 2019-02-07 17:00:17 +01:00
aescrypt2hashcat.pl Fix some typos 2023-07-27 23:11:55 +07:00
benchmark_deep.pl Added 'next_power_of_two()' and moved both 'next_power_of_two()' and 'previous_power_of_two()' to 'shared.c' 2025-06-25 11:21:51 +02:00
bisq2hashcat.py Fix file permissions for bisq2hashcat.py 2023-07-13 16:32:48 +00:00
bitwarden2hashcat.py cleanup: remove spaces at the end of lines 2022-06-20 15:19:01 +02:00
cachedata2hashcat.py - Renamed shuffle() in inc_hash_scrypt.cl to avoid name collision with 2025-06-26 19:36:06 +02:00
cryptoloop2hashcat.py Memory Management: Refactored the code responsible for limiting kernel accel in order to avoid out of -host- memory situations 2021-07-28 20:50:05 +02:00
exodus2hashcat.py Tool exodus2hashcat.py code cleanup 2022-10-27 18:36:49 +02:00
install_modules.sh Added hash-mode: BestCrypt v4 Volume Encryption 2025-04-27 20:57:43 +02:00
kremlin2hashcat.py Fix some file modes 2023-09-18 07:19:23 +00:00
lastpass2hashcat.py Add lastpass2hashcat.py 2022-10-24 09:31:04 +02:00
luks2hashcat.py Extract all active keys 2022-11-02 22:02:46 +01:00
metamask2hashcat.py Update metamask2hashcat.py 2023-08-29 21:43:11 +02:00
mozilla2hashcat.py make our hash extraction scripts executable 2022-05-21 11:45:48 +02:00
package_bin.sh - Handle case where system does not offer any reliable method to query actual free memory 2025-06-10 12:54:15 +02:00
radmin3_to_hashcat.pl make radmin3_to_hashcat.pl executable 2022-06-04 11:03:03 +02:00
recursivefiles2sha256sum.pl Add XML support for keepass keyfile and improve performance by not using chdir() 2022-08-25 20:33:10 +02:00
rules-test-cases.yaml Fix some expected values from tools/rules-test-cases.yaml 2020-06-12 08:55:36 +02:00
securenotes2hashcat.pl perl scripts: add license and chmod +x 2020-06-10 12:02:33 +02:00
sqlcipher2hashcat.pl Add additional support for SQLCipher v3 and hashes SHA1 and SHA256 and a unit-test 2021-03-26 11:36:41 +01:00
test_rules.pl cosmetic: minor code style fixes 2020-06-13 11:19:00 +02:00
test.pl cleanup test.pl and implement module_get_random_password() in 31500/31600 test modules 2023-05-18 21:38:14 +02:00
test.sh Fix test.sh bugs with RC4, a6 and a7 multi 2025-05-27 18:54:35 +02:00
truecrypt2hashcat.py Tool truecrypt2hashcat.py code cleanup 2022-07-25 15:54:14 +02:00
veeamvbk2hashcat.py Added hash-mode: Veeam VBK 2023-03-01 11:35:37 +00:00
veracrypt2hashcat.py New VeraCrypt modules 2022-06-07 23:01:03 +02:00
virtualbox2hashcat.py make our hash extraction scripts executable 2022-05-21 11:45:48 +02:00
vmwarevmx2hashcat.py make our hash extraction scripts executable 2022-05-21 11:45:48 +02:00