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(150, "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       case STREAM_ACL_AFS_TEXT:
 655          /*
 656           * Do not restore ACLs when
 657           * a) The current file is not extracted
 658           * b)     and it is not a directory (they are never "extracted")
 659           * c) or the file name is empty
 660           */
 661          if ((!rctx.extract && jcr->last_type != FT_DIREND) || (*jcr->last_fname == 0)) {
 662             break;
 663          }
 664          if (have_acl) {
 665             pm_memcpy(jcr->acl_data->content, sd->msg, sd->msglen);
 666             jcr->acl_data->content_length = sd->msglen;
 667             switch (parse_acl_streams(jcr, rctx.stream)) {
 668             case bacl_exit_fatal:
 669                goto bail_out;
 670             case bacl_exit_error:
 671                /*
 672                 * Non-fatal errors, count them and when the number is under ACL_REPORT_ERR_MAX_PER_JOB
 673                 * print the error message set by the lower level routine in jcr->errmsg.
 674                 */
 675                if (jcr->acl_data->nr_errors < ACL_REPORT_ERR_MAX_PER_JOB) {
 676                   Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 677                }
 678                jcr->acl_data->nr_errors++;
 679                break;
 680             case bacl_exit_ok:
 681                break;
 682             }
 683          } else {
 684             non_support_acl++;
 685          }
 686          break;
 687
 688       case STREAM_XATTR_OPENBSD:
 689       case STREAM_XATTR_SOLARIS_SYS:
 690       case STREAM_XATTR_SOLARIS:
 691       case STREAM_XATTR_DARWIN:
 692       case STREAM_XATTR_FREEBSD:
 693       case STREAM_XATTR_LINUX:
 694       case STREAM_XATTR_NETBSD:
 695          /*
 696           * Do not restore Extended Attributes when
 697           * a) The current file is not extracted
 698           * b)     and it is not a directory (they are never "extracted")
 699           * c) or the file name is empty
 700           */
 701          if ((!rctx.extract && jcr->last_type != FT_DIREND) || (*jcr->last_fname == 0)) {
 702             break;
 703          }
 704          if (have_xattr) {
 705             pm_memcpy(jcr->xattr_data->content, sd->msg, sd->msglen);
 706             jcr->xattr_data->content_length = sd->msglen;
 707             switch (parse_xattr_streams(jcr, rctx.stream)) {
 708             case bxattr_exit_fatal:
 709                goto bail_out;
 710             case bxattr_exit_error:
 711                /*
 712                 * Non-fatal errors, count them and when the number is under XATTR_REPORT_ERR_MAX_PER_JOB
 713                 * print the error message set by the lower level routine in jcr->errmsg.
 714                 */
 715                if (jcr->xattr_data->nr_errors < XATTR_REPORT_ERR_MAX_PER_JOB) {
 716                   Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 717                }
 718                jcr->xattr_data->nr_errors++;
 719                break;
 720             case bxattr_exit_ok:
 721                break;
 722             }
 723          } else {
 724             non_support_xattr++;
 725          }
 726          break;
 727
 728       case STREAM_SIGNED_DIGEST:
 729          /*
 730           * Is this an unexpected signature?
 731           */
 732          if (rctx.sig) {
 733             Jmsg0(jcr, M_ERROR, 0, _("Unexpected cryptographic signature data stream.\n"));
 734             free_signature(rctx);
 735             continue;
 736          }
 737          /*
 738           * Save signature.
 739           */
 740          if (rctx.extract && (rctx.sig = crypto_sign_decode(jcr, (uint8_t *)sd->msg, (uint32_t)sd->msglen)) == NULL) {
 741             Jmsg1(jcr, M_ERROR, 0, _("Failed to decode message signature for %s\n"), jcr->last_fname);
 742          }
 743          break;
 744
 745       case STREAM_MD5_DIGEST:
 746       case STREAM_SHA1_DIGEST:
 747       case STREAM_SHA256_DIGEST:
 748       case STREAM_SHA512_DIGEST:
 749          break;
 750
 751       case STREAM_PROGRAM_NAMES:
 752       case STREAM_PROGRAM_DATA:
 753          if (!non_support_progname) {
 754             Pmsg0(000, "Got Program Name or Data Stream. Ignored.\n");
 755             non_support_progname++;
 756          }
 757          break;
 758
 759       case STREAM_PLUGIN_NAME:
 760          close_previous_stream(rctx);
 761          Dmsg1(50, "restore stream_plugin_name=%s\n", sd->msg);
 762          plugin_name_stream(jcr, sd->msg);
 763          break;
 764
 765       case STREAM_RESTORE_OBJECT:
 766          break;                    /* these are sent by Director */
 767
 768       default:
 769          close_previous_stream(rctx);
 770          Jmsg(jcr, M_ERROR, 0, _("Unknown stream=%d ignored. This shouldn't happen!\n"),
 771               rctx.stream);
 772          Dmsg2(0, "Unknown stream=%d data=%s\n", rctx.stream, sd->msg);
 773          break;
 774       } /* end switch(stream) */
 775    } /* end while get_msg() */
 776
 777    /*
 778     * If output file is still open, it was the last one in the
 779     * archive since we just hit an end of file, so close the file.
 780     */
 781    if (is_bopen(&rctx.forkbfd)) {
 782       bclose_chksize(jcr, &rctx.forkbfd, rctx.fork_size);
 783    }
 784
 785    close_previous_stream(rctx);
 786    set_jcr_job_status(jcr, JS_Terminated);
 787    goto ok_out;
 788
 789 bail_out:
 790    set_jcr_job_status(jcr, JS_ErrorTerminated);
 791
 792 ok_out:
 793    /*
 794     * First output the statistics.
 795     */
 796    Dmsg2(10, "End Do Restore. Files=%d Bytes=%s\n", jcr->JobFiles,
 797       edit_uint64(jcr->JobBytes, ec1));
 798    if (have_acl && jcr->acl_data->nr_errors > 0) {
 799       Jmsg(jcr, M_ERROR, 0, _("Encountered %ld acl errors while doing restore\n"),
 800            jcr->acl_data->nr_errors);
 801    }
 802    if (have_xattr && jcr->xattr_data->nr_errors > 0) {
 803       Jmsg(jcr, M_ERROR, 0, _("Encountered %ld xattr errors while doing restore\n"),
 804            jcr->xattr_data->nr_errors);
 805    }
 806    if (non_support_data > 1 || non_support_attr > 1) {
 807       Jmsg(jcr, M_ERROR, 0, _("%d non-supported data streams and %d non-supported attrib streams ignored.\n"),
 808          non_support_data, non_support_attr);
 809    }
 810    if (non_support_rsrc) {
 811       Jmsg(jcr, M_INFO, 0, _("%d non-supported resource fork streams ignored.\n"), non_support_rsrc);
 812    }
 813    if (non_support_finfo) {
 814       Jmsg(jcr, M_INFO, 0, _("%d non-supported Finder Info streams ignored.\n"), non_support_rsrc);
 815    }
 816    if (non_support_acl) {
 817       Jmsg(jcr, M_INFO, 0, _("%d non-supported acl streams ignored.\n"), non_support_acl);
 818    }
 819    if (non_support_crypto) {
 820       Jmsg(jcr, M_INFO, 0, _("%d non-supported crypto streams ignored.\n"), non_support_acl);
 821    }
 822    if (non_support_xattr) {
 823       Jmsg(jcr, M_INFO, 0, _("%d non-supported xattr streams ignored.\n"), non_support_xattr);
 824    }
 825
 826    /*
 827     * Free Signature & Crypto Data
 828     */
 829    free_signature(rctx);
 830    free_session(rctx);
 831    if (jcr->crypto.digest) {
 832       crypto_digest_free(jcr->crypto.digest);
 833       jcr->crypto.digest = NULL;
 834    }
 835
 836    /*
 837     * Free file cipher restore context
 838     */
 839    if (rctx.cipher_ctx.cipher) {
 840       crypto_cipher_free(rctx.cipher_ctx.cipher);
 841       rctx.cipher_ctx.cipher = NULL;
 842    }
 843
 844    if (rctx.cipher_ctx.buf) {
 845       free_pool_memory(rctx.cipher_ctx.buf);
 846       rctx.cipher_ctx.buf = NULL;
 847    }
 848
 849    /*
 850     * Free alternate stream cipher restore context
 851     */
 852    if (rctx.fork_cipher_ctx.cipher) {
 853       crypto_cipher_free(rctx.fork_cipher_ctx.cipher);
 854       rctx.fork_cipher_ctx.cipher = NULL;
 855    }
 856    if (rctx.fork_cipher_ctx.buf) {
 857       free_pool_memory(rctx.fork_cipher_ctx.buf);
 858       rctx.fork_cipher_ctx.buf = NULL;
 859    }
 860
 861    if (jcr->compress_buf) {
 862       free_pool_memory(jcr->compress_buf);
 863       jcr->compress_buf = NULL;
 864       jcr->compress_buf_size = 0;
 865    }
 866
 867    if (have_acl && jcr->acl_data) {
 868       free_pool_memory(jcr->acl_data->content);
 869       free(jcr->acl_data);
 870       jcr->acl_data = NULL;
 871    }
 872
 873    if (have_xattr && jcr->xattr_data) {
 874       free_pool_memory(jcr->xattr_data->content);
 875       free(jcr->xattr_data);
 876       jcr->xattr_data = NULL;
 877    }
 878
 879    bclose(&rctx.forkbfd);
 880    bclose(&rctx.bfd);
 881    free_attr(rctx.attr);
 882 }
 883
 884 #ifdef HAVE_LIBZ
 885 /*
 886  * Convert ZLIB error code into an ASCII message
 887  */
 888 static const char *zlib_strerror(int stat)
 889 {
 890    if (stat >= 0) {
 891       return _("None");
 892    }
 893    switch (stat) {
 894    case Z_ERRNO:
 895       return _("Zlib errno");
 896    case Z_STREAM_ERROR:
 897       return _("Zlib stream error");
 898    case Z_DATA_ERROR:
 899       return _("Zlib data error");
 900    case Z_MEM_ERROR:
 901       return _("Zlib memory error");
 902    case Z_BUF_ERROR:
 903       return _("Zlib buffer error");
 904    case Z_VERSION_ERROR:
 905       return _("Zlib version error");
 906    default:
 907       return _("*none*");
 908    }
 909 }
 910 #endif
 911
 912 static int do_file_digest(JCR *jcr, FF_PKT *ff_pkt, bool top_level)
 913 {
 914    Dmsg1(50, "do_file_digest jcr=%p\n", jcr);
 915    return (digest_file(jcr, ff_pkt, jcr->crypto.digest));
 916 }
 917
 918 /*
 919  * Verify the signature for the last restored file
 920  * Return value is either true (signature correct)
 921  * or false (signature could not be verified).
 922  * TODO landonf: Implement without using find_one_file and
 923  * without re-reading the file.
 924  */
 925 static bool verify_signature(JCR *jcr, r_ctx &rctx)
 926 {
 927    X509_KEYPAIR *keypair;
 928    DIGEST *digest = NULL;
 929    crypto_error_t err;
 930    uint64_t saved_bytes;
 931    crypto_digest_t signing_algorithm = have_sha2 ?
 932                                        CRYPTO_DIGEST_SHA256 : CRYPTO_DIGEST_SHA1;
 933    crypto_digest_t algorithm;
 934    SIGNATURE *sig = rctx.sig;
 935
 936
 937    if (!jcr->crypto.pki_sign) {
 938       /*
 939        * no signature OK
 940        */
 941       return true;
 942    }
 943    if (!sig) {
 944       if (rctx.type == FT_REGE || rctx.type == FT_REG || rctx.type == FT_RAW) {
 945          Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"),
 946                jcr->last_fname);
 947          goto bail_out;
 948       }
 949       return true;
 950    }
 951
 952    /*
 953     * Iterate through the trusted signers
 954     */
 955    foreach_alist(keypair, jcr->crypto.pki_signers) {
 956       err = crypto_sign_get_digest(sig, jcr->crypto.pki_keypair, algorithm, &digest);
 957       switch (err) {
 958       case CRYPTO_ERROR_NONE:
 959          Dmsg0(50, "== Got digest\n");
 960          /*
 961           * We computed jcr->crypto.digest using signing_algorithm while writing
 962           * the file. If it is not the same as the algorithm used for
 963           * this file, punt by releasing the computed algorithm and
 964           * computing by re-reading the file.
 965           */
 966          if (algorithm != signing_algorithm) {
 967             if (jcr->crypto.digest) {
 968                crypto_digest_free(jcr->crypto.digest);
 969                jcr->crypto.digest = NULL;
 970             }
 971          }
 972          if (jcr->crypto.digest) {
 973              /*
 974               * Use digest computed while writing the file to verify the signature
 975               */
 976             if ((err = crypto_sign_verify(sig, keypair, jcr->crypto.digest)) != CRYPTO_ERROR_NONE) {
 977                Dmsg1(50, "Bad signature on %s\n", jcr->last_fname);
 978                Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for file %s: ERR=%s\n"),
 979                      jcr->last_fname, crypto_strerror(err));
 980                goto bail_out;
 981             }
 982          } else {
 983             /*
 984              * Signature found, digest allocated.  Old method,
 985              * re-read the file and compute the digest
 986              */
 987             jcr->crypto.digest = digest;
 988
 989             /*
 990              * Checksum the entire file
 991              * Make sure we don't modify JobBytes by saving and restoring it
 992              */
 993             saved_bytes = jcr->JobBytes;
 994             if (find_one_file(jcr, jcr->ff, do_file_digest, jcr->last_fname, (dev_t)-1, 1) != 0) {
 995                Jmsg(jcr, M_ERROR, 0, _("Digest one file failed for file: %s\n"),
 996                     jcr->last_fname);
 997                jcr->JobBytes = saved_bytes;
 998                goto bail_out;
 999             }
1000             jcr->JobBytes = saved_bytes;
1001
1002             /*
1003              * Verify the signature
1004              */
1005             if ((err = crypto_sign_verify(sig, keypair, digest)) != CRYPTO_ERROR_NONE) {
1006                Dmsg1(50, "Bad signature on %s\n", jcr->last_fname);
1007                Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for file %s: ERR=%s\n"),
1008                      jcr->last_fname, crypto_strerror(err));
1009                goto bail_out;
1010             }
1011             jcr->crypto.digest = NULL;
1012          }
1013
1014          /*
1015           * Valid signature
1016           */
1017          Dmsg1(50, "Signature good on %s\n", jcr->last_fname);
1018          crypto_digest_free(digest);
1019          return true;
1020
1021       case CRYPTO_ERROR_NOSIGNER:
1022          /*
1023           * Signature not found, try again
1024           */
1025          if (digest) {
1026             crypto_digest_free(digest);
1027             digest = NULL;
1028          }
1029          continue;
1030       default:
1031          /*
1032           * Something strange happened (that shouldn't happen!)...
1033           */
1034          Qmsg2(jcr, M_ERROR, 0, _("Signature validation failed for %s: %s\n"), jcr->last_fname, crypto_strerror(err));
1035          goto bail_out;
1036       }
1037    }
1038
1039    /*
1040     * No signer
1041     */
1042    Dmsg1(50, "Could not find a valid public key for signature on %s\n", jcr->last_fname);
1043
1044 bail_out:
1045    if (digest) {
1046       crypto_digest_free(digest);
1047    }
1048    return false;
1049 }
1050
1051 bool sparse_data(JCR *jcr, BFILE *bfd, uint64_t *addr, char **data, uint32_t *length)
1052 {
1053       unser_declare;
1054       uint64_t faddr;
1055       char ec1[50];
1056       unser_begin(*data, SPARSE_FADDR_SIZE);
1057       unser_uint64(faddr);
1058       if (*addr != faddr) {
1059          *addr = faddr;
1060          if (blseek(bfd, (boffset_t)*addr, SEEK_SET) < 0) {
1061             berrno be;
1062             Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"),
1063                   edit_uint64(*addr, ec1), jcr->last_fname,
1064                   be.bstrerror(bfd->berrno));
1065             return false;
1066          }
1067       }
1068       *data += SPARSE_FADDR_SIZE;
1069       *length -= SPARSE_FADDR_SIZE;
1070       return true;
1071 }
1072
1073 bool decompress_data(JCR *jcr, char **data, uint32_t *length)
1074 {
1075 #ifdef HAVE_LIBZ
1076    uLong compress_len;
1077    int stat;
1078    char ec1[50]; /* Buffer printing huge values */
1079
1080    /*
1081     * NOTE! We only use uLong and Byte because they are
1082     * needed by the zlib routines, they should not otherwise
1083     * be used in Bacula.
1084     */
1085    compress_len = jcr->compress_buf_size;
1086    Dmsg2(200, "Comp_len=%d msglen=%d\n", compress_len, *length);
1087    while ((stat=uncompress((Byte *)jcr->compress_buf, &compress_len,
1088                            (const Byte *)*data, (uLong)*length)) == Z_BUF_ERROR)
1089    {
1090       /*
1091        * The buffer size is too small, try with a bigger one
1092        */
1093       compress_len = jcr->compress_buf_size = jcr->compress_buf_size + (jcr->compress_buf_size >> 1);
1094       Dmsg2(200, "Comp_len=%d msglen=%d\n", compress_len, *length);
1095       jcr->compress_buf = check_pool_memory_size(jcr->compress_buf,
1096                                                  compress_len);
1097    }
1098    if (stat != Z_OK) {
1099       Qmsg(jcr, M_ERROR, 0, _("Uncompression error on file %s. ERR=%s\n"),
1100            jcr->last_fname, zlib_strerror(stat));
1101       return false;
1102    }
1103    *data = jcr->compress_buf;
1104    *length = compress_len;
1105    Dmsg2(200, "Write uncompressed %d bytes, total before write=%s\n", compress_len, edit_uint64(jcr->JobBytes, ec1));
1106    return true;
1107 #else
1108    Qmsg(jcr, M_ERROR, 0, _("GZIP data stream found, but GZIP not configured!\n"));
1109    return false;
1110 #endif
1111 }
1112
1113 static void unser_crypto_packet_len(RESTORE_CIPHER_CTX *ctx)
1114 {
1115    unser_declare;
1116    if (ctx->packet_len == 0 && ctx->buf_len >= CRYPTO_LEN_SIZE) {
1117       unser_begin(&ctx->buf[0], CRYPTO_LEN_SIZE);
1118       unser_uint32(ctx->packet_len);
1119       ctx->packet_len += CRYPTO_LEN_SIZE;
1120    }
1121 }
1122
1123 bool store_data(JCR *jcr, BFILE *bfd, char *data, const int32_t length, bool win32_decomp)
1124 {
1125    if (jcr->crypto.digest) {
1126       crypto_digest_update(jcr->crypto.digest, (uint8_t *)data, length);
1127    }
1128    if (win32_decomp) {
1129       if (!processWin32BackupAPIBlock(bfd, data, length)) {
1130          berrno be;
1131          Jmsg2(jcr, M_ERROR, 0, _("Write error in Win32 Block Decomposition on %s: %s\n"),
1132                jcr->last_fname, be.bstrerror(bfd->berrno));
1133          return false;
1134       }
1135    } else if (bwrite(bfd, data, length) != (ssize_t)length) {
1136       berrno be;
1137       Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: %s\n"),
1138             jcr->last_fname, be.bstrerror(bfd->berrno));
1139       return false;
1140    }
1141
1142    return true;
1143 }
1144
1145 /*
1146  * In the context of jcr, write data to bfd.
1147  * We write buflen bytes in buf at addr. addr is updated in place.
1148  * The flags specify whether to use sparse files or compression.
1149  * Return value is the number of bytes written, or -1 on errors.
1150  */
1151 int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen,
1152                      uint64_t *addr, int flags, RESTORE_CIPHER_CTX *cipher_ctx)
1153 {
1154    char *wbuf;                 /* write buffer */
1155    uint32_t wsize;             /* write size */
1156    uint32_t rsize;             /* read size */
1157    uint32_t decrypted_len = 0; /* Decryption output length */
1158    char ec1[50];               /* Buffer printing huge values */
1159
1160    rsize = buflen;
1161    jcr->ReadBytes += rsize;
1162    wsize = rsize;
1163    wbuf = buf;
1164
1165    if (flags & FO_ENCRYPT) {
1166       ASSERT(cipher_ctx->cipher);
1167
1168       /*
1169        * NOTE: We must implement block preserving semantics for the
1170        * non-streaming compression and sparse code.
1171        *
1172        * Grow the crypto buffer, if necessary.
1173        * crypto_cipher_update() will process only whole blocks,
1174        * buffering the remaining input.
1175        */
1176       cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf,
1177                         cipher_ctx->buf_len + wsize + cipher_ctx->block_size);
1178
1179       /*
1180        * Decrypt the input block
1181        */
1182       if (!crypto_cipher_update(cipher_ctx->cipher,
1183                                 (const u_int8_t *)wbuf,
1184                                 wsize,
1185                                 (u_int8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1186                                 &decrypted_len)) {
1187          /*
1188           * Decryption failed. Shouldn't happen.
1189           */
1190          Jmsg(jcr, M_FATAL, 0, _("Decryption error\n"));
1191          goto bail_out;
1192       }
1193
1194       if (decrypted_len == 0) {
1195          /*
1196           * No full block of encrypted data available, write more data
1197           */
1198          return 0;
1199       }
1200
1201       Dmsg2(200, "decrypted len=%d encrypted len=%d\n", decrypted_len, wsize);
1202
1203       cipher_ctx->buf_len += decrypted_len;
1204       wbuf = cipher_ctx->buf;
1205
1206       /*
1207        * If one full preserved block is available, write it to disk,
1208        * and then buffer any remaining data. This should be effecient
1209        * as long as Bacula's block size is not significantly smaller than the
1210        * encryption block size (extremely unlikely!)
1211        */
1212       unser_crypto_packet_len(cipher_ctx);
1213       Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1214
1215       if (cipher_ctx->packet_len == 0 || cipher_ctx->buf_len < cipher_ctx->packet_len) {
1216          /*
1217           * No full preserved block is available.
1218           */
1219          return 0;
1220       }
1221
1222       /*
1223        * We have one full block, set up the filter input buffers
1224        */
1225       wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1226       wbuf = &wbuf[CRYPTO_LEN_SIZE]; /* Skip the block length header */
1227       cipher_ctx->buf_len -= cipher_ctx->packet_len;
1228       Dmsg2(130, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1229    }
1230
1231    if (flags & FO_SPARSE) {
1232       if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1233          goto bail_out;
1234       }
1235    }
1236
1237    if (flags & FO_GZIP) {
1238       if (!decompress_data(jcr, &wbuf, &wsize)) {
1239          goto bail_out;
1240       }
1241    }
1242
1243    if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1244       goto bail_out;
1245    }
1246    jcr->JobBytes += wsize;
1247    *addr += wsize;
1248    Dmsg2(130, "Write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1249
1250    /*
1251     * Clean up crypto buffers
1252     */
1253    if (flags & FO_ENCRYPT) {
1254       /* Move any remaining data to start of buffer */
1255       if (cipher_ctx->buf_len > 0) {
1256          Dmsg1(130, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1257          memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1258             cipher_ctx->buf_len);
1259       }
1260       /*
1261        * The packet was successfully written, reset the length so that the next
1262        * packet length may be re-read by unser_crypto_packet_len()
1263        */
1264       cipher_ctx->packet_len = 0;
1265    }
1266    return wsize;
1267
1268 bail_out:
1269    return -1;
1270 }
1271
1272
1273 /*
1274  * If extracting, close any previous stream
1275  */
1276 static void close_previous_stream(r_ctx &rctx)
1277 {
1278    /*
1279     * If extracting, it was from previous stream, so
1280     * close the output file and validate the signature.
1281     */
1282    if (rctx.extract) {
1283       if (rctx.size > 0 && !is_bopen(&rctx.bfd)) {
1284          Jmsg0(rctx.jcr, M_ERROR, 0, _("Logic error: output file should be open\n"));
1285          Dmsg2(000, "=== logic error size=%d bopen=%d\n", rctx.size,
1286             is_bopen(&rctx.bfd));
1287       }
1288
1289       if (rctx.prev_stream != STREAM_ENCRYPTED_SESSION_DATA) {
1290          deallocate_cipher(rctx);
1291          deallocate_fork_cipher(rctx);
1292       }
1293
1294       if (rctx.jcr->plugin) {
1295          plugin_set_attributes(rctx.jcr, rctx.attr, &rctx.bfd);
1296       } else {
1297          set_attributes(rctx.jcr, rctx.attr, &rctx.bfd);
1298       }
1299       rctx.extract = false;
1300
1301       /*
1302        * Verify the cryptographic signature, if any
1303        */
1304       rctx.type = rctx.attr->type;
1305       verify_signature(rctx.jcr, rctx);
1306
1307       /*
1308        * Free Signature
1309        */
1310       free_signature(rctx);
1311       free_session(rctx);
1312       rctx.jcr->ff->flags = 0;
1313       Dmsg0(130, "Stop extracting.\n");
1314    } else if (is_bopen(&rctx.bfd)) {
1315       Jmsg0(rctx.jcr, M_ERROR, 0, _("Logic error: output file should not be open\n"));
1316       Dmsg0(000, "=== logic error !open\n");
1317       bclose(&rctx.bfd);
1318    }
1319 }
1320
1321
1322 /*
1323  * In the context of jcr, flush any remaining data from the cipher context,
1324  * writing it to bfd.
1325  * Return value is true on success, false on failure.
1326  */
1327 bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags,
1328                   RESTORE_CIPHER_CTX *cipher_ctx)
1329 {
1330    uint32_t decrypted_len = 0;
1331    char *wbuf;                        /* write buffer */
1332    uint32_t wsize;                    /* write size */
1333    char ec1[50];                      /* Buffer printing huge values */
1334    bool second_pass = false;
1335
1336 again:
1337    /*
1338     * Write out the remaining block and free the cipher context
1339     */
1340    cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf, cipher_ctx->buf_len +
1341                                             cipher_ctx->block_size);
1342
1343    if (!crypto_cipher_finalize(cipher_ctx->cipher, (uint8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1344         &decrypted_len)) {
1345       /*
1346        * Writing out the final, buffered block failed. Shouldn't happen.
1347        */
1348       Jmsg3(jcr, M_ERROR, 0, _("Decryption error. buf_len=%d decrypt_len=%d on file %s\n"),
1349             cipher_ctx->buf_len, decrypted_len, jcr->last_fname);
1350    }
1351
1352    Dmsg2(130, "Flush decrypt len=%d buf_len=%d\n", decrypted_len, cipher_ctx->buf_len);
1353    /*
1354     * If nothing new was decrypted, and our output buffer is empty, return
1355     */
1356    if (decrypted_len == 0 && cipher_ctx->buf_len == 0) {
1357       return true;
1358    }
1359
1360    cipher_ctx->buf_len += decrypted_len;
1361
1362    unser_crypto_packet_len(cipher_ctx);
1363    Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1364    wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1365    /*
1366     * Decrypted, possibly decompressed output here.
1367     */
1368    wbuf = &cipher_ctx->buf[CRYPTO_LEN_SIZE];
1369    cipher_ctx->buf_len -= cipher_ctx->packet_len;
1370    Dmsg2(130, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1371
1372    if (flags & FO_SPARSE) {
1373       if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1374          return false;
1375       }
1376    }
1377
1378    if (flags & FO_GZIP) {
1379       if (!decompress_data(jcr, &wbuf, &wsize)) {
1380          return false;
1381       }
1382    }
1383
1384    Dmsg0(130, "Call store_data\n");
1385    if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1386       return false;
1387    }
1388    jcr->JobBytes += wsize;
1389    Dmsg2(130, "Flush write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1390
1391    /*
1392     * Move any remaining data to start of buffer
1393     */
1394    if (cipher_ctx->buf_len > 0) {
1395       Dmsg1(130, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1396       memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1397          cipher_ctx->buf_len);
1398    }
1399    /*
1400     * The packet was successfully written, reset the length so that the next
1401     * packet length may be re-read by unser_crypto_packet_len()
1402     */
1403    cipher_ctx->packet_len = 0;
1404
1405    if (cipher_ctx->buf_len >0 && !second_pass) {
1406       second_pass = true;
1407       goto again;
1408    }
1409
1410    /*
1411     * Stop decryption
1412     */
1413    cipher_ctx->buf_len = 0;
1414    cipher_ctx->packet_len = 0;
1415
1416    return true;
1417 }
1418
1419 static void deallocate_cipher(r_ctx &rctx)
1420 {
1421    /*
1422     * Flush and deallocate previous stream's cipher context
1423     */
1424    if (rctx.cipher_ctx.cipher) {
1425       flush_cipher(rctx.jcr, &rctx.bfd, &rctx.fileAddr, rctx.flags, &rctx.cipher_ctx);
1426       crypto_cipher_free(rctx.cipher_ctx.cipher);
1427       rctx.cipher_ctx.cipher = NULL;
1428    }
1429 }
1430
1431 static void deallocate_fork_cipher(r_ctx &rctx)
1432 {
1433
1434    /*
1435     * Flush and deallocate previous stream's fork cipher context
1436     */
1437    if (rctx.fork_cipher_ctx.cipher) {
1438       flush_cipher(rctx.jcr, &rctx.forkbfd, &rctx.fork_addr, rctx.fork_flags, &rctx.fork_cipher_ctx);
1439       crypto_cipher_free(rctx.fork_cipher_ctx.cipher);
1440       rctx.fork_cipher_ctx.cipher = NULL;
1441    }
1442 }
1443
1444 static void free_signature(r_ctx &rctx)
1445 {
1446    if (rctx.sig) {
1447       crypto_sign_free(rctx.sig);
1448       rctx.sig = NULL;
1449    }
1450 }
1451
1452 static void free_session(r_ctx &rctx)
1453 {
1454    if (rctx.cs) {
1455       crypto_session_free(rctx.cs);
1456       rctx.cs = NULL;
1457    }
1458 }
1459
1460
1461 /*
1462  * This code if implemented goes above
1463  */
1464 #ifdef stbernard_implemented
1465 /  #if defined(HAVE_WIN32)
1466    bool        bResumeOfmOnExit = FALSE;
1467    if (isOpenFileManagerRunning()) {
1468        if ( pauseOpenFileManager() ) {
1469           Jmsg(jcr, M_INFO, 0, _("Open File Manager paused\n") );
1470           bResumeOfmOnExit = TRUE;
1471        }
1472        else {
1473           Jmsg(jcr, M_ERROR, 0, _("FAILED to pause Open File Manager\n") );
1474        }
1475    }
1476    {
1477        char username[UNLEN+1];
1478        DWORD usize = sizeof(username);
1479        int privs = enable_backup_privileges(NULL, 1);
1480        if (GetUserName(username, &usize)) {
1481           Jmsg2(jcr, M_INFO, 0, _("Running as '%s'. Privmask=%#08x\n"), username,
1482        } else {
1483           Jmsg(jcr, M_WARNING, 0, _("Failed to retrieve current UserName\n"));
1484        }
1485    }
1486 #endif