zuluCrypt-cli.1

.TH zuluCrypt-cli 1

.br
.SH NAME
zuluCrypt-cli - command line interface frontend to cryptsetup and tcplay

.SH SYNOPSIS
meaning of symbols:
.br
<> = required option
.br
[] = optional argument
.br
*  = default option
.br
|  = alternatives for the same option
.br
{}  = not allowed option
.br
zuluCrypt-cli --test
.br
zuluCrypt-cli -o <d> <m> [e] <p|f|h>
.br
zuluCrypt-cli -O <d> {m} [e] <p|f|h>
.br
zuluCrypt-cli -q <d>
.br
zuluCrypt-cli -i <d>
.br
zuluCrypt-cli -c <d> <p|f|h> [ktzg]
.br
zuluCrypt-cli -r <-d> <p|f|h>
.br
zuluCrypt-cli -a <d> <<y|u> <l|n>>|<h>
.br
zuluCrypt-cli -b <d>
.br
zuluCrypt-cli -w <d>   d argument must be something like: UUID=\"2468d6a7-9a71-4312-8bd9-662f982fade5\" ( or without quotes )
.br
zuluCrypt-cli -P <d>   d device must be mapper path at /dev/mapper/
.br
zuluCrypt-cli -X <d>
.br
zuluCrypt-cli -J <d>
.br
zuluCrypt-cli -R <d> <f> <z>
.br
zuluCrypt-cli -B <d> <f> <z>
.br
zuluCrypt-cli -A
.br
zuluCrypt-cli -S
.br
zuluCrypt-cli -N
.br

.br
examples:
.br
create volume: zuluCrypt-cli -c -d /dev/sdc1 -z ext4 -t luks -p xxx
.br
open volume  : zuluCrypt-cli -o -d /dev/sdc1 -m sdc1 -e ro -p xxx
.br
open volume through sudo/pkexec  : zuluCrypt-cli -o -d /dev/sdc1 -m sdc1 -e ro -p xxx -K $USER_ID
.br
close volume ; zuluCrypt-cli -q -d /dev/sdc1
.br
remove key   ; zuluCrypt-cli -r -d /dev/sdc1 -p xxx
.br
add key      : zuluCrypt-cli -a -d /dev/sdc1 -y xxx -l yyy
.br
get device path from mapper  : zuluCrypt-cli -P -d /dev/mapper/zuluCrypt-sdc1
.br
check if partition with UUID is present : zuluCrypt-cli -w -d UUID=\"d2d210b8-0b1f-419f-9172-9d509ea9af0c\"
.br

.SH DESCRIPTION
zuluCrypt is a front end to cryptsetup. It aims to simplify using cryptsetup volumes by creating a simple to use
command line interface and a Qt based GUI front end to the command line.

The command line program is called "zuluCrypt-cli", the Qt based GUI is called "zuluCrypt-gui".
The cli part of the program is an suid program to allow management of the volumes without
setting up sudo with appropriate permissions first or requiring root's password.

The GUI part of the program calls the cli part for its operations.

This tool will create volumes only in non system partitions.

System partition is a partition with an active entry in /etc/fstab and /etc/crypttab

.br

.SH USAGE
usage: zuluCrypt-cli <operation> <options specific to the operation>
.br
operation list:
.br
-c         create an encrypted volume
.br
-o         open and encrypted volume
.br
-O         open an encrypted volume but do not mount it( -m therefore not needed )
.br
-K         if zuluCrypt-cli or zuluMount-cli is invoked with sudo/pkexec to unlock a volume, use this option
           to tell zuluCrypt to work on behalf of what user. If this option is not set them the unlocked volume
           will incorrectly belong to root user instead of the user who run zuluCrypt-cli/zuluMount-cli.
.br
-q         close an opened encrypted volume
.br
-r         remove a key from luks volume
.br
-a         add a key to luks volume
.br
-i         check if a device contain a luks volume
.br
-s         check if a device is opened and print its properties if it is
.br
-b         show status of each slot of luks volume."0"=empty,"1"=occupied,"2"=invalid slot,"3"=last occupied
.br
-A         print the list of all partitions on the system
.br
-N         print a list of non system partitions on the system( partitions with no active entries in /etc/fstab and /etc/crypttab
.br
-T         print a detailed list of mounted partitions.Must be used with -A or -S or -N
.br
-Z         print a detailed list of unmounted partitions.Must be used with -A or -S or -N
.br
-S         print a list of system partitions on the system( partitions with active entries in /etc/fstab and /etc/crypttab
.br
-w         check if UUID matches UUID of any partition
.br
-P         get device path from mapper( located at /dev/mapper )
.br
-L         print a list of all opened volumes and their mount point.The list is not formatted
.br
-X         open a device pointed by argument -d and write random data to it hiding data previously written to device
.br
-W         check if a device is a truecrypt device or not,required argument are -p or -f
.br
-U         print UUID of a given device,required argument: -d
.br
-H         compare a header on a luks device to a backup header,required arg: -d and -f
.br
-M         create a publicly accessible "mirror" of the mount point in "/run/media/public/" from the original created in "/run/media/private/$USER/"
.br
-J         create a plain mapper owned by the user who run the command on a device pointed by argument -d
.br
-B         create a luks or truecrypt header backup
.br
-R         restore a luks or truecrypt header on a device from backup
.br
.br
.B NOTE
.br
A system partition is defined as a partition with an active entry in /etc/fstab and/or /etc/crypttab.
.br
An active entry is an entry that is not commented out.
.br
.br

options that goes with above operations:
.br
-G         module name to use to get a passphrase to open a volume
.br
-e         mode for opening volumes(ro*/rw) when used with -o/-O.
.br
-e         mode for managing a truecrypt header when used with -B/-R.Options can be "fde" for volumes that use whole disk
.br
           encryption,"sys" for a windows system volume.The volume is assumed to be a normal one when the option is not set.
.br
-k         do not ask for confirmation when doing dangerous operations
.br
-d         path to a file or partition with encrypted volume
.br
-m         path component to be added to mount point prefix(/run/media/private/$USER or /home/$USER)
.br
-z         file system type installed(ext2,ext3,ext4* etc) or  or luks/tcrypt header backup path
.br
-t         type of volume (vera,plain/luks*). "vera" is a necessary argument when opening a VeraCrypt volume
.br
-g         options to be used when creating a volume.
.br
           default for luks are:   "/dev/urandom.aes.xts-plain64.256.sha1"
.br
           default for tcrypt are: "/dev/urandom.aes.xts-plain64.256.ripemd160"
           possible combination for tcrypt: "/dev/urandom.serpent:twofish:aes.xts-plain64.256.whirlpool"
.br
-h         get passphrase interactively
.br
-p         passphrase
.br
-f         path to keyfile
.br
-F         path to normal truecrypt multiple keyfiles.Multiple keyfiles are added by setting the option multiple times.
.br
-V         path to hidden truecrypt multiple keyfiles.Multiple keyfiles are added by setting the option multiple times.
.br
-y         passphrase already in the volume(required by -a if -u is absent and -h is also absent)
.br
-u         path to keyfile with passphrase already in the volume(required by -a if -y is absent and -h is also absent)
.br
-l         passphrase to be added(required by -a if -n is absent and -h is also absent)
.br
-n         path to keyfile with a passphrase to be added (required by -a if -l is absent and -h is also absent)
.br

.SH COPYRIGHT
Copyright (c) 2011-2020
.br
name : Francis Banyikwa
.br
email: mhogomchungu@gmail.com
.br
.br

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
.br

.SH LAST EDIT
Last change: Tue 09 Jun 2020 01:21:51 PM EAT