Oops, adding ninjahelper to Makefile
[matthijs/upstream/backupninja.git] / handlers / dup.helper
1 # -*- mode: sh; sh-basic-offset: 3; indent-tabs-mode: nil; -*-
2
3 HELPERS="$HELPERS dup:incremental_encrypted_remote_filesystem_backup"
4
5 ### Functions
6
7 do_dup_host_includes() {
8    set -o noglob
9    # choose the files to backup
10    REPLY=
11    while [ -z "$REPLY" ]; do
12       formBegin "$dup_title - host system: includes"
13          [ -z "$dup_includes" ] && dup_includes="$dup_default_includes"
14          for i in $dup_includes; do
15             formItem include "$i"
16          done
17          formItem include ""
18          formItem include ""
19          formItem include ""
20          formDisplay
21       [ $? = 0 ] || return 1
22       dup_includes="$REPLY"
23    done
24    set +o noglob
25 }
26
27 do_dup_vserver() {
28    # choose the vservers to backup (into $selected_vservers)
29    choose_one_or_more_vservers "$dup_title"
30    [ $? = 0 ] || return 1
31
32    set -o noglob
33    # choose the files to backup
34    REPLY=
35    while [ -z "$REPLY" ]; do
36       formBegin "$dup_title - vservers: includes"
37          [ -z "$dup_vsincludes" ] && dup_vsincludes="$dup_default_includes"
38          for i in $dup_vsincludes; do
39             formItem include "$i"
40          done
41          formItem include ""
42          formItem include ""
43          formItem include ""
44       formDisplay
45       [ $? = 0 ] || return 1
46       dup_vsincludes="$REPLY"
47    done
48    set +o noglob
49 }
50
51 do_dup_excludes() {
52    set -o noglob
53    formBegin "$dup_title: excludes"
54      [ -z "$dup_excludes" ] && dup_excludes="$dup_default_excludes"
55      for i in $dup_excludes; do
56         formItem exclude "$i"
57      done
58      formItem exclude ""
59      formItem exclude ""
60      formItem exclude ""
61    formDisplay
62    [ $? = 0 ] || return 1
63    dup_excludes="$REPLY"
64    set +o noglob
65 }
66
67 do_dup_src() {
68    choose_host_or_vservers_or_both "$dup_title"
69    [ $? = 0 ] || return 1
70    case $host_or_vservers in
71       'host')
72          do_dup_host_includes
73          [ $? = 0 ] || return 1
74          ;;
75       'vservers')
76          do_dup_vserver
77          [ $? = 0 ] || return 1
78          ;;
79       'both')
80          do_dup_host_includes
81          [ $? = 0 ] || return 1
82          do_dup_vserver
83          [ $? = 0 ] || return 1
84          ;;
85       *)
86          return 1
87          ;;
88    esac
89    do_dup_excludes
90    [ $? = 0 ] || return 1
91    
92    _src_done="(DONE)"
93    setDefault dest
94 }
95
96 do_dup_dest() {
97
98    local replyconverted
99    local thereply
100
101    set -o noglob
102    REPLY=
103    while [ -z "$REPLY" -o -z "$dup_destdir" -o -z "$dup_desthost" -o -z "$dup_destuser" ]; do
104       formBegin "$dup_title - destination: first three items are compulsory"
105         formItem "desthost" "$dup_desthost"
106         formItem "destuser" "$dup_destuser"
107         formItem "destdir" "$dup_destdir"
108         formItem "keep" "$dup_keep"
109         formItem "incremental" "$dup_incremental"
110         formItem "bandwidthlimit" "$dup_bandwidth"
111         formItem "sshoptions" "$dup_sshoptions"
112       formDisplay
113       [ $? = 0 ] || return 1
114
115       IFS=$''
116       replyconverted=`echo $REPLY | tr '\n' :`
117       IFS=$':'
118       thereply=($replyconverted)
119       IFS=$' \t\n'
120       
121       dup_desthost=${thereply[0]}
122       dup_destuser=${thereply[1]}
123       dup_destdir=${thereply[2]}
124       dup_keep=${thereply[3]}
125       dup_incremental=${thereply[4]}
126       dup_bandwidth=${thereply[5]}
127       dup_sshoptions=${thereply[6]}
128
129    done
130    set +o noglob
131
132    _dest_done="(DONE)"
133    setDefault gpg
134 }
135
136 do_dup_gpg_encryptkey() {
137    REPLY=
138    while [ -z "$REPLY" -o -z "$dup_gpg_encryptkey" ]; do
139       inputBox "$dup_title - GnuPG" "Enter ID of the public GnuPG key to be used to encrypt the backups:" "$dup_gpg_encryptkey"
140       [ $? = 0 ] || return 1
141       dup_gpg_encryptkey="$REPLY"
142    done
143 }
144
145 do_dup_gpg_sign() {
146    # sign ?
147    booleanBox "$dup_title - GnuPG" "Sign the backups?" "$dup_gpg_sign"
148    if [ $? = 0 ]; then
149       dup_gpg_sign=yes
150    else
151       dup_gpg_sign=no
152    fi
153 }
154
155 do_dup_gpg_signkey() {
156    # one key pair ?
157    booleanBox "$dup_title - GnuPG" "Use the same GnuPG key pair for encryption and signing?" "$dup_gpg_onekeypair"
158    if [ $? = 0 ]; then
159       dup_gpg_onekeypair=yes
160    else
161       dup_gpg_onekeypair=no
162    fi
163
164    if [ "$dup_gpg_onekeypair" == "no" }; then
165       # signkey ?
166       REPLY=
167       while [ -z "$REPLY" -o -z "$dup_gpg_signkey" ]; do
168          inputBox "$dup_title - GnuPG" "Enter the ID of the private GnuPG key to be used to sign the backups:" "$dup_gpg_signkey"
169          [ $? = 0 ] || return 1
170          dup_gpg_signkey="$REPLY"
171       done
172    fi
173 }
174
175 do_dup_gpg_passphrase() {
176    local question="Enter the passphrase needed to $@:"
177    REPLY=
178    while [ -z "$REPLY" -o -z "$dup_gpg_password" ]; do
179       passwordBox "$dup_title - GnuPG" "$question"
180       [ $? = 0 ] || return 1
181       dup_gpg_password="$REPLY"
182    done
183 }
184
185 do_dup_gpg() {
186    
187    # symmetric or public key encryption ?
188    booleanBox "$dup_title - GnuPG" "Use public key encryption? Else, symmetric encryption will be used, and data signing will be impossible." "$dup_gpg_asymmetric_encryption"
189    if [ $? = 0 ]; then
190       dup_gpg_asymmetric_encryption=yes
191    else
192       dup_gpg_asymmetric_encryption=no
193    fi
194
195    # when using public/private key pair encryption, ask for the keys to use
196    if [ "$dup_gpg_asymmetric_encryption" == yes ]; then
197       do_dup_gpg_encryptkey ; [ $? = 0 ] || return 1
198       do_dup_gpg_sign ; [ $? = 0 ] || return 1
199       if [ "$dup_gpg_sign" == yes ]; then
200          do_dup_gpg_signkey ; [ $? = 0 ] || return 1
201       fi
202    fi
203
204    # a passphrase is only needed when signing, or when symmetric encryption is used
205    if [ "$dup_gpg_asymmetric_encryption" == "no" ]; then
206          do_dup_gpg_passphrase "encrypt the backups"
207          [ $? = 0 ] || return 1
208    elif [ "$dup_gpg_sign" == "yes" ]; then
209       if [ -z "$dup_gpg_signkey" ]; then
210          do_dup_gpg_passphrase "unlock the GnuPG 0x$dup_gpg_signkey key used to sign the backups"
211          [ $? = 0 ] || return 1
212       else
213          do_dup_gpg_passphrase "unlock the GnuPG 0x$dup_gpg_encryptkey key used to sign the backups"
214          [ $? = 0 ] || return 1
215       fi
216    fi
217
218    _gpg_done="(DONE)"
219    setDefault adv
220    # TODO: replace the above line by the following when do_dup_conn is written
221    # setDefault conn
222 }
223
224 # TODO: share rdiff.helper code in some lib, and use it here
225 do_dup_conn() {
226    _con_done="(DONE)"
227    setDefault adv
228 }
229
230 do_dup_misc_options() {
231
232    set -o noglob
233    local replyconverted
234    local thereply
235
236    formBegin "$dup_title - misc. options"
237      formItem "nicelevel" "$dup_nicelevel"
238      formItem "testconnect" "$dup_testconnect"
239      formItem "options" "$dup_options"
240    formDisplay
241    [ $? = 0 ] || return 1
242
243    IFS=$''
244    replyconverted=`echo $REPLY | tr '\n' :`
245    IFS=$':'
246    thereply=($replyconverted)
247    IFS=$' \t\n'
248
249    dup_nicelevel=${thereply[0]}
250    dup_testconnect=${thereply[1]}
251    dup_options=${thereply[2]}
252
253    set +o noglob
254 }
255
256 # (rdiff.helper compatible interface... there could be some sode to share, hmmm.)
257 do_dup_adv() {
258    do_dup_misc_options
259    [ $? = 0 ] || return 1
260    _adv_done="(DONE)"
261    setDefault finish
262 }
263
264 do_dup_finish() {
265    get_next_filename $configdirectory/90.dup
266    cat > $next_filename <<EOF
267 # passed directly to duplicity
268 #options = --verbosity 8
269 options = $dup_options
270
271 # default is 0, but set to 19 if you want to lower the priority.
272 nicelevel = $dup_nicelevel
273
274 # default is yes. set to no to skip the test if the remote host is alive
275 testconnect = $dup_testconnect
276
277 ######################################################
278 ## gpg section
279 ## (how to encrypt and optionnally sign the backups)
280 ##
281 ## WARNING: old (pre-0.9.2) example.dup used to give wrong information about
282 ##          the way the following options are used. Please read ahead
283 ##          carefully.
284 ##
285 ## If the encryptkey variable is set:
286 ##   - data is encrypted with the GnuPG public key specified by the encryptkey
287 ##     variable
288 ##   - if signing is enabled, the password variable is used to unlock the GnuPG
289 ##     private key used for signing; else, you do not need to set the password
290 ##     variable
291 ## If the encryptkey option is not set:
292 ##   - data signing is not possible
293 ##   - the password variable is used to encrypt the data with symmetric
294 ##     encryption: no GnuPG key pair is needed
295
296 [gpg]
297
298 # when set to yes, encryptkey variable must be set bellow; if you want to use
299 # two different keys for encryption and signing, you must also set the signkey
300 # variable bellow.
301 # default is no, for backward compatibility with backupninja <= 0.5.
302 sign = $dup_gpg_sign
303
304 # ID of the GnuPG public key used for data encryption.
305 # if not set, symmetric encryption is used, and data signing is not possible.
306 encryptkey = $dup_gpg_encryptkey
307
308 # ID of the GnuPG private key used for data signing.
309 # if not set, encryptkey will be used.
310 signkey = $dup_gpg_signkey
311
312 # password
313 # NB: do not quote it, and it should not contain any quote
314 password = $dup_gpg_password
315
316 ######################################################
317 ## source section
318 ## (where the files to be backed up are coming from)
319
320 [source]
321
322 # files to include in the backup
323 # (supports globbing with '*')
324 # BIG FAT WARNING
325 # Symlinks are not dereferenced. Moreover, an include line whose path
326 # contains, at any level, a symlink to a directory, will only have the
327 # symlink backed-up, not the target directory's content. Yes, you have
328 # to dereference yourself the symlinks, or to use 'mount --bind'
329 # instead.
330 # EXAMPLE
331 # Let's say /home is a symlink to /mnt/crypt/home ; the following line
332 # will only backup a "/home" symlink ; neither /home/user nor
333 # /home/user/Mail will be backed-up :
334 #   include = /home/user/Mail
335 # A workaround is to 'mount --bind /mnt/crypt/home /home' ; another
336 # one is to write :
337 #   include = /mnt/crypt/home/user/Mail
338 EOF
339
340    if [ "$host_or_vservers" == host -o "$host_or_vservers" == both ]; then
341       set -o noglob
342       for i in $dup_includes; do
343          echo "include = $i" >> $next_filename
344       done
345       set +o noglob
346    fi
347
348    cat >> $next_filename <<EOF
349
350 # If vservers = yes in /etc/backupninja.conf then the following variables can
351 # be used:
352 # vsnames = all | <vserver1> <vserver2> ... (default = all)
353 # vsinclude = <path>
354 # Any path specified in vsinclude is added to the include list for each vserver
355 # listed in vsnames (or all if vsnames = all).
356 # E.g. vsinclude = /home will backup the /home partition in every vserver
357 # listed in vsnames. If you have vsnames = "foo bar baz", this vsinclude will
358 # add to the include list /vservers/foo/home, /vservers/bar/home and
359 # /vservers/baz/home.
360 # Vservers paths are derived from $VROOTDIR.
361
362 EOF
363
364    if [ "$host_or_vservers" == vservers -o "$host_or_vservers" == both ]; then
365       set -o noglob
366       echo -e "vsnames = \"$selected_vservers\"\n" >> $next_filename
367       for i in $dup_vsincludes; do
368          echo "vsinclude = $i" >> $next_filename
369       done
370       set +o noglob
371    fi
372
373    # excludes
374    cat >> $next_filename <<EOF
375
376 # rdiff-backup specific comment, TO ADAPT
377 # files to exclude from the backup
378 # (supports globbing with '*')
379 EOF
380     set -o noglob
381     for i in $dup_excludes; do
382         echo "exclude = $i" >> $next_filename
383     done
384     set +o noglob
385
386     cat >> $next_filename <<EOF
387
388 ######################################################
389 ## destination section
390 ## (where the files are copied to)
391
392 [dest]
393
394 # perform an incremental backup? (default = yes)
395 # if incremental = no, perform a full backup in order to start a new backup set
396 incremental = $dup_incremental
397
398 # how many days of data to keep ; default is 60 days.
399 # (you can also use the time format of duplicity)
400 # 'keep = yes' means : do not delete old data, the remote host will take care of this
401 #keep = 60
402 #keep = yes
403 keep = $dup_keep
404
405 # bandwith limit, in kbit/s ; default is 0, i.e. no limit
406 #bandwidthlimit = 128
407 bandwidthlimit = $dup_bandwidth
408
409 # passed directly to ssh and scp
410 #sshoptions = -i /root/.ssh/id_dsa_duplicity
411 sshoptions = $dup_sshoptions
412
413 # put the backups under this directory
414 destdir = $dup_destdir
415
416 # the machine which will receive the backups
417 desthost = $dup_desthost
418
419 # make the files owned by this user
420 # note: you must be able to ssh backupuser@backhost
421 # without specifying a password (if type = remote).
422 destuser = $dup_destuser
423
424 EOF
425
426     chmod 600 $next_filename
427
428 }
429
430 dup_main_menu() {
431
432   while true; do
433      srcitem="choose files to include & exclude $_src_done"
434      destitem="configure backup destination $_dest_done"
435      gpgitem="configure GnuPG encryption/signing $_gpg_done"
436      conitem="set up ssh keys and test remote connection $_con_done"
437      advitem="edit advanced settings $_adv_done"
438      # TODO: add the following to the menu when do_dup_conn is written
439      # conn "$conitem" \
440      menuBox "$dup_title" "choose a step:" \
441         src "$srcitem" \
442         dest "$destitem" \
443         gpg "$gpgitem" \
444         adv "$advitem" \
445         finish "finish and create config file"
446      [ $? = 0 ] || return 1
447      result="$REPLY"
448
449      case "$result" in
450         "src") do_dup_src;;
451         "dest") do_dup_dest;;
452         "gpg") do_dup_gpg;;
453         # TODO: enable the following when do_dup_conn is written
454         # "conn") do_dup_conn;;
455         "adv") do_dup_adv;;
456         "finish")
457            if [[ "$_dest_done$_gpg_done$_src_done" != "(DONE)(DONE)(DONE)" ]]; then
458            # TODO: replace the previous test by the following when do_dup_conn is written
459            # if [[ "$_con_done$_dest_done$_gpg_done$_src_done" != "(DONE)(DONE)(DONE)(DONE)" ]]; then
460               msgBox "$dup_title" "You cannot create the configuration file until the four first steps are completed."
461            else
462               do_dup_finish
463               break
464            fi
465            ;;
466      esac
467
468   done
469 }
470
471 ### Main function
472
473 dup_wizard() {
474    
475    require_packages duplicity
476
477    # Global variables
478    dup_title="Duplicity action wizard"
479    _src_done=
480    _dest_done=
481    _con_done=
482    _gpg_done=
483    _adv_done=
484    dup_includes=
485    dup_excludes=
486    dup_vsincludes=
487    dup_incremental=yes
488    dup_keep=60
489    dup_bandwidth=
490    dup_sshoptions=
491    dup_destdir="/backups/`hostname`"
492    dup_desthost=
493    dup_destuser=
494    dup_gpg_asymmetric_encryption="yes"
495    dup_gpg_encryptkey=""
496    dup_gpg_sign="yes"
497    dup_gpg_onekeypair="yes"
498    dup_gpg_signkey=""
499    dup_gpg_password=""
500    dup_nicelevel=19
501    dup_testconnect=yes
502    dup_options=
503
504    # Global variables whose '*' shall not be expanded
505    set -o noglob
506    dup_default_includes="/var/spool/cron/crontabs /var/backups /etc /root /home /usr/local/*bin /var/lib/dpkg/status*"
507    dup_default_excludes="/home/*/.gnupg"
508    set +o noglob
509
510    dup_main_menu
511 }