diff --git a/v0.2.1/README b/v0.2.1/README index 1b83811..e3db853 100644 --- a/v0.2.1/README +++ b/v0.2.1/README @@ -1,21 +1,24 @@ -TODO: write a good README :) +$Id$ +CryptoBox version 0.2.1 1) Documentation -The documentation is available at https://systemausfall.org/toolforge/CryptoBox +The documentation is available at https://systemausfall.org/trac/cryptobox/wiki/CryptoBoxUser 2) Building a LiveCD try: "scripts/cbox-build.sh release" -or look at the developer's documentation: https://systemausfall.org/toolforge/CryptoBoxDev +or look at the developer's documentation: https://systemausfall.org/trac/cryptobox/wiki/CryptoBoxDev 3) Bug reporting -Use our issue tracker at https://systemausfall.org/trac/cryptobox +Use our issue tracker at https://systemausfall.org/trac/cryptobox/newticket 4) Licence All scripts are GPL code (v2.0 or above). -The documentation is licenced under "Creative Commons 2.0 non-commercial share-alike" (http://creativecommons.org/licenses/by-nc-sa/2.0/) +The documentation is licenced under "Creative Commons 2.5 share-alike" (http://creativecommons.org/licenses/by-sa/2.5/). 5) Contributors Clavdia Horvat, Tadej Brce & Dušan Rebolj - slovenian translation 6) Contact -email us: cryptobox@systemausfall.org +email: cryptobox@systemausfall.org + +The CryptoBox project is mainly driven by sense.lab (https://systemausfall.org/senselab). diff --git a/v0.2.1/cbox-tree.d/_offline/doc/de/CryptoBox.html b/v0.2.1/cbox-tree.d/_offline/doc/de/CryptoBox.html index 434eb89..5ed1eb0 100644 --- a/v0.2.1/cbox-tree.d/_offline/doc/de/CryptoBox.html +++ b/v0.2.1/cbox-tree.d/_offline/doc/de/CryptoBox.html @@ -29,142 +29,90 @@
+
-
-
unter CryptoBoxIntro/de findest du einen sehr kurzen Überblick
- -Das erste Release der CryptoBox wird im Oktober bei http://codecoop.org/projects/cryptobox/ verfügbar sein.
- -Die CryptoBox ist eine Live-CD mit der sich jeder alte Rechner in Sekundenschnelle in einen verschlüsselnden Server umwandeln lässt. Damit kannst du sensible Daten speichern, ohne dass du etwas über Kryptografie wissen musst.
-Die Dokumentation der CryptoBox ist bisher in folgenden Sprachen verfügbar:
- -Wir freuen uns über weitere Übersetzugen
- -
- System - |
-
- Debian/Linux basierte Live-CD - |
-
- benötigter Computer - |
-
- "ausrangierter" PC (i386 ab p1 mind. 32MB RAM) - |
-
- unterstützte Clients - |
-- - | -
- interner Fileserver - |
-
- samba (Netzwerkfreigaben) - |
-
- Benutzerschnittstelle - |
-
- per Browser bedienbares Web-Interface - |
-
- Verschlüsselung - |
-
- AES via device-mapper - |
-
Das Web-Interface der CryptoBox ünterstützt derzeit folgende Sprachen:
-deutsch
-englisch
-slowenisch
-Du kannst gern weitere Übersetzungen in andere Sprachen hinzufügen (idealerweise utf-encodiert).
-Das Nutzerhandbuch ist unter CryptoBoxUser/de verfügbar.
- -Beteilige dich an der Entwicklung der CryptoBox und werde reich und schön!
- Nee im Ernst, wir freuen uns über jeden partizipierenden Menschen. Du wirst in einem entspannten Team reichlich Erfahrungen sammeln, eine nützliche Sache voranbringen und - wer weiß - vielleicht macht dich das auch schön. Schreib eine Mail an cryptobox[at]systemausfall.org und hab Spaß.
Fehler kannst du in unserer Fehlerdatenbank eintragen.
-Die Entwickler-Doku findest du unter CryptoBoxDev (bisher nur englisch).
- -Alle Skripte unterliegen der GPL - sie sind also quasi vollständig frei.
-Die Dokumentation unterliegt einer Creative Commons-Lizenz, damit wird die Möglichkeit der freien Verbreitung des gesammelten Wissens gewährleistet.
-Wir übernehmen keinerlei Haftung für eventuelle Folgen, die durch die Nutzung einer CryptoBox entstehen könnten.
-+Das erste Release der CryptoBox ist bei Codecoop.org verfügbar. +
+
+Die CryptoBox ist eine Live-CD mit der sich jeder alte Rechner in Sekundenschnelle in einen verschlüsselnden Server umwandeln lässt. Damit kannst du sensible Daten speichern, ohne dass du etwas über Kryptografie wissen musst.
+Die Bedienung erfolgt vollständig per Webbrowser. Wirf einen Blick auf die ScreenShots.
+
Spezifikation + | |
System | Debian GNU/Linux-basierte Live-CD + |
benötigter Computer | "ausrangierter" PC (i386 ab p1 mind. 32MB RAM) + |
unterstützte Clients | *nix; *bsd; Windows; Mac OS + |
interner Fileserver | samba (Netzwerkfreigaben) + |
Benutzerschnittstelle | per Browser bedienbares Web-Interface + |
Verschlüsselung | AES via device-mapper + |
+Das Web-Interface der CryptoBox unterstützt derzeit folgende Sprachen: +
++Wir suchen noch Übersetzungen in andere Sprachen. Wenn du dich beteiligen möchtest, wirf einen Blick in die Übersetzungen-Sektion. Dort gibt es eine "README" Datei in der genauere Beschreibungen stehen. +
+
+Beteilige dich an der Entwicklung der CryptoBox und werde reich und schön! ;)
+Nee im Ernst, wir freuen uns über jeden partizipierenden Menschen. Du wirst in einem entspannten Team reichlich Erfahrungen sammeln, eine nützliche Sache voranbringen und - wer weiß - vielleicht macht dich das auch schön.
+Schreib eine Mail an cryptobox[at]systemausfall.org und hab Spaß.
+
+Die englischsprachige Entwickler-Doku findest du unter CryptoBoxDev. +
++
+
+
-
+
The following pages are written for developers only. Users of the CryptoBox should read CryptoBoxUser instead.
-We are waiting for your emails to cryptobox[at]systemausfall.org.
- -Please use our issue tracker, if you discover problems: https://systemausfall.org/trac/cryptobox
+ ++Navigation: ( CryptoBox/de, CryptoBox/en) +
+
+The following pages are written for developers only.
+Users of the CryptoBox should read CryptoBoxUser instead.
+
+You may browse the source code. +
++We are waiting for your emails to cryptobox[at]systemausfall.org. +
++If you think you found a bug or you get an error message, please help us to fix the problem and file a ticket (a bug report). Follow these steps: +
++
-
-
back to CryptoBoxDev
++Navigation: ( CryptoBoxDev) -
The base system of the CryptoBox Live-CD is created by dfsbuild.
-It is recommended to use some kind of caching tool for the retrieval of the debian packages (e.g.: apt-cacher or apt-proxy). This saves a lot of bandwidth and time.
-The documentation for dfsbuild is sparse. But it is quite unlikely, that you will get in direct contact with it, as it is wrapped by cbox-build. However the following links may help you for specific problems:
- - -The linux kernel for the CryptoBox is compiled statically. If you want to change it, you could follow this steps:
-get the sources: apt-get install kernel-tree-2.6.11 (or the version of your choice)
-copy the exisiting config file kernel/config-2.6.11 as .config into your kernel source directory
-build the debian kernel package make-kpkg --revision=1.dfs --rootcmd=fakeroot kernel_image
-change the kernel in the unpackdebs setting in dfs-cbox.conf (see CryptoBoxDevCustomBuild for details)
-Qemu is a portable system emulator. It is a convenient tool to ease the development workflow, as you do not need to burn LiveCDs for testing.
- -We tried some other LiveCDs before we decided to use dfsbuild. The following pages describe their advantages and disadvantages as the base system for the CryptoBox:
-CryptoBoxKnoppixVerworfen - Knoppix
-CryptoBoxMorphixVerworfen - Morphix / IBuild
-+The base system of the CryptoBox Live-CD is created by dfsbuild. +
++It is recommended to use some kind of caching tool for the retrieval of the debian packages (e.g.: apt-cacher, apt-proxy or approx). This saves a lot of bandwidth and time. +
++The documentation for dfsbuild is sparse. But it is quite unlikely, that you will get in direct contact with it, as it is wrapped by cbox-build. However the following links may help you for specific problems: +
++The linux kernel for the CryptoBox is compiled statically. If you want to change it, you could follow this steps: +
++See source:trunk/hints/kernel-build.txt for more details. +
++Qemu is a portable system emulator. It is a convenient tool to ease the development workflow, as you do not need to burn LiveCDs for testing. +
++We tried some other LiveCDs before we decided to use dfsbuild. The following pages describe their advantages and disadvantages as the base system for the CryptoBox: +
++
+
- + ++Navigation: ( CryptoBoxDev, CryptoBoxDevBackground, CryptoBoxDevPreparation, CryptoBoxDevWorkFlow) - -
-
-
back to CryptoBoxDev
- -The following sections are useful, if you want to change the default settings of your personal CryptoBox development environment.
-You should have completed the steps described in CryptoBoxDevPreparation.
- -All settings for dfsbuild can be found in etc-defaults.d/dfs-cbox.conf.
-If you want to change any of them, you should do the following:
-copy etc-defaults.d/dfs-cbox.conf file to etc-local.d/
-change etc-local.d/dfs-cbox.conf according to your needs
-This allows you to use your own (personal) settings, without interfering with files under version control.
- -Some settings regarding the building, configuring and validating of the CryptoBox can be found in etc-defaults.d/cbox-dev.conf.
-If you want to change any of them, you should do the following:
-copy etc-defaults.d/cbox-dev.conf file to etc-local.d/
-change etc-local.d/cbox-dev.conf according to your needs
-The file etc-defaults.d/ssh_config is used to establish a connection to a running CryptoBox system.
-It can be necessary to change these settings, if:
-you do not want to use the default IP for the CryptoBox
-or the CryptoBox is not within your local network.
-If you want to change some settings, you should do the following:
-copy etc-defaults.d/ssh_config file to etc-local.d/
-change etc-local.d/ssh_config according to your needs
-The file etc-defauolts.d/qemu-ifup is used for the CryptoBox emulation with qemu. See man qemu for details.
-If you want to change some settings, you should do the following:
-copy etc-defaults.d/qemu-ifup file to etc-local.d/
-change etc-local.d/qemu-ifup according to your needs
-+The following sections are useful, if you want to change the default settings of your personal CryptoBox development environment. +
++You should have completed the steps described in CryptoBoxDevPreparation. +
++All settings for dfsbuild can be found in etc-defaults.d/dfs-cbox.conf. +
++If you want to change any of them, you should do the following: +
++This allows you to use your own (personal) settings, without interfering with files under version control. +
++Some settings regarding the building, configuring and validating of the CryptoBox can be found in etc-defaults.d/cbox-dev.conf. +
++If you want to change any of them, you should do the following: +
++The file ssh_config is used to establish a connection to a running CryptoBox system. +
++It can be necessary to change these settings, if: +
++If you want to change some settings, you should do the following: +
++The file etc-defauolts.d/qemu-ifup is used for the CryptoBox emulation with qemu. See man qemu for details. +
++If you want to change some settings, you should do the following: +
++
+
-+Navigation: ( CryptoBoxDev) -
You may change nearly every aspect of the CryptoBox by using the custom configuration hook directory.
-Any script inside of this directory will be executed after the default configuration procedure (see CryptoBoxDevWorkFlow).
-The order of execution is defined by the names of the scripts (alphabetically).
- -Some example customization scripts can be found in configure-examples.d/.
-You may put your scripts into configure-local.d/. They will be sourced by cbox-build.sh.
- -The examples in configure-examples.d/ can be copied to configure-local.d/ and adjusted to your needs.
-change the default IP address of the CryptoBox
-set the default language
-set the default idle time for automatic unmounting
-change the default hostname
-change the password of root (only useful for a development CryptoBox)
-upload a ssh key for passwordless access to a development CryptoBox
-where to look for usable harddisks
-+You may change nearly every aspect of the CryptoBox by using the custom configuration hook directory. +
++Any script inside of this directory will be executed after the default configuration procedure (see CryptoBoxDevWorkFlow). +
++The order of execution is defined by the names of the scripts (alphabetically). +
++Some example customization scripts can be found in configure-examples.d/. +
++You may put your scripts into configure-local.d/. They will be sourced by cbox-build.sh. +
++The examples in configure-examples.d/ can be copied to configure-local.d/ and adjusted to your needs. +
+set_default_ip | change the default IP address of the CryptoBox + |
set_default_language | set the default language + |
set_default_timeout | set the default idle time for automatic unmounting + |
set_hostname | change the default hostname + |
set_root_pw | change the password of root (only useful for a development CryptoBox) + |
import_authorized_keys | upload a ssh key for passwordless access to a development CryptoBox + |
set_scan_devices | where to look for usable harddisks + |
+
+
+Navigation: ( CryptoBoxDev) - -
-
- -
You should update qemu to version 0.7 or higher.
- -This happens under certain circumstances. We do not know a solution for this problem.
+ ++You should update qemu to version 0.7 or higher. +
++This happens under certain circumstances. We do not know a solution for this problem. +
++This can be caused by a (strange) mix of debian package versions. Track this bug at http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=320991. +
++
+
-
-
back to CryptoBoxDev
- -We use Debian as our development environment. This was a natural choice, as the CryptoBox-LiveCD is also based on Debian. Other distributions should work too, of course - YMMV.
-required:
-recommended:
-If you want to use qemu to test your CryptoBox in a virtual environment, then you will need the tun/tap kernel feature.
--CONFIG_TUN=m+
+Navigation: ( CryptoBoxDev, CryptoBoxDevCustomBuild, CryptoBoxDevWorkFlow) -
Download the latest release from our subversion-Repository:
--svn checkout https://svn.systemausfall.org/svn/cryptobox/trunk- -
run scripts/cbox-build.sh release as root - hopefully, there should be no errors
-Hint: This step will fail, if you did not install apt-cacher. See CryptoBoxDevCustomBuild for details on how to change the build-configuration settings (in this case: mirror in dfs-cbox.conf).
- -Now you can start to pariticipate in the development of the CryptoBox or simply customize your own CryptoBox-LiveCD.
-See CryptoBoxDevWorkFlow for details of how to use the developer's tools of the CryptoBox.
-CryptoBoxDevCustomBuild shows some examples for local customizations of the CryptoBox.
++We use Debian as our development environment. This was a natural choice, as the CryptoBox-LiveCD is also based on Debian. Other distributions should work too, of course - your mileage may vary. +
++required: +
++recommended: +
++If you want to use qemu to test your CryptoBox in a virtual environment, then you will need the tun/tap kernel feature. +
+CONFIG_TUN=m +
+Download the latest release from our subversion-Repository: +
+svn checkout https://svn.systemausfall.org/svn/cryptobox/trunk +
+run scripts/cbox-build.sh release as root - hopefully, there should be no errors :) +
++Hint: This step will fail, if you did not install apt-cacher. See CryptoBoxDevCustomBuild for details on how to change the build-configuration settings (in this case: mirror in dfs-cbox.conf). +
++Now you can start to pariticipate in the development of the CryptoBox or simply customize your own CryptoBox-LiveCD. +
++See CryptoBoxDevWorkFlow for details of how to use the developer's tools of the CryptoBox. +
++CryptoBoxDevCustomBuild shows some examples for local customizations of the CryptoBox. +
++
+
-
-
back to CryptoBoxDev
++Navigation: ( CryptoBoxDev) -
The validation feature allows to check the programming logic of the CryptoBox. A lot of test cases are defined to test as many functions of the CryptoBox as possible.
-The requests are processed with curl.
-The received web page is saved to allow a later design review or css debugging.
-The current state of the CryptoBox is represented by ten single values (e.g.: box is configured, IP of the box, current language setting, ...), which are invisibly a part of each html page (as comments). The returned status of every request is compared to the predicted value of the test case.
-Similar test cases are pooled into test groups (e.g.: initialization, configuration and mounting).
- -Run scripts/validate.sh check_all to conduct all tests of all groups. See scripts/validate.sh help for other actions.
-The results will be saved in validation/report.
-In addition to every single retrieved page, a html page called summary.html is created, which contains the state checks of all tests in a group.
- -All test cases can be found in validation/test-cases.
-Every test consists of:
-the configuration file for the curl request
-the predicted state of the CryptoBox after the call
-a short description of the test (will be used for the summary)
-[optional] time to wait after this test
-Use the existing test cases as templates for new tests.
-Any logical path of the web interface CGI should be validated by a test case.
+ ++The validation feature helps you to check the programming logic of the CryptoBox. A lot of test cases are defined to verify as many functions of the CryptoBox as possible. +
++The requests are processed with curl. +
++The received web page is saved to allow a later design review or css debugging. +
++The current state of the CryptoBox is represented by ten single values (e.g.: box is configured, IP of the box, current language setting, ...), which are invisibly a part of each html page (as comments). The returned status of every request is compared to the predicted value of the test case. +
++Similar test cases are pooled into test groups (e.g.: initialization, configuration and mounting). +
++Run scripts/validate.sh] to conduct all tests of all groups. See scripts/validate.sh help for other actions. +
++The results will be saved in validation/report. +
++In addition to every single retrieved page, a html page called summary-?.html is created, which contains the state checks of all tests in a group. +
++All test cases can be found in validation/test-cases. +
++Every test consists of the following files: +
+input.curl | the configuration file for the curl request + |
output | the predicted state of the CryptoBox after the call + |
description | a short description of the test (will be used for the summary) + |
delay | [optional] time to wait after this test + |
+Use the existing test cases as templates for new tests. +
++Read validation/test-cases/README for details. +
++Every logical path of the web interface CGI should be validated by a test case. +
++
+
+Navigation: ( CryptoBoxDev, CryptoBoxDevCustomConfigure, CryptoBoxDevPreparation) -
-
-
back to CryptoBoxDev
- -You should have completed the steps described in CryptoBoxDevPreparation.
- -The following steps can be executed in the order of their appearance.
-Usually there is no need to repeat the whole process, after you changed some parts of the CryptoBox. Especially the first step (building of the base system with dfsbuild) may usually be skipped.
-Every step of the building process must be executed as root.
- -Run scripts/cbox-build.sh dfsbuild to create the base system for the LiveCD.
-The result can be found in _builddir/cd1/image.
-If you do not want to use the apt-cacher to save bandwidth and time, then you should modify the mirror-setting in dfs-cbox.conf (see CryptoBoxDevCustomBuild for details).
- -Run scripts/cbox-build.sh config to copy the CryptoBox-specific files to the base image.
-TODO: link to cbox-build.sh-manpage
- -The original base system, that was created by dfsbuild contains a lot packages and some scripts, that are only useful during development. You should remove them, as they case severe security implications.
-To reduce the CryptoBox-LiveCD to the usable minimum for operational use, you should run scripts/cbox-build.sh harden.
- -To burn a CryptoBox-LiveCD, you need an bootable iso9660-image.
-Create the iso image with scripts/cbox-build.sh iso. The resulting file can be found at _builddir/cd1/cryptobox.iso.
- -Do it manually: cdrecord -v dev=0,0,0 _builddir/cd1/cryptobox.iso (change the dev setting according to your setup).
-Let the script do it for you: scripts/cbox-build.sh burn (maybe you have to change the CDWRITER setting in cbox-dev.conf - see CryptoBoxDevCustomBuild).
-Of course, it is not wise to use CD-R media. CD-RW consume less resources.
- -This section is only useful for developers, who want to improve or change the CryptoBox system.
- -If you modified the perl- or shell-scripts of the CryptoBox, then you can check for syntax errors by running them in a chroot environment. Be careful: you have access to all ressources of your computer, while you are working within a chroot environment - so you can easily repartition your real disk ...
-To start a chroot environment, you can execute scripts/cbox-dev.sh chroot.
-For more intensive tests, you may use qemu (see below) or burn real LiveCDs - of course this would take much more time.
- -The processor emulator qemu allows you test the CryptoBox in a virtual environment, that is completely separated from your real computer's resources. It is the tool of choice, if you do nat have a real computer around for testing.
-Beware - there are some problems, when using qemu:
-smbd does not start (segfault)
-???
-To start a qemu emulation of the iso image, you may type: scripts/cbox-dev.sh qemu.
- -This section is only useful for developers, who want to develop on a running CryptoBox system (emulated or real).
-You may access the CryptoBox directly or you can use ssh to open a remote session (./cbox-dev.sh ssh).
- -When you run an emulation or test a real LiveCD, you may encounter problems and bugs. To test your fixes for these problems, it is convenient, to change the running test system. Afterwards you can merge these changes to your local development copy.
-Type scripts/cbox-dev.sh diff to see the changes, you made on the running CryptoBox system.
-Type scripts/cbox-dev.sh merge to merge these changes to your local working copy.
- -Alternatively you may also upload a new version of your local working copy to the running CryptoBox system.
-Type scripts/cbox-dev.sh upload - beware: all recent changes you made to the running CryptoBox system, are lost.
+ ++You should have completed the steps described in CryptoBoxDevPreparation. +
++The following steps can be executed in the order of their appearance. +
++Usually there is no need to repeat the whole process, after you changed some parts of the CryptoBox. Especially the first step (building of the base system with dfsbuild) may usually be skipped. +
++Every step of the building process must be executed as root. +
++Run scripts/cbox-build.sh dfsbuild to create the base system for the LiveCD. +
++The result can be found in _builddir/cd1/image. +
++If you do not want to use the apt-cacher to save bandwidth and time, then you should modify the mirror-setting in dfs-cbox.conf (see CryptoBoxDevCustomBuild for details). +
++Run scripts/cbox-build.sh config to copy the CryptoBox-specific files to the base image. +
++TODO: link to cbox-build.sh-manpage +
++The original base system, that was created by dfsbuild contains a lot packages and some scripts, that are only useful during development. You should remove them, as they cause severe security implications. +
++To reduce the CryptoBox-LiveCD to the usable minimum for operational use, you should run scripts/cbox-build.sh harden. +
++To burn a CryptoBox-LiveCD, you need an bootable iso9660-image. +
++Create the iso image with scripts/cbox-build.sh iso. The resulting file can be found at _builddir/cd1/cryptobox.iso. +
++Do it manually: +
+cdrecord -v dev=0,0,0 _builddir/cryptobox.iso +
+(change the dev setting according to your setup). +
++Let the script do it for you: scripts/cbox-build.sh burn (maybe you have to change the CDWRITER setting in cbox-dev.conf - see CryptoBoxDevCustomBuild). +
++Of course, it is not wise to use CD-R media. CD-RW consume less resources. +
++This section is only useful for developers, who want to improve or change the CryptoBox system. +
++If you modified the perl- or shell-scripts of the CryptoBox, then you can check for syntax errors by running them in a chroot environment. Be careful: you have access to all ressources of your computer, while you are working within a chroot environment - so you can easily repartition your real disk ... +
++To start a chroot environment, you can execute scripts/cbox-dev.sh chroot. +
++For more intensive tests, you may use qemu (see below) or burn real LiveCDs - of course this would take much more time. +
++The processor emulator qemu allows you test the CryptoBox in a virtual environment, that is completely separated from your real computer's resources. It is the tool of choice, if you do nat have a real computer around for testing. +
++Beware - there are some problems, when using qemu: +
++To start a qemu emulation of the iso image, you may type: +
+scripts/cbox-dev.sh qemu +
+This section is only useful for developers, who want to develop on a running CryptoBox system (emulated or real). +
++You may access the CryptoBox directly or you can use ssh to open a remote session: +
+./cbox-dev.sh ssh +
+When you run an emulation or test a real LiveCD, you may encounter problems and bugs. To test your fixes for these problems, it is convenient, to change the running test system. Afterwards you can merge these changes to your local development copy. +
++Type scripts/cbox-dev.sh diff to see the changes, you made on the running CryptoBox system. +
++Type scripts/cbox-dev.sh merge to merge these changes to your local working copy. +
++Alternatively you may also upload a new version of your local working copy to the running CryptoBox system. +
++Type scripts/cbox-dev.sh upload - beware: all recent changes you made to the running CryptoBox system, are lost. +
++
+
-
- -
Die folgenden Seiten beschreiben die Nutzung der CryptoBox.
-Die online-Version dieses Handbuchs ist ein Wiki. Das bedeutet, dass du diese Seiten verändern kannst. Falls du also Fragen oder Anregungen hast, schreibe bitte deine Anmerkungen in den Fragen-Abschnitt am Ende der jeweiligen Seite. Die Entwickler werden deine Fragen beantworten und das Handbuch schnellstmöglich aktualisieren. Auf diese Art und Weise kannst du die Nutzbarkeit der CryptoBox für alle Nutzer verbessern!
-CryptoBoxUserGettingStarted/de -- die Vorbereitung der Hardware
-CryptoBoxUserConfiguration/de -- die Einrichtung deines neuen verschlüsselten Dateiservers
-CryptoBoxUserDailyUse/de -- die tägliche Nutzung der CryptoBox
-Die online-Version dieses Handbuchs befindet sich unter https://systemausfall.org/toolforge/CryptoBoxUser/de.
-+
+Navigation: ( CryptoBox/de) +
++Die folgenden Seiten beschreiben die Nutzung der CryptoBox. +
++Die online-Version dieses Handbuchs ist ein Wiki. Das bedeutet, dass du diese Seiten verändern kannst. Falls du also Fragen oder Anregungen hast, schreibe bitte deine Anmerkungen in den Kommentar-Abschnitt am Ende der jeweiligen Seite. Die Entwickler werden deine Fragen beantworten und das Handbuch schnellstmöglich aktualisieren. Auf diese Art und Weise kannst du die Nutzbarkeit der CryptoBox für alle Nutzer verbessern! +
++Die online-Version dieses Handbuchs befindet sich unter https://systemausfall.org/trac/cryptobox/wiki/CryptoBoxUser/de. +
++
+
-
+
Alle Funktionen der CryptoBox können durch das komfortable Web-Interface bedient werden. Zur Erst-Einrichtung der CryptoBox folge einfach den folgenden Schritten.
-Falls du in Eile bist, kannst du das Vorwort überspringen.
-Die Initialisierung erklärt die Einrichtung der Festplatte. Dieser Schritt ist nur bei der ersten Einrichtung oder nach einem Festplattenwechsel notwendig.
-Im Konfigurations-Abschnitt werden die verfügbaren Einstellungen der CryptoBox beschrieben. Hier kannst du beispielsweise die Sprache des Web-Interfaces oder die Netzwerkadresse deiner CryptoBox einstellen.
-Vergiss nicht, auch den Hinweise/Fallstricke-Abschnitt zu lesen.
- -Du bist den Anweisungen aus CryptoBoxUserGettingStarted/de gefolgt und sitzt nun vor deinem Arbeits-Rechner. Nun kannst du in deinem Web-Browser das Web-Interface der CryptoBox ansteuern: https://192.168.0.23.
-Bevor du Daten auf deiner CryptoBox speichern kannst, muss die Festplatte mit einem verschlüsselten Dateisystem versehen werden. Das klingt kompliziert, ist jedoch mit einem Klick erledigt.
- -Klickke auf Initialisierung in der Menü-Zeile.
-Jetzt wirst du zur Eingabe zweier Passworte aufgefordert (jeweils mit Wiederholung - zum Training deiner Tipp-Fertigkeiten ;)).
--
Das erste Passwort ist das Administrations-Password.
-Es schützt die Konfiguration deiner CryptoBox.
-Dies ist notwendig, um zu verhindern, dass jemand unerlaubt die Daten auf deiner CryptoBox durch eine erneute Initialisierung löscht.
-Wahrscheinlich wirst du dieses Passwort nie wieder benötigen.
-Du kannst das Administrations-Passwort leer lassen - dies wird jedoch nicht empfohlen.
-Das Crypto-Passwort ist wesentlich wichtiger, da es der einzige Schutz der Daten auf der verschlüsselten Festplatte ist. Wähle es mit Sorgfalt!
-Du benötigst es, um auf deine Daten zuzugreifen.
-Ein sicheres Passwort sollte aus mindestens 15 Zeichen (einschließlich Ziffern und Sonderzeichen) bestehen. Die Sicherheit deiner Daten steht und fällt mit der Qualität dieses Passworts.
-Um dich daran zu erinnern, dass dieser Schritt die Festplatte der CryptoBox komplett löschen wird, musst du den angezeigten roten Warnhinweis im letzten Formularfeld eingeben.
-Nun kannst du die Initialisierung durch einen Klick auf Initialisiere die CryptoBox abschließen.
-Das war es dann auch schon. Cryptographie war wohl nie einfacher zu verwenden, oder?
-Der Initialisierungsvorgang läuft nun im Hintergrund ab und wird nach wenigen Minuten (abhängig von der Größe deiner Festplatte) abgeschlossen.
- -Im Gegensatz zur Initialisierung, die nur einmal durchgeführt werden muss, kannst du die Konfiguration jederzeit deinen Wünschen anpassen. Dazu klickst du einfach auf Konfiguration in der Menü-Zeile des Web-Interfaces. Nun wird dir ein Formular mit vier Feldern präsentiert:
--
Falls du ein Administrator-Passwort während der Initialisierung festgelegt hast, musst du es nun eingeben. Andernfalls wird dieses Formularfeld nicht angezeigt.
-Du kannst die voreingestellte Netzwerk-Adresse (IP) verändern, falls sie nicht zu deiner Netzwerk-Struktur passt.
-Die Zeitabschaltung sorgt dafür, dass nach einer festgelegten Dauer von Inaktivität (in Minuten), das Crypto-Dateisystem deaktiviert wird (damit sind deine Daten wieder geschützt). Laufende Dateiübertragungen werden dadurch natürlich nicht gestört.
-Es ist ratsam, eine kurze Abschalt-Zeit einzustellen (wenige Minuten).
-Der Wert 0 deaktiviert die automatische Abschaltung.
-Die Sprache ist der Standard für alle Nutzer des CryptoBox-Web-Interfaces. Sie kann individuell durch die Sprach-Links am rechten oberen Bildschirmrand überschrieben werden.
-Speichere deine neuen Einstellungen durch einen Klick auf Speichere Konfiguration.
-Das ist alles - deine CryptoBox ist jetzt bereit für die tägliche Nutzung!
- -Alle Daten auf der Festplatte in der CryptoBox werden bei der Initialisierung gelöscht.
-Die Passworte müssen jeweils zweimal eingegeben werden, um die Gefahr von Tipp-Fehlern zu vermindern.
-Das optionale Administrations-Passwort ist nur für die Konfiguration oder eine erneute Initialisierung erforderlich.
-Das Crypto-Passwort beschützt deine sensiblen Daten.
-Falls die CryptoBox nicht über die Adresse 192.168.0.23 erreichbar ist, musst du die Netzwerk-Adresse deines Arbeits-Rechners für die Dauer der Initialisierung der CryptoBox vorübergehend ändern.
-zurück zu CryptoBoxUser/de
-- -
+Navigation: ( CryptoBoxUser/de) +
++Alle Funktionen der CryptoBox können durch das komfortable Web-Interface bedient werden. Zur Erst-Einrichtung der CryptoBox folge einfach den folgenden Schritten. +
++Falls du in Eile bist, kannst du das Vorwort überspringen. +
++Die Initialisierung erklärt die Einrichtung der Festplatte. Dieser Schritt ist nur bei der ersten Einrichtung oder nach einem Festplattenwechsel notwendig. +
++Im Konfigurations-Abschnitt werden die verfügbaren Einstellungen der CryptoBox beschrieben. Hier kannst du beispielsweise die Sprache des Web-Interfaces oder die Netzwerkadresse deiner CryptoBox einstellen. +
++Vergiss nicht, auch den Hinweise/Fallstricke-Abschnitt zu lesen. +
++Du bist den Anweisungen aus CryptoBoxUserGettingStarted gefolgt und sitzt nun vor deinem Arbeits-Rechner. Nun kannst du in deinem Web-Browser das Web-Interface der CryptoBox ansteuern: https://192.168.0.23. +
++Bevor du Daten auf deiner CryptoBox speichern kannst, muss die Festplatte mit einem verschlüsselten Dateisystem versehen werden. Das klingt kompliziert, ist jedoch mit einem Klick erledigt. :) +
++Klicke auf Initialisierung in der Menü-Zeile. +
++Jetzt wirst du zur Eingabe zweier Passworte aufgefordert (jeweils mit Wiederholung - zum Training deiner Tipp-Fertigkeiten ;)). +
+ ++Das war es dann auch schon. Kryptographie war wohl nie einfacher zu verwenden, oder? ;) +
++Der Initialisierungsvorgang läuft nun im Hintergrund ab und wird nach wenigen Minuten (abhängig von der Größe deiner Festplatte) abgeschlossen. +
++Im Gegensatz zur Initialisierung, die nur einmal durchgeführt werden muss, kannst du die Konfiguration jederzeit deinen Wünschen anpassen. Dazu klickst du einfach auf Konfiguration in der Menü-Zeile des Web-Interfaces. Nun wird dir ein Formular mit vier Feldern präsentiert: +
+ ++Speichere deine neuen Einstellungen durch einen Klick auf Speichere Konfiguration. +
++Das ist alles - deine CryptoBox ist jetzt bereit für die tägliche Nutzung! +
++zurück zu CryptoBoxUser +
++
+
-
+
Du kannst dein verschlüsseltes Dateisystem mit folgenden Schritten aktivieren:
-Wähle mit deinem Web-Browser die Adresse deiner CryptoBox an. Die Voreinstellung ist https://192.168.0.23.
-Klicke auf Aktivieren der Crypto-Daten. Daraufhin erscheint ein Formular zur Eingabe des Crypto-Passworts.
-Gib dein Crypto-Passwort ein und klicke auf die darunterliegende Schaltfläche.
--
Nun ist das verschlüsselte Dateisystem verfügbar. Um es zu nutzen, suche in deiner Netzwerkumgebung nach der Netzwerk-Adresse deiner CryptoBox (Voreinstellung: 192.168.0.23). Nun kannst du das Netzlaufwerk wie üblich verwenden.
- -Du kannst das verschlüsselte Dateisystem abschalten, indem du in der Menü-Zeile des Web-Interfaces der CryptoBox auf Deaktivierung der Crypto-Daten klickst.
-Deine Daten sind nun wieder vor jedem Zugriff geschützt.
- -Klicke auf System in der Menü-Zeile des Web-Interfaces. Nun kannst du zwischen Abschaltung und Neustart wählen. Die Abschaltung dauert einige Sekunden.
-Falls dein CryptoBox-Rechner relativ neu ist (ungefähr ab Baujahr 02000), wird er sich nun selbständig abschalten. Andernfalls musst du dies per Hand tun.
- -Falls du deine Daten wirklich schnell vor neugierigen Augen schützen musst, dann ziehe einfach den Stecker der CryptoBox. Dies ist nicht besonders sauber und kann (in sehr seltenen Ausnahmefällen) geöffnete Dateien beschädigen. Es ist jedoch die schnellste Methode zur Sicherung deiner Daten vor unbefugtem Zugriff.
-zurück zu CryptoBoxUser/de
-- -
+Navigation: ( CryptoBoxUser/de, CryptoBoxUserConfiguration/de) +
++Du kannst dein verschlüsseltes Dateisystem mit folgenden Schritten aktivieren: +
++Nun ist das verschlüsselte Dateisystem verfügbar. Um es zu nutzen, suche in deiner Netzwerkumgebung nach der Netzwerk-Adresse deiner CryptoBox (Voreinstellung: 192.168.0.23). Nun kannst du das Netzlaufwerk wie üblich verwenden. +
++Um als normaler Nutzer auf die Crypto-Partition zuzugreifen, solltest du folgende Zeile zur /etc/fstab hinzufügen: +
+//192.168.0.23/public /mnt/ smbfs defaults,noexec,noauto,user,guest 0 0 +
+Nun kannst du die Crypto-Partition nach /mnt mounten: +
+mount /mnt/ +
+bzw. unmounten: +
+smbumount /mnt +
+Starte den Windows Explorer und wähle im Menü unter Extras die Option Netzlaufwerke verbinden aus. +
+ ++Trage unter Pfad die Adresse des Verzeichnisse der CryptoBox ein, auf das du zugreifen willst (Standard: \\192.168.0.23\public). Soll die Verbindung beim jedem Start von Windows wiederhergestellt werden, aktiviere Verbindung beim Start wiederherstellen. +
++Nun kannst du auf das verschlüsselte Dateisystem wie jedes andere Laufwerk benutzen. +
++Du kannst das verschlüsselte Dateisystem abschalten, indem du in der Menü-Zeile des Web-Interfaces der CryptoBox auf Deaktivierung der Crypto-Daten klickst. +
++Deine Daten sind nun wieder vor jedem Zugriff geschützt. +
++Klicke auf System in der Menü-Zeile des Web-Interfaces. Nun kannst du zwischen Abschaltung und Neustart wählen. Die Abschaltung dauert einige Sekunden. +
++Falls dein CryptoBox-Rechner relativ neu ist (ungefähr ab Baujahr 02000), wird er sich nun selbständig abschalten. Andernfalls musst du dies per Hand tun. +
++Falls du deine Daten wirklich schnell vor neugierigen Augen schützen musst, dann ziehe einfach den Stecker der CryptoBox. Dies ist nicht besonders sauber und kann (in sehr seltenen Ausnahmefällen) geöffnete Dateien beschädigen. Es ist jedoch die schnellste Methode zur Sicherung deiner Daten vor unbefugtem Zugriff. +
++zurück zu CryptoBoxUser +
++Erscheint diese Fehlermeldung, hast du dich beim Start von Windows nicht angemeldet bzw. das Anmeldefenster mit der Taste Esc (Escape) verschwinden lassen. Klicke auf Start und Abmelden und melde dich neu an - sobald das Anmeldefenster erscheint, klicke auf OK: +
+ ++Das Unmounten der Crypto-Partition mit umount funktioniert nicht. +
++Lösung: Verwende stattdessen: +
+smbumount /mnt +
+Der Versuch die Partition als normaler Nutzer zu mounten schlägt fehl: +
+cannot mount on /mnt/: Operation not permitted +smbmnt failed: 1 +
+Lösung: Das Mount-Verzeichnis muss dem selben Nutzer gehören, der den mount-Befehl ausführt (bspw. phil): +
+chown phil. /mnt +
+
+
-
+
Die CryptoBox ist schnellt aufgebaut:
-Du brauchst einen alten Computer (mindestens 100MHZ, 48MB RAM) (Faustregel: nach 1996 gekauft). Dazu eine passende Netzwerkkarte, ein CD-ROM Laufwerk und eine riesige Festplatte.
-Die Festplatte muss nicht riesig sein, je nachdem was du speichern willst, reicht auch 'ne kleine
-Du brauchst keinen Monitor, keine Tastatur und keine Maus, um die CryptoBox zu benutzen (bzw. nur für die Erst-Einrichtung).
-Du kannst natürlich einen schnelleren Rechner verwenden - der unbedeutende Performance-Zuwachs wird jedoch wohl nicht durch den erhöhten Energiebedarf gerechtfertigt.
-Lade die aktuellste Version der CryptoBox als iso-image herunter und brenne dieses auf einen CD-Rohling.
- -Konfiguriere den PC, so dass er vom CD Laufwerk bootet. Dazu solltest du im BIOS als "boot device" "CD-ROM" einstellen.
-Pack die frisch gebrannte CryptoBox CD ins Laufwerk und starte den Computer.
-Wenn der Computer jetzt von der CD startet, hast du alle Anforderungen erfüllt.
-Du kannst nun zu deinem Arbeits-Rechner in demselben Netzwerk gehen und "https://192.168.0.23" ansurfen. Dort sollte die CryptoBox-Konfigurationsseite erscheinen. Ist doch kinderleicht, oder?
-Die weiteren Schritte werden unter CryptoBoxUser/de beschrieben.
- -Eventuell musst du für die Einrichtung der CryptoBox kurzzeitig deine Netzwerkaddresse (IP) ändern. Falls du nicht weißt, wie und warum, dann frage jemanden um Rat ... (wahrscheinlich klappt es aber ohne Änderungen)
-Falls du eine neue Festplatte kaufen willst, beachte, dass alte PCs nicht mit modernen Festplattengrößen klarkommen.
-Einige alte PCs können nicht vom CD-ROM-Laufwerk booten.
-Falls dir der Begriff "BIOS" nichts sagt, bitte Menschen um Hilfe, bevor du was veränderst
-Vergiss nicht, den CryptoBox-Rechner ans Netzwerk anzuschliessen!
-Du brauchst einen Monitor und eine Tastatur für die Konfiguration des BIOS.
-zurück zu CryptoBoxUser/de
-- -
+Navigation: ( CryptoBoxUser/de, CryptoBoxUserConfiguration/de) +
++Die CryptoBox ist schnell aufgebaut: +
++Wenn der Computer jetzt von der CD startet, hast du alle Anforderungen erfüllt. +
++Du kannst nun zu deinem Arbeits-Rechner in demselben Netzwerk gehen und "https://192.168.0.23" ansurfen. Dort sollte die CryptoBox-Konfigurationsseite erscheinen. Ist doch kinderleicht, oder? +
++Die weiteren Schritte werden unter CryptoBoxUserConfiguration beschrieben. +
++
+
-
-
see CryptoBoxIntro/en for a very short overview
- -We are moving this project to https://codecoop.org/projects/cryptobox/
-The first release of the CryptoBox-LiveCD is planned for October 02005.
- -The CryptoBox is a Debian/Linux based live-cd. This CD boots up, starting a secure fileserver. Even non-technical users are able to store their data on its encrypted harddisk. There is no special knowledge about cryptography or servers required at all.
-We provide the documentation in different languages. Feel free to add more translations:
- - -
- system - |
-
- Debian/Linux based Live-CD - |
-
- needed hardware - |
-
- "outdated" PC (i386 p1-100 32MB RAM minimum) - |
-
- supported clients - |
-- - | -
- fileserver - |
-
- samba (network shares) - |
-
- userinterface - |
-
- fully remote controlled via webbrowser - |
-
- encryption - |
-
- AES via device-mapper - |
-
The web interface of the CryptoBox supports the following languages:
-english
-german
-slovenian
-Feel free to contribute a translation for another language (preferably utf-encoded).
-The user documentation has its home at CryptoBoxUser/en.
- -Take a look at the developer's documentation at CryptoBoxDev/en.
-Report bugs at https://systemausfall.org/trac/cryptobox.
-Browse the source code in the CryptoBox-websvn interface.
-Anything else? Write us an email: cryptobox[at]systemausfall.org
- -All scripts are GPL licensed
-The documentation licensed under a Creative Commons License
-We do not take any warranty for the functionality or usability of the CryptoBox.
-+The first release of the CryptoBox is available at Codecoop.org. +
+
+The CryptoBox is a Debian/Linux based live-cd. This CD boots up, starting a secure fileserver. Even non-technical users are able to store their data on its encrypted harddisk. There is no special knowledge about cryptography or servers required at all.
+The CryptoBox is fully controllable via your web browser. Have a look at the ScreenShots.
+
Specs + | |
system | Debian/Linux based Live-CD + |
needed hardware | "outdated" PC (i386 p1-100 32MB RAM minimum) + |
supported clients | *nix; *bsd; Windows; Mac OS + |
fileserver | samba (network shares) + |
userinterface | fully remote controlled via webbrowser + |
encryption | AES via device-mapper + |
+The web interface of the CryptoBox supports the following languages: +
++We are looking for more translations. Just take a look at the "README"-file in our language section. +There you can find further instructions if you'd like to contribute. +
++Take a look at the developer's documentation at CryptoBoxDev for more information. +
++
+
+
-
+
The following pages are written for developers only. Users of the CryptoBox should read CryptoBoxUser instead.
-We are waiting for your emails to cryptobox[at]systemausfall.org.
- -Please use our issue tracker, if you discover problems: https://systemausfall.org/trac/cryptobox
+ ++Navigation: ( CryptoBox/de, CryptoBox/en) +
+
+The following pages are written for developers only.
+Users of the CryptoBox should read CryptoBoxUser instead.
+
+You may browse the source code. +
++We are waiting for your emails to cryptobox[at]systemausfall.org. +
++If you think you found a bug or you get an error message, please help us to fix the problem and file a ticket (a bug report). Follow these steps: +
++
-
-
back to CryptoBoxDev
++Navigation: ( CryptoBoxDev) -
The base system of the CryptoBox Live-CD is created by dfsbuild.
-It is recommended to use some kind of caching tool for the retrieval of the debian packages (e.g.: apt-cacher or apt-proxy). This saves a lot of bandwidth and time.
-The documentation for dfsbuild is sparse. But it is quite unlikely, that you will get in direct contact with it, as it is wrapped by cbox-build. However the following links may help you for specific problems:
- - -The linux kernel for the CryptoBox is compiled statically. If you want to change it, you could follow this steps:
-get the sources: apt-get install kernel-tree-2.6.11 (or the version of your choice)
-copy the exisiting config file kernel/config-2.6.11 as .config into your kernel source directory
-build the debian kernel package make-kpkg --revision=1.dfs --rootcmd=fakeroot kernel_image
-change the kernel in the unpackdebs setting in dfs-cbox.conf (see CryptoBoxDevCustomBuild for details)
-Qemu is a portable system emulator. It is a convenient tool to ease the development workflow, as you do not need to burn LiveCDs for testing.
- -We tried some other LiveCDs before we decided to use dfsbuild. The following pages describe their advantages and disadvantages as the base system for the CryptoBox:
-CryptoBoxKnoppixVerworfen - Knoppix
-CryptoBoxMorphixVerworfen - Morphix / IBuild
-+The base system of the CryptoBox Live-CD is created by dfsbuild. +
++It is recommended to use some kind of caching tool for the retrieval of the debian packages (e.g.: apt-cacher, apt-proxy or approx). This saves a lot of bandwidth and time. +
++The documentation for dfsbuild is sparse. But it is quite unlikely, that you will get in direct contact with it, as it is wrapped by cbox-build. However the following links may help you for specific problems: +
++The linux kernel for the CryptoBox is compiled statically. If you want to change it, you could follow this steps: +
++See source:trunk/hints/kernel-build.txt for more details. +
++Qemu is a portable system emulator. It is a convenient tool to ease the development workflow, as you do not need to burn LiveCDs for testing. +
++We tried some other LiveCDs before we decided to use dfsbuild. The following pages describe their advantages and disadvantages as the base system for the CryptoBox: +
++
+
- + ++Navigation: ( CryptoBoxDev, CryptoBoxDevBackground, CryptoBoxDevPreparation, CryptoBoxDevWorkFlow) - -
-
-
back to CryptoBoxDev
- -The following sections are useful, if you want to change the default settings of your personal CryptoBox development environment.
-You should have completed the steps described in CryptoBoxDevPreparation.
- -All settings for dfsbuild can be found in etc-defaults.d/dfs-cbox.conf.
-If you want to change any of them, you should do the following:
-copy etc-defaults.d/dfs-cbox.conf file to etc-local.d/
-change etc-local.d/dfs-cbox.conf according to your needs
-This allows you to use your own (personal) settings, without interfering with files under version control.
- -Some settings regarding the building, configuring and validating of the CryptoBox can be found in etc-defaults.d/cbox-dev.conf.
-If you want to change any of them, you should do the following:
-copy etc-defaults.d/cbox-dev.conf file to etc-local.d/
-change etc-local.d/cbox-dev.conf according to your needs
-The file etc-defaults.d/ssh_config is used to establish a connection to a running CryptoBox system.
-It can be necessary to change these settings, if:
-you do not want to use the default IP for the CryptoBox
-or the CryptoBox is not within your local network.
-If you want to change some settings, you should do the following:
-copy etc-defaults.d/ssh_config file to etc-local.d/
-change etc-local.d/ssh_config according to your needs
-The file etc-defauolts.d/qemu-ifup is used for the CryptoBox emulation with qemu. See man qemu for details.
-If you want to change some settings, you should do the following:
-copy etc-defaults.d/qemu-ifup file to etc-local.d/
-change etc-local.d/qemu-ifup according to your needs
-+The following sections are useful, if you want to change the default settings of your personal CryptoBox development environment. +
++You should have completed the steps described in CryptoBoxDevPreparation. +
++All settings for dfsbuild can be found in etc-defaults.d/dfs-cbox.conf. +
++If you want to change any of them, you should do the following: +
++This allows you to use your own (personal) settings, without interfering with files under version control. +
++Some settings regarding the building, configuring and validating of the CryptoBox can be found in etc-defaults.d/cbox-dev.conf. +
++If you want to change any of them, you should do the following: +
++The file ssh_config is used to establish a connection to a running CryptoBox system. +
++It can be necessary to change these settings, if: +
++If you want to change some settings, you should do the following: +
++The file etc-defauolts.d/qemu-ifup is used for the CryptoBox emulation with qemu. See man qemu for details. +
++If you want to change some settings, you should do the following: +
++
+
-+Navigation: ( CryptoBoxDev) -
You may change nearly every aspect of the CryptoBox by using the custom configuration hook directory.
-Any script inside of this directory will be executed after the default configuration procedure (see CryptoBoxDevWorkFlow).
-The order of execution is defined by the names of the scripts (alphabetically).
- -Some example customization scripts can be found in configure-examples.d/.
-You may put your scripts into configure-local.d/. They will be sourced by cbox-build.sh.
- -The examples in configure-examples.d/ can be copied to configure-local.d/ and adjusted to your needs.
-change the default IP address of the CryptoBox
-set the default language
-set the default idle time for automatic unmounting
-change the default hostname
-change the password of root (only useful for a development CryptoBox)
-upload a ssh key for passwordless access to a development CryptoBox
-where to look for usable harddisks
-+You may change nearly every aspect of the CryptoBox by using the custom configuration hook directory. +
++Any script inside of this directory will be executed after the default configuration procedure (see CryptoBoxDevWorkFlow). +
++The order of execution is defined by the names of the scripts (alphabetically). +
++Some example customization scripts can be found in configure-examples.d/. +
++You may put your scripts into configure-local.d/. They will be sourced by cbox-build.sh. +
++The examples in configure-examples.d/ can be copied to configure-local.d/ and adjusted to your needs. +
+set_default_ip | change the default IP address of the CryptoBox + |
set_default_language | set the default language + |
set_default_timeout | set the default idle time for automatic unmounting + |
set_hostname | change the default hostname + |
set_root_pw | change the password of root (only useful for a development CryptoBox) + |
import_authorized_keys | upload a ssh key for passwordless access to a development CryptoBox + |
set_scan_devices | where to look for usable harddisks + |
+
+
+Navigation: ( CryptoBoxDev) - -
-
- -
You should update qemu to version 0.7 or higher.
- -This happens under certain circumstances. We do not know a solution for this problem.
+ ++You should update qemu to version 0.7 or higher. +
++This happens under certain circumstances. We do not know a solution for this problem. +
++This can be caused by a (strange) mix of debian package versions. Track this bug at http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=320991. +
++
+
-
-
back to CryptoBoxDev
- -We use Debian as our development environment. This was a natural choice, as the CryptoBox-LiveCD is also based on Debian. Other distributions should work too, of course - YMMV.
-required:
-recommended:
-If you want to use qemu to test your CryptoBox in a virtual environment, then you will need the tun/tap kernel feature.
--CONFIG_TUN=m+
+Navigation: ( CryptoBoxDev, CryptoBoxDevCustomBuild, CryptoBoxDevWorkFlow) -
Download the latest release from our subversion-Repository:
--svn checkout https://svn.systemausfall.org/svn/cryptobox/trunk- -
run scripts/cbox-build.sh release as root - hopefully, there should be no errors
-Hint: This step will fail, if you did not install apt-cacher. See CryptoBoxDevCustomBuild for details on how to change the build-configuration settings (in this case: mirror in dfs-cbox.conf).
- -Now you can start to pariticipate in the development of the CryptoBox or simply customize your own CryptoBox-LiveCD.
-See CryptoBoxDevWorkFlow for details of how to use the developer's tools of the CryptoBox.
-CryptoBoxDevCustomBuild shows some examples for local customizations of the CryptoBox.
++We use Debian as our development environment. This was a natural choice, as the CryptoBox-LiveCD is also based on Debian. Other distributions should work too, of course - your mileage may vary. +
++required: +
++recommended: +
++If you want to use qemu to test your CryptoBox in a virtual environment, then you will need the tun/tap kernel feature. +
+CONFIG_TUN=m +
+Download the latest release from our subversion-Repository: +
+svn checkout https://svn.systemausfall.org/svn/cryptobox/trunk +
+run scripts/cbox-build.sh release as root - hopefully, there should be no errors :) +
++Hint: This step will fail, if you did not install apt-cacher. See CryptoBoxDevCustomBuild for details on how to change the build-configuration settings (in this case: mirror in dfs-cbox.conf). +
++Now you can start to pariticipate in the development of the CryptoBox or simply customize your own CryptoBox-LiveCD. +
++See CryptoBoxDevWorkFlow for details of how to use the developer's tools of the CryptoBox. +
++CryptoBoxDevCustomBuild shows some examples for local customizations of the CryptoBox. +
++
+
-
-
back to CryptoBoxDev
++Navigation: ( CryptoBoxDev) -
The validation feature allows to check the programming logic of the CryptoBox. A lot of test cases are defined to test as many functions of the CryptoBox as possible.
-The requests are processed with curl.
-The received web page is saved to allow a later design review or css debugging.
-The current state of the CryptoBox is represented by ten single values (e.g.: box is configured, IP of the box, current language setting, ...), which are invisibly a part of each html page (as comments). The returned status of every request is compared to the predicted value of the test case.
-Similar test cases are pooled into test groups (e.g.: initialization, configuration and mounting).
- -Run scripts/validate.sh check_all to conduct all tests of all groups. See scripts/validate.sh help for other actions.
-The results will be saved in validation/report.
-In addition to every single retrieved page, a html page called summary.html is created, which contains the state checks of all tests in a group.
- -All test cases can be found in validation/test-cases.
-Every test consists of:
-the configuration file for the curl request
-the predicted state of the CryptoBox after the call
-a short description of the test (will be used for the summary)
-[optional] time to wait after this test
-Use the existing test cases as templates for new tests.
-Any logical path of the web interface CGI should be validated by a test case.
+ ++The validation feature helps you to check the programming logic of the CryptoBox. A lot of test cases are defined to verify as many functions of the CryptoBox as possible. +
++The requests are processed with curl. +
++The received web page is saved to allow a later design review or css debugging. +
++The current state of the CryptoBox is represented by ten single values (e.g.: box is configured, IP of the box, current language setting, ...), which are invisibly a part of each html page (as comments). The returned status of every request is compared to the predicted value of the test case. +
++Similar test cases are pooled into test groups (e.g.: initialization, configuration and mounting). +
++Run scripts/validate.sh] to conduct all tests of all groups. See scripts/validate.sh help for other actions. +
++The results will be saved in validation/report. +
++In addition to every single retrieved page, a html page called summary-?.html is created, which contains the state checks of all tests in a group. +
++All test cases can be found in validation/test-cases. +
++Every test consists of the following files: +
+input.curl | the configuration file for the curl request + |
output | the predicted state of the CryptoBox after the call + |
description | a short description of the test (will be used for the summary) + |
delay | [optional] time to wait after this test + |
+Use the existing test cases as templates for new tests. +
++Read validation/test-cases/README for details. +
++Every logical path of the web interface CGI should be validated by a test case. +
++
+
+Navigation: ( CryptoBoxDev, CryptoBoxDevCustomConfigure, CryptoBoxDevPreparation) -
-
-
back to CryptoBoxDev
- -You should have completed the steps described in CryptoBoxDevPreparation.
- -The following steps can be executed in the order of their appearance.
-Usually there is no need to repeat the whole process, after you changed some parts of the CryptoBox. Especially the first step (building of the base system with dfsbuild) may usually be skipped.
-Every step of the building process must be executed as root.
- -Run scripts/cbox-build.sh dfsbuild to create the base system for the LiveCD.
-The result can be found in _builddir/cd1/image.
-If you do not want to use the apt-cacher to save bandwidth and time, then you should modify the mirror-setting in dfs-cbox.conf (see CryptoBoxDevCustomBuild for details).
- -Run scripts/cbox-build.sh config to copy the CryptoBox-specific files to the base image.
-TODO: link to cbox-build.sh-manpage
- -The original base system, that was created by dfsbuild contains a lot packages and some scripts, that are only useful during development. You should remove them, as they case severe security implications.
-To reduce the CryptoBox-LiveCD to the usable minimum for operational use, you should run scripts/cbox-build.sh harden.
- -To burn a CryptoBox-LiveCD, you need an bootable iso9660-image.
-Create the iso image with scripts/cbox-build.sh iso. The resulting file can be found at _builddir/cd1/cryptobox.iso.
- -Do it manually: cdrecord -v dev=0,0,0 _builddir/cd1/cryptobox.iso (change the dev setting according to your setup).
-Let the script do it for you: scripts/cbox-build.sh burn (maybe you have to change the CDWRITER setting in cbox-dev.conf - see CryptoBoxDevCustomBuild).
-Of course, it is not wise to use CD-R media. CD-RW consume less resources.
- -This section is only useful for developers, who want to improve or change the CryptoBox system.
- -If you modified the perl- or shell-scripts of the CryptoBox, then you can check for syntax errors by running them in a chroot environment. Be careful: you have access to all ressources of your computer, while you are working within a chroot environment - so you can easily repartition your real disk ...
-To start a chroot environment, you can execute scripts/cbox-dev.sh chroot.
-For more intensive tests, you may use qemu (see below) or burn real LiveCDs - of course this would take much more time.
- -The processor emulator qemu allows you test the CryptoBox in a virtual environment, that is completely separated from your real computer's resources. It is the tool of choice, if you do nat have a real computer around for testing.
-Beware - there are some problems, when using qemu:
-smbd does not start (segfault)
-???
-To start a qemu emulation of the iso image, you may type: scripts/cbox-dev.sh qemu.
- -This section is only useful for developers, who want to develop on a running CryptoBox system (emulated or real).
-You may access the CryptoBox directly or you can use ssh to open a remote session (./cbox-dev.sh ssh).
- -When you run an emulation or test a real LiveCD, you may encounter problems and bugs. To test your fixes for these problems, it is convenient, to change the running test system. Afterwards you can merge these changes to your local development copy.
-Type scripts/cbox-dev.sh diff to see the changes, you made on the running CryptoBox system.
-Type scripts/cbox-dev.sh merge to merge these changes to your local working copy.
- -Alternatively you may also upload a new version of your local working copy to the running CryptoBox system.
-Type scripts/cbox-dev.sh upload - beware: all recent changes you made to the running CryptoBox system, are lost.
+ ++You should have completed the steps described in CryptoBoxDevPreparation. +
++The following steps can be executed in the order of their appearance. +
++Usually there is no need to repeat the whole process, after you changed some parts of the CryptoBox. Especially the first step (building of the base system with dfsbuild) may usually be skipped. +
++Every step of the building process must be executed as root. +
++Run scripts/cbox-build.sh dfsbuild to create the base system for the LiveCD. +
++The result can be found in _builddir/cd1/image. +
++If you do not want to use the apt-cacher to save bandwidth and time, then you should modify the mirror-setting in dfs-cbox.conf (see CryptoBoxDevCustomBuild for details). +
++Run scripts/cbox-build.sh config to copy the CryptoBox-specific files to the base image. +
++TODO: link to cbox-build.sh-manpage +
++The original base system, that was created by dfsbuild contains a lot packages and some scripts, that are only useful during development. You should remove them, as they cause severe security implications. +
++To reduce the CryptoBox-LiveCD to the usable minimum for operational use, you should run scripts/cbox-build.sh harden. +
++To burn a CryptoBox-LiveCD, you need an bootable iso9660-image. +
++Create the iso image with scripts/cbox-build.sh iso. The resulting file can be found at _builddir/cd1/cryptobox.iso. +
++Do it manually: +
+cdrecord -v dev=0,0,0 _builddir/cryptobox.iso +
+(change the dev setting according to your setup). +
++Let the script do it for you: scripts/cbox-build.sh burn (maybe you have to change the CDWRITER setting in cbox-dev.conf - see CryptoBoxDevCustomBuild). +
++Of course, it is not wise to use CD-R media. CD-RW consume less resources. +
++This section is only useful for developers, who want to improve or change the CryptoBox system. +
++If you modified the perl- or shell-scripts of the CryptoBox, then you can check for syntax errors by running them in a chroot environment. Be careful: you have access to all ressources of your computer, while you are working within a chroot environment - so you can easily repartition your real disk ... +
++To start a chroot environment, you can execute scripts/cbox-dev.sh chroot. +
++For more intensive tests, you may use qemu (see below) or burn real LiveCDs - of course this would take much more time. +
++The processor emulator qemu allows you test the CryptoBox in a virtual environment, that is completely separated from your real computer's resources. It is the tool of choice, if you do nat have a real computer around for testing. +
++Beware - there are some problems, when using qemu: +
++To start a qemu emulation of the iso image, you may type: +
+scripts/cbox-dev.sh qemu +
+This section is only useful for developers, who want to develop on a running CryptoBox system (emulated or real). +
++You may access the CryptoBox directly or you can use ssh to open a remote session: +
+./cbox-dev.sh ssh +
+When you run an emulation or test a real LiveCD, you may encounter problems and bugs. To test your fixes for these problems, it is convenient, to change the running test system. Afterwards you can merge these changes to your local development copy. +
++Type scripts/cbox-dev.sh diff to see the changes, you made on the running CryptoBox system. +
++Type scripts/cbox-dev.sh merge to merge these changes to your local working copy. +
++Alternatively you may also upload a new version of your local working copy to the running CryptoBox system. +
++Type scripts/cbox-dev.sh upload - beware: all recent changes you made to the running CryptoBox system, are lost. +
++
+
-
- -
The following pages describe the easy use of the CryptoBox.
-The online version of this manual is a wiki, which means you can edit the pages. So if you have a question or some description is unclear, please post it on the bottom of the relevant page. The developers will answer your questions and update the manual as fast as possible. This way you can contribute in making the CryptoBox a better experience for everyone!
-CryptoBoxUserGettingStarted/en -- first steps to get the Cryptobox up and running
-CryptoBoxUserConfiguration/en -- configure the details of your new encrypted fileserver
-CryptoBoxUserDailyUse/en -- daily use of your CryptoBox
-The online version of this manual can be found at https://systemausfall.org/toolforge/CryptoBoxUser/en.
-+
+Navigation: ( CryptoBox/en, CryptoBoxUser) +
++The following pages describe the easy use of the CryptoBox. +
++The online version of this manual is a wiki, which means you can edit the pages. So if you have a question or you perceive a description as unclear, please post it on the bottom of the relevant page. The developers will answer your questions and update the manual as fast as possible. This way you can contribute in making the CryptoBox a better experience for everyone! +
++The online version of this manual can be found at https://systemausfall.org/trac/cryptobox/wiki/CryptoBoxUser/en. +
++
+
-
+
All parts of administration of the CryptoBox are done through a comfortable web interface. If this is the first time you use the CryptoBox, just follow the steps below.
-You can safely ignore the Foreword if you're in a hurry.
-Initialization describes the process of integrating a new harddisk. You usually have to perform this steps if you start with a new CryptoBox or after changing the harddisk.
-In the Configuration section, you can configure the CryptoBox according to your personal needs, e.g. change your desired language for the web interface or change the IP address of the CryptoBox.
-Don't forget to read the Hints / Caveats section too.
- -Okay, you finished the CryptoBoxUserGettingStarted/en and are now sitting in front of a computer that is connected via network with your CryptoBox. You point a browser to "https://192.168.0.23" and the CryptoBox interface appears.
-Before you can save data on your CryptoBox, its harddisk has to be formatted with a cryptographic filesystem. Sounds complicated but don't be scared - it's really a "one click" thing.
- -Click on Initialize CryptoBox in the title bar.
-Now you are promted to enter two passwords twice (because we want to train your typing skills ;).
-The first password is the administration password.
-It is used to protect the configuration of the CryptoBox.
-This is necessary to make sure, that no one without your permission can destroy your data by re-initializing the CryptoBox.
-Chances are good, that you will only need it once.
-You may leave it empty, but this is not recommended.
-The crypto password is the more important password, protecting the data on your harddisk. Choose it wisely!
-You will need it, whenever you want to access your encrypted data.
-For a secure password consider a length of at least 15 characters including digits and special characters. The security of your encrypted data stands or falls with a good password.
-To avoid mistakes and to remind you on what you're going to do, you have to type the displayed red phrase into the last field.
-Now you can complete the initialization by clicking on the Initialize CryptoBox button at the bottom of the form.
-That's all. Wasn't it a real "one click" thing? Cryptography has never been easier to use.
-The initialization process takes place in the background and will be completed after a few minutes, depending on your harddisk's size.
- -While the initialization is usually done only once, the configuration can be changed at any time you want. You can reach it by clicking at Configuration in the menu bar of the website. Now you see a form with four fields:
-If you defined a administration passwort during Initialization, you have to enter it first. Otherwise this field does not appear.
-If the default network address (IP) doesn't fit into your network infrastructure, you can change it in the second field.
-The timeout defines the amount of time (in minutes) after that the CryptoBox deactivates the access to the encrypted data. If you e.g. copy a file on the box, it starts counting at zero, so down-/uploads won't be interrupted.
-It's good choice to enter a small number (few minutes).
-A timeout of 0 turns off the automatic deactivation - this is not recommended.
-At language preferences you can select the default language for the CryptoBox interface.
-Complete your changes by clicking on Save configuration.
-That's all - your CryptoBox is now ready for daily use!
- -All data on the CryptoBox harddisk will be erased during Initialization.
-All passwords have to be typed twice to reduce the chance of a typo.
-The optional adminstration password is necessary for configuration only.
-The crypto password protects your beloved data.
-If the cryptobox is not reachable by browsing to 192.168.0.23, you may have to adjust the network settings of your computer for initialization of the CryptoBox.
-back to CryptoBoxUser/en
-- -
+Navigation: ( CryptoBoxUser/en, CryptoBoxUserConfiguration) +
++All parts of administration of the CryptoBox are done through a comfortable web interface. If this is the first time you use the CryptoBox, just follow the steps below. +
++You can safely ignore the Foreword if you are in a hurry. +
++Initialization describes the process of integrating a new harddisk. You usually have to perform this steps if you start with a new CryptoBox or after replacing the harddisk. +
++In the Configuration section, you can configure the CryptoBox according to your personal needs, e.g. change your desired language for the web interface or change the IP address of the CryptoBox. +
++Do not forget to read the Hints / Caveats section too. +
++Okay, you finished the CryptoBoxUserGettingStarted and are now sitting in front of a computer that is connected via network with your CryptoBox. You point a browser to "https://192.168.0.23" and the CryptoBox interface appears. +
++Before you can save data on your CryptoBox, its harddisk has to be formatted with a cryptographic filesystem. Sounds complicated but don't be scared - it's really a "one click" thing. :) +
++Click on Initialize CryptoBox in the title bar. +
++Now you are promted to enter two passwords twice (because we want to train your typing skills ;). +
++That's all. Wasn't it a real "one click" thing? Cryptography has never been easier to use. ;) +
++The initialization process takes place in the background and will be completed after a few minutes, depending on your harddisk's size. +
++While the initialization is usually done only once, the configuration can be changed at any time you want. You can reach it by clicking at Configuration in the menu bar of the website. Now you see a form with four fields: +
++Complete your changes by clicking on Save configuration. +
++That's all - your CryptoBox is now ready for daily use! +
++back to CryptoBoxUser +
++
+
-
+
You can activate your encrypted filesystem by doing following these steps:
-Point your web browser at the address of your CryptoBox. The default is https://192.168.0.23.
-Click on Activation of encrypted data. A new page asking for your crypto password appears.
-Enter your crypto password and click on the button below labeled activate encrypted filesystem.
-Now the filesystem is accessible. To use it, search for a computer in your network neighborhood. When asked for the name, enter the above IP address (default: 192.168.0.23). Now you can use it like any other network resource.
- -You can deactivate the encrypted filesystem by clicking at Deactivation of encrypted data in the web interface of your CryptoBox.
-Your data is now protected again.
- -Click at the Shutdown link in the menu of the web interface. There you can choose poweroff or reboot. The shutdown takes some seconds.
-If the hardware of your CryptoBox is quite recent, it will power-off automatically. Otherwise you have to do it manually.
- -If you have to protect the drive really fast, just power-off the CryptoBox machine instantly by pulling the plug or pushing the power button. This is not very clean and can (in very rare circumstances) corrupt open files, but it is the fasted method to secure your data.
-back to CryptoBoxUser/en
-- -
+Navigation: ( CryptoBoxUser/en, CryptoBoxUserConfiguration/en, CryptoBoxUserDailyUse) +
++You can activate your encrypted filesystem by doing following these steps: +
++Now the filesystem is accessible. To use it, search for a computer in your network neighborhood. When asked for the name, enter the above IP address (default: 192.168.0.23). Now you can use it like any other network resource. +
++To use the encrypted data partition with regular user rights add the line below to your /etc/fstab: +
+//192.168.0.23/public /mnt/ smbfs defaults,noexec,noauto,user,guest 0 0 +
+Now you can mount the encrypted data partition to /mnt: +
+mount /mnt +
+resp. unmount: +
+smbumount /mnt +
+Run the the Windows Explorer and choose Map network drive in the Tools menu: +
++Now you can use your encrypted data like any other network resource. +
++You can deactivate the encrypted filesystem by clicking at Deactivation of encrypted data in the web interface of your CryptoBox. +
++Your data is now protected again. +
++Click at the Shutdown link in the menu of the web interface. There you can choose poweroff or reboot. The shutdown takes some seconds. +
++If the hardware of your CryptoBox is quite recent, it will power-off automatically. Otherwise you have to do it manually. +
++If you have to protect the drive really fast, just power-off the CryptoBox machine instantly by pulling the plug or pushing the power button. This is not very clean and can (in very rare circumstances) corrupt open files, but it is the fasted method to secure your data. +
++back to CryptoBoxUser +
++This error message may appear, if you did not login during the booting of you windows machine (or you closed the login dialog by pressing ESC). +
++Solution: Choose Logout in the Start menu and login again. +
+ ++You can't unmount the partition with umount. +
++Solution: Use smbumount instead: +
+smbumount /mnt +
+The attempt to mount the partition as a regular user ends up with: +
+cannot mount on /mnt/: Operation not permitted +smbmnt failed: 1 +
+Solution: Set the directory's owner to the same user that mounts the share (e.g. phil): +
+chown phil. /mnt +
+
+
-
+
Getting the CryptoBox started doesn't take much:
-You need an old Computer (at least 100MHz, 48MB RAM) (rule of thumb: bought at least after 1996). This PC needs a network card, a CD-ROM drive and a huge harddisk.
-Well the disk doesn't need to be huge, it should just suit your filestorage needs
-You don't need a monitor or a keyboard to use your CryptoBox (with one exception, see below).
-Of course, you may use a faster computer, but they usually consume much more energy and do not provide signifcant advantages.
-Then download the latest version of the CryptoBox as an iso-image and burn this image onto a CD.
- -Configure your PC, so it can boot from the CD. Therefore you have to enter the BIOS and configure the CD-ROM as boot device.
-Insert the shiny new CryptoBox CD you've just burned and start the computer.
-If it now boots from the CD, you accomplished all of the requirements.
-Now you can just go to your current desktop computer and point your browser to https://192.168.0.23 where the CryptoBox interface should be displayed. Easy - isn't it?
-For further steps go to CryptoBoxUserConfiguration/en.
- -Maybe you need to change the network address (IP) of your PC to configure the CryptoBox for the first time. Ask someone for help, if you don't know how and why ...
-If you're going to buy a new harddisk keep in mind that very old hardware can't handle actual disksizes!
-Some old PCs are not able to boot from CD.
-If you don't know what a BIOS is, better ask someone, before you try to change something.
-Don't forget to connect your PC to your local area network!
-To configure the BIOS, you need a keyboard and a monitor. But this has to be done only once.
-back to CryptoBoxUser/en
-- -
+Navigation: ( CryptoBoxUser/en, CryptoBoxUserConfiguration/en, CryptoBoxUserGettingStarted) +
++Getting the CryptoBox started doesn't take much: +
++ +If it now boots from the CD, you accomplished all of the requirements. +
++Now you can just go to your current desktop computer and point your browser to https://192.168.0.23 where the CryptoBox interface should be displayed. Easy - isn't it? +
++For further steps go to CryptoBoxUserConfiguration. +
++ +
++back to CryptoBoxUser +
++