DragonFly On-Line Manual Pages

TCPLAY(8)	       DragonFly System Manager's Manual	     TCPLAY(8)

NAME
     tcplay -- tool to manage TrueCrypt volumes

SYNOPSIS
     tcplay -c -d device [-g] [-a pbkdf_hash] [-b cipher] [-f keyfile_hidden]
	    [-k keyfile] [-x pbkdf_hash] [-y cipher]
     tcplay -i -d device [-e] [-f keyfile_hidden] [-k keyfile]
	    [-s system_device]
     tcplay -m mapping -d device [-e] [-f keyfile_hidden] [-k keyfile]
	    [-s system_device]
     tcplay -h | -v

DESCRIPTION
     The tcplay utility provides full support for creating and opening/mapping
     TrueCrypt-compatible volumes.  It supports the following commands, each
     with a set of options detailed further below:

     -c, --create
	     Create a new encrypted TrueCrypt volume on the device specified
	     by --device.

     -h, --help
	     Print help message and exit.

     -i, --info
	     Print out information about the encrypted device specified by
	     --device.

     -m mapping, --map=mapping
	     Map the encrypted TrueCrypt volume on the device specified by
	     --device as a dm(4) mapping called mapping.

     -v, --version
	     Print version message and exit.

     Options common to all commands are:

     -d device, --device=device
	     Specifies the disk device on which the TrueCrypt volume
	     resides/will reside.  This option is mandatory for all commands.

     -f keyfile_hidden, --keyfile-hidden=keyfile_hidden
	     Specifies a keyfile to use in addition to the passphrase when
	     either creating a hidden volume or when protecting a hidden vol-
	     ume while mapping or querying the outer volume.  If you only
	     intend to map a hidden volume, the --keyfile option has to be
	     used.  This option can appear multiple times; if so, multiple
	     keyfiles will be used.

     -k keyfile, --keyfile=keyfile
	     Specifies a keyfile to use in addition to the passphrase.	This
	     option can appear multiple times; if so, multiple keyfiles will
	     be used.

     Additional options for the --create command are:

     -a pbkdf_hash, --pbkdf-prf=pbkdf_hash
	     Specifies which hash algorithm to use for the PBKDF2 password
	     derivation.  To see which algorithms are supported, specify
	     --pbkdf-prf=help.

     -b cipher, --cipher=cipher
	     Specifies which cipher algorithm or cascade of ciphers to use to
	     encrypt the new volume.  To see which algorithms are supported,
	     specify --cipher=help.

     -g, --hidden
	     Specifies that the newly created volume will contain a hidden
	     volume.  The keyfiles applied to the passphrase for the hidden
	     volume are those specified by --keyfile-hidden.  The user will be
	     prompted for the size of the hidden volume interactively.

     -x pbkdf_hash, --pbkdf-prf-hidden=pbkdf_hash
	     Specifies which hash algorithm to use for the PBKDF2 password
	     derivation for the hidden volume.	Only valid in conjunction with
	     --hidden.	If no algorithm is specified, the same as for the
	     outer volume will be used.  To see which algorithms are sup-
	     ported, specify --pbkdf-prf-hidden=help.

     -y cipher, --cipher-hidden=cipher
	     Specifies which cipher algorithm or cascade of ciphers to use to
	     encrypt the hidden volume on the new TrueCrypt volume.  Only
	     valid in conjunction with --hidden.  If no cipher is specified,
	     the same as for the outer volume will be used.  To see which
	     algorithms are supported, specify --cipher-hidden=help.

     Additional options for the --info and --map commands are:

     -e, --protect-hidden
	     Specifies that an outer volume will be queried or mapped, but its
	     reported size will be adjusted accordingly to the size of the
	     hidden volume contained in it.  Both the hidden volume and outer
	     volume passphrase and keyfiles will be required.

     -s system_device, --system-encryption=system_device
	     This option is required if you are attempting to access a device
	     that uses system encryption, for example an encrypted Windows
	     system partition.	The --device option will point at the actual
	     encrypted partition, while the system_device argument will point
	     to the parent device (i.e. underlying physical disk) of the
	     encrypted partition.

EXAMPLES
     Create a new TrueCrypt volume on /dev/vn0 using the cipher cascade of AES
     and Twofish and the Whirlpool hash algorithm for PBKDF2 password deriva-
     tion and two keyfiles, one.key and two.key:

	   tcplay --create --device=/dev/vn0
	   --cipher=AES-256-XTS,TWOFISH-256-XTS --pbkdf-prf=whirlpool
	   --keyfile=one.key --keyfile=two.key

     Map the outer volume on the TrueCrypt volume on /dev/vn0 as truecrypt1,
     but protect the hidden volume, using the keyfile hidden.key, from being
     overwritten:

	   tcplay --map=truecrypt1 --device=/dev/vn0 --protect-hidden
	   --keyfile-hidden=hidden.key

     Map the hidden volume on the TrueCrypt volume on /dev/vn0 as truecrypt2,
     using the keyfile hidden.key:

	   tcplay --map=truecrypt2 --device=/dev/vn0 --keyfile=hidden.key

SEE ALSO
     crypttab(5), cryptsetup(8)

HISTORY
     The tcplay utility appeared in DragonFly 2.11.

AUTHORS
     Alex Hornung

DragonFly 3.5			 July 5, 2011			 DragonFly 3.5