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