8a12db1974324266a52ebb734d2da7781ef4009c
[debian/amanda] / man / xml-source / amcrypt.8.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
4 [
5   <!-- entities files to use -->
6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
7   %global_entities;
8 ]>
9
10 <refentry id='amcrypt.8'>
11 <refmeta>
12 <refentrytitle>amcrypt</refentrytitle>
13 <manvolnum>8</manvolnum>
14 </refmeta>
15 <refnamediv>
16 <refname>amcrypt</refname>
17 <refpurpose>reference crypt program for &A; symmetric data encryption</refpurpose>
18 </refnamediv>
19 <!-- body begins here -->
20 <refsynopsisdiv>
21 <cmdsynopsis>
22   <command>amcrypt</command>    
23 </cmdsynopsis>
24 </refsynopsisdiv>
25
26
27 <refsect1><title>DESCRIPTION</title>
28 <para>&amcrypt; 
29 requires <emphasis remap='B'>aespipe</emphasis> and <emphasis
30 remap='B'>gpg</emphasis>  to work. Aespipe is available from <ulink
31 url="http://loop-aes.sourceforge.net"/></para>
32 <para>&amcrypt; will search for the aespipe program in the following directories:
33 /usr/bin:/usr/local/bin:/sbin:/usr/sbin.</para>
34 &amcrypt; calls &amaespipe; and pass the
35 <emphasis remap='B'>passphrase</emphasis> through file descriptor 3.
36 The passphrase should be stored in ~amanda/.am_passphrase.
37 </refsect1>
38
39 <refsect1><title>How to create encryption keys for amcrypt</title>
40 1. Create 65 random encryption keys and encrypt those keys using gpg. Reading
41 from /dev/random may take indefinitely long if kernel's random entropy pool
42 is empty. If that happens, do some other work on some other console (use
43 keyboard, mouse and disks). 
44 <para> head -c 2925 /dev/random | uuencode -m - | head -n 66 | tail -n 65 \
45         | gpg --symmetric -a > ~amanda/.gnupg/am_key.gpg
46 </para>
47 <para>This will ask for a passphrase. Remember this passphrase as you will need
48 it in the next step.</para>
49 <para>2. Store the passphrase inside the home-directory of the AMANDA-user and
50 protect it with proper permissions:</para>
51
52 <programlisting>
53 echo my_secret_passphrase > ~amanda/.am_passphrase
54 chown amanda:disk ~amanda/.am_passphrase
55 chmod 700 ~amanda/.am_passphrase
56 </programlisting>
57
58 </refsect1>
59
60 <refsect1><title>Key and Passphrase</title>
61 <para>&amcrypt; uses the same key to encrypt and decrypt data.</para>
62 It is very important to store and protect the key and the passphrase
63 properly. Encrypted backup data can <emphasis remap='B'>only</emphasis> be recovered with the correct key and
64 passphrase.
65 </refsect1>
66
67 <refsect1><title>SEE ALSO</title>
68 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
69 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
70 <citerefentry><refentrytitle>aespipe</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
71 <citerefentry><refentrytitle>amaespipe</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
72 <citerefentry><refentrytitle>gpg</refentrytitle><manvolnum>1</manvolnum></citerefentry>
73 </para>
74 </refsect1>
75 </refentry>
76