man/cryptsetup-benchmark.8.adoc

   1 = cryptsetup-benchmark(8)
   2 :doctype: manpage
   3 :manmanual: Maintenance Commands
   4 :mansource: cryptsetup {release-version}
   5 :man-linkstyle: pass:[blue R < >]
   6 :COMMON_OPTIONS:
   7 :ACTION_BENCHMARK:
   8
   9 == Name
  10
  11 cryptsetup-benchmark - benchmarks ciphers and KDF
  12
  13 == SYNOPSIS
  14
  15 *cryptsetup _benchmark_ [<options>]*
  16
  17 == DESCRIPTION
  18
  19 Benchmarks ciphers and KDF (key derivation function). Without
  20 parameters, it tries to measure few common configurations.
  21
  22 To benchmark other ciphers or modes, you need to specify *--cipher* and
  23 *--key-size* options.
  24
  25 To benchmark PBKDF you need to specify *--pbkdf* or *--hash* with optional
  26 cost parameters *--iter-time*, *--pbkdf-memory* or *--pbkdf-parallel*.
  27
  28 *NOTE:* This benchmark uses memory only and is only informative. You
  29 cannot directly predict real storage encryption speed from it.
  30
  31 For testing block ciphers, this benchmark requires kernel userspace
  32 crypto API to be available (introduced in Linux kernel 2.6.38). If you
  33 are configuring kernel yourself, enable "User-space interface for
  34 symmetric key cipher algorithms" in "Cryptographic API" section
  35 (CRYPTO_USER_API_SKCIPHER .config option).
  36
  37 *<options>* can be [--cipher, --key-size, --hash, --pbkdf, --iter-time,
  38 --pbkdf-memory, --pbkdf-parallel].
  39
  40 include::man/common_options.adoc[]
  41 include::man/common_footer.adoc[]