6c966d9437bc0cb63c545b083a9d3bbd13286e5f
[debian/amanda] / man / xml-source / amcrypt-ossl.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-ossl.8'>
11
12 <refmeta>
13   <refentrytitle>amcrypt-ossl</refentrytitle>
14   <manvolnum>8</manvolnum>
15 &rmi.source;
16 &rmi.version;
17 &rmi.manual.8;
18 </refmeta>
19 <refnamediv>
20   <refname>amcrypt-ossl</refname>
21   <refpurpose>crypt program for &A; symmetric data encryption using OpenSSL</refpurpose>
22 </refnamediv>
23 <refentryinfo>
24 &author.ktill;
25 </refentryinfo>
26 <!-- body begins here -->
27 <refsynopsisdiv>
28   <cmdsynopsis>
29     <command>amcrypt-ossl</command>    
30     <arg choice="opt">-d</arg>
31   </cmdsynopsis>
32 </refsynopsisdiv>
33 <refsect1>
34   <title>DESCRIPTION</title>
35   <para>
36     &amcryptossl; uses <emphasis remap='B'>OpenSSL</emphasis> to encrypt
37     and decrypt data.  OpenSSL is available from <ulink
38     url="http://www.openssl.org/">www.openssl.org</ulink>. OpenSSL
39     offers a wide variety of cipher choices (&amcryptossl; defaults to
40     256-bit AES) and can use hardware cryptographic accelerators on several
41     platforms.
42   </para>
43   <para>
44     &amcryptossl; will search for the OpenSSL program in the following
45     directories: /bin:/usr/bin:/usr/local/bin:/usr/ssl/bin:/usr/local/ssl/bin.
46   </para>
47 </refsect1>
48 <refsect1>
49   <title>PASSPHRASE MANAGEMENT</title>
50   <para>
51     &amcryptossl; uses the same pass phrase to encrypt and decrypt data.
52     It is very important to store and protect the pass phrase properly.
53     Encrypted backup data can <emphasis remap='B'>only</emphasis> be
54     recovered with the correct passphrase.
55   </para>
56   <para>
57     OpenSSL's key derivation routines use a salt to guard against
58     dictionary attacks on the pass phrase; still it is important to pick
59     a pass phrase that is hard to guess.  The Diceware method (see <ulink
60     url="http://www.diceware.com/">www.diceware.com</ulink>) can be used to create passphrases
61     that are difficult to guess and easy to remember.
62   </para>
63 </refsect1>
64 <refsect1>
65   <title>FILES</title>
66   <variablelist remap='TP'>
67     <varlistentry>
68       <term>/var/lib/amanda/.am_passphrase</term>
69       <listitem>
70         <para>
71           File containing the pass phrase. It should not be readable by any user other than the &A; user.
72         </para>
73       </listitem>
74     </varlistentry>
75   </variablelist>
76 </refsect1>
77
78 <refsect1>
79   <title>SEE ALSO</title>
80   <para>
81     <citerefentry>
82       <refentrytitle>amanda</refentrytitle>
83       <manvolnum>8</manvolnum>
84     </citerefentry>,
85     <citerefentry>
86       <refentrytitle>amanda.conf</refentrytitle>
87       <manvolnum>5</manvolnum>
88     </citerefentry>,
89     <citerefentry>
90       <refentrytitle>openssl</refentrytitle>
91       <manvolnum>1</manvolnum>
92     </citerefentry>,
93     <citerefentry>
94       <refentrytitle>amcrypt-ossl-asym</refentrytitle>
95       <manvolnum>8</manvolnum>
96     </citerefentry>,
97     <ulink url="http://wiki.zmanda.com"/>
98   </para>
99 </refsect1>
100
101 </refentry>