man/cryptsetup-luksConvertKey.8.adoc

   1 = cryptsetup-luksConvertKey(8)
   2 :doctype: manpage
   3 :manmanual: Maintenance Commands
   4 :mansource: cryptsetup {release-version}
   5 :man-linkstyle: pass:[blue R < >]
   6 :COMMON_OPTIONS:
   7 :ACTION_LUKSCONVERTKEY:
   8
   9 == Name
  10
  11 cryptsetup-luksConvertKey - converts an existing LUKS2 keyslot to new PBKDF parameters
  12
  13 == SYNOPSIS
  14
  15 *cryptsetup _luksConvertKey_ [<options>] <device>*
  16
  17 == DESCRIPTION
  18
  19 Converts an existing LUKS2 keyslot to new PBKDF parameters. The
  20 passphrase for keyslot to be converted must be supplied interactively or
  21 via --key-file. If no --pbkdf parameters are specified LUKS2 default
  22 PBKDF values will apply.
  23
  24 If a keyslot is specified (via --key-slot), the passphrase for that
  25 keyslot must be given. If no keyslot is specified and there is still a
  26 free keyslot, then the new parameters will be put into a free keyslot
  27 before the keyslot containing the old parameters is purged. If there is
  28 no free keyslot, then the keyslot with the old parameters is overwritten
  29 directly.
  30
  31 *WARNING:* If a keyslot is overwritten, a media failure during this
  32 operation can cause the overwrite to fail after the old parameters have
  33 been wiped and make the LUKS container inaccessible.
  34
  35 *<options>* can be [--key-file, --keyfile-offset, --keyfile-size,
  36 --key-slot, --hash, --header, --disable-locks, --iter-time, --pbkdf,
  37 --pbkdf-force-iterations, --pbkdf-memory, --pbkdf-parallel,
  38 --keyslot-cipher, --keyslot-key-size, --timeout, --verify-passphrase].
  39
  40 include::man/common_options.adoc[]
  41 include::man/common_footer.adoc[]