git.gag.com Git - debian/amanda/blob - man/amcrypt-ossl-asym.8

   1 .\"     Title: amcrypt-ossl-asym
   2 .\"    Author: Kevin Till <kevin.till@zmanda.com>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMCRYPT\-OSSL\-ASYM" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amcrypt-ossl-asym \- crypt program for \fIAmanda\fR asymmetric data encryption using OpenSSL
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamcrypt\-ossl\-asym\fR\ 'u
 174 \fBamcrypt\-ossl\-asym\fR [\-d]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178
 179 \fBamcrypt\-ossl\-asym\fR
 180 uses
 181 \fBOpenSSL\fR
 182 to encrypt and decrypt data\&. OpenSSL is available from
 183 www\&.openssl\&.org\&. OpenSSL offers a wide variety of cipher choices (
 184 \fBamcrypt\-ossl\-asym\fR
 185 defaults to 256\-bit AES) and can use hardware cryptographic accelerators on several platforms\&.
 186 .PP
 187
 188 \fBamcrypt\-ossl\-asym\fR
 189 will search for the OpenSSL program in the following directories: /bin:/usr/bin:/usr/local/bin:/usr/ssl/bin:/usr/local/ssl/bin\&.
 190 .SH "GENERATING PUBLIC AND PRIVATE KEYS"
 191 .PP
 192 RSA keys can be generated with the standard OpenSSL commands, e\&.g\&.:
 193 .nf
 194 $ cd /var/lib/amanda
 195 $ openssl genrsa \-aes128 \-out backup\-privkey\&.pem 1024
 196 Generating RSA private key, 1024 bit long modulus
 197 [\&.\&.\&.]
 198 Enter pass phrase for backup\-privkey\&.pem: \fIENTER YOUR PASS PHRASE\fR
 199 Verifying \- Enter pass phrase for backup\-key\&.pem: \fIENTER YOUR PASS PHRASE\fR
 200
 201 $ openssl rsa \-in backup\-privkey\&.pem \-pubout \-out backup\-pubkey\&.pem
 202 Enter pass phrase for backup\-privkey\&.pem: \fIENTER YOUR PASS PHRASE\fR
 203 Writing RSA key
 204 .fi
 205 .PP
 206 To generate a private key without a passphrase, omit the
 207 \fB\-aes128\fR
 208 option\&. See
 209 \fBopenssl_genrsa\fR(1)
 210 for more key generation options\&.
 211 .PP
 212 Note that it is always possible to generate the public key from the private key\&.
 213 .SH "KEY AND PASSPHRASE MANAGEMENT"
 214 .PP
 215
 216 \fBamcrypt\-ossl\-asym\fR
 217 uses the
 218 \fIpublic key\fR
 219 to encrypt data\&. The security of the data does not depend on the confidentiality of the public key\&. The
 220 \fIprivate key\fR
 221 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\&.
 222 .PP
 223 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\&.
 224 .PP
 225 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
 226 www\&.diceware\&.com) can be used to create passphrases that are difficult to guess and easy to remember\&.
 227 .SH "FILES"
 228 .PP
 229 /var/lib/amanda/backup\-privkey\&.pem
 230 .RS 4
 231 File containing the RSA private key\&. It should not be readable by any user other than the
 232 \fIAmanda\fR
 233 user\&.
 234 .RE
 235 .PP
 236 /var/lib/amanda/backup\-pubkey\&.pem
 237 .RS 4
 238 File containing the RSA public key\&.
 239 .RE
 240 .PP
 241 /var/lib/amanda/\&.am_passphrase
 242 .RS 4
 243 File containing the passphrase\&. It should not be readable by any user other than the
 244 \fIAmanda\fR
 245 user\&.
 246 .RE
 247 .SH "SEE ALSO"
 248 .PP
 249
 250 \fBamanda\fR(8),
 251 \fBamanda.conf\fR(5),
 252 \fBopenssl\fR(1),
 253 \fBamcrypt-ossl\fR(8),
 254 : http://wiki.zmanda.com
 255 .SH "Author"
 256 .PP
 257 \fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
 258 .RS 4
 259 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 260 .RE
 261 .SH "Notes"
 262 .IP " 1." 4
 263 www.openssl.org
 264 .RS 4
 265 \%http://www.openssl.org/
 266 .RE
 267 .IP " 2." 4
 268 www.diceware.com
 269 .RS 4
 270 \%http://www.diceware.com/
 271 .RE