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