3 # Purpose: Program to format, mount and unmount encrypted devices/files
4 # Authors: Michael Gebetsroither <gebi@grml.org>
5 # Bug-Reports: see http://grml.org/bugs/
6 # License: This file is licensed under the GPL v2.
7 # Latest change: Don Jul 26 19:57:28 CEST 2007 [mika]
8 ################################################################################
15 #. /etc/grml/sysexits-sh
24 DEV_MAPPER_="/dev/mapper"
25 CRYPTSETUP_="cryptsetup"
36 DM_PREFIX_="grml-crypt_"
39 ENTROPY_SOURCE_='/dev/urandom'
40 OPTIMIZED_MODE_SET_='false'
43 CIPHER_="aes-cbc-essiv:sha256"
44 ITERATION_TIME_="1000"
45 ADDITIONAL_CRYPTSETUP_ARGS_=""
47 ADDITIONAL_MOUNT_ARGS_=""
48 BATCH_MODE_="--batch-mode"
57 Usage: "$PROG_NAME__" [OPTIONS] action <device/file> [mountpoint]
59 $PROG_NAME__ is a wrapper around cryptsetup with LUKS support to format a device
62 -s size of the loop-filesystem to create, in MB (default=$SIZE_)
63 -t type of filesystem (default=$FSTYPE_)
64 -r read only mode (fully supported only by start)
65 -z insecure mode, using /dev/zero for most of the initialisation (INSECURE!)
66 -o optimised initialisation mode (should be as secure as the default but faster)
67 -y verifies the passphrase by asking for it twice
68 -f force file overwriting in format mode and/or disable confirmation dialog
69 -F only for action start: run fsck before mounting the filesystem. Use fsck's -f option if given twice.
70 -m additional arguments to mount
71 -v verbose (show what is going on, v++)
74 CRYPTSETUP FORMAT OPTIONS:
75 -S cipher size, could be 128, 192 or 256 (default=$CIPHER_SIZE_)
76 -C cipher, should be aes-plain for pre-2.6.10 (default=$CIPHER_)
77 -I iteration time spend with PBKDF2 password processing in seconds (default=$ITERATION_TIME_)
78 -A additional arguments for cryptsetup (only supportet by format)
81 format <device/file> [mountpoint]
82 Format a device or a file (is created with the given size if it
83 does not exist) with the given filesystem and mount it, if a
85 start <device/file> <mountpoint>
86 Mount the device/file in the mountpoint.
88 Umount the given mountpoint (umount, luksClose, losetup -d)
94 losetup does _NOT_ work on unionfs => grml-crypt with a filesystem image does ONLY
95 work if the image is on a tmpfs (eg. in /home/grml or /tmp).
106 # first trying normal devicename
107 tmp_="${DM_PREFIX_}${device_}"
108 if [ ! -e "$tmp_" ]; then
113 # second trying uuid of luks
114 #uuid_=`execute "$CRYPTSETUP_ luksUUID $1"`
115 #if [[ $? == 0 ]]; then
116 # echo "$prefix_$uuid_"
119 warn "could not create device-mapper name for $1"
124 function formatDevice
126 type_="$1" # could be donothing or init
129 args_="$VERIFY_PW_ $BATCH_MODE_ --key-size $CIPHER_SIZE_ --cipher $CIPHER_ --iter-time $ITERATION_TIME_ $ADDITIONAL_CRYPTSETUP_ARGS_"
130 #args_=`echo "$args_" |tr -s ' '`
131 execute "$CRYPTSETUP_ $args_ luksFormat $TARGET_" warn || return 1
133 execute "$CRYPTSETUP_ luksOpen $TARGET_ $DM_NAME_" warn \
134 "could not open $DM_PATH_ to create a filesystem on it!" || return 1
135 if [[ $type_ == 'init' && $OPTIMIZED_MODE_SET_ == 'true' ]]; then
136 echo "finishing optimised initialisation (this could take some time)"
138 execute "dd if=/dev/zero of=$DM_PATH_ bs=1M &>/dev/null" # || \
139 # warn "could not finish optimised initialisation properly"
141 # cutted out because of no space left on device error :(
142 #if [[ $ret_ != 0 ]]; then
143 # execute "$CRYPTSETUP_ luksClose $DM_NAME_" warn
148 execute "$MKFS_ $DM_PATH_ >/dev/null" warn
149 if [[ $? != 0 ]]; then
150 execute "$CRYPTSETUP_ luksClose $DM_NAME_"
151 warn "could not create filesystem on $DM_PATH_" 1
154 echo "Successully created $FSTYPE_ on encrypted $TARGET_"
164 # no mountpoint, by-by
165 if [[ "$MOUNT_POINT_" == "" ]]; then
167 die 'no mountpoint given'
169 if [ ! -d "$MOUNT_POINT_" ]; then
170 die "mountpoint $MOUNT_POINT_ does not exist"
172 # removed due to unionfs problem isLuks does not work with filesystem images
174 #$CRYPTSETUP_ isLuks $TARGET_ || die "$TARGET_ is not a luks partition"
176 # TARGET (is/should be) a filesystem image
177 if [ ! -b "$TARGET_" ]; then
178 notice "Operating on a file"
179 isExistent "$TARGET_" die "image does not exist"
180 TARGET_=`findNextFreeLoop` || die "could not find a free loop device"
182 # TARGET_ is now /dev/loop<x>
183 execute "losetup $TARGET_ $ORIG_TARGET_" die
186 $READONLY_SET_ && cargs_='--readonly'
187 execute "$CRYPTSETUP_ $cargs_ luksOpen $TARGET_ $DM_NAME_" warn || execute "losetup -d $TARGET_" || \
188 die "could not luksOpen $TARGET_"
189 if [[ "$FSCK_" == "true" ]] ; then
190 execute "fsck -C $DM_PATH_" || die "fsck failed on $DM_PATH_"
191 elif [[ "$FSCK_" == "trueforce" ]] ; then
192 execute "fsck -f -C $DM_PATH_" || die "fsck failed on $DM_PATH_"
195 $READONLY_SET_ && margs_='-r'
196 execute "mount $margs_ $ADDITIONAL_MOUNT_ARGS_ $DM_PATH_ $MOUNT_POINT_" die
205 isExistent "$mp_" die
206 tmp_=`realpath $mp_` || die "could not get realpath of $mp_"
207 dprint "realpath_=\"$tmp_\""
209 dm_path_=`mount |grep "$tmp_ "` || die "$tmp_ is not mounted"
210 dprint "dm_path_=\"$dm_path_\""
211 dm_path_=`echo $dm_path_ |awk '{print $1}'` || die "could not get devicemapper name for $tmp_"
212 dprint "dm_path_=\"$dm_path_\""
214 dm_name_="${dm_path_##*/}"
215 dprint "dm_name_=\"$dm_name_\""
217 dmsetup info $dm_name_ >/dev/null ||die "$dm_name_ is not aktive"
218 device_=`$CRYPTSETUP_ status $dm_name_ |awk '/device:/{print $2}'` || \
219 die "could not get underlying device of $dm_path_"
220 dprint "device_=\"$device_\""
222 execute "umount $dm_path_" die "could not unmount $device_"
223 execute "$CRYPTSETUP_ luksClose $dm_name_" die "could not close $dm_path_"
224 echo "$device_" |grep loop &>/dev/null && execute "losetup -d $device_" \
225 die "could not delete loop device $device_" || \
226 execute "losetup -d $device_ &>/dev/null" eprint "could not delete loop device $device_, \
227 this device could possible not be a loop device => maybe bogus error"
228 notice "$mp_ successfully unmountet/closed/deleted"
238 echo -n " (type uppercase yes): " >&2
240 if [[ $input == 'YES' ]]; then
247 function actionFormat
253 if (( $SIZE_ < 3 )); then
254 die "the minimum size of an encrypted luks partition should be 2"
257 # TARGET (is/should be) a filesystem image
258 if [ ! -b "$TARGET_" ]; then
259 notice "Operating on a file"
261 if [ -e "$TARGET_" ]; then
262 $FORCE_ || die "$TARGET_ does already exist"
263 warn "overwriting file $TARGET_"
266 echo -n "Initialising file with "
267 if [[ $OPTIMIZED_MODE_SET_ == 'true' ]]; then
268 echo "optimised SECURE mode"
269 execute "dd if=/dev/zero of=$TARGET_ bs=1M count=${SIZE_} &>/dev/null" \
270 die "could not initialise $TARGET_ with /dev/zero"
272 if [[ $ENTROPY_SOURCE_ == '/dev/zero' ]]; then
273 echo "INSERCURE mode"
275 echo "SECURE mode (taking /dev/urandom as source, this could take some time)"
277 execute "dd if=$ENTROPY_SOURCE_ of=$TARGET_ bs=1M count=${SIZE_} &>/dev/null" ||\
278 die "could not initialise $TARGET_ with $ENTROPY_SOURCE_"
282 TARGET_=`findNextFreeLoop` || die "could not find a free loop device"
284 # TARGET_ is now /dev/loop<x>
285 execute "losetup $TARGET_ $ORIG_TARGET_" die
286 if [[ $OPTIMIZED_MODE_SET_ == 'true' || $ENTROPY_SOURCE_ == '/dev/zero' ]]; then
287 execute "dd if=/dev/urandom of=$TARGET_ bs=1M count=2 &>/dev/null" \
288 die "could not initialise the fist 2MB of $TARGET_ with /dev/urandom"
290 formatDevice "$init_"
293 $FORCE_ || (yesDialog "Are you shure you want to overwrite $TARGET_ ?" || die 'You are not sure')
294 notice 'Operating on a device'
295 echo -n 'Initialising device with '
296 if [[ $OPTIMIZED_MODE_SET_ == 'true' ]]; then
297 echo "optimised SECURE mode"
298 execute "dd if=/dev/urandom of=$TARGET_ bs=1M count=2 &>/dev/null" ||\
299 die "could not initialise the first 2MB of $TARGET_ with /dev/urandom"
300 elif [[ $ENTROPY_SOURCE_ != '/dev/zero' ]]; then
302 echo "SECURE mode (taking $ENTROPY_SOURCE_ as source, this could take some time)"
303 execute "dd if=$ENTROPY_SOURCE_ of=$TARGET_ bs=1M &>/dev/null" #||\
304 # skipped because "no space left on device" from dd
305 # die "could not initialise $TARGET_ with $ENTROPY_SOURCE_"
307 echo 'INSECURE mode (only initialising the fist 2MB with /dev/urandom)'
308 execute "dd if=/dev/urandom of=$TARGET_ bs=1M count=2 &>/dev/null" \
309 die "could not initialise the first 2MB of $TARGET_ with /dev/urandom"
312 formatDevice "$init_"
316 # formatDevice was successfully
317 if (( $ret_ == 0 )); then
318 # a mountpoint was given (don't luksClose the device)
319 local mount_point_exists_='true'
320 test -d "$MOUNT_POINT_" || mount_point_exists_='false'
322 if [[ $MOUNT_POINT_ != "" && "$mount_point_exists_" == 'true' ]]; then
323 $READONLY_SET_ && margs_='-r'
324 execute "mount $margs_ $ADDITIONAL_MOUNT_ARGS_ $DM_PATH_ $MOUNT_POINT_" die
326 if [[ $MOUNT_POINT_ != "" ]]; then
327 $mount_point_exists_ || warn "mountpoint $MOUNT_POINT_ does not exist, not mounting. please use \"grml-crypt start $ORIG_TARGET_ <mountpoint>\" to start the device"
329 execute "$CRYPTSETUP_ luksClose $DM_NAME_" warn
330 $IS_IMAGE_ && execute "losetup -d $TARGET_" warn
333 execute "$CRYPTSETUP_ luksClose $DM_NAME_" warn
334 $IS_IMAGE_ && execute "losetup -d $TARGET_" warn
344 while getopts "s:t:rzoyfFm:hvS:C:I:A:" opt; do
346 s) SIZE_="$OPTARG"; SIZE_SET_='true' ;;
347 t) FSTYPE_="$OPTARG" ;;
348 r) READONLY_SET_='true' ;;
349 z) let OPTIMIZING_LEVEL_=$OPTIMIZING_LEVEL_+1
350 ENTROPY_SOURCE_='/dev/zero'
351 warn 'initialising from INSECURE source /dev/zero' ;;
352 o) let OPTIMIZING_LEVEL_=$OPTIMIZING_LEVEL_+1
353 OPTIMIZED_MODE_SET_='true' ;;
354 y) VERIFY_PW_="--verify-passphrase" ;;
356 F) if [[ "$FSCK_" == "true" ]] ; then
362 m) ADDITIONAL_MOUNT_ARGS_="$OPTARG" ;;
363 h) printUsage; exit ;;
364 v) let verbose_=$verbose_+1 ;;
365 S) CIPHER_SIZE_="$OPTARG" ;;
366 C) CIPHER_="$OPTARG" ;;
367 I) ITERATION_TIME_="$OPTARG" ;;
368 A) ADDITIONAL_CRYPTSETUP_ARGS_="$OPTARG" ;;
369 ?) printUsage; exit 64 ;;
372 shift $(($OPTIND - 1)) # set ARGV to the first not parsed commandline parameter
375 checkRoot die "You have to be root to use this program"
378 if [[ $1 == 'help' ]]; then
382 if (( $# < 2 )); then
384 die "wrong number of arguments ($#)" 1
386 if (( $OPTIMIZING_LEVEL_ > 1 )); then
388 die "please choose ONE initialisation methode"
392 MKFS_="/sbin/mkfs.$FSTYPE_"
393 if [ ! -x "$MKFS_" ]; then
394 die "invalid filesystem type \"$FSTYPE_\"" 1
397 # use batch-mode if available
398 $CRYPTSETUP_ $BATCH_MODE_ --help &>/dev/null;
401 0) dprint "your cryptsetup understands --batch-mode" ;;
402 1) BATCH_MODE_=""; notice "your cryptsetup does NOT understand --batch-mode, trying without" ;;
403 127) die "could not execute cryptsetup" 127 ;;
404 *) warn "problems executing $CRYPTSETUP_" $ret_
407 DM_NAME_="`getDMName $TARGET_`"
408 DM_PATH_="$DEV_MAPPER_/$DM_NAME_"
409 ORIG_TARGET_="$TARGET_"
413 format) ACTION_='format'; actionFormat ;;
414 start) ACTION_='start'; actionStart ;;
415 stop) ACTION_='stop'; actionStop "$TARGET_" ;;
420 ################################################################################
421 # vim:foldmethod=marker tabstop=2 expandtab shiftwidth=2