= cryptsetup-benchmark(8)
:doctype: manpage
:manmanual: Maintenance Commands
:mansource: cryptsetup {release-version}
:man-linkstyle: pass:[blue R < >]
:COMMON_OPTIONS:
:ACTION_BENCHMARK:

== Name

cryptsetup-benchmark - benchmarks ciphers and KDF

== SYNOPSIS

*cryptsetup _benchmark_ [<options>]*

== DESCRIPTION

Benchmarks, ciphers and KDF (key derivation function).
Without parameters, it tries to measure a few common configurations.

To benchmark other ciphers or modes, specify --cipher and --key-size options.

To benchmark PBKDF you need to specify --pbkdf or --hash with optional cost parameters --iter-time, --pbkdf-memory or --pbkdf-parallel.

This benchmark uses memory only and is only informative.
You cannot directly predict real storage encryption speed from it.

For testing block ciphers, this benchmark requires the kernel userspace crypto API to be available (introduced in Linux kernel 2.6.38).
If you are configuring the kernel yourself, enable "User-space interface for symmetric key cipher algorithms" in "Cryptographic API" section (CRYPTO_USER_API_SKCIPHER .config option).

*<options>* can be [--cipher, --key-size, --hash, --pbkdf, --iter-time, --pbkdf-memory, --pbkdf-parallel].

include::man/common_options.adoc[]
include::man/common_footer.adoc[]
