git.gag.com Git - debian/amanda/blob - man/amgpgcrypt.8

   1 '\" t
   2 .\"     Title: amgpgcrypt
   3 .\"    Author: Kevin Till <kevin.till@zmanda.com>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 11/05/2009
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 2.6.1p2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMGPGCRYPT" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "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 amgpgcrypt \- reference crypt program for \fIAmanda\fR public\-key data encryption
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBamgpgcrypt\fR\ 'u
  25 \fBamgpgcrypt\fR  to be called by \fIAmanda\fR only
  26 .SH "DESCRIPTION"
  27 .PP
  28
  29 \fBamgpgcrypt\fR
  30 calls
  31 \fBgpg\fR
  32 to perform public\-key data encryption on
  33 \fIAmanda\fR
  34 backup\&.
  35 \fBamgpgcrypt\fR
  36 will search for the gpg program in the following directories: /usr/local/bin:/usr/bin:/usr/sbin:/bin:/sbin
  37 .PP
  38
  39 \fBamgpgcrypt\fR
  40 sets GNUPGHOME to $AMANDA_HOME/\&.gnupg where gpg will look for the gpg keys\&.
  41 \fBamgpgcrypt\fR
  42 uses the public key to encrypt the
  43 \fIAmanda\fR
  44 data and uses the private key to decrypt the
  45 \fIAmanda\fR
  46 backup data\&. Thus, passphrase is only required at the time of data restore\&.
  47 .SH "KEY AND PASSPHRASE"
  48 .PP
  49
  50 \fBamgpgcrypt\fR
  51 uses the private key to decrypt
  52 \fIAmanda\fR
  53 backup data\&.
  54
  55 It is very important to store, manage and  protect the key and the passphrase
  56 properly\&. Encrypted backup data can \fBonly\fR be recovered with the correct key and
  57 passphrase\&.
  58 .SH "HOW TO CREATE ENCRYPTION KEYS AND PASSPHRASE FOR AMGPGCRYPT"
  59 .PP
  60 Store the passphrase that you used in following "gpg \-\-gen\-key" command inside the home\-directory of the AMANDA\-user($amanda_user) and protect it with proper permissions:
  61
  62    echo my_secret_passphrase > ~$amanda_user/\&.am_passphrase
  63    chown $amanda_user:disk ~$amanda_user/\&.am_passphrase
  64    chmod 700 ~$amanda_user/\&.am_passphrase
  65 .PP
  66 Run "gpg \-\-gen\-key"\&. Below is an example:
  67 .nf
  68 $ gpg \-\-gen\-key
  69 gpg (GnuPG) 1\&.2\&.6; Copyright (C) 2004 Free Software Foundation, Inc\&.
  70 This program comes with ABSOLUTELY NO WARRANTY\&.
  71 This is free software, and you are welcome to redistribute it
  72 under certain conditions\&. See the file COPYING for details\&.
  73
  74 Please select what kind of key you want:
  75    (1) DSA and ElGamal (default)
  76    (2) DSA (sign only)
  77    (4) RSA (sign only)
  78 Your selection? 1
  79 DSA keypair will have 1024 bits\&.
  80 About to generate a new ELG\-E keypair\&.
  81               minimum keysize is  768 bits
  82               default keysize is 1024 bits
  83     highest suggested keysize is 2048 bits
  84 What keysize do you want? (1024)
  85 Requested keysize is 1024 bits
  86 Please specify how long the key should be valid\&.
  87          0 = key does not expire
  88       (n)  = key expires in n days
  89       (n)w = key expires in n weeks
  90       (n)m = key expires in n months
  91       (n)y = key expires in n years
  92 Key is valid for? (0) 6m
  93 Key expires at Sun 06 Aug 2006 03:51:25 PM PDT
  94 Is this correct (y/n)? y
  95
  96 You need a User\-ID to identify your key; the software constructs the user id
  97 from Real Name, Comment and Email Address in this form:
  98     "Heinrich Heine (Der Dichter) (heinrichh@duesseldorf\&.de)"
  99
 100 Real name: amandabackup
 101 Email address:
 102 Comment: gpg keys for amandabackup
 103 You selected this USER\-ID:
 104     "amandabackup (gpg keys for amandabackup)"
 105
 106 Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? o
 107 You need a Passphrase to protect your secret key\&.
 108
 109 We need to generate a lot of random bytes\&. It is a good idea to perform
 110 some other action (type on the keyboard, move the mouse, utilize the
 111 disks) during the prime generation; this gives the random number
 112 generator a better chance to gain enough entropy\&.
 113
 114 We need to generate a lot of random bytes\&. It is a good idea to perform
 115 some other action (type on the keyboard, move the mouse, utilize the
 116 disks) during the prime generation; this gives the random number
 117 generator a better chance to gain enough entropy\&.
 118
 119 public and secret key created and signed\&.
 120 key marked as ultimately trusted\&.
 121
 122 pub  1024D/4417A8CB 2006\-02\-07 amandabackup (gpg keys for amandabackup)
 123      Key fingerprint = 139C 6369 44FC 7F1A 655C  E5E9 7EAA 515A 4417 A8CB
 124 sub  1024g/8C3A6A78 2006\-02\-07 [expires: 2006\-08\-06]
 125 .fi
 126 .SH "FILES"
 127 .PP
 128 \fB$AMANDA_HOME/\&.gnupg/pubring\&.gpg\fR
 129 .RS 4
 130 The public key\&.
 131 \fBamgpgcrypt\fR
 132 encrypt data with this public key along with the cipher algorithm\&.
 133 .RE
 134 .PP
 135 \fB$AMANDA_HOME/\&.gnupg/secring\&.gpg\fR
 136 .RS 4
 137 The private/secret key\&. It\'s only needed during amrecover/amrestore\&. Store and protect it properly during other time\&.
 138 .RE
 139 .PP
 140 \fB$AMANDA_HOME/\&.am_passphrase\fR
 141 .RS 4
 142 The passphrase\&. It\'s only needed during amrecover/amrestore\&. Store and protect it properly during other time\&.
 143 .RE
 144 .SH "BUGS"
 145 .PP
 146 \fIAmanda\fR
 147 has problem with gpg mdc(modification detection code) in the binary mode\&.
 148 \fBamgpgcrypt\fR
 149 calls gpg with mdc disabled
 150 .SH "SEE ALSO"
 151 .PP
 152
 153 \fBamanda\fR(8),
 154 \fBamanda.conf\fR(5),
 155 \fBamcrypt\fR(8),
 156 \fBamrestore\fR(8),
 157 \fBgpg\fR(1),
 158 : http://wiki.zmanda.com
 159 .SH "AUTHOR"
 160 .PP
 161 \fBKevin Till\fR <\&kevin\&.till@zmanda\&.com\&>
 162 .RS 4
 163 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
 164 .RE