1zuluCrypt-cli(1) General Commands Manual zuluCrypt-cli(1)
3
7 zuluCrypt-cli - command line interface frontend to cryptsetup and
8 tcplay
9
12 meaning of symbols:
13 <> = required option
14 [] = optional argument
15 * = default option
16 | = alternatives for the same option
17 {} = not allowed option
18 zuluCrypt-cli --test
19 zuluCrypt-cli -E <d> <e> <p|f|h>
20 zuluCrypt-cli -D <d> <e> <p|f|h>
21 zuluCrypt-cli -o <d> <m> [e] <p|f|h>
22 zuluCrypt-cli -O <d> {m} [e] <p|f|h>
23 zuluCrypt-cli -q <d>
24 zuluCrypt-cli -i <d>
25 zuluCrypt-cli -c <d> <p|f|h> [ktzg]
26 zuluCrypt-cli -r <-d> <p|f|h>
27 zuluCrypt-cli -a <d> <<y|u> <l|n>>|<h>
28 zuluCrypt-cli -b <d>
29 zuluCrypt-cli -w <d> d argument must be something like: UUID=
30 zuluCrypt-cli -P <d> d device must be mapper path at /dev/mapper/
31 zuluCrypt-cli -X <d>
32 zuluCrypt-cli -J <d>
33 zuluCrypt-cli -R <d> <f>
34 zuluCrypt-cli -B <d> <f>
35 zuluCrypt-cli -A
36 zuluCrypt-cli -S
37 zuluCrypt-cli -N
38 examples:
40 create volume: zuluCrypt-cli -c -d /dev/sdc1 -z ext4 -t luks -p xxx
41 open volume : zuluCrypt-cli -o -d /dev/sdc1 -m sdc1 -e ro -p xxx
42 close volume ; zuluCrypt-cli -q -d /dev/sdc1
43 remove key ; zuluCrypt-cli -r -d /dev/sdc1 -p xxx
44 add key : zuluCrypt-cli -a -d /dev/sdc1 -y xxx -l yyy
45 get device path from mapper : zuluCrypt-cli -P -d /dev/mapper/zulu‐
46 Crypt-sdc1
47 check if partition with UUID is present : zuluCrypt-cli -w -d UUID=
48
51 zuluCrypt is a front end to cryptsetup. It aims to simplify using
52 cryptsetup volumes by creating a simple to use command line interface
53 and a Qt based GUI front end to the command line.
54 The command line program is called "zuluCrypt-cli", the Qt based GUI is
56 called "zuluCrypt-gui". The cli part of the program is an suid program
57 to allow management of the volumes without setting up sudo with appro‐
58 priate permissions first or requiring root's password.
59 The GUI part of the program calls the cli part for its operations.
61 This tool will create volumes only in non system partitions.
63 System partition is a partition with an active entry in /etc/fstab and
65 /etc/crypttab
66
70 usage: zuluCrypt-cli <operation> <options specific to the operation>
71 operation list:
72 -c create an encrypted volume
73 -o open and encrypted volume
74 -O open an encrypted volume but do not mount it( -m therefore
75 not needed )
76 -q close an opened encrypted volume
77 -r remove a key from luks volume
78 -a add a key to luks volume
79 -i check if a device contain a luks volume
80 -s check if a device is opened and print its properties if it
81 is
82 -b show status of each slot of luks volume."0"=empty,"1"=occu‐
83 pied,"2"=invalid slot,"3"=last occupied
84 -A print the list of all partitions on the system
85 -N print a list of non system partitions on the system( parti‐
86 tions with no active entries in /etc/fstab and /etc/crypttab
87 -T print a detailed list of mounted partitions.Must be used
88 with -A or -S or -N
89 -Z print a detailed list of unmounted partitions.Must be used
90 with -A or -S or -N
91 -S print a list of system partitions on the system( partitions
92 with active entries in /etc/fstab and /etc/crypttab
93 -w check if UUID matches UUID of any partition
94 -P get device path from mapper( located at /dev/mapper )
95 -L print a list of all opened volumes and their mount point.The
96 list is not formatted
97 -X open a device pointed by argument -d and write random data
98 to it hiding data previously written to device
99 -W check if a device is a truecrypt device or not,required
100 argument are -p or -f
101 -U print UUID of a given device,required argument: -d
102 -H compare a header on a luks device to a backup
103 header,required arg: -d and -f
104 -M create a publicly accessible "mirror" of the mount point in
105 "/run/media/public/" from the original created in "/run/media/pri‐
106 vate/$USER/"
107 -J create a plain mapper owned by the user who run the command
108 on a device pointed by argument -d
109 -B create a luks or truecrypt header backup
110 -R restore a luks or truecrypt header on a device from backup
111 NOTE
112 A system partition is defined as a partition with an active entry in
113 /etc/fstab and/or /etc/crypttab.
114 An active entry is an entry that is not commented out.
115 options that goes with above operations:
117 -G module name to use to get a passphrase to open a volume
118 -e mode for opening volumes(ro*/rw) when used with -o/-O. path
119 to destination file when used with -E/-D
120 -e mode for managing a truecrypt header when used with
121 -B/-R.Options can be "fde" for volumes that use whole disk
122 encryption,"sys" for a windows system volume.The volume is
123 assumed to be a normal one when the option is not set.
124 -k do not ask for confirmation when doing dangerous operations
125 -d path to a file or partition with encrypted volume
126 -m path component to be added to mount point pre‐
127 fix(/run/media/private/$USER or /home/$USER)
128 -z file system type installed(ext2,ext3,ext4* etc) or or
129 luks/tcrypt header backup path
130 -t type of volume (vera,plain/luks*). "vera" is a necessary
131 argument when opening a VeraCrypt volume
132 -g options to be used when creating a volume.
133 default for luks are: "/dev/urandom.aes.xts-
134 plain64.256.sha1"
135 default for tcrypt are: "/dev/urandom.aes.xts-
136 plain64.256.ripemd160"
137 possible combination for tcrypt: "/dev/urandom.ser‐
138 pent:twofish:aes.xts-plain64.256.whirlpool"
139 -h get passphrase interactively
140 -p passphrase
141 -f path to keyfile
142 -F path to normal truecrypt multiple keyfiles.Multiple keyfiles
143 are added by setting the option multiple times.
144 -V path to hidden truecrypt multiple keyfiles.Multiple keyfiles
145 are added by setting the option multiple times.
146 -y passphrase already in the volume(required by -a if -u is
147 absent and -h is also absent)
148 -u path to keyfile with passphrase already in the vol‐
149 ume(required by -a if -y is absent and -h is also absent)
150 -l passphrase to be added(required by -a if -n is absent and -h
151 is also absent)
152 -n path to keyfile with a passphrase to be added (required by
153 -a if -l is absent and -h is also absent)
154
157 Copyright (c) 2011-2013
158 name : Francis Banyikwa
159 email: mhogomchungu@gmail.com
160 This program is free software: you can redistribute it and/or modify it
162 under the terms of the GNU General Public License as published by the
163 Free Software Foundation, either version 2 of the License, or (at your
164 option) any later version. This program is distributed in the hope
165 that it will be useful, but WITHOUT ANY WARRANTY; without even the
166 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
167 POSE. See the GNU General Public License for more details. You should
168 have received a copy of the GNU General Public License along with this
169 program. If not, see <http://www.gnu.org/licenses/>.
170
173 Last change: Fri Jan 9 14:43:08 EAT 2015
174 zuluCrypt-cli(1)