git.sur5r.net Git - bacula/bacula/blob - bacula/src/filed/restore.c

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of Kern Sibbald.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  *  Bacula File Daemon  restore.c Restorefiles.
  30  *
  31  *    Kern Sibbald, November MM
  32  *
  33  */
  34
  35 #include "bacula.h"
  36 #include "filed.h"
  37 #include "restore.h"
  38
  39 #ifdef HAVE_DARWIN_OS
  40 #include <sys/attr.h>
  41 const bool have_darwin_os = true;
  42 #else
  43 const bool have_darwin_os = false;
  44 #endif
  45
  46 #if defined(HAVE_CRYPTO)
  47 const bool have_crypto = true;
  48 #else
  49 const bool have_crypto = false;
  50 #endif
  51
  52 #if defined(HAVE_ACL)
  53 const bool have_acl = true;
  54 #else
  55 const bool have_acl = false;
  56 #endif
  57
  58 #ifdef HAVE_SHA2
  59 const bool have_sha2 = true;
  60 #else
  61 const bool have_sha2 = false;
  62 #endif
  63
  64 #if defined(HAVE_XATTR)
  65 const bool have_xattr = true;
  66 #else
  67 const bool have_xattr = false;
  68 #endif
  69
  70 /*
  71  * Data received from Storage Daemon
  72  */
  73 static char rec_header[] = "rechdr %ld %ld %ld %ld %ld";
  74
  75 /*
  76  * Forward referenced functions
  77  */
  78 #if   defined(HAVE_LIBZ)
  79 static const char *zlib_strerror(int stat);
  80 const bool have_libz = true;
  81 #else
  82 const bool have_libz = false;
  83 #endif
  84
  85 static void deallocate_cipher(r_ctx &rctx);
  86 static void deallocate_fork_cipher(r_ctx &rctx);
  87 static void free_signature(r_ctx &rctx);
  88 static void free_session(r_ctx &rctx);
  89 static void close_previous_stream(r_ctx &rctx);
  90
  91 static bool verify_signature(JCR *jcr, r_ctx &rctx);
  92 int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen,
  93                      uint64_t *addr, int flags, RESTORE_CIPHER_CTX *cipher_ctx);
  94 bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags,
  95                   RESTORE_CIPHER_CTX *cipher_ctx);
  96
  97 /*
  98  * Close a bfd check that we are at the expected file offset.
  99  * Makes use of some code from set_attributes().
 100  */
 101 static int bclose_chksize(JCR *jcr, BFILE *bfd, boffset_t osize)
 102 {
 103    char ec1[50], ec2[50];
 104    boffset_t fsize;
 105
 106    fsize = blseek(bfd, 0, SEEK_CUR);
 107    bclose(bfd);
 108    if (fsize > 0 && fsize != osize) {
 109       Qmsg3(jcr, M_ERROR, 0, _("Size of data or stream of %s not correct. Original %s, restored %s.\n"),
 110             jcr->last_fname, edit_uint64(osize, ec1),
 111             edit_uint64(fsize, ec2));
 112       return -1;
 113    }
 114    return 0;
 115 }
 116
 117 #ifdef HAVE_DARWIN_OS
 118 bool restore_finderinfo(JCR *jcr, POOLMEM *buf, int32_t buflen)
 119 {
 120    struct attrlist attrList;
 121
 122    memset(&attrList, 0, sizeof(attrList));
 123    attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
 124    attrList.commonattr = ATTR_CMN_FNDRINFO;
 125
 126    Dmsg0(130, "Restoring Finder Info\n");
 127    jcr->ff->flags |= FO_HFSPLUS;
 128    if (buflen != 32) {
 129       Jmsg(jcr, M_ERROR, 0, _("Invalid length of Finder Info (got %d, not 32)\n"), buflen);
 130       return false;
 131    }
 132
 133    if (setattrlist(jcr->last_fname, &attrList, buf, buflen, 0) != 0) {
 134       Jmsg(jcr, M_ERROR, 0, _("Could not set Finder Info on %s\n"), jcr->last_fname);
 135       return false;
 136    }
 137
 138    return true;
 139 }
 140 #else
 141 bool restore_finderinfo(JCR *jcr, POOLMEM *buf, int32_t buflen)
 142 {
 143    return true;
 144 }
 145 #endif
 146
 147 /*
 148  * Restore the requested files.
 149  */
 150 void do_restore(JCR *jcr)
 151 {
 152    BSOCK *sd;
 153    uint32_t VolSessionId, VolSessionTime;
 154    int32_t file_index;
 155    char ec1[50];                      /* Buffer printing huge values */
 156    uint32_t buf_size;                 /* client buffer size */
 157    int stat;
 158    intmax_t rsrc_len = 0;             /* Original length of resource fork */
 159    r_ctx rctx;
 160    ATTR *attr;
 161    /* ***FIXME*** make configurable */
 162    crypto_digest_t signing_algorithm = have_sha2 ?
 163                                        CRYPTO_DIGEST_SHA256 : CRYPTO_DIGEST_SHA1;
 164    memset(&rctx, 0, sizeof(rctx));
 165    rctx.jcr = jcr;
 166
 167    /*
 168     * The following variables keep track of "known unknowns"
 169     */
 170    int non_support_data = 0;
 171    int non_support_attr = 0;
 172    int non_support_rsrc = 0;
 173    int non_support_finfo = 0;
 174    int non_support_acl = 0;
 175    int non_support_progname = 0;
 176    int non_support_crypto = 0;
 177    int non_support_xattr = 0;
 178
 179    sd = jcr->store_bsock;
 180    set_jcr_job_status(jcr, JS_Running);
 181
 182    LockRes();
 183    CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL);
 184    UnlockRes();
 185    if (client) {
 186       buf_size = client->max_network_buffer_size;
 187    } else {
 188       buf_size = 0;                   /* use default */
 189    }
 190    if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) {
 191       set_jcr_job_status(jcr, JS_ErrorTerminated);
 192       return;
 193    }
 194    jcr->buf_size = sd->msglen;
 195
 196    /*
 197     * St Bernard code goes here if implemented -- see end of file
 198     */
 199
 200    if (have_libz) {
 201       uint32_t compress_buf_size = jcr->buf_size + 12 + ((jcr->buf_size+999) / 1000) + 100;
 202       jcr->compress_buf = get_memory(compress_buf_size);
 203       jcr->compress_buf_size = compress_buf_size;
 204    }
 205
 206    if (have_crypto) {
 207       rctx.cipher_ctx.buf = get_memory(CRYPTO_CIPHER_MAX_BLOCK_SIZE);
 208       if (have_darwin_os) {
 209          rctx.fork_cipher_ctx.buf = get_memory(CRYPTO_CIPHER_MAX_BLOCK_SIZE);
 210       }
 211    }
 212
 213    /*
 214     * Get a record from the Storage daemon. We are guaranteed to
 215     *   receive records in the following order:
 216     *   1. Stream record header
 217     *   2. Stream data (one or more of the following in the order given)
 218     *        a. Attributes (Unix or Win32)
 219     *        b. Possibly stream encryption session data (e.g., symmetric session key)
 220     *        c. File data for the file
 221     *        d. Alternate data stream (e.g. Resource Fork)
 222     *        e. Finder info
 223     *        f. ACLs
 224     *        g. XATTRs
 225     *        h. Possibly a cryptographic signature
 226     *        i. Possibly MD5 or SHA1 record
 227     *   3. Repeat step 1
 228     *
 229     * NOTE: We keep track of two bacula file descriptors:
 230     *   1. bfd for file data.
 231     *      This fd is opened for non empty files when an attribute stream is
 232     *      encountered and closed when we find the next attribute stream.
 233     *   2. fork_bfd for alternate data streams
 234     *      This fd is opened every time we encounter a new alternate data
 235     *      stream for the current file. When we find any other stream, we
 236     *      close it again.
 237     *      The expected size of the stream, fork_len, should be set when
 238     *      opening the fd.
 239     *   3. Not all the stream data records are required -- e.g. if there
 240     *      is no fork, there is no alternate data stream, no ACL, ...
 241     */
 242    binit(&rctx.bfd);
 243    binit(&rctx.forkbfd);
 244    attr = rctx.attr = new_attr(jcr);
 245    if (have_acl) {
 246       jcr->acl_data = (acl_data_t *)malloc(sizeof(acl_data_t));
 247       memset((caddr_t)jcr->acl_data, 0, sizeof(acl_data_t));
 248       jcr->acl_data->content = get_pool_memory(PM_MESSAGE);
 249    }
 250    if (have_xattr) {
 251       jcr->xattr_data = (xattr_data_t *)malloc(sizeof(xattr_data_t));
 252       memset((caddr_t)jcr->xattr_data, 0, sizeof(xattr_data_t));
 253       jcr->xattr_data->content = get_pool_memory(PM_MESSAGE);
 254    }
 255
 256    while (bget_msg(sd) >= 0 && !job_canceled(jcr)) {
 257       /*
 258        * Remember previous stream type
 259        */
 260       rctx.prev_stream = rctx.stream;
 261
 262       /*
 263        * First we expect a Stream Record Header
 264        */
 265       if (sscanf(sd->msg, rec_header, &VolSessionId, &VolSessionTime, &file_index,
 266           &rctx.stream, &rctx.size) != 5) {
 267          Jmsg1(jcr, M_FATAL, 0, _("Record header scan error: %s\n"), sd->msg);
 268          goto bail_out;
 269       }
 270       Dmsg5(50, "Got hdr: Files=%d FilInx=%d size=%d Stream=%d, %s.\n",
 271             jcr->JobFiles, file_index, rctx.size, rctx.stream, stream_to_ascii(rctx.stream));
 272
 273       /*
 274        * Now we expect the Stream Data
 275        */
 276       if (bget_msg(sd) < 0) {
 277          Jmsg1(jcr, M_FATAL, 0, _("Data record error. ERR=%s\n"), sd->bstrerror());
 278          goto bail_out;
 279       }
 280       if (rctx.size != (uint32_t)sd->msglen) {
 281          Jmsg2(jcr, M_FATAL, 0, _("Actual data size %d not same as header %d\n"),
 282                sd->msglen, rctx.size);
 283          Dmsg2(50, "Actual data size %d not same as header %d\n",
 284                sd->msglen, rctx.size);
 285          goto bail_out;
 286       }
 287       Dmsg3(130, "Got stream: %s len=%d extract=%d\n", stream_to_ascii(rctx.stream),
 288             sd->msglen, rctx.extract);
 289
 290       /*
 291        * If we change streams, close and reset alternate data streams
 292        */
 293       if (rctx.prev_stream != rctx.stream) {
 294          if (is_bopen(&rctx.forkbfd)) {
 295             deallocate_fork_cipher(rctx);
 296             bclose_chksize(jcr, &rctx.forkbfd, rctx.fork_size);
 297          }
 298          /*
 299           * Use an impossible value and set a proper one below
 300           */
 301          rctx.fork_size = -1;
 302          rctx.fork_addr = 0;
 303       }
 304
 305       /*
 306        * File Attributes stream
 307        */
 308       switch (rctx.stream) {
 309       case STREAM_UNIX_ATTRIBUTES:
 310       case STREAM_UNIX_ATTRIBUTES_EX:
 311          /*
 312           * if any previous stream open, close it
 313           */
 314          close_previous_stream(rctx);
 315
 316          /*
 317           * TODO: manage deleted files
 318           */
 319          if (rctx.type == FT_DELETED) { /* deleted file */
 320             continue;
 321          }
 322          /*
 323           * Restore objects should be ignored here -- they are
 324           * returned at the beginning of the restore.
 325           */
 326          if (rctx.type == FT_RESTORE_FIRST) {
 327             continue;
 328          }
 329
 330          /*
 331           * Unpack attributes and do sanity check them
 332           */
 333          if (!unpack_attributes_record(jcr, rctx.stream, sd->msg, sd->msglen, attr)) {
 334             goto bail_out;
 335          }
 336
 337          Dmsg3(100, "File %s\nattrib=%s\nattribsEx=%s\n", attr->fname,
 338                attr->attr, attr->attrEx);
 339          Dmsg3(100, "=== msglen=%d attrExlen=%d msg=%s\n", sd->msglen,
 340                strlen(attr->attrEx), sd->msg);
 341
 342          attr->data_stream = decode_stat(attr->attr, &attr->statp, &attr->LinkFI);
 343
 344          if (!is_restore_stream_supported(attr->data_stream)) {
 345             if (!non_support_data++) {
 346                Jmsg(jcr, M_ERROR, 0, _("%s stream not supported on this Client.\n"),
 347                   stream_to_ascii(attr->data_stream));
 348             }
 349             continue;
 350          }
 351
 352          build_attr_output_fnames(jcr, attr);
 353
 354          /*
 355           * Try to actually create the file, which returns a status telling
 356           * us if we need to extract or not.
 357           */
 358          jcr->num_files_examined++;
 359          rctx.extract = false;
 360          if (jcr->plugin) {
 361             stat = plugin_create_file(jcr, attr, &rctx.bfd, jcr->replace);
 362          } else {
 363             stat = create_file(jcr, attr, &rctx.bfd, jcr->replace);
 364          }
 365          jcr->lock();
 366          pm_strcpy(jcr->last_fname, attr->ofname);
 367          jcr->last_type = attr->type;
 368          jcr->unlock();
 369          Dmsg2(130, "Outfile=%s create_file stat=%d\n", attr->ofname, stat);
 370          switch (stat) {
 371          case CF_ERROR:
 372          case CF_SKIP:
 373             pm_strcpy(jcr->last_fname, attr->ofname);
 374             jcr->last_type = attr->type;
 375             break;
 376          case CF_EXTRACT:
 377             /*
 378              * File created and we expect file data
 379              */
 380             rctx.extract = true;
 381             /*
 382              * FALLTHROUGH
 383              */
 384          case CF_CREATED:
 385             /*
 386              * File created, but there is no content
 387              */
 388             rctx.fileAddr = 0;
 389             print_ls_output(jcr, attr);
 390
 391             if (have_darwin_os) {
 392                /*
 393                 * Only restore the resource fork for regular files
 394                 */
 395                from_base64(&rsrc_len, attr->attrEx);
 396                if (attr->type == FT_REG && rsrc_len > 0) {
 397                   rctx.extract = true;
 398                }
 399
 400                /*
 401                 * Count the resource forks not as regular files being restored.
 402                 */
 403                if (rsrc_len == 0) {
 404                   jcr->JobFiles++;
 405                }
 406             } else {
 407                jcr->JobFiles++;
 408             }
 409
 410             if (!rctx.extract) {
 411                /*
 412                 * set attributes now because file will not be extracted
 413                 */
 414                if (jcr->plugin) {
 415                   plugin_set_attributes(jcr, attr, &rctx.bfd);
 416                } else {
 417                   set_attributes(jcr, attr, &rctx.bfd);
 418                }
 419             }
 420             break;
 421          }
 422          break;
 423
 424       /*
 425        * Data stream
 426        */
 427       case STREAM_ENCRYPTED_SESSION_DATA:
 428          crypto_error_t cryptoerr;
 429
 430          /*
 431           * Is this an unexpected session data entry?
 432           */
 433          if (rctx.cs) {
 434             Jmsg0(jcr, M_ERROR, 0, _("Unexpected cryptographic session data stream.\n"));
 435             rctx.extract = false;
 436             bclose(&rctx.bfd);
 437             continue;
 438          }
 439
 440          /*
 441           * Do we have any keys at all?
 442           */
 443          if (!jcr->crypto.pki_recipients) {
 444             Jmsg(jcr, M_ERROR, 0, _("No private decryption keys have been defined to decrypt encrypted backup data.\n"));
 445             rctx.extract = false;
 446             bclose(&rctx.bfd);
 447             break;
 448          }
 449
 450          if (jcr->crypto.digest) {
 451             crypto_digest_free(jcr->crypto.digest);
 452          }
 453          jcr->crypto.digest = crypto_digest_new(jcr, signing_algorithm);
 454          if (!jcr->crypto.digest) {
 455             Jmsg0(jcr, M_FATAL, 0, _("Could not create digest.\n"));
 456             rctx.extract = false;
 457             bclose(&rctx.bfd);
 458             break;
 459          }
 460
 461          /*
 462           * Decode and save session keys.
 463           */
 464          cryptoerr = crypto_session_decode((uint8_t *)sd->msg, (uint32_t)sd->msglen,
 465                         jcr->crypto.pki_recipients, &rctx.cs);
 466          switch(cryptoerr) {
 467          case CRYPTO_ERROR_NONE:
 468             /*
 469              * Success
 470              */
 471             break;
 472          case CRYPTO_ERROR_NORECIPIENT:
 473             Jmsg(jcr, M_ERROR, 0, _("Missing private key required to decrypt encrypted backup data.\n"));
 474             break;
 475          case CRYPTO_ERROR_DECRYPTION:
 476             Jmsg(jcr, M_ERROR, 0, _("Decrypt of the session key failed.\n"));
 477             break;
 478          default:
 479             /*
 480              * Shouldn't happen
 481              */
 482             Jmsg1(jcr, M_ERROR, 0, _("An error occurred while decoding encrypted session data stream: %s\n"), crypto_strerror(cryptoerr));
 483             break;
 484          }
 485
 486          if (cryptoerr != CRYPTO_ERROR_NONE) {
 487             rctx.extract = false;
 488             bclose(&rctx.bfd);
 489             continue;
 490          }
 491
 492          break;
 493
 494       case STREAM_FILE_DATA:
 495       case STREAM_SPARSE_DATA:
 496       case STREAM_WIN32_DATA:
 497       case STREAM_GZIP_DATA:
 498       case STREAM_SPARSE_GZIP_DATA:
 499       case STREAM_WIN32_GZIP_DATA:
 500       case STREAM_ENCRYPTED_FILE_DATA:
 501       case STREAM_ENCRYPTED_WIN32_DATA:
 502       case STREAM_ENCRYPTED_FILE_GZIP_DATA:
 503       case STREAM_ENCRYPTED_WIN32_GZIP_DATA:
 504          /*
 505           * Force an expected, consistent stream type here
 506           */
 507          if (rctx.extract && (rctx.prev_stream == rctx.stream
 508                          || rctx.prev_stream == STREAM_UNIX_ATTRIBUTES
 509                          || rctx.prev_stream == STREAM_UNIX_ATTRIBUTES_EX
 510                          || rctx.prev_stream == STREAM_ENCRYPTED_SESSION_DATA)) {
 511             rctx.flags = 0;
 512
 513             if (rctx.stream == STREAM_SPARSE_DATA ||
 514                 rctx.stream == STREAM_SPARSE_GZIP_DATA) {
 515                rctx.flags |= FO_SPARSE;
 516             }
 517
 518             if (rctx.stream == STREAM_GZIP_DATA
 519                   || rctx.stream == STREAM_SPARSE_GZIP_DATA
 520                   || rctx.stream == STREAM_WIN32_GZIP_DATA
 521                   || rctx.stream == STREAM_ENCRYPTED_FILE_GZIP_DATA
 522                   || rctx.stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) {
 523                rctx.flags |= FO_GZIP;
 524             }
 525
 526             if (rctx.stream == STREAM_ENCRYPTED_FILE_DATA
 527                   || rctx.stream == STREAM_ENCRYPTED_FILE_GZIP_DATA
 528                   || rctx.stream == STREAM_ENCRYPTED_WIN32_DATA
 529                   || rctx.stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) {
 530                /*
 531                 * Set up a decryption context
 532                 */
 533                if (!rctx.cipher_ctx.cipher) {
 534                   if (!rctx.cs) {
 535                      Jmsg1(jcr, M_ERROR, 0, _("Missing encryption session data stream for %s\n"), jcr->last_fname);
 536                      rctx.extract = false;
 537                      bclose(&rctx.bfd);
 538                      continue;
 539                   }
 540
 541                   if ((rctx.cipher_ctx.cipher = crypto_cipher_new(rctx.cs, false,
 542                            &rctx.cipher_ctx.block_size)) == NULL) {
 543                      Jmsg1(jcr, M_ERROR, 0, _("Failed to initialize decryption context for %s\n"), jcr->last_fname);
 544                      free_session(rctx);
 545                      rctx.extract = false;
 546                      bclose(&rctx.bfd);
 547                      continue;
 548                   }
 549                }
 550                rctx.flags |= FO_ENCRYPT;
 551             }
 552
 553             if (is_win32_stream(rctx.stream) && !have_win32_api()) {
 554                set_portable_backup(&rctx.bfd);
 555                /*
 556                 * "decompose" BackupWrite data
 557                 */
 558                rctx.flags |= FO_WIN32DECOMP;
 559             }
 560
 561             if (extract_data(jcr, &rctx.bfd, sd->msg, sd->msglen, &rctx.fileAddr,
 562                              rctx.flags, &rctx.cipher_ctx) < 0) {
 563                rctx.extract = false;
 564                bclose(&rctx.bfd);
 565                continue;
 566             }
 567          }
 568          break;
 569
 570       /*
 571        * Resource fork stream - only recorded after a file to be restored
 572        * Silently ignore if we cannot write - we already reported that
 573        */
 574       case STREAM_ENCRYPTED_MACOS_FORK_DATA:
 575       case STREAM_MACOS_FORK_DATA:
 576          if (have_darwin_os) {
 577             rctx.fork_flags = 0;
 578             jcr->ff->flags |= FO_HFSPLUS;
 579
 580             if (rctx.stream == STREAM_ENCRYPTED_MACOS_FORK_DATA) {
 581                rctx.fork_flags |= FO_ENCRYPT;
 582
 583                /*
 584                 * Set up a decryption context
 585                 */
 586                if (rctx.extract && !rctx.fork_cipher_ctx.cipher) {
 587                   if (!rctx.cs) {
 588                      Jmsg1(jcr, M_ERROR, 0, _("Missing encryption session data stream for %s\n"), jcr->last_fname);
 589                      rctx.extract = false;
 590                      bclose(&rctx.bfd);
 591                      continue;
 592                   }
 593
 594                   if ((rctx.fork_cipher_ctx.cipher = crypto_cipher_new(rctx.cs, false, &rctx.fork_cipher_ctx.block_size)) == NULL) {
 595                      Jmsg1(jcr, M_ERROR, 0, _("Failed to initialize decryption context for %s\n"), jcr->last_fname);
 596                      free_session(rctx);
 597                      rctx.extract = false;
 598                      bclose(&rctx.bfd);
 599                      continue;
 600                   }
 601                }
 602             }
 603
 604             if (rctx.extract) {
 605                if (rctx.prev_stream != rctx.stream) {
 606                   if (bopen_rsrc(&rctx.forkbfd, jcr->last_fname, O_WRONLY | O_TRUNC | O_BINARY, 0) < 0) {
 607                      Jmsg(jcr, M_ERROR, 0, _("Cannot open resource fork for %s.\n"), jcr->last_fname);
 608                      rctx.extract = false;
 609                      continue;
 610                   }
 611
 612                   rctx.fork_size = rsrc_len;
 613                   Dmsg0(130, "Restoring resource fork\n");
 614                }
 615
 616                if (extract_data(jcr, &rctx.forkbfd, sd->msg, sd->msglen, &rctx.fork_addr, rctx.fork_flags,
 617                                 &rctx.fork_cipher_ctx) < 0) {
 618                   rctx.extract = false;
 619                   bclose(&rctx.forkbfd);
 620                   continue;
 621                }
 622             }
 623          } else {
 624             non_support_rsrc++;
 625          }
 626          break;
 627
 628       case STREAM_HFSPLUS_ATTRIBUTES:
 629          if (have_darwin_os) {
 630             if (!restore_finderinfo(jcr, sd->msg, sd->msglen)) {
 631                continue;
 632             }
 633          } else {
 634             non_support_finfo++;
 635          }
 636          break;
 637
 638       case STREAM_UNIX_ACCESS_ACL:
 639       case STREAM_UNIX_DEFAULT_ACL:
 640       case STREAM_ACL_AIX_TEXT:
 641       case STREAM_ACL_DARWIN_ACCESS_ACL:
 642       case STREAM_ACL_FREEBSD_DEFAULT_ACL:
 643       case STREAM_ACL_FREEBSD_ACCESS_ACL:
 644       case STREAM_ACL_HPUX_ACL_ENTRY:
 645       case STREAM_ACL_IRIX_DEFAULT_ACL:
 646       case STREAM_ACL_IRIX_ACCESS_ACL:
 647       case STREAM_ACL_LINUX_DEFAULT_ACL:
 648       case STREAM_ACL_LINUX_ACCESS_ACL:
 649       case STREAM_ACL_TRU64_DEFAULT_ACL:
 650       case STREAM_ACL_TRU64_DEFAULT_DIR_ACL:
 651       case STREAM_ACL_TRU64_ACCESS_ACL:
 652       case STREAM_ACL_SOLARIS_ACLENT:
 653       case STREAM_ACL_SOLARIS_ACE:
 654          /*
 655           * Do not restore ACLs when
 656           * a) The current file is not extracted
 657           * b)     and it is not a directory (they are never "extracted")
 658           * c) or the file name is empty
 659           */
 660          if ((!rctx.extract && jcr->last_type != FT_DIREND) || (*jcr->last_fname == 0)) {
 661             break;
 662          }
 663          if (have_acl) {
 664             pm_memcpy(jcr->acl_data->content, sd->msg, sd->msglen);
 665             jcr->acl_data->content_length = sd->msglen;
 666             switch (parse_acl_streams(jcr, rctx.stream)) {
 667             case bacl_exit_fatal:
 668                goto bail_out;
 669             case bacl_exit_error:
 670                /*
 671                 * Non-fatal errors, count them and when the number is under ACL_REPORT_ERR_MAX_PER_JOB
 672                 * print the error message set by the lower level routine in jcr->errmsg.
 673                 */
 674                if (jcr->acl_data->nr_errors < ACL_REPORT_ERR_MAX_PER_JOB) {
 675                   Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 676                }
 677                jcr->acl_data->nr_errors++;
 678                break;
 679             case bacl_exit_ok:
 680                break;
 681             }
 682          } else {
 683             non_support_acl++;
 684          }
 685          break;
 686
 687       case STREAM_XATTR_OPENBSD:
 688       case STREAM_XATTR_SOLARIS_SYS:
 689       case STREAM_XATTR_SOLARIS:
 690       case STREAM_XATTR_DARWIN:
 691       case STREAM_XATTR_FREEBSD:
 692       case STREAM_XATTR_LINUX:
 693       case STREAM_XATTR_NETBSD:
 694          /*
 695           * Do not restore Extended Attributes when
 696           * a) The current file is not extracted
 697           * b)     and it is not a directory (they are never "extracted")
 698           * c) or the file name is empty
 699           */
 700          if ((!rctx.extract && jcr->last_type != FT_DIREND) || (*jcr->last_fname == 0)) {
 701             break;
 702          }
 703          if (have_xattr) {
 704             pm_memcpy(jcr->xattr_data->content, sd->msg, sd->msglen);
 705             jcr->xattr_data->content_length = sd->msglen;
 706             switch (parse_xattr_streams(jcr, rctx.stream)) {
 707             case bxattr_exit_fatal:
 708                goto bail_out;
 709             case bxattr_exit_error:
 710                /*
 711                 * Non-fatal errors, count them and when the number is under XATTR_REPORT_ERR_MAX_PER_JOB
 712                 * print the error message set by the lower level routine in jcr->errmsg.
 713                 */
 714                if (jcr->xattr_data->nr_errors < XATTR_REPORT_ERR_MAX_PER_JOB) {
 715                   Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 716                }
 717                jcr->xattr_data->nr_errors++;
 718                break;
 719             case bxattr_exit_ok:
 720                break;
 721             }
 722          } else {
 723             non_support_xattr++;
 724          }
 725          break;
 726
 727       case STREAM_SIGNED_DIGEST:
 728          /*
 729           * Is this an unexpected signature?
 730           */
 731          if (rctx.sig) {
 732             Jmsg0(jcr, M_ERROR, 0, _("Unexpected cryptographic signature data stream.\n"));
 733             free_signature(rctx);
 734             continue;
 735          }
 736          /*
 737           * Save signature.
 738           */
 739          if (rctx.extract && (rctx.sig = crypto_sign_decode(jcr, (uint8_t *)sd->msg, (uint32_t)sd->msglen)) == NULL) {
 740             Jmsg1(jcr, M_ERROR, 0, _("Failed to decode message signature for %s\n"), jcr->last_fname);
 741          }
 742          break;
 743
 744       case STREAM_MD5_DIGEST:
 745       case STREAM_SHA1_DIGEST:
 746       case STREAM_SHA256_DIGEST:
 747       case STREAM_SHA512_DIGEST:
 748          break;
 749
 750       case STREAM_PROGRAM_NAMES:
 751       case STREAM_PROGRAM_DATA:
 752          if (!non_support_progname) {
 753             Pmsg0(000, "Got Program Name or Data Stream. Ignored.\n");
 754             non_support_progname++;
 755          }
 756          break;
 757
 758       case STREAM_PLUGIN_NAME:
 759          close_previous_stream(rctx);
 760          Dmsg1(50, "restore stream_plugin_name=%s\n", sd->msg);
 761          plugin_name_stream(jcr, sd->msg);
 762          break;
 763
 764       default:
 765          close_previous_stream(rctx);
 766          Jmsg(jcr, M_ERROR, 0, _("Unknown stream=%d ignored. This shouldn't happen!\n"),
 767               rctx.stream);
 768          Dmsg2(0, "Unknown stream=%d data=%s\n", rctx.stream, sd->msg);
 769          break;
 770       } /* end switch(stream) */
 771    } /* end while get_msg() */
 772
 773    /*
 774     * If output file is still open, it was the last one in the
 775     * archive since we just hit an end of file, so close the file.
 776     */
 777    if (is_bopen(&rctx.forkbfd)) {
 778       bclose_chksize(jcr, &rctx.forkbfd, rctx.fork_size);
 779    }
 780
 781    close_previous_stream(rctx);
 782    set_jcr_job_status(jcr, JS_Terminated);
 783    goto ok_out;
 784
 785 bail_out:
 786    set_jcr_job_status(jcr, JS_ErrorTerminated);
 787
 788 ok_out:
 789    /*
 790     * First output the statistics.
 791     */
 792    Dmsg2(10, "End Do Restore. Files=%d Bytes=%s\n", jcr->JobFiles,
 793       edit_uint64(jcr->JobBytes, ec1));
 794    if (have_acl && jcr->acl_data->nr_errors > 0) {
 795       Jmsg(jcr, M_ERROR, 0, _("Encountered %ld acl errors while doing restore\n"),
 796            jcr->acl_data->nr_errors);
 797    }
 798    if (have_xattr && jcr->xattr_data->nr_errors > 0) {
 799       Jmsg(jcr, M_ERROR, 0, _("Encountered %ld xattr errors while doing restore\n"),
 800            jcr->xattr_data->nr_errors);
 801    }
 802    if (non_support_data > 1 || non_support_attr > 1) {
 803       Jmsg(jcr, M_ERROR, 0, _("%d non-supported data streams and %d non-supported attrib streams ignored.\n"),
 804          non_support_data, non_support_attr);
 805    }
 806    if (non_support_rsrc) {
 807       Jmsg(jcr, M_INFO, 0, _("%d non-supported resource fork streams ignored.\n"), non_support_rsrc);
 808    }
 809    if (non_support_finfo) {
 810       Jmsg(jcr, M_INFO, 0, _("%d non-supported Finder Info streams ignored.\n"), non_support_rsrc);
 811    }
 812    if (non_support_acl) {
 813       Jmsg(jcr, M_INFO, 0, _("%d non-supported acl streams ignored.\n"), non_support_acl);
 814    }
 815    if (non_support_crypto) {
 816       Jmsg(jcr, M_INFO, 0, _("%d non-supported crypto streams ignored.\n"), non_support_acl);
 817    }
 818    if (non_support_xattr) {
 819       Jmsg(jcr, M_INFO, 0, _("%d non-supported xattr streams ignored.\n"), non_support_xattr);
 820    }
 821
 822    /*
 823     * Free Signature & Crypto Data
 824     */
 825    free_signature(rctx);
 826    free_session(rctx);
 827    if (jcr->crypto.digest) {
 828       crypto_digest_free(jcr->crypto.digest);
 829       jcr->crypto.digest = NULL;
 830    }
 831
 832    /*
 833     * Free file cipher restore context
 834     */
 835    if (rctx.cipher_ctx.cipher) {
 836       crypto_cipher_free(rctx.cipher_ctx.cipher);
 837       rctx.cipher_ctx.cipher = NULL;
 838    }
 839
 840    if (rctx.cipher_ctx.buf) {
 841       free_pool_memory(rctx.cipher_ctx.buf);
 842       rctx.cipher_ctx.buf = NULL;
 843    }
 844
 845    /*
 846     * Free alternate stream cipher restore context
 847     */
 848    if (rctx.fork_cipher_ctx.cipher) {
 849       crypto_cipher_free(rctx.fork_cipher_ctx.cipher);
 850       rctx.fork_cipher_ctx.cipher = NULL;
 851    }
 852    if (rctx.fork_cipher_ctx.buf) {
 853       free_pool_memory(rctx.fork_cipher_ctx.buf);
 854       rctx.fork_cipher_ctx.buf = NULL;
 855    }
 856
 857    if (jcr->compress_buf) {
 858       free_pool_memory(jcr->compress_buf);
 859       jcr->compress_buf = NULL;
 860       jcr->compress_buf_size = 0;
 861    }
 862
 863    if (have_acl && jcr->acl_data) {
 864       free_pool_memory(jcr->acl_data->content);
 865       free(jcr->acl_data);
 866       jcr->acl_data = NULL;
 867    }
 868
 869    if (have_xattr && jcr->xattr_data) {
 870       free_pool_memory(jcr->xattr_data->content);
 871       free(jcr->xattr_data);
 872       jcr->xattr_data = NULL;
 873    }
 874
 875    bclose(&rctx.forkbfd);
 876    bclose(&rctx.bfd);
 877    free_attr(rctx.attr);
 878 }
 879
 880 #ifdef HAVE_LIBZ
 881 /*
 882  * Convert ZLIB error code into an ASCII message
 883  */
 884 static const char *zlib_strerror(int stat)
 885 {
 886    if (stat >= 0) {
 887       return _("None");
 888    }
 889    switch (stat) {
 890    case Z_ERRNO:
 891       return _("Zlib errno");
 892    case Z_STREAM_ERROR:
 893       return _("Zlib stream error");
 894    case Z_DATA_ERROR:
 895       return _("Zlib data error");
 896    case Z_MEM_ERROR:
 897       return _("Zlib memory error");
 898    case Z_BUF_ERROR:
 899       return _("Zlib buffer error");
 900    case Z_VERSION_ERROR:
 901       return _("Zlib version error");
 902    default:
 903       return _("*none*");
 904    }
 905 }
 906 #endif
 907
 908 static int do_file_digest(JCR *jcr, FF_PKT *ff_pkt, bool top_level)
 909 {
 910    Dmsg1(50, "do_file_digest jcr=%p\n", jcr);
 911    return (digest_file(jcr, ff_pkt, jcr->crypto.digest));
 912 }
 913
 914 /*
 915  * Verify the signature for the last restored file
 916  * Return value is either true (signature correct)
 917  * or false (signature could not be verified).
 918  * TODO landonf: Implement without using find_one_file and
 919  * without re-reading the file.
 920  */
 921 static bool verify_signature(JCR *jcr, r_ctx &rctx)
 922 {
 923    X509_KEYPAIR *keypair;
 924    DIGEST *digest = NULL;
 925    crypto_error_t err;
 926    uint64_t saved_bytes;
 927    crypto_digest_t signing_algorithm = have_sha2 ?
 928                                        CRYPTO_DIGEST_SHA256 : CRYPTO_DIGEST_SHA1;
 929    crypto_digest_t algorithm;
 930    SIGNATURE *sig = rctx.sig;
 931
 932
 933    if (!jcr->crypto.pki_sign) {
 934       /*
 935        * no signature OK
 936        */
 937       return true;
 938    }
 939    if (!sig) {
 940       if (rctx.type == FT_REGE || rctx.type == FT_REG || rctx.type == FT_RAW) {
 941          Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"),
 942                jcr->last_fname);
 943          goto bail_out;
 944       }
 945       return true;
 946    }
 947
 948    /*
 949     * Iterate through the trusted signers
 950     */
 951    foreach_alist(keypair, jcr->crypto.pki_signers) {
 952       err = crypto_sign_get_digest(sig, jcr->crypto.pki_keypair, algorithm, &digest);
 953       switch (err) {
 954       case CRYPTO_ERROR_NONE:
 955          Dmsg0(50, "== Got digest\n");
 956          /*
 957           * We computed jcr->crypto.digest using signing_algorithm while writing
 958           * the file. If it is not the same as the algorithm used for
 959           * this file, punt by releasing the computed algorithm and
 960           * computing by re-reading the file.
 961           */
 962          if (algorithm != signing_algorithm) {
 963             if (jcr->crypto.digest) {
 964                crypto_digest_free(jcr->crypto.digest);
 965                jcr->crypto.digest = NULL;
 966             }
 967          }
 968          if (jcr->crypto.digest) {
 969              /*
 970               * Use digest computed while writing the file to verify the signature
 971               */
 972             if ((err = crypto_sign_verify(sig, keypair, jcr->crypto.digest)) != CRYPTO_ERROR_NONE) {
 973                Dmsg1(50, "Bad signature on %s\n", jcr->last_fname);
 974                Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for file %s: ERR=%s\n"),
 975                      jcr->last_fname, crypto_strerror(err));
 976                goto bail_out;
 977             }
 978          } else {
 979             /*
 980              * Signature found, digest allocated.  Old method,
 981              * re-read the file and compute the digest
 982              */
 983             jcr->crypto.digest = digest;
 984
 985             /*
 986              * Checksum the entire file
 987              * Make sure we don't modify JobBytes by saving and restoring it
 988              */
 989             saved_bytes = jcr->JobBytes;
 990             if (find_one_file(jcr, jcr->ff, do_file_digest, jcr->last_fname, (dev_t)-1, 1) != 0) {
 991                Jmsg(jcr, M_ERROR, 0, _("Digest one file failed for file: %s\n"),
 992                     jcr->last_fname);
 993                jcr->JobBytes = saved_bytes;
 994                goto bail_out;
 995             }
 996             jcr->JobBytes = saved_bytes;
 997
 998             /*
 999              * Verify the signature
1000              */
1001             if ((err = crypto_sign_verify(sig, keypair, digest)) != CRYPTO_ERROR_NONE) {
1002                Dmsg1(50, "Bad signature on %s\n", jcr->last_fname);
1003                Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for file %s: ERR=%s\n"),
1004                      jcr->last_fname, crypto_strerror(err));
1005                goto bail_out;
1006             }
1007             jcr->crypto.digest = NULL;
1008          }
1009
1010          /*
1011           * Valid signature
1012           */
1013          Dmsg1(50, "Signature good on %s\n", jcr->last_fname);
1014          crypto_digest_free(digest);
1015          return true;
1016
1017       case CRYPTO_ERROR_NOSIGNER:
1018          /*
1019           * Signature not found, try again
1020           */
1021          if (digest) {
1022             crypto_digest_free(digest);
1023             digest = NULL;
1024          }
1025          continue;
1026       default:
1027          /*
1028           * Something strange happened (that shouldn't happen!)...
1029           */
1030          Qmsg2(jcr, M_ERROR, 0, _("Signature validation failed for %s: %s\n"), jcr->last_fname, crypto_strerror(err));
1031          goto bail_out;
1032       }
1033    }
1034
1035    /*
1036     * No signer
1037     */
1038    Dmsg1(50, "Could not find a valid public key for signature on %s\n", jcr->last_fname);
1039
1040 bail_out:
1041    if (digest) {
1042       crypto_digest_free(digest);
1043    }
1044    return false;
1045 }
1046
1047 bool sparse_data(JCR *jcr, BFILE *bfd, uint64_t *addr, char **data, uint32_t *length)
1048 {
1049       unser_declare;
1050       uint64_t faddr;
1051       char ec1[50];
1052       unser_begin(*data, SPARSE_FADDR_SIZE);
1053       unser_uint64(faddr);
1054       if (*addr != faddr) {
1055          *addr = faddr;
1056          if (blseek(bfd, (boffset_t)*addr, SEEK_SET) < 0) {
1057             berrno be;
1058             Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"),
1059                   edit_uint64(*addr, ec1), jcr->last_fname,
1060                   be.bstrerror(bfd->berrno));
1061             return false;
1062          }
1063       }
1064       *data += SPARSE_FADDR_SIZE;
1065       *length -= SPARSE_FADDR_SIZE;
1066       return true;
1067 }
1068
1069 bool decompress_data(JCR *jcr, char **data, uint32_t *length)
1070 {
1071 #ifdef HAVE_LIBZ
1072    uLong compress_len;
1073    int stat;
1074    char ec1[50]; /* Buffer printing huge values */
1075
1076    /*
1077     * NOTE! We only use uLong and Byte because they are
1078     * needed by the zlib routines, they should not otherwise
1079     * be used in Bacula.
1080     */
1081    compress_len = jcr->compress_buf_size;
1082    Dmsg2(200, "Comp_len=%d msglen=%d\n", compress_len, *length);
1083    while ((stat=uncompress((Byte *)jcr->compress_buf, &compress_len,
1084                            (const Byte *)*data, (uLong)*length)) == Z_BUF_ERROR)
1085    {
1086       /*
1087        * The buffer size is too small, try with a bigger one
1088        */
1089       compress_len = jcr->compress_buf_size = jcr->compress_buf_size + (jcr->compress_buf_size >> 1);
1090       Dmsg2(200, "Comp_len=%d msglen=%d\n", compress_len, *length);
1091       jcr->compress_buf = check_pool_memory_size(jcr->compress_buf,
1092                                                  compress_len);
1093    }
1094    if (stat != Z_OK) {
1095       Qmsg(jcr, M_ERROR, 0, _("Uncompression error on file %s. ERR=%s\n"),
1096            jcr->last_fname, zlib_strerror(stat));
1097       return false;
1098    }
1099    *data = jcr->compress_buf;
1100    *length = compress_len;
1101    Dmsg2(200, "Write uncompressed %d bytes, total before write=%s\n", compress_len, edit_uint64(jcr->JobBytes, ec1));
1102    return true;
1103 #else
1104    Qmsg(jcr, M_ERROR, 0, _("GZIP data stream found, but GZIP not configured!\n"));
1105    return false;
1106 #endif
1107 }
1108
1109 static void unser_crypto_packet_len(RESTORE_CIPHER_CTX *ctx)
1110 {
1111    unser_declare;
1112    if (ctx->packet_len == 0 && ctx->buf_len >= CRYPTO_LEN_SIZE) {
1113       unser_begin(&ctx->buf[0], CRYPTO_LEN_SIZE);
1114       unser_uint32(ctx->packet_len);
1115       ctx->packet_len += CRYPTO_LEN_SIZE;
1116    }
1117 }
1118
1119 bool store_data(JCR *jcr, BFILE *bfd, char *data, const int32_t length, bool win32_decomp)
1120 {
1121    if (jcr->crypto.digest) {
1122       crypto_digest_update(jcr->crypto.digest, (uint8_t *)data, length);
1123    }
1124    if (win32_decomp) {
1125       if (!processWin32BackupAPIBlock(bfd, data, length)) {
1126          berrno be;
1127          Jmsg2(jcr, M_ERROR, 0, _("Write error in Win32 Block Decomposition on %s: %s\n"),
1128                jcr->last_fname, be.bstrerror(bfd->berrno));
1129          return false;
1130       }
1131    } else if (bwrite(bfd, data, length) != (ssize_t)length) {
1132       berrno be;
1133       Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: %s\n"),
1134             jcr->last_fname, be.bstrerror(bfd->berrno));
1135       return false;
1136    }
1137
1138    return true;
1139 }
1140
1141 /*
1142  * In the context of jcr, write data to bfd.
1143  * We write buflen bytes in buf at addr. addr is updated in place.
1144  * The flags specify whether to use sparse files or compression.
1145  * Return value is the number of bytes written, or -1 on errors.
1146  */
1147 int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen,
1148                      uint64_t *addr, int flags, RESTORE_CIPHER_CTX *cipher_ctx)
1149 {
1150    char *wbuf;                 /* write buffer */
1151    uint32_t wsize;             /* write size */
1152    uint32_t rsize;             /* read size */
1153    uint32_t decrypted_len = 0; /* Decryption output length */
1154    char ec1[50];               /* Buffer printing huge values */
1155
1156    rsize = buflen;
1157    jcr->ReadBytes += rsize;
1158    wsize = rsize;
1159    wbuf = buf;
1160
1161    if (flags & FO_ENCRYPT) {
1162       ASSERT(cipher_ctx->cipher);
1163
1164       /*
1165        * NOTE: We must implement block preserving semantics for the
1166        * non-streaming compression and sparse code.
1167        *
1168        * Grow the crypto buffer, if necessary.
1169        * crypto_cipher_update() will process only whole blocks,
1170        * buffering the remaining input.
1171        */
1172       cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf,
1173                         cipher_ctx->buf_len + wsize + cipher_ctx->block_size);
1174
1175       /*
1176        * Decrypt the input block
1177        */
1178       if (!crypto_cipher_update(cipher_ctx->cipher,
1179                                 (const u_int8_t *)wbuf,
1180                                 wsize,
1181                                 (u_int8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1182                                 &decrypted_len)) {
1183          /*
1184           * Decryption failed. Shouldn't happen.
1185           */
1186          Jmsg(jcr, M_FATAL, 0, _("Decryption error\n"));
1187          goto bail_out;
1188       }
1189
1190       if (decrypted_len == 0) {
1191          /*
1192           * No full block of encrypted data available, write more data
1193           */
1194          return 0;
1195       }
1196
1197       Dmsg2(200, "decrypted len=%d encrypted len=%d\n", decrypted_len, wsize);
1198
1199       cipher_ctx->buf_len += decrypted_len;
1200       wbuf = cipher_ctx->buf;
1201
1202       /*
1203        * If one full preserved block is available, write it to disk,
1204        * and then buffer any remaining data. This should be effecient
1205        * as long as Bacula's block size is not significantly smaller than the
1206        * encryption block size (extremely unlikely!)
1207        */
1208       unser_crypto_packet_len(cipher_ctx);
1209       Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1210
1211       if (cipher_ctx->packet_len == 0 || cipher_ctx->buf_len < cipher_ctx->packet_len) {
1212          /*
1213           * No full preserved block is available.
1214           */
1215          return 0;
1216       }
1217
1218       /*
1219        * We have one full block, set up the filter input buffers
1220        */
1221       wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1222       wbuf = &wbuf[CRYPTO_LEN_SIZE]; /* Skip the block length header */
1223       cipher_ctx->buf_len -= cipher_ctx->packet_len;
1224       Dmsg2(130, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1225    }
1226
1227    if (flags & FO_SPARSE) {
1228       if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1229          goto bail_out;
1230       }
1231    }
1232
1233    if (flags & FO_GZIP) {
1234       if (!decompress_data(jcr, &wbuf, &wsize)) {
1235          goto bail_out;
1236       }
1237    }
1238
1239    if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1240       goto bail_out;
1241    }
1242    jcr->JobBytes += wsize;
1243    *addr += wsize;
1244    Dmsg2(130, "Write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1245
1246    /*
1247     * Clean up crypto buffers
1248     */
1249    if (flags & FO_ENCRYPT) {
1250       /* Move any remaining data to start of buffer */
1251       if (cipher_ctx->buf_len > 0) {
1252          Dmsg1(130, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1253          memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1254             cipher_ctx->buf_len);
1255       }
1256       /*
1257        * The packet was successfully written, reset the length so that the next
1258        * packet length may be re-read by unser_crypto_packet_len()
1259        */
1260       cipher_ctx->packet_len = 0;
1261    }
1262    return wsize;
1263
1264 bail_out:
1265    return -1;
1266 }
1267
1268
1269 /*
1270  * If extracting, close any previous stream
1271  */
1272 static void close_previous_stream(r_ctx &rctx)
1273 {
1274    /*
1275     * If extracting, it was from previous stream, so
1276     * close the output file and validate the signature.
1277     */
1278    if (rctx.extract) {
1279       if (rctx.size > 0 && !is_bopen(&rctx.bfd)) {
1280          Jmsg0(rctx.jcr, M_ERROR, 0, _("Logic error: output file should be open\n"));
1281          Dmsg2(000, "=== logic error size=%d bopen=%d\n", rctx.size,
1282             is_bopen(&rctx.bfd));
1283       }
1284
1285       if (rctx.prev_stream != STREAM_ENCRYPTED_SESSION_DATA) {
1286          deallocate_cipher(rctx);
1287          deallocate_fork_cipher(rctx);
1288       }
1289
1290       if (rctx.jcr->plugin) {
1291          plugin_set_attributes(rctx.jcr, rctx.attr, &rctx.bfd);
1292       } else {
1293          set_attributes(rctx.jcr, rctx.attr, &rctx.bfd);
1294       }
1295       rctx.extract = false;
1296
1297       /*
1298        * Verify the cryptographic signature, if any
1299        */
1300       rctx.type = rctx.attr->type;
1301       verify_signature(rctx.jcr, rctx);
1302
1303       /*
1304        * Free Signature
1305        */
1306       free_signature(rctx);
1307       free_session(rctx);
1308       rctx.jcr->ff->flags = 0;
1309       Dmsg0(130, "Stop extracting.\n");
1310    } else if (is_bopen(&rctx.bfd)) {
1311       Jmsg0(rctx.jcr, M_ERROR, 0, _("Logic error: output file should not be open\n"));
1312       Dmsg0(000, "=== logic error !open\n");
1313       bclose(&rctx.bfd);
1314    }
1315 }
1316
1317
1318 /*
1319  * In the context of jcr, flush any remaining data from the cipher context,
1320  * writing it to bfd.
1321  * Return value is true on success, false on failure.
1322  */
1323 bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags,
1324                   RESTORE_CIPHER_CTX *cipher_ctx)
1325 {
1326    uint32_t decrypted_len = 0;
1327    char *wbuf;                        /* write buffer */
1328    uint32_t wsize;                    /* write size */
1329    char ec1[50];                      /* Buffer printing huge values */
1330    bool second_pass = false;
1331
1332 again:
1333    /*
1334     * Write out the remaining block and free the cipher context
1335     */
1336    cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf, cipher_ctx->buf_len +
1337                                             cipher_ctx->block_size);
1338
1339    if (!crypto_cipher_finalize(cipher_ctx->cipher, (uint8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1340         &decrypted_len)) {
1341       /*
1342        * Writing out the final, buffered block failed. Shouldn't happen.
1343        */
1344       Jmsg3(jcr, M_ERROR, 0, _("Decryption error. buf_len=%d decrypt_len=%d on file %s\n"),
1345             cipher_ctx->buf_len, decrypted_len, jcr->last_fname);
1346    }
1347
1348    Dmsg2(130, "Flush decrypt len=%d buf_len=%d\n", decrypted_len, cipher_ctx->buf_len);
1349    /*
1350     * If nothing new was decrypted, and our output buffer is empty, return
1351     */
1352    if (decrypted_len == 0 && cipher_ctx->buf_len == 0) {
1353       return true;
1354    }
1355
1356    cipher_ctx->buf_len += decrypted_len;
1357
1358    unser_crypto_packet_len(cipher_ctx);
1359    Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1360    wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1361    /*
1362     * Decrypted, possibly decompressed output here.
1363     */
1364    wbuf = &cipher_ctx->buf[CRYPTO_LEN_SIZE];
1365    cipher_ctx->buf_len -= cipher_ctx->packet_len;
1366    Dmsg2(130, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1367
1368    if (flags & FO_SPARSE) {
1369       if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1370          return false;
1371       }
1372    }
1373
1374    if (flags & FO_GZIP) {
1375       if (!decompress_data(jcr, &wbuf, &wsize)) {
1376          return false;
1377       }
1378    }
1379
1380    Dmsg0(130, "Call store_data\n");
1381    if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1382       return false;
1383    }
1384    jcr->JobBytes += wsize;
1385    Dmsg2(130, "Flush write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1386
1387    /*
1388     * Move any remaining data to start of buffer
1389     */
1390    if (cipher_ctx->buf_len > 0) {
1391       Dmsg1(130, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1392       memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1393          cipher_ctx->buf_len);
1394    }
1395    /*
1396     * The packet was successfully written, reset the length so that the next
1397     * packet length may be re-read by unser_crypto_packet_len()
1398     */
1399    cipher_ctx->packet_len = 0;
1400
1401    if (cipher_ctx->buf_len >0 && !second_pass) {
1402       second_pass = true;
1403       goto again;
1404    }
1405
1406    /*
1407     * Stop decryption
1408     */
1409    cipher_ctx->buf_len = 0;
1410    cipher_ctx->packet_len = 0;
1411
1412    return true;
1413 }
1414
1415 static void deallocate_cipher(r_ctx &rctx)
1416 {
1417    /*
1418     * Flush and deallocate previous stream's cipher context
1419     */
1420    if (rctx.cipher_ctx.cipher) {
1421       flush_cipher(rctx.jcr, &rctx.bfd, &rctx.fileAddr, rctx.flags, &rctx.cipher_ctx);
1422       crypto_cipher_free(rctx.cipher_ctx.cipher);
1423       rctx.cipher_ctx.cipher = NULL;
1424    }
1425 }
1426
1427 static void deallocate_fork_cipher(r_ctx &rctx)
1428 {
1429
1430    /*
1431     * Flush and deallocate previous stream's fork cipher context
1432     */
1433    if (rctx.fork_cipher_ctx.cipher) {
1434       flush_cipher(rctx.jcr, &rctx.forkbfd, &rctx.fork_addr, rctx.fork_flags, &rctx.fork_cipher_ctx);
1435       crypto_cipher_free(rctx.fork_cipher_ctx.cipher);
1436       rctx.fork_cipher_ctx.cipher = NULL;
1437    }
1438 }
1439
1440 static void free_signature(r_ctx &rctx)
1441 {
1442    if (rctx.sig) {
1443       crypto_sign_free(rctx.sig);
1444       rctx.sig = NULL;
1445    }
1446 }
1447
1448 static void free_session(r_ctx &rctx)
1449 {
1450    if (rctx.cs) {
1451       crypto_session_free(rctx.cs);
1452       rctx.cs = NULL;
1453    }
1454 }
1455
1456
1457 /*
1458  * This code if implemented goes above
1459  */
1460 #ifdef stbernard_implemented
1461 /  #if defined(HAVE_WIN32)
1462    bool        bResumeOfmOnExit = FALSE;
1463    if (isOpenFileManagerRunning()) {
1464        if ( pauseOpenFileManager() ) {
1465           Jmsg(jcr, M_INFO, 0, _("Open File Manager paused\n") );
1466           bResumeOfmOnExit = TRUE;
1467        }
1468        else {
1469           Jmsg(jcr, M_ERROR, 0, _("FAILED to pause Open File Manager\n") );
1470        }
1471    }
1472    {
1473        char username[UNLEN+1];
1474        DWORD usize = sizeof(username);
1475        int privs = enable_backup_privileges(NULL, 1);
1476        if (GetUserName(username, &usize)) {
1477           Jmsg2(jcr, M_INFO, 0, _("Running as '%s'. Privmask=%#08x\n"), username,
1478        } else {
1479           Jmsg(jcr, M_WARNING, 0, _("Failed to retrieve current UserName\n"));
1480        }
1481    }
1482 #endif