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: vsincludes (backup these directories from every selected vserver)"
  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 unlock the GnuPG key:"
 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? Otherwise, 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 alway needed
 205    do_dup_gpg_passphrase
 206
 207    _gpg_done="(DONE)"
 208    setDefault adv
 209    # TODO: replace the above line by the following when do_dup_conn is written
 210    # setDefault conn
 211 }
 212
 213 # TODO: share rdiff.helper code in some lib, and use it here
 214 do_dup_conn() {
 215    _con_done="(DONE)"
 216    setDefault adv
 217 }
 218
 219 do_dup_misc_options() {
 220
 221    set -o noglob
 222    local replyconverted
 223    local thereply
 224
 225    formBegin "$dup_title - misc. options"
 226      formItem "nicelevel" "$dup_nicelevel"
 227      formItem "testconnect" "$dup_testconnect"
 228      formItem "options" "$dup_options"
 229    formDisplay
 230    [ $? = 0 ] || return 1
 231
 232    IFS=$''
 233    replyconverted=`echo $REPLY | tr '\n' :`
 234    IFS=$':'
 235    thereply=($replyconverted)
 236    IFS=$' \t\n'
 237
 238    dup_nicelevel=${thereply[0]}
 239    dup_testconnect=${thereply[1]}
 240    dup_options=${thereply[2]}
 241
 242    set +o noglob
 243 }
 244
 245 # (rdiff.helper compatible interface... there could be some sode to share, hmmm.)
 246 do_dup_adv() {
 247    do_dup_misc_options
 248    [ $? = 0 ] || return 1
 249    _adv_done="(DONE)"
 250    setDefault finish
 251 }
 252
 253 do_dup_finish() {
 254    get_next_filename $configdirectory/90.dup
 255    cat > $next_filename <<EOF
 256 # passed directly to duplicity
 257 #options = --verbosity 8
 258 options = $dup_options
 259
 260 # default is 0, but set to 19 if you want to lower the priority.
 261 nicelevel = $dup_nicelevel
 262
 263 # default is yes. set to no to skip the test if the remote host is alive
 264 testconnect = $dup_testconnect
 265
 266 ######################################################
 267 ## gpg section
 268 ## (how to encrypt and optionally sign the backups)
 269 ##
 270 ## WARNING: old (pre-0.9.4) example.dup used to give wrong information about
 271 ##          the way the following options are used. Please read the following
 272 ##          carefully.
 273 ##
 274 ## If the encryptkey variable is set:
 275 ##   - data is encrypted with the GnuPG public key specified by the encryptkey
 276 ##     variable
 277 ##   - if signing is enabled, data is signed with the GnuPG private
 278 ##     key specified by the signkey variable
 279 ##   - the password variable is used to unlock the GnuPG key(s) used
 280 ##     for encryption and (optionnal) signing
 281 ##
 282 ## If the encryptkey option is not set:
 283 ##   - data signing is not possible
 284 ##   - the password variable is used to encrypt the data with symmetric
 285 ##     encryption: no GnuPG key pair is needed
 286
 287 [gpg]
 288
 289 # when set to yes, encryptkey variable must be set below; if you want to use
 290 # two different keys for encryption and signing, you must also set the signkey
 291 # variable below.
 292 # default is no, for backwards compatibility with backupninja <= 0.5.
 293 sign = $dup_gpg_sign
 294
 295 # ID of the GnuPG public key used for data encryption.
 296 # if not set, symmetric encryption is used, and data signing is not possible.
 297 encryptkey = $dup_gpg_encryptkey
 298
 299 # ID of the GnuPG private key used for data signing.
 300 # if not set, encryptkey will be used.
 301 signkey = $dup_gpg_signkey
 302
 303 # password
 304 # NB: neither quote this, nor should it include any quotes
 305 password = $dup_gpg_password
 306
 307 ######################################################
 308 ## source section
 309 ## (where the files to be backed up are coming from)
 310
 311 [source]
 312
 313 # files to include in the backup
 314 # (supports globbing with '*')
 315 # BIG FAT WARNING
 316 # Symlinks are not dereferenced. Moreover, an include line whose path
 317 # contains, at any level, a symlink to a directory, will only have the
 318 # symlink backed-up, not the target directory's content. Yes, you have
 319 # to dereference yourself the symlinks, or to use 'mount --bind'
 320 # instead.
 321 # EXAMPLE
 322 # Let's say /home is a symlink to /mnt/crypt/home ; the following line
 323 # will only backup a "/home" symlink ; neither /home/user nor
 324 # /home/user/Mail will be backed-up :
 325 #   include = /home/user/Mail
 326 # A workaround is to 'mount --bind /mnt/crypt/home /home' ; another
 327 # one is to write :
 328 #   include = /mnt/crypt/home/user/Mail
 329 EOF
 330
 331    if [ "$host_or_vservers" == host -o "$host_or_vservers" == both ]; then
 332       set -o noglob
 333       for i in $dup_includes; do
 334          echo "include = $i" >> $next_filename
 335       done
 336       set +o noglob
 337    fi
 338
 339    cat >> $next_filename <<EOF
 340
 341 # If vservers = yes in /etc/backupninja.conf then the following variables can
 342 # be used:
 343 # vsnames = all | <vserver1> <vserver2> ... (default = all)
 344 # vsinclude = <path>
 345 # vsinclude = <path>
 346 # ...
 347 # Any path specified in vsinclude is added to the include list for each vserver
 348 # listed in vsnames (or all if vsnames = all, which is the default).
 349 #
 350 # For example, vsinclude = /home will backup the /home directory in every
 351 # vserver listed in vsnames. If you have 'vsnames = foo bar baz', this
 352 # vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
 353 # and /vservers/baz/home.
 354 # Vservers paths are derived from $VROOTDIR.
 355 # vsinclude supports globbing with '*'.
 356
 357 EOF
 358
 359    if [ "$host_or_vservers" == vservers -o "$host_or_vservers" == both ]; then
 360       set -o noglob
 361       echo -e "vsnames = $selected_vservers\n" >> $next_filename
 362       for i in $dup_vsincludes; do
 363          echo "vsinclude = $i" >> $next_filename
 364       done
 365       set +o noglob
 366    fi
 367
 368    # excludes
 369    cat >> $next_filename <<EOF
 370
 371 # rdiff-backup specific comment, TO ADAPT
 372 # files to exclude from the backup
 373 # (supports globbing with '*')
 374 EOF
 375     set -o noglob
 376     for i in $dup_excludes; do
 377         echo "exclude = $i" >> $next_filename
 378     done
 379     set +o noglob
 380
 381     cat >> $next_filename <<EOF
 382
 383 ######################################################
 384 ## destination section
 385 ## (where the files are copied to)
 386
 387 [dest]
 388
 389 # perform an incremental backup? (default = yes)
 390 # if incremental = no, perform a full backup in order to start a new backup set
 391 incremental = $dup_incremental
 392
 393 # how many days of data to keep ; default is 60 days.
 394 # (you can also use the time format of duplicity)
 395 # 'keep = yes' means : do not delete old data, the remote host will take care of this
 396 #keep = 60
 397 #keep = yes
 398 keep = $dup_keep
 399
 400 # bandwith limit, in kbit/s ; default is 0, i.e. no limit
 401 # NB: does not work anymore with duplicity >=0.4.2, work in progress to fix this
 402 #bandwidthlimit = 128
 403 bandwidthlimit = $dup_bandwidth
 404
 405 # passed directly to ssh and scp
 406 #sshoptions = -i /root/.ssh/id_dsa_duplicity
 407 sshoptions = $dup_sshoptions
 408
 409 # put the backups under this directory
 410 destdir = $dup_destdir
 411
 412 # the machine which will receive the backups
 413 desthost = $dup_desthost
 414
 415 # make the files owned by this user
 416 # note: you must be able to ssh backupuser@backhost
 417 # without specifying a password (if type = remote).
 418 destuser = $dup_destuser
 419
 420 EOF
 421
 422     chmod 600 $next_filename
 423
 424 }
 425
 426 dup_main_menu() {
 427
 428   while true; do
 429      srcitem="choose files to include & exclude $_src_done"
 430      destitem="configure backup destination $_dest_done"
 431      gpgitem="configure GnuPG encryption/signing $_gpg_done"
 432      conitem="set up ssh keys and test remote connection $_con_done"
 433      advitem="edit advanced settings $_adv_done"
 434      # TODO: add the following to the menu when do_dup_conn is written
 435      # conn "$conitem" \
 436      menuBox "$dup_title" "choose a step:" \
 437         src "$srcitem" \
 438         dest "$destitem" \
 439         gpg "$gpgitem" \
 440         adv "$advitem" \
 441         finish "finish and create config file"
 442      [ $? = 0 ] || return 1
 443      result="$REPLY"
 444
 445      case "$result" in
 446         "src") do_dup_src;;
 447         "dest") do_dup_dest;;
 448         "gpg") do_dup_gpg;;
 449         # TODO: enable the following when do_dup_conn is written
 450         # "conn") do_dup_conn;;
 451         "adv") do_dup_adv;;
 452         "finish")
 453            if [[ "$_dest_done$_gpg_done$_src_done" != "(DONE)(DONE)(DONE)" ]]; then
 454            # TODO: replace the previous test by the following when do_dup_conn is written
 455            # if [[ "$_con_done$_dest_done$_gpg_done$_src_done" != "(DONE)(DONE)(DONE)(DONE)" ]]; then
 456               msgBox "$dup_title" "You cannot create the configuration file until the four first steps are completed."
 457            else
 458               do_dup_finish
 459               break
 460            fi
 461            ;;
 462      esac
 463
 464   done
 465 }
 466
 467 ### Main function
 468
 469 dup_wizard() {
 470
 471    require_packages duplicity
 472
 473    # Global variables
 474    dup_title="Duplicity action wizard"
 475    _src_done=
 476    _dest_done=
 477    _con_done=
 478    _gpg_done=
 479    _adv_done=
 480    dup_includes=
 481    dup_excludes=
 482    dup_vsincludes=
 483    dup_incremental=yes
 484    dup_keep=60
 485    dup_bandwidth=
 486    dup_sshoptions=
 487    dup_destdir="/backups/`hostname`"
 488    dup_desthost=
 489    dup_destuser=
 490    dup_gpg_asymmetric_encryption="yes"
 491    dup_gpg_encryptkey=""
 492    dup_gpg_sign="yes"
 493    dup_gpg_onekeypair="yes"
 494    dup_gpg_signkey=""
 495    dup_gpg_password=""
 496    dup_nicelevel=19
 497    dup_testconnect=yes
 498    dup_options=
 499
 500    # Global variables whose '*' shall not be expanded
 501    set -o noglob
 502    dup_default_includes="/var/spool/cron/crontabs /var/backups /etc /root /home /usr/local/*bin /var/lib/dpkg/status*"
 503    dup_default_excludes="/home/*/.gnupg /home/*/.gnupg /home/*/.local/share/Trash /home/*/.Trash /home/*/.thumbnails /home/*/.beagle /home/*/.aMule /home/*/gtk-gnutella-downloads"
 504    set +o noglob
 505
 506    dup_main_menu
 507 }