49bd78007e497dcca92903ddf05421a549f50399
[debian/amanda] / man / xml-source / amcryptsimple.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='amcryptsimple.8'>
11 <refmeta>
12 <refentrytitle>amcryptsimple</refentrytitle>
13 <manvolnum>8</manvolnum>
14 &rmi.source;
15 &rmi.version;
16 &rmi.manual.8;
17 </refmeta>
18 <refnamediv>
19 <refname>amcryptsimple</refname>
20 <refpurpose>reference simple crypt program for &A; symmetric data encryption</refpurpose>
21 </refnamediv>
22 <refentryinfo>
23 &author.ktill;
24 </refentryinfo>
25 <!-- body begins here -->
26 <refsynopsisdiv>
27 <cmdsynopsis>
28   <command>amcryptsimple</command>  to be called by &A; only 
29 </cmdsynopsis>
30 </refsynopsisdiv>
31
32 <refsect1><title>DESCRIPTION</title>
33 <para>&amcryptsimple;
34 calls <emphasis remap='B'>gpg</emphasis> to perform symmetric data encryption
35 on &A; backup.
36 &amcryptsimple; will search for the gpg program in the following directories:
37 /usr/local/bin:/usr/bin:/usr/sbin:/bin:/sbin</para>
38 <para>&amcryptsimple; uses one passphrase to encrypt the &A; data
39 and uses the same passphrase to decrypt the &A; backup data. &amcryptsimple; uses
40 AES256 as the symmetric cipher.</para> 
41 </refsect1>
42
43
44 <refsect1><title>How to Create Passphrase</title>
45
46 Store  the  passphrase  inside the home-directory of the AMANDA-user($amanda_user) and protect it with proper permissions:
47
48    echo my_secret_passphrase > ~$amanda_user/.am_passphrase
49    chown $amanda_user:disk ~$amanda_user/.am_passphrase
50    chmod 700 ~$amanda_user/.am_passphrase
51 </refsect1>
52
53 <refsect1><title>NOTES</title>
54 <para>Choose a good passphrase and protect it properly. Backup data can only be
55 restored with the passphrase. There is no backdoor.</para>
56 <para>If storing and securing passphrase in your environment presents challenges,
57 &A; provide public-key data encryption through &amgpgcrypt;. Public-key
58 encryption uses the public key to encrypt and uses the private key to decrypt.</para>
59 </refsect1>
60
61 <refsect1><title>SEE ALSO</title>
62 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
63 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
64 <citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
65 <citerefentry><refentrytitle>amgpgcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
66 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
67 <citerefentry><refentrytitle>gpg</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
68 <ulink url="http://wiki.zmanda.com"/>
69 </para>
70 </refsect1>
71 </refentry>
72