1CRYPTSETUP-CONVERT(8)        Maintenance Commands        CRYPTSETUP-CONVERT(8)
2
3
4

NAME

6       cryptsetup-convert - converts the device between LUKS1 and LUKS2 format
7

SYNOPSIS

9       cryptsetup convert --type <format> [<options>] <device>
10

DESCRIPTION

12       Converts the device between LUKS1 and LUKS2 format (if possible). The
13       conversion will not be performed if there is an additional LUKS2
14       feature or LUKS1 has unsupported header size.
15
16       Conversion (both directions) must be performed on inactive device.
17       There must not be active dm-crypt mapping established for LUKS header
18       requested for conversion.
19
20       The --type option is mandatory with the following accepted values:
21       luks1 or luks2.
22
23       WARNING: The convert action can destroy the LUKS header in the case of
24       a crash during conversion or if a media error occurs. Always create a
25       header backup before performing this operation!
26
27       <options> can be [--header, --type, --disable-locks].
28

OPTIONS

30       --type <device-type>
31           Specifies required device type, for more info read BASIC ACTIONS
32           section in cryptsetup(8).
33
34       --header <device or file storing the LUKS header>
35           Use a detached (separated) metadata device or file where the LUKS
36           header is stored. This option allows one to store ciphertext and
37           LUKS header on different devices.
38
39           For commands that change the LUKS header (e.g. luksAddKey), specify
40           the device or file with the LUKS header directly as the LUKS
41           device.
42
43       --disable-locks
44           Disable lock protection for metadata on disk. This option is valid
45           only for LUKS2 and ignored for other formats.
46
47           WARNING: Do not use this option unless you run cryptsetup in a
48           restricted environment where locking is impossible to perform
49           (where /run directory cannot be used).
50
51       --batch-mode, -q
52           Suppresses all confirmation questions. Use with care!
53
54           If the --verify-passphrase option is not specified, this option
55           also switches off the passphrase verification.
56
57       --debug or --debug-json
58           Run in debug mode with full diagnostic logs. Debug output lines are
59           always prefixed by #.
60
61           If --debug-json is used, additional LUKS2 JSON data structures are
62           printed.
63
64       --version, -V
65           Show the program version.
66
67       --usage
68           Show short option help.
69
70       --help, -?
71           Show help text and default parameters.
72

REPORTING BUGS

74       Report bugs at cryptsetup mailing list <cryptsetup@lists.linux.dev> or
75       in Issues project section
76       <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.
77
78       Please attach output of the failed command with --debug option added.
79

SEE ALSO

81       Cryptsetup FAQ
82       <https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions>
83
84       cryptsetup(8), integritysetup(8) and veritysetup(8)
85

CRYPTSETUP

87       Part of cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>.
88
89
90
91cryptsetup 2.5.0                  2022-07-28             CRYPTSETUP-CONVERT(8)
Impressum