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