From 30c862e36f3bd177b1a0192ef61ec037af281e5a Mon Sep 17 00:00:00 2001 From: Jaromil Date: Tue, 27 Sep 2011 12:16:19 +0200 Subject: [PATCH] documentation updates for release also updated authors information --- AUTHORS | 7 ++- README | 3 +- TODO.org | 15 +++-- doc/tomb-open.1 | 59 +++++++++++++++--- doc/tomb-status.1 | 59 +++++++++++++++--- doc/tomb.1 | 10 +++- doc/web/views/index.muse | 6 +- doc/web/views/manual.html | 122 +++++++++++++++++++++++++++++++------- src/tomb | 2 +- 9 files changed, 229 insertions(+), 54 deletions(-) diff --git a/AUTHORS b/AUTHORS index 2d48ee2..a222333 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,9 +1,10 @@ - Tomb is designed and written by Denis Roio aka Jaromil. +Tomb includes code by Anathema and Boyska. + Tomb's artwork is contributed by Jordi aka Mon Mort -Testing and fixes are contributed by Dreamer, Hellekin O. Wolf, -Shining, Mancausoft, Asbesto, Anathema, Boyska and Nignux. +Testing and reviews are contributed by Hellekin O. Wolf, Dreamer, +Shining, Mancausoft, Asbesto Molesto. Cryptsetup is developed by Christophe Saout and Clemens Fruhwirth diff --git a/README b/README index fd334de..f51f031 100644 --- a/README +++ b/README @@ -53,7 +53,8 @@ encrypt the Home directory of users. As such, it uses well tested and reviewed routines and its shell code is pretty readable. The name transition from 'mknest' to 'tomb' is marked by the adaptation of mknest to work on the Debian operating -system, used by its author in the past 3 years. +system and it has been used in production environments for the past 4 +years. ** How can you help diff --git a/TODO.org b/TODO.org index 5b4b034..1371b0a 100644 --- a/TODO.org +++ b/TODO.org @@ -3,6 +3,10 @@ TODO and Roadmap for Tomb you are welcome to send patches to jaromil@dyne.org +Issue tracking is now handled via GitHub, see http://github.com/dyne/Tomb + +Old roadmap notes: + * DONE Release 1.0 :100%: ** TODO [#C] make one single status handle more tombs @@ -48,20 +52,15 @@ you are welcome to send patches to jaromil@dyne.org ** DONE [#A] desktop integration the freedesktop way :jaromil: ** DONE [#B] debian packaging with desktop integration :jaromil: +** DONE [#A] Avoid overwriting key on exhume on same filename +** DONE [#A] Should refuse opening a tomb that is already open :jaromil: + * TODO Release 2.0 :00%: Must be 100% backward compatible with tombs created with 1.0 -** Bugs to fix - -*** TODO [#B] Avoid overwriting key on exhume on same filename - - -*** DONE [#A] Should refuse opening a tomb that is already open :jaromil: - - ** New features *** [#A] system to split keys in parts (ssss) diff --git a/doc/tomb-open.1 b/doc/tomb-open.1 index 95ca32a..11e4b1b 100644 --- a/doc/tomb-open.1 +++ b/doc/tomb-open.1 @@ -1,4 +1,4 @@ -.TH tomb 1 "May 15, 2011" "tomb" +.TH tomb 1 "Sept 26, 2011" "tomb" .SH NAME Tomb \- the Crypto Undertaker @@ -91,7 +91,7 @@ given. This is used to recoved buried keys from unsuspected places. .B .B .IP "-s \fI\fR" -When creating a tomb, this option must be used to specify the size of +When creating a tomb, this option MUST be used to specify the size of the new \fIfile\fR to be created, in megabytes. .B .IP "-k \fI\fR" @@ -100,6 +100,15 @@ of the key to use. Keys are created with the same name of the tomb file adding a '.gpg' suffix, but can be later renamed and transported on other media. When a key is not found, the program asks to insert a USB storage device and it will look for the key file inside it. +If \fI\fR is "-" (dash), it will read stdin +.IP +When creating a tomb, this option can be used to specify the name (and +location) of the key you are creating. For example, you could use +.EX +tomb create -s 100 tombname -k /media/usb/tombname +.EE +to put the key on a usb pendrive + .B .IP "-n" Skip processing of post-hooks and bind-hooks if found inside the tomb. @@ -111,6 +120,11 @@ of the default \fIrw,noatime,nodev\fR. This option can be used to mount a tomb read-only (ro) to prevent any modification of its data, or to experiment with other settings (if you really know what you are doing) see the mount(8) man page. +.B +.IP "--ignore-swap" +By default, Tomb will abort any create and open operation if swap is used (see +SWAP section for details). This flag will disable this behaviour. NOTE: it is +not secure to do so, unless you know that your swap is encrypted .B .IP "-h" @@ -124,6 +138,7 @@ Run more quietly .IP "-D" Print more information while running, for debugging purposes + .SH HOOKS Hooks are special files that can be placed inside the tomb and trigger @@ -161,21 +176,49 @@ pinentry(1) is adopted to collect passwords from the user. Tomb executes as super user only those commands requiring it, while it executes desktop applications as processes owned by the user. +.SH SWAP + +During "create" and "open" operation, swap will complain and \fIabort\fR if +your system has swap activated. This can be annoying, and you can disable this +behaviour using \fI--ignore-swap\fR. Before doing that, however, you may be +interested in knowing the risks of doing so: +.IP \(bu +During both creation and opening it could write your secret key on the disk +.IP \(bu +After having opened the tomb, an application you're using could swap file +contents. So you'll put file contents in clear on your disk +.P + +If you don't need swap, execute \fI swapoff -a\fR. If you really need it, you +could encrypt it. Tomb doesn't detect if your swap is encrypted, and will +complain anyway. In that case, using --ignore-swap is safe. Otherwise, use +--ignore-swap at your own risk + + .SH BUGS -Please report bugs on the tracker at http://bugs.dyne.org +Please report bugs on the tracker at +.UR http://bugs.dyne.org +.UE -Get in touch with developers via mail using this web page -http://dyne.org/contact or via chat on http://irc.dyne.org +Get in touch with developers via mail using this +.UR http://dyne.org/contact +web page +.UE +or via chat on +.UR http://irc.dyne.org +.UE .SH AUTHORS Tomb is designed and written by Denis Roio aka Jaromil. +Tomb includes code by Anathema and Boyska. + Tomb's artwork is contributed by Jordi aka Mon Mort -Testing and fixes are contributed by Dreamer, Hellekin O. Wolf, -Shining, Asbesto Molesto, Anathema, Boyska and Nignux. +Testing and reviews are contributed by Hellekin O. Wolf, Dreamer, +Shining, Mancausoft, Asbesto Molesto. Cryptsetup is developed by Christophe Saout and Clemens Fruhwirth @@ -183,6 +226,8 @@ Cryptsetup is developed by Christophe Saout and Clemens Fruhwirth This manual is Copyleft (c) 2011 Denis Roio <\fIjaromil@dyne.org\fR> +It includes contributions by Boyska + Permission is granted to copy, distribute and/or modify this manual under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation. diff --git a/doc/tomb-status.1 b/doc/tomb-status.1 index 95ca32a..11e4b1b 100644 --- a/doc/tomb-status.1 +++ b/doc/tomb-status.1 @@ -1,4 +1,4 @@ -.TH tomb 1 "May 15, 2011" "tomb" +.TH tomb 1 "Sept 26, 2011" "tomb" .SH NAME Tomb \- the Crypto Undertaker @@ -91,7 +91,7 @@ given. This is used to recoved buried keys from unsuspected places. .B .B .IP "-s \fI\fR" -When creating a tomb, this option must be used to specify the size of +When creating a tomb, this option MUST be used to specify the size of the new \fIfile\fR to be created, in megabytes. .B .IP "-k \fI\fR" @@ -100,6 +100,15 @@ of the key to use. Keys are created with the same name of the tomb file adding a '.gpg' suffix, but can be later renamed and transported on other media. When a key is not found, the program asks to insert a USB storage device and it will look for the key file inside it. +If \fI\fR is "-" (dash), it will read stdin +.IP +When creating a tomb, this option can be used to specify the name (and +location) of the key you are creating. For example, you could use +.EX +tomb create -s 100 tombname -k /media/usb/tombname +.EE +to put the key on a usb pendrive + .B .IP "-n" Skip processing of post-hooks and bind-hooks if found inside the tomb. @@ -111,6 +120,11 @@ of the default \fIrw,noatime,nodev\fR. This option can be used to mount a tomb read-only (ro) to prevent any modification of its data, or to experiment with other settings (if you really know what you are doing) see the mount(8) man page. +.B +.IP "--ignore-swap" +By default, Tomb will abort any create and open operation if swap is used (see +SWAP section for details). This flag will disable this behaviour. NOTE: it is +not secure to do so, unless you know that your swap is encrypted .B .IP "-h" @@ -124,6 +138,7 @@ Run more quietly .IP "-D" Print more information while running, for debugging purposes + .SH HOOKS Hooks are special files that can be placed inside the tomb and trigger @@ -161,21 +176,49 @@ pinentry(1) is adopted to collect passwords from the user. Tomb executes as super user only those commands requiring it, while it executes desktop applications as processes owned by the user. +.SH SWAP + +During "create" and "open" operation, swap will complain and \fIabort\fR if +your system has swap activated. This can be annoying, and you can disable this +behaviour using \fI--ignore-swap\fR. Before doing that, however, you may be +interested in knowing the risks of doing so: +.IP \(bu +During both creation and opening it could write your secret key on the disk +.IP \(bu +After having opened the tomb, an application you're using could swap file +contents. So you'll put file contents in clear on your disk +.P + +If you don't need swap, execute \fI swapoff -a\fR. If you really need it, you +could encrypt it. Tomb doesn't detect if your swap is encrypted, and will +complain anyway. In that case, using --ignore-swap is safe. Otherwise, use +--ignore-swap at your own risk + + .SH BUGS -Please report bugs on the tracker at http://bugs.dyne.org +Please report bugs on the tracker at +.UR http://bugs.dyne.org +.UE -Get in touch with developers via mail using this web page -http://dyne.org/contact or via chat on http://irc.dyne.org +Get in touch with developers via mail using this +.UR http://dyne.org/contact +web page +.UE +or via chat on +.UR http://irc.dyne.org +.UE .SH AUTHORS Tomb is designed and written by Denis Roio aka Jaromil. +Tomb includes code by Anathema and Boyska. + Tomb's artwork is contributed by Jordi aka Mon Mort -Testing and fixes are contributed by Dreamer, Hellekin O. Wolf, -Shining, Asbesto Molesto, Anathema, Boyska and Nignux. +Testing and reviews are contributed by Hellekin O. Wolf, Dreamer, +Shining, Mancausoft, Asbesto Molesto. Cryptsetup is developed by Christophe Saout and Clemens Fruhwirth @@ -183,6 +226,8 @@ Cryptsetup is developed by Christophe Saout and Clemens Fruhwirth This manual is Copyleft (c) 2011 Denis Roio <\fIjaromil@dyne.org\fR> +It includes contributions by Boyska + Permission is granted to copy, distribute and/or modify this manual under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation. diff --git a/doc/tomb.1 b/doc/tomb.1 index d989542..303495c 100644 --- a/doc/tomb.1 +++ b/doc/tomb.1 @@ -1,4 +1,4 @@ -.TH tomb 1 "May 15, 2011" "tomb" +.TH tomb 1 "Sept 26, 2011" "tomb" .SH NAME Tomb \- the Crypto Undertaker @@ -217,10 +217,12 @@ or via chat on Tomb is designed and written by Denis Roio aka Jaromil. +Tomb includes code by Anathema and Boyska. + Tomb's artwork is contributed by Jordi aka Mon Mort -Testing and fixes are contributed by Dreamer, Hellekin O. Wolf, -Shining, Asbesto Molesto, Anathema, Boyska and Nignux. +Testing and reviews are contributed by Hellekin O. Wolf, Dreamer, +Shining, Mancausoft, Asbesto Molesto. Cryptsetup is developed by Christophe Saout and Clemens Fruhwirth @@ -228,6 +230,8 @@ Cryptsetup is developed by Christophe Saout and Clemens Fruhwirth This manual is Copyleft (c) 2011 Denis Roio <\fIjaromil@dyne.org\fR> +It includes contributions by Boyska + Permission is granted to copy, distribute and/or modify this manual under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation. diff --git a/doc/web/views/index.muse b/doc/web/views/index.muse index 4ec4fe2..532d770 100644 --- a/doc/web/views/index.muse +++ b/doc/web/views/index.muse @@ -295,10 +295,10 @@ Tomb is designed and written by [[http://jaromil.dyne.org][Jaromil]]. Tomb's artwork is contributed by [[http://monmort.blogspot.com][Món Mort]]. -Tomb includes code by Hellekin O. Wolf and Anathema. +Tomb includes code by Anathema and Boyska. -Testing and fixes are contributed by Dreamer, Shining, Mancausoft, -Asbesto and Boyska. +Testing and reviews are contributed by Hellekin O. Wolf, Dreamer, +Shining, Mancausoft, Asbesto Molesto. Most research we refer to is documented by Clemens Fruhwirth who also developed Cryptsetup together with Christophe Saout. diff --git a/doc/web/views/manual.html b/doc/web/views/manual.html index b62fe0e..8da308e 100644 --- a/doc/web/views/manual.html +++ b/doc/web/views/manual.html @@ -4,7 +4,7 @@ Content-type: text/html Man page of tomb

tomb

-Section: User Commands (1)
Updated: February 12, 2011
Index +Section: User Commands (1)
Updated: Sept 26, 2011
Index Return to Main Contents

@@ -72,14 +72,32 @@ a second argument is given it will indicate the mountpoint where the tomb should be made accessible, if not then the tomb is mounted in a directory named after the filename and inside /media.

+

list
+ + +

+List all the tombs found open, including information about the time +they were opened and the hooks that they mounted. If the first +argument is present, then shows only the tomb named that way or +returns an error if its not found. +

close
Closes a currently open tomb. When an argument is specified, it -should point to the tomb mount on /dev/mapper; if not specified and -only one tomb is open then it will be closed; if multiple tombs are -open, the command will list them on the terminal. The special -argument 'all' will close all currently open tombs. +should be the name of a mounted tomb; if not specified and only one +tomb is open then it will be closed; if multiple tombs are open, the +command will list them on the terminal. The special +argument 'all' will close all currently open tombs. This command +fails if the tomb is in use by running processes, the command +slam can be used to force close. +

+

slam
+ + +Closes a tomb like the command close does, but in case it is in +use looks for all the processes accessing its files and violently +kills them using -9.

bury
@@ -108,7 +126,7 @@ given. This is used to recoved buried keys from unsuspected places. -When creating a tomb, this option must be used to specify the size of +When creating a tomb, this option MUST be used to specify the size of the new file to be created, in megabytes.
-k <keyfile>
@@ -118,11 +136,35 @@ of the key to use. Keys are created with the same name of the tomb file adding a '.gpg' suffix, but can be later renamed and transported on other media. When a key is not found, the program asks to insert a USB storage device and it will look for the key file inside it. +If <keyfile> is "-" (dash), it will read stdin +
+When creating a tomb, this option can be used to specify the name (and +location) of the key you are creating. For example, you could use + +tomb create -s 100 tombname -k /media/usb/tombname + +to put the key on a usb pendrive +

-n
Skip processing of post-hooks and bind-hooks if found inside the tomb. See the HOOKS section in this manual for more information. +
-o
+ + +Manually specify mount options to be used when opening a tomb instead +of the default rw,noatime,nodev. This option can be used to +mount a tomb read-only (ro) to prevent any modification of its data, +or to experiment with other settings (if you really know what you are +doing) see the mount(8) man page. +
--ignore-swap
+ + +By default, Tomb will abort any create and open operation if swap is used (see +SWAP section for details). This flag will disable this behaviour. NOTE: it is +not secure to do so, unless you know that your swap is encrypted +

-h
@@ -138,6 +180,7 @@ Run more quietly
-D
Print more information while running, for debugging purposes

+

 

HOOKS

@@ -184,33 +227,69 @@ execute most of its operations: to do so it uses   -

BUGS

+

SWAP

-Please report bugs on the tracker at http://bugs.dyne.org

-Get in touch with developers via mail using this web page -http://dyne.org/contact or via chat on http://irc.dyne.org +During "create" and "open" operation, swap will complain and abort if +your system has swap activated. This can be annoying, and you can disable this +behaviour using --ignore-swap. Before doing that, however, you may be +interested in knowing the risks of doing so: +

+
•
+During both creation and opening it could write your secret key on the disk +
•
+After having opened the tomb, an application you're using could swap file +contents. So you'll put file contents in clear on your disk +
+

+ +

+If you don't need swap, execute swapoff -a. If you really need it, you +could encrypt it. Tomb doesn't detect if your swap is encrypted, and will +complain anyway. In that case, using --ignore-swap is safe. Otherwise, use +--ignore-swap at your own risk +

+

  +

BUGS

+ +Please report bugs on the tracker at + + +

+Get in touch with developers via mail using this + +web page + +or via chat on + + +

+ 

AUTHORS

Tomb is designed and written by Denis Roio aka Jaromil.

+Tomb includes code by Hellekin O. Wolf, Anathema and Boyska. +

Tomb's artwork is contributed by Jordi aka Mon Mort

-Testing and fixes are contributed by Dreamer and Hellekin O. Wolf +Testing and reviews are contributed by Dreamer, Shining, Mancausoft, +Asbesto Molesto.

Cryptsetup is developed by Christophe Saout and Clemens Fruhwirth

-  + 

COPYING

This manual is Copyleft (c) 2011 Denis Roio <jaromil@dyne.org>

+It includes contributions by Boyska +

Permission is granted to copy, distribute and/or modify this manual under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation. @@ -218,7 +297,7 @@ Permission is granted to make and distribute verbatim copies of this manual page provided the above copyright notice and this permission notice are preserved on all copies.

-  + 

AVAILABILITY

@@ -226,7 +305,7 @@ The most recent version of Tomb sourcecode and up to date documentation is available for download from its website on http://tomb.dyne.org.

-  + 

SEE ALSO

@@ -253,16 +332,17 @@ LUKS website, http://code.google.c

OPTIONS
HOOKS
PRIVILEGE ESCALATION
-
BUGS
-
AUTHORS
-
COPYING
-
AVAILABILITY
-
SEE ALSO
+
SWAP
+
BUGS
+
AUTHORS
+
COPYING
+
AVAILABILITY
+
SEE ALSO
This document was created by man2html, using the manual pages.
-Time: 18:57:34 GMT, March 09, 2011 +Time: 10:33:09 GMT, September 26, 2011 diff --git a/src/tomb b/src/tomb index 5668098..05a19a7 100755 --- a/src/tomb +++ b/src/tomb @@ -21,7 +21,7 @@ # Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. VERSION=1.1 -DATE=May/2011 +DATE=Sept/2011 TOMBEXEC=$0 TOMBOPENEXEC="tomb-open" typeset -a OLDARGS