Imported Upstream version 3.2.0
[debian/amanda] / man / amcrypt-ossl-asym.8
1 '\" t
2 .\"     Title: amcrypt-ossl-asym
3 .\"    Author: Kevin Till <kevin.till@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 10/18/2010
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.2.0
8 .\"  Language: English
9 .\"
10 .TH "AMCRYPT\-OSSL\-ASYM" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 amcrypt-ossl-asym \- crypt program for Amanda asymmetric data encryption using OpenSSL
23 .SH "SYNOPSIS"
24 .HP \w'\fBamcrypt\-ossl\-asym\fR\ 'u
25 \fBamcrypt\-ossl\-asym\fR [\-d]
26 .SH "DESCRIPTION"
27 .PP
28
29 \fBamcrypt\-ossl\-asym\fR
30 uses
31 \fBOpenSSL\fR
32 to encrypt and decrypt data\&. OpenSSL is available from
33 www\&.openssl\&.org\&. OpenSSL offers a wide variety of cipher choices (
34 \fBamcrypt\-ossl\-asym\fR
35 defaults to 256\-bit AES) and can use hardware cryptographic accelerators on several platforms\&.
36 .PP
37
38 \fBamcrypt\-ossl\-asym\fR
39 will search for the OpenSSL program in the following directories: /bin:/usr/bin:/usr/local/bin:/usr/ssl/bin:/usr/local/ssl/bin\&.
40 .SH "GENERATING PUBLIC AND PRIVATE KEYS"
41 .PP
42 RSA keys can be generated with the standard OpenSSL commands, e\&.g\&.:
43 .nf
44 $ cd /var/lib/amanda
45 $ openssl genrsa \-aes128 \-out backup\-privkey\&.pem 1024
46 Generating RSA private key, 1024 bit long modulus
47 [\&.\&.\&.]
48 Enter pass phrase for backup\-privkey\&.pem: \fIENTER YOUR PASS PHRASE\fR
49 Verifying \- Enter pass phrase for backup\-key\&.pem: \fIENTER YOUR PASS PHRASE\fR
50
51 $ openssl rsa \-in backup\-privkey\&.pem \-pubout \-out backup\-pubkey\&.pem
52 Enter pass phrase for backup\-privkey\&.pem: \fIENTER YOUR PASS PHRASE\fR
53 Writing RSA key
54 .fi
55 .PP
56 To generate a private key without a passphrase, omit the
57 \fB\-aes128\fR
58 option\&. See
59 \fBopenssl_genrsa\fR(1)
60 for more key generation options\&.
61 .PP
62 Note that it is always possible to generate the public key from the private key\&.
63 .SH "KEY AND PASSPHRASE MANAGEMENT"
64 .PP
65
66 \fBamcrypt\-ossl\-asym\fR
67 uses the
68 \fIpublic key\fR
69 to encrypt data\&. The security of the data does not depend on the confidentiality of the public key\&. The
70 \fIprivate key\fR
71 is used to decrypt data, and must be protected\&. Encrypted backup data cannot be recovered without the private key\&. The private key may optionally be encrypted with a passphrase\&.
72 .PP
73 While the public key must be online at all times to perorm backups, the private key and optional passphrase are only needed to restore data\&. It is recommended that the latter be stored offline all other times\&. For example, you could keep the private key on removable media, and copy it into place for a restore; or you could keep the private key online, encrypted with a passphrase that is present only for a restore\&.
74 .PP
75 OpenSSL\'s key derivation routines use a salt to guard against dictionary attacks on the pass phrase; still it is important to pick a pass phrase that is hard to guess\&. The Diceware method (see
76 www\&.diceware\&.com) can be used to create passphrases that are difficult to guess and easy to remember\&.
77 .SH "FILES"
78 .PP
79 /var/lib/amanda/backup\-privkey\&.pem
80 .RS 4
81 File containing the RSA private key\&. It should not be readable by any user other than the Amanda user\&.
82 .RE
83 .PP
84 /var/lib/amanda/backup\-pubkey\&.pem
85 .RS 4
86 File containing the RSA public key\&.
87 .RE
88 .PP
89 /var/lib/amanda/\&.am_passphrase
90 .RS 4
91 File containing the passphrase\&. It should not be readable by any user other than the Amanda user\&.
92 .RE
93 .SH "SEE ALSO"
94 .PP
95 \fBamanda\fR(8),
96 \fBamanda.conf\fR(5),
97 \fBopenssl\fR(1),
98 \fBamcrypt-ossl\fR(8)
99 .PP
100 The Amanda Wiki:
101 : http://wiki.zmanda.com/
102 .SH "AUTHOR"
103 .PP
104 \fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
105 .RS 4
106 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
107 .RE
108 .SH "NOTES"
109 .IP " 1." 4
110 www.openssl.org
111 .RS 4
112 \%http://www.openssl.org/
113 .RE
114 .IP " 2." 4
115 www.diceware.com
116 .RS 4
117 \%http://www.diceware.com/
118 .RE