X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=bacula%2Fsrc%2Ffiled%2Frestore.c;h=c2cebe8416319bc170f2c5000bdf89def1c0d284;hb=348443164908c223c56ed5b1e609ede38c24b9f9;hp=fc356f09dc3e65a32c9a5a936d4e08cb107438cc;hpb=6f2d74796f2c34566e9017371687c7fb393addb0;p=bacula%2Fbacula diff --git a/bacula/src/filed/restore.c b/bacula/src/filed/restore.c index fc356f09dc..c2cebe8416 100644 --- a/bacula/src/filed/restore.c +++ b/bacula/src/filed/restore.c @@ -1,5 +1,5 @@ /* - * Bacula File Daemon restore.c Restorefiles. + * Bacula File Daemon restore.c Restorefiles. * * Kern Sibbald, November MM * @@ -7,364 +7,1006 @@ * */ /* - Copyright (C) 2000-2003 Kern Sibbald and John Walker + Bacula® - The Network Backup Solution - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License as - published by the Free Software Foundation; either version 2 of - the License, or (at your option) any later version. + Copyright (C) 2000-2006 Free Software Foundation Europe e.V. - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of + The main author of Bacula is Kern Sibbald, with contributions from + many others, a complete list can be found in the file AUTHORS. + This program is Free Software; you can redistribute it and/or + modify it under the terms of version two of the GNU General Public + License as published by the Free Software Foundation plus additions + that are listed in the file LICENSE. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - You should have received a copy of the GNU General Public - License along with this program; if not, write to the Free - Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, - MA 02111-1307, USA. + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + 02110-1301, USA. - */ + Bacula® is a registered trademark of John Walker. + The licensor of Bacula is the Free Software Foundation Europe + (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich, + Switzerland, email:ftf@fsfeurope.org. +*/ #include "bacula.h" #include "filed.h" +#ifdef HAVE_DARWIN_OS +#include +#endif + +#if defined(HAVE_CRYPTO) +const bool have_crypto = true; +#else +const bool have_crypto = false; +#endif + /* Data received from Storage Daemon */ static char rec_header[] = "rechdr %ld %ld %ld %ld %ld"; /* Forward referenced functions */ +#if defined(HAVE_LIBZ) +static const char *zlib_strerror(int stat); +const bool have_libz = true; +#else +const bool have_libz = false; +#endif -#define RETRY 10 /* retry wait time */ +int verify_signature(JCR *jcr, SIGNATURE *sig); +int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen, + uint64_t *addr, int flags, CIPHER_CONTEXT *cipher, uint32_t cipher_block_size); +bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags, CIPHER_CONTEXT *cipher, + uint32_t cipher_block_size); -/* +#define RETRY 10 /* retry wait time */ + +/* + * Close a bfd check that we are at the expected file offset. + * Makes some code in set_attributes(). + */ +int bclose_chksize(JCR *jcr, BFILE *bfd, boffset_t osize) +{ + char ec1[50], ec2[50]; + boffset_t fsize; + + fsize = blseek(bfd, 0, SEEK_CUR); + bclose(bfd); /* first close file */ + if (fsize > 0 && fsize != osize) { + Qmsg3(jcr, M_ERROR, 0, _("Size of data or stream of %s not correct. Original %s, restored %s.\n"), + jcr->last_fname, edit_uint64(osize, ec1), + edit_uint64(fsize, ec2)); + return -1; + } + return 0; +} + +/* * Restore the requested files. - * + * */ void do_restore(JCR *jcr) { - int wherelen; BSOCK *sd; - int32_t stream; - uint32_t size; + int32_t stream = 0; + int32_t prev_stream; uint32_t VolSessionId, VolSessionTime; + bool extract = false; int32_t file_index; - int extract = FALSE; - BFILE bfd; + char ec1[50]; /* Buffer printing huge values */ + BFILE bfd; /* File content */ + uint64_t fileAddr = 0; /* file write address */ + uint32_t size; /* Size of file */ + BFILE altbfd; /* Alternative data stream */ + uint64_t alt_addr = 0; /* Write address for alternative stream */ + intmax_t alt_size = 0; /* Size of alternate stream */ + SIGNATURE *sig = NULL; /* Cryptographic signature (if any) for file */ + CRYPTO_SESSION *cs = NULL; /* Cryptographic session data (if any) for file */ + CIPHER_CONTEXT *cipher_ctx = NULL; /* Cryptographic cipher context (if any) for file */ + uint32_t cipher_block_size = 0; /* Cryptographic algorithm block size for file */ + int flags = 0; /* Options for extract_data() */ int stat; - uint32_t total = 0; /* Job total but only 32 bits for debug */ - char *wbuf; /* write buffer */ - uint32_t wsize; /* write size */ - uint64_t fileAddr = 0; /* file write address */ + ATTR *attr; + + /* The following variables keep track of "known unknowns" */ int non_support_data = 0; int non_support_attr = 0; - int prog_name_msg = 0; - ATTR *attr; - - wherelen = strlen(jcr->where); + int non_support_rsrc = 0; + int non_support_finfo = 0; + int non_support_acl = 0; + int non_support_progname = 0; + + /* Finally, set up for special configurations */ +#ifdef HAVE_DARWIN_OS + intmax_t rsrc_len = 0; /* Original length of resource fork */ + struct attrlist attrList; + + memset(&attrList, 0, sizeof(attrList)); + attrList.bitmapcount = ATTR_BIT_MAP_COUNT; + attrList.commonattr = ATTR_CMN_FNDRINFO; +#endif - binit(&bfd); sd = jcr->store_bsock; set_jcr_job_status(jcr, JS_Running); - if (!bnet_set_buffer_size(sd, MAX_NETWORK_BUFFER_SIZE, BNET_SETBUF_READ)) { + LockRes(); + CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL); + UnlockRes(); + uint32_t buf_size; + if (client) { + buf_size = client->max_network_buffer_size; + } else { + buf_size = 0; /* use default */ + } + if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) { set_jcr_job_status(jcr, JS_ErrorTerminated); return; } jcr->buf_size = sd->msglen; - attr = new_attr(); - -#ifdef HAVE_LIBZ - uint32_t compress_buf_size = jcr->buf_size + 12 + ((jcr->buf_size+999) / 1000) + 100; - jcr->compress_buf = (char *)bmalloc(compress_buf_size); +#ifdef stbernard_implemented +/ #if defined(HAVE_WIN32) + bool bResumeOfmOnExit = FALSE; + if (isOpenFileManagerRunning()) { + if ( pauseOpenFileManager() ) { + Jmsg(jcr, M_INFO, 0, _("Open File Manager paused\n") ); + bResumeOfmOnExit = TRUE; + } + else { + Jmsg(jcr, M_ERROR, 0, _("FAILED to pause Open File Manager\n") ); + } + } + { + char username[UNLEN+1]; + DWORD usize = sizeof(username); + int privs = enable_backup_privileges(NULL, 1); + if (GetUserName(username, &usize)) { + Jmsg2(jcr, M_INFO, 0, _("Running as '%s'. Privmask=%#08x\n"), username, + } else { + Jmsg(jcr, M_WARNING, 0, _("Failed to retrieve current UserName\n")); + } + } #endif - /* - * Get a record from the Storage daemon. We are guaranteed to - * receive records in the following order: - * 1. Stream record header - * 2. Stream data - * a. Attributes (Unix or Win32) - * or b. File data for the file - * or c. Possibly MD5 or SHA1 record - * 3. Repeat step 1 + if (have_libz) { + uint32_t compress_buf_size = jcr->buf_size + 12 + ((jcr->buf_size+999) / 1000) + 100; + jcr->compress_buf = (char *)bmalloc(compress_buf_size); + jcr->compress_buf_size = compress_buf_size; + } + + if (have_crypto) { + jcr->crypto_buf = get_memory(CRYPTO_CIPHER_MAX_BLOCK_SIZE); + jcr->crypto_buf_len = 0; + jcr->crypto_packet_len = 0; + } + + /* + * Get a record from the Storage daemon. We are guaranteed to + * receive records in the following order: + * 1. Stream record header + * 2. Stream data + * a. Attributes (Unix or Win32) + * b. Possibly stream encryption session data (e.g., symmetric session key) + * or c. File data for the file + * or d. Alternate data stream (e.g. Resource Fork) + * or e. Finder info + * or f. ACLs + * or g. Possibly a cryptographic signature + * or h. Possibly MD5 or SHA1 record + * 3. Repeat step 1 + * + * NOTE: We keep track of two bacula file descriptors: + * 1. bfd for file data. + * This fd is opened for non empty files when an attribute stream is + * encountered and closed when we find the next attribute stream. + * 2. alt_bfd for alternate data streams + * This fd is opened every time we encounter a new alternate data + * stream for the current file. When we find any other stream, we + * close it again. + * The expected size of the stream, alt_len, should be set when + * opening the fd. */ + binit(&bfd); + binit(&altbfd); + attr = new_attr(); + jcr->acl_text = get_pool_memory(PM_MESSAGE); + while (bget_msg(sd) >= 0 && !job_canceled(jcr)) { - /* - * First we expect a Stream Record Header - */ + /* Remember previous stream type */ + prev_stream = stream; + + /* First we expect a Stream Record Header */ if (sscanf(sd->msg, rec_header, &VolSessionId, &VolSessionTime, &file_index, - &stream, &size) != 5) { + &stream, &size) != 5) { Jmsg1(jcr, M_FATAL, 0, _("Record header scan error: %s\n"), sd->msg); - goto bail_out; + goto bail_out; } - Dmsg2(30, "Got hdr: FilInx=%d Stream=%d.\n", file_index, stream); + Dmsg4(30, "Got hdr: Files=%d FilInx=%d Stream=%d, %s.\n", + jcr->JobFiles, file_index, stream, stream_to_ascii(stream)); - /* - * Now we expect the Stream Data - */ + /* * Now we expect the Stream Data */ if (bget_msg(sd) < 0) { Jmsg1(jcr, M_FATAL, 0, _("Data record error. ERR=%s\n"), bnet_strerror(sd)); - goto bail_out; + goto bail_out; } if (size != (uint32_t)sd->msglen) { Jmsg2(jcr, M_FATAL, 0, _("Actual data size %d not same as header %d\n"), sd->msglen, size); - goto bail_out; + goto bail_out; + } + Dmsg3(30, "Got stream: %s len=%d extract=%d\n", stream_to_ascii(stream), + sd->msglen, extract); + + /* If we change streams, close and reset alternate data streams */ + if (prev_stream != stream) { + if (is_bopen(&altbfd)) { + bclose_chksize(jcr, &altbfd, alt_size); + } + alt_size = -1; /* Use an impossible value and set a proper one below */ + alt_addr = 0; } - Dmsg1(30, "Got stream data, len=%d\n", sd->msglen); /* File Attributes stream */ switch (stream) { case STREAM_UNIX_ATTRIBUTES: case STREAM_UNIX_ATTRIBUTES_EX: - - Dmsg1(30, "Stream=Unix Attributes. extract=%d\n", extract); - /* If extracting, it was from previous stream, so - * close the output file. - */ - if (extract) { - if (!is_bopen(&bfd)) { - Jmsg0(jcr, M_ERROR, 0, _("Logic error output file should be open\n")); - } - set_attributes(jcr, attr, &bfd); - extract = FALSE; + /* + * If extracting, it was from previous stream, so + * close the output file and validate the signature. + */ + if (extract) { + if (size > 0 && !is_bopen(&bfd)) { + Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should be open\n")); + } + /* Flush and deallocate previous stream's cipher context */ + if (cipher_ctx && prev_stream != STREAM_ENCRYPTED_SESSION_DATA) { + flush_cipher(jcr, &bfd, &fileAddr, flags, cipher_ctx, cipher_block_size); + crypto_cipher_free(cipher_ctx); + cipher_ctx = NULL; + } + set_attributes(jcr, attr, &bfd); + extract = false; + + /* Verify the cryptographic signature, if any */ + if (jcr->pki_sign) { + if (sig) { + // Failure is reported in verify_signature() ... + verify_signature(jcr, sig); + } else { + Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"), jcr->last_fname); + } + } + /* Free Signature */ + if (sig) { + crypto_sign_free(sig); + sig = NULL; + } + if (cs) { + crypto_session_free(cs); + cs = NULL; + } Dmsg0(30, "Stop extracting.\n"); - } - - if (!unpack_attributes_record(jcr, stream, sd->msg, attr)) { - goto bail_out; - } - if (file_index != attr->file_index) { + } else if (is_bopen(&bfd)) { + Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should not be open\n")); + bclose(&bfd); + } + + /* + * Unpack and do sanity check fo attributes. + */ + if (!unpack_attributes_record(jcr, stream, sd->msg, attr)) { + goto bail_out; + } + if (file_index != attr->file_index) { Jmsg(jcr, M_FATAL, 0, _("Record header file index %ld not equal record index %ld\n"), - file_index, attr->file_index); + file_index, attr->file_index); Dmsg0(100, "File index error\n"); - goto bail_out; - } - - Dmsg3(200, "File %s\nattrib=%s\nattribsEx=%s\n", attr->fname, - attr->attr, attr->attrEx); + goto bail_out; + } - attr->data_stream = decode_stat(attr->attr, &attr->statp, &attr->LinkFI); + Dmsg3(200, "File %s\nattrib=%s\nattribsEx=%s\n", attr->fname, + attr->attr, attr->attrEx); - if (!is_stream_supported(attr->data_stream)) { - if (!non_support_data++) { - Jmsg(jcr, M_ERROR, 0, _("%s stream not supported on this Client.\n"), - stream_to_ascii(attr->data_stream)); - } - continue; - } + attr->data_stream = decode_stat(attr->attr, &attr->statp, &attr->LinkFI); - build_attr_output_fnames(jcr, attr); + if (!is_restore_stream_supported(attr->data_stream)) { + if (!non_support_data++) { + Jmsg(jcr, M_ERROR, 0, _("%s stream not supported on this Client.\n"), + stream_to_ascii(attr->data_stream)); + } + continue; + } - jcr->num_files_examined++; + build_attr_output_fnames(jcr, attr); + /* + * Now determine if we are extracting or not. + */ + jcr->num_files_examined++; Dmsg1(30, "Outfile=%s\n", attr->ofname); - extract = FALSE; - stat = create_file(jcr, attr, &bfd, jcr->replace); - switch (stat) { - case CF_ERROR: - case CF_SKIP: - break; - case CF_EXTRACT: - extract = TRUE; - P(jcr->mutex); - pm_strcpy(&jcr->last_fname, attr->ofname); - V(jcr->mutex); - jcr->JobFiles++; - fileAddr = 0; - print_ls_output(jcr, attr); - /* Set attributes after file extracted */ - break; - case CF_CREATED: - P(jcr->mutex); - pm_strcpy(&jcr->last_fname, attr->ofname); - V(jcr->mutex); - jcr->JobFiles++; - fileAddr = 0; - print_ls_output(jcr, attr); - /* set attributes now because file will not be extracted */ - set_attributes(jcr, attr, &bfd); - break; - } - break; - - /* Windows Backup data stream */ - case STREAM_WIN32_DATA: - if (!is_win32_backup()) { - if (!non_support_data) { - Jmsg(jcr, M_ERROR, 0, _("%s stream not supported on this Client.\n"), - stream_to_ascii(stream)); - } - extract = FALSE; - non_support_data++; - continue; - } - goto extract_data; + extract = false; + stat = create_file(jcr, attr, &bfd, jcr->replace); + switch (stat) { + case CF_ERROR: + case CF_SKIP: + break; + case CF_EXTRACT: /* File created and we expect file data */ + extract = true; + /* FALLTHROUGH */ + case CF_CREATED: /* File created, but there is no content */ + jcr->lock(); + pm_strcpy(jcr->last_fname, attr->ofname); + jcr->last_type = attr->type; + jcr->JobFiles++; + jcr->unlock(); + fileAddr = 0; + print_ls_output(jcr, attr); +#ifdef HAVE_DARWIN_OS + /* Only restore the resource fork for regular files */ + from_base64(&rsrc_len, attr->attrEx); + if (attr->type == FT_REG && rsrc_len > 0) { + extract = true; + } +#endif + if (!extract) { + /* set attributes now because file will not be extracted */ + set_attributes(jcr, attr, &bfd); + } + break; + } + break; /* Data stream */ + case STREAM_ENCRYPTED_SESSION_DATA: + crypto_error_t cryptoerr; + + /* Do we have any keys at all? */ + if (!jcr->pki_recipients) { + Jmsg(jcr, M_ERROR, 0, _("No private decryption keys have been defined to decrypt encrypted backup data.\n")); + extract = false; + bclose(&bfd); + break; + } + + /* Decode and save session keys. */ + cryptoerr = crypto_session_decode((uint8_t *)sd->msg, (uint32_t)sd->msglen, jcr->pki_recipients, &cs); + switch(cryptoerr) { + case CRYPTO_ERROR_NONE: + /* Success */ + break; + case CRYPTO_ERROR_NORECIPIENT: + Jmsg(jcr, M_ERROR, 0, _("Missing private key required to decrypt encrypted backup data.\n")); + break; + case CRYPTO_ERROR_DECRYPTION: + Jmsg(jcr, M_ERROR, 0, _("Decrypt of the session key failed.\n")); + break; + default: + /* Shouldn't happen */ + Jmsg1(jcr, M_ERROR, 0, _("An error occured while decoding encrypted session data stream: %s\n"), crypto_strerror(cryptoerr)); + break; + } + + if (cryptoerr != CRYPTO_ERROR_NONE) { + extract = false; + bclose(&bfd); + continue; + } + + /* Set up a decryption context */ + if ((cipher_ctx = crypto_cipher_new(cs, false, &cipher_block_size)) == NULL) { + Jmsg1(jcr, M_ERROR, 0, _("Failed to initialize decryption context for %s\n"), jcr->last_fname); + crypto_session_free(cs); + cs = NULL; + extract = false; + bclose(&bfd); + continue; + } + + break; + case STREAM_FILE_DATA: - case STREAM_SPARSE_DATA: - -extract_data: - if (extract) { - if (stream == STREAM_SPARSE_DATA) { - ser_declare; - uint64_t faddr; - char ec1[50]; - - wbuf = sd->msg + SPARSE_FADDR_SIZE; - wsize = sd->msglen - SPARSE_FADDR_SIZE; - ser_begin(sd->msg, SPARSE_FADDR_SIZE); - unser_uint64(faddr); - if (fileAddr != faddr) { - fileAddr = faddr; - if (blseek(&bfd, (off_t)fileAddr, SEEK_SET) < 0) { - Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"), - edit_uint64(fileAddr, ec1), attr->ofname, berror(&bfd)); - extract = FALSE; - continue; - } - } - } else { - wbuf = sd->msg; - wsize = sd->msglen; - } - Dmsg2(30, "Write %u bytes, total before write=%u\n", wsize, total); - if ((uint32_t)bwrite(&bfd, wbuf, wsize) != wsize) { - Dmsg0(0, "===Write error===\n"); - Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: ERR=%s\n"), attr->ofname, berror(&bfd)); - extract = FALSE; - continue; - } - total += wsize; - jcr->JobBytes += wsize; - jcr->ReadBytes += wsize; - fileAddr += wsize; - } - break; - - /* Windows Backup GZIP data stream */ - case STREAM_WIN32_GZIP_DATA: - if (!is_win32_backup()) { - if (!non_support_attr) { - Jmsg(jcr, M_ERROR, 0, _("%s stream not supported on this Client.\n"), - stream_to_ascii(stream)); - } - extract = FALSE; - non_support_attr++; - continue; - } - /* Fall through desired */ - - /* GZIP data stream */ + case STREAM_SPARSE_DATA: + case STREAM_WIN32_DATA: case STREAM_GZIP_DATA: - case STREAM_SPARSE_GZIP_DATA: -#ifdef HAVE_LIBZ - if (extract) { - ser_declare; - uLong compress_len; - uint64_t faddr; - char ec1[50]; - int stat; - - if (stream == STREAM_SPARSE_GZIP_DATA) { - wbuf = sd->msg + SPARSE_FADDR_SIZE; - wsize = sd->msglen - SPARSE_FADDR_SIZE; - ser_begin(sd->msg, SPARSE_FADDR_SIZE); - unser_uint64(faddr); - if (fileAddr != faddr) { - fileAddr = faddr; - if (blseek(&bfd, (off_t)fileAddr, SEEK_SET) < 0) { - Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"), - edit_uint64(fileAddr, ec1), attr->ofname, berror(&bfd)); - extract = FALSE; - continue; - } - } - } else { - wbuf = sd->msg; - wsize = sd->msglen; - } - compress_len = compress_buf_size; - Dmsg2(100, "Comp_len=%d msglen=%d\n", compress_len, wsize); - if ((stat=uncompress((Byte *)jcr->compress_buf, &compress_len, - (const Byte *)wbuf, (uLong)wsize)) != Z_OK) { - Jmsg(jcr, M_ERROR, 0, _("Uncompression error. ERR=%d\n"), stat); - extract = FALSE; - continue; - } - - Dmsg2(100, "Write uncompressed %d bytes, total before write=%d\n", compress_len, total); - if ((uLong)bwrite(&bfd, jcr->compress_buf, compress_len) != compress_len) { - Dmsg0(0, "===Write error===\n"); - Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: %s\n"), attr->ofname, berror(&bfd)); - extract = FALSE; - continue; - } - total += compress_len; - jcr->JobBytes += compress_len; - jcr->ReadBytes += wsize; - fileAddr += compress_len; - } + case STREAM_SPARSE_GZIP_DATA: + case STREAM_WIN32_GZIP_DATA: + case STREAM_ENCRYPTED_FILE_DATA: + case STREAM_ENCRYPTED_WIN32_DATA: + case STREAM_ENCRYPTED_FILE_GZIP_DATA: + case STREAM_ENCRYPTED_WIN32_GZIP_DATA: + /* Force an expected, consistent stream type here */ + if (extract && (prev_stream == stream || prev_stream == STREAM_UNIX_ATTRIBUTES + || prev_stream == STREAM_UNIX_ATTRIBUTES_EX + || prev_stream == STREAM_ENCRYPTED_SESSION_DATA)) { + flags = 0; + + if (stream == STREAM_SPARSE_DATA || stream == STREAM_SPARSE_GZIP_DATA) { + flags |= FO_SPARSE; + } + + if (stream == STREAM_GZIP_DATA || stream == STREAM_SPARSE_GZIP_DATA + || stream == STREAM_WIN32_GZIP_DATA || stream == STREAM_ENCRYPTED_FILE_GZIP_DATA + || stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) { + flags |= FO_GZIP; + } + + if (stream == STREAM_ENCRYPTED_FILE_DATA + || stream == STREAM_ENCRYPTED_FILE_GZIP_DATA + || stream == STREAM_ENCRYPTED_WIN32_DATA + || stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) { + flags |= FO_ENCRYPT; + } + + if (is_win32_stream(stream) && !have_win32_api()) { + set_portable_backup(&bfd); + flags |= FO_WIN32DECOMP; /* "decompose" BackupWrite data */ + } + + if (extract_data(jcr, &bfd, sd->msg, sd->msglen, &fileAddr, flags, + cipher_ctx, cipher_block_size) < 0) { + extract = false; + bclose(&bfd); + continue; + } + } + break; + + /* Resource fork stream - only recorded after a file to be restored */ + /* Silently ignore if we cannot write - we already reported that */ + case STREAM_ENCRYPTED_MACOS_FORK_DATA: + flags |= FO_ENCRYPT; + case STREAM_MACOS_FORK_DATA: +#ifdef HAVE_DARWIN_OS + if (extract) { + if (prev_stream != stream) { + if (bopen_rsrc(&altbfd, jcr->last_fname, O_WRONLY | O_TRUNC | O_BINARY, 0) < 0) { + Jmsg(jcr, M_ERROR, 0, _(" Cannot open resource fork for %s.\n"), jcr->last_fname); + extract = false; + continue; + } + alt_size = rsrc_len; + Dmsg0(30, "Restoring resource fork\n"); + } + flags = 0; + if (extract_data(jcr, &altbfd, sd->msg, sd->msglen, &alt_addr, flags, + cipher_ctx, cipher_block_size) < 0) { + extract = false; + bclose(&altbfd); + continue; + } + } +#else + non_support_rsrc++; +#endif + break; + + case STREAM_HFSPLUS_ATTRIBUTES: +#ifdef HAVE_DARWIN_OS + Dmsg0(30, "Restoring Finder Info\n"); + if (sd->msglen != 32) { + Jmsg(jcr, M_ERROR, 0, _(" Invalid length of Finder Info (got %d, not 32)\n"), sd->msglen); + continue; + } + if (setattrlist(jcr->last_fname, &attrList, sd->msg, sd->msglen, 0) != 0) { + Jmsg(jcr, M_ERROR, 0, _(" Could not set Finder Info on %s\n"), jcr->last_fname); + continue; + } #else - if (extract) { - Jmsg(jcr, M_ERROR, 0, _("GZIP data stream found, but GZIP not configured!\n")); - extract = FALSE; - continue; - } + non_support_finfo++; #endif - break; - case STREAM_MD5_SIGNATURE: - case STREAM_SHA1_SIGNATURE: - break; + case STREAM_UNIX_ATTRIBUTES_ACCESS_ACL: +#ifdef HAVE_ACL + pm_strcpy(jcr->acl_text, sd->msg); + Dmsg2(400, "Restoring ACL type 0x%2x <%s>\n", BACL_TYPE_ACCESS, jcr->acl_text); + if (bacl_set(jcr, BACL_TYPE_ACCESS) != 0) { + Qmsg1(jcr, M_WARNING, 0, _("Can't restore ACL of %s\n"), jcr->last_fname); + } +#else + non_support_acl++; +#endif + break; + + case STREAM_UNIX_ATTRIBUTES_DEFAULT_ACL: +#ifdef HAVE_ACL + pm_strcpy(jcr->acl_text, sd->msg); + Dmsg2(400, "Restoring ACL type 0x%2x <%s>\n", BACL_TYPE_DEFAULT, jcr->acl_text); + if (bacl_set(jcr, BACL_TYPE_DEFAULT) != 0) { + Qmsg1(jcr, M_WARNING, 0, _("Can't restore default ACL of %s\n"), jcr->last_fname); + } +#else + non_support_acl++; +#endif + break; + + case STREAM_SIGNED_DIGEST: + /* Save signature. */ + if (extract && (sig = crypto_sign_decode((uint8_t *)sd->msg, (uint32_t)sd->msglen)) == NULL) { + Jmsg1(jcr, M_ERROR, 0, _("Failed to decode message signature for %s\n"), jcr->last_fname); + } + break; + + case STREAM_MD5_DIGEST: + case STREAM_SHA1_DIGEST: + case STREAM_SHA256_DIGEST: + case STREAM_SHA512_DIGEST: + break; case STREAM_PROGRAM_NAMES: case STREAM_PROGRAM_DATA: - if (!prog_name_msg) { + if (!non_support_progname) { Pmsg0(000, "Got Program Name or Data Stream. Ignored.\n"); - prog_name_msg++; - } - break; + non_support_progname++; + } + break; default: - /* If extracting, wierd stream (not 1 or 2), close output file anyway */ - if (extract) { + /* If extracting, wierd stream (not 1 or 2), close output file anyway */ + if (extract) { Dmsg1(30, "Found wierd stream %d\n", stream); - if (!is_bopen(&bfd)) { - Jmsg0(jcr, M_ERROR, 0, _("Logic error output file should be open but is not.\n")); - } - set_attributes(jcr, attr, &bfd); - extract = FALSE; - } + if (size > 0 && !is_bopen(&bfd)) { + Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should be open\n")); + } + /* Flush and deallocate cipher context */ + if (cipher_ctx) { + flush_cipher(jcr, &bfd, &fileAddr, flags, cipher_ctx, cipher_block_size); + crypto_cipher_free(cipher_ctx); + cipher_ctx = NULL; + } + set_attributes(jcr, attr, &bfd); + + /* Verify the cryptographic signature if any */ + if (jcr->pki_sign) { + if (sig) { + // Failure is reported in verify_signature() ... + verify_signature(jcr, sig); + } else { + Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"), jcr->last_fname); + } + } + + extract = false; + } else if (is_bopen(&bfd)) { + Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should not be open\n")); + bclose(&bfd); + } Jmsg(jcr, M_ERROR, 0, _("Unknown stream=%d ignored. This shouldn't happen!\n"), stream); Dmsg2(0, "None of above!!! stream=%d data=%s\n", stream,sd->msg); - break; + break; } /* end switch(stream) */ } /* end while get_msg() */ /* If output file is still open, it was the last one in the - * archive since we just hit an end of file, so close the file. + * archive since we just hit an end of file, so close the file. */ - if (is_bopen(&bfd)) { + if (is_bopen(&altbfd)) { + bclose_chksize(jcr, &altbfd, alt_size); + } + if (extract) { + /* Flush and deallocate cipher context */ + if (cipher_ctx) { + flush_cipher(jcr, &bfd, &fileAddr, flags, cipher_ctx, cipher_block_size); + crypto_cipher_free(cipher_ctx); + cipher_ctx = NULL; + } set_attributes(jcr, attr, &bfd); + + /* Verify the cryptographic signature on the last file, if any */ + if (jcr->pki_sign) { + if (sig) { + // Failure is reported in verify_signature() ... + verify_signature(jcr, sig); + } else { + Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"), jcr->last_fname); + } + } } + + if (is_bopen(&bfd)) { + bclose(&bfd); + } + set_jcr_job_status(jcr, JS_Terminated); goto ok_out; bail_out: set_jcr_job_status(jcr, JS_ErrorTerminated); ok_out: + + /* Free Signature & Crypto Data */ + if (sig) { + crypto_sign_free(sig); + sig = NULL; + } + if (cs) { + crypto_session_free(cs); + cs = NULL; + } + if (cipher_ctx) { + crypto_cipher_free(cipher_ctx); + cipher_ctx = NULL; + } if (jcr->compress_buf) { free(jcr->compress_buf); jcr->compress_buf = NULL; + jcr->compress_buf_size = 0; + } + if (jcr->crypto_buf) { + free_pool_memory(jcr->crypto_buf); + jcr->crypto_buf = NULL; } + bclose(&altbfd); + bclose(&bfd); free_attr(attr); - Dmsg2(10, "End Do Restore. Files=%d Bytes=%" lld "\n", jcr->JobFiles, - jcr->JobBytes); + free_pool_memory(jcr->acl_text); + Dmsg2(10, "End Do Restore. Files=%d Bytes=%s\n", jcr->JobFiles, + edit_uint64(jcr->JobBytes, ec1)); if (non_support_data > 1 || non_support_attr > 1) { Jmsg(jcr, M_ERROR, 0, _("%d non-supported data streams and %d non-supported attrib streams ignored.\n"), - non_support_data, non_support_attr); + non_support_data, non_support_attr); + } + if (non_support_rsrc) { + Jmsg(jcr, M_INFO, 0, _("%d non-supported resource fork streams ignored.\n"), non_support_rsrc); + } + if (non_support_finfo) { + Jmsg(jcr, M_INFO, 0, _("%d non-supported Finder Info streams ignored.\n"), non_support_rsrc); + } + if (non_support_acl) { + Jmsg(jcr, M_INFO, 0, _("%d non-supported acl streams ignored.\n"), non_support_acl); + } + +} + +/* + * Convert ZLIB error code into an ASCII message + */ +static const char *zlib_strerror(int stat) +{ + if (stat >= 0) { + return _("None"); + } + switch (stat) { + case Z_ERRNO: + return _("Zlib errno"); + case Z_STREAM_ERROR: + return _("Zlib stream error"); + case Z_DATA_ERROR: + return _("Zlib data error"); + case Z_MEM_ERROR: + return _("Zlib memory error"); + case Z_BUF_ERROR: + return _("Zlib buffer error"); + case Z_VERSION_ERROR: + return _("Zlib version error"); + default: + return _("*none*"); + } +} + +static int do_file_digest(FF_PKT *ff_pkt, void *pkt, bool top_level) +{ + JCR *jcr = (JCR *)pkt; + return (digest_file(jcr, ff_pkt, jcr->digest)); +} + +/* + * Verify the signature for the last restored file + * Return value is either true (signature correct) + * or false (signature could not be verified). + * TODO landonf: Better signature failure handling. + */ +int verify_signature(JCR *jcr, SIGNATURE *sig) +{ + X509_KEYPAIR *keypair; + DIGEST *digest = NULL; + crypto_error_t err; + + /* Iterate through the trusted signers */ + foreach_alist(keypair, jcr->pki_signers) { + err = crypto_sign_get_digest(sig, jcr->pki_keypair, &digest); + + switch (err) { + case CRYPTO_ERROR_NONE: + /* Signature found, digest allocated */ + jcr->digest = digest; + + /* Checksum the entire file */ + if (find_one_file(jcr, jcr->ff, do_file_digest, jcr, jcr->last_fname, (dev_t)-1, 1) != 0) { + Qmsg(jcr, M_ERROR, 0, _("Signature validation failed for %s: \n"), jcr->last_fname); + return false; + } + + /* Verify the signature */ + if ((err = crypto_sign_verify(sig, keypair, digest)) != CRYPTO_ERROR_NONE) { + Dmsg1(100, "Bad signature on %s\n", jcr->last_fname); + Qmsg2(jcr, M_ERROR, 0, _("Signature validation failed for %s: %s\n"), jcr->last_fname, crypto_strerror(err)); + crypto_digest_free(digest); + return false; + } + + /* Valid signature */ + Dmsg1(100, "Signature good on %s\n", jcr->last_fname); + crypto_digest_free(digest); + return true; + + case CRYPTO_ERROR_NOSIGNER: + /* Signature not found, try again */ + continue; + default: + /* Something strange happened (that shouldn't happen!)... */ + Qmsg2(jcr, M_ERROR, 0, _("Signature validation failed for %s: %s\n"), jcr->last_fname, crypto_strerror(err)); + if (digest) { + crypto_digest_free(digest); + } + return false; + } + } + + /* No signer */ + Dmsg1(100, "Could not find a valid public key for signature on %s\n", jcr->last_fname); + crypto_digest_free(digest); + return false; +} + +bool sparse_data(JCR *jcr, BFILE *bfd, uint64_t *addr, char **data, uint32_t *length) +{ + unser_declare; + uint64_t faddr; + char ec1[50]; + unser_begin(*data, SPARSE_FADDR_SIZE); + unser_uint64(faddr); + if (*addr != faddr) { + *addr = faddr; + if (blseek(bfd, (boffset_t)*addr, SEEK_SET) < 0) { + berrno be; + Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"), + edit_uint64(*addr, ec1), jcr->last_fname, + be.strerror(bfd->berrno)); + return false; + } + } + *data += SPARSE_FADDR_SIZE; + *length -= SPARSE_FADDR_SIZE; + return true; +} + +bool decompress_data(JCR *jcr, char **data, uint32_t *length) +{ +#ifdef HAVE_LIBZ + uLong compress_len; + int stat; + char ec1[50]; /* Buffer printing huge values */ + + /* + * NOTE! We only use uLong and Byte because they are + * needed by the zlib routines, they should not otherwise + * be used in Bacula. + */ + compress_len = jcr->compress_buf_size; + Dmsg2(100, "Comp_len=%d msglen=%d\n", compress_len, *length); + if ((stat=uncompress((Byte *)jcr->compress_buf, &compress_len, + (const Byte *)*data, (uLong)*length)) != Z_OK) { + Qmsg(jcr, M_ERROR, 0, _("Uncompression error on file %s. ERR=%s\n"), + jcr->last_fname, zlib_strerror(stat)); + return false; + } + *data = jcr->compress_buf; + *length = compress_len; + Dmsg2(100, "Write uncompressed %d bytes, total before write=%s\n", compress_len, edit_uint64(jcr->JobBytes, ec1)); + return true; +#else + Qmsg(jcr, M_ERROR, 0, _("GZIP data stream found, but GZIP not configured!\n")); + return false; +#endif +} + +static void unser_crypto_packet_len(JCR *jcr) +{ + unser_declare; + if (jcr->crypto_packet_len == 0 && jcr->crypto_buf_len >= CRYPTO_LEN_SIZE) { + unser_begin(&jcr->crypto_buf[0], CRYPTO_LEN_SIZE); + unser_uint32(jcr->crypto_packet_len); + jcr->crypto_packet_len += CRYPTO_LEN_SIZE; } -} +} + +bool store_data(JCR *jcr, BFILE *bfd, char *data, const int32_t length, bool win32_decomp) +{ + if (win32_decomp) { + if (!processWin32BackupAPIBlock(bfd, data, length)) { + berrno be; + Jmsg2(jcr, M_ERROR, 0, _("Write error in Win32 Block Decomposition on %s: %s\n"), + jcr->last_fname, be.strerror(bfd->berrno)); + return false; + } + } else if (bwrite(bfd, data, length) != (ssize_t)length) { + berrno be; + Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: %s\n"), + jcr->last_fname, be.strerror(bfd->berrno)); + return false; + } + + return true; +} + +/* + * In the context of jcr, write data to bfd. + * We write buflen bytes in buf at addr. addr is updated in place. + * The flags specify whether to use sparse files or compression. + * Return value is the number of bytes written, or -1 on errors. + */ +int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen, + uint64_t *addr, int flags, CIPHER_CONTEXT *cipher, uint32_t cipher_block_size) +{ + char *wbuf; /* write buffer */ + uint32_t wsize; /* write size */ + uint32_t rsize; /* read size */ + uint32_t decrypted_len = 0; /* Decryption output length */ + char ec1[50]; /* Buffer printing huge values */ + + rsize = buflen; + jcr->ReadBytes += rsize; + wsize = rsize; + wbuf = buf; + + if (flags & FO_ENCRYPT) { + ASSERT(cipher); + + /* NOTE: We must implement block preserving semantics for the + * non-streaming compression and sparse code. */ + + /* + * Grow the crypto buffer, if necessary. + * crypto_cipher_update() will process only whole blocks, + * buffering the remaining input. + */ + jcr->crypto_buf = check_pool_memory_size(jcr->crypto_buf, + jcr->crypto_buf_len + wsize + cipher_block_size); + + /* Decrypt the input block */ + if (!crypto_cipher_update(cipher, + (const u_int8_t *)wbuf, + wsize, + (u_int8_t *)&jcr->crypto_buf[jcr->crypto_buf_len], + &decrypted_len)) { + /* Decryption failed. Shouldn't happen. */ + Jmsg(jcr, M_FATAL, 0, _("Decryption error\n")); + return -1; + } + + if (decrypted_len == 0) { + /* No full block of encrypted data available, write more data */ + return 0; + } + + Dmsg2(100, "decrypted len=%d encrypted len=%d\n", decrypted_len, wsize); + + jcr->crypto_buf_len += decrypted_len; + wbuf = jcr->crypto_buf; + + /* If one full preserved block is available, write it to disk, + * and then buffer any remaining data. This should be effecient + * as long as Bacula's block size is not significantly smaller than the + * encryption block size (extremely unlikely!) */ + unser_crypto_packet_len(jcr); + Dmsg1(500, "Crypto unser block size=%d\n", jcr->crypto_packet_len - CRYPTO_LEN_SIZE); + + if (jcr->crypto_packet_len == 0 || jcr->crypto_buf_len < jcr->crypto_packet_len) { + /* No full preserved block is available. */ + return 0; + } + + /* We have one full block, set up the filter input buffers */ + wsize = jcr->crypto_packet_len - CRYPTO_LEN_SIZE; + wbuf = &wbuf[CRYPTO_LEN_SIZE]; /* Skip the block length header */ + jcr->crypto_buf_len -= jcr->crypto_packet_len; + Dmsg2(30, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, jcr->crypto_buf_len); + } + + if (flags & FO_SPARSE) { + if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) { + return -1; + } + } + + if (flags & FO_GZIP) { + if (!decompress_data(jcr, &wbuf, &wsize)) { + return -1; + } + } else { + Dmsg2(30, "Write %u bytes, total before write=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1)); + } + + if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) { + return -1; + } + + jcr->JobBytes += wsize; + *addr += wsize; + + /* Clean up crypto buffers */ + if (flags & FO_ENCRYPT) { + /* Move any remaining data to start of buffer */ + if (jcr->crypto_buf_len > 0) { + Dmsg1(30, "Moving %u buffered bytes to start of buffer\n", jcr->crypto_buf_len); + memmove(jcr->crypto_buf, &jcr->crypto_buf[jcr->crypto_packet_len], + jcr->crypto_buf_len); + } + /* The packet was successfully written, reset the length so that the next + * packet length may be re-read by unser_crypto_packet_len() */ + jcr->crypto_packet_len = 0; + } + + return wsize; +} + +/* + * In the context of jcr, flush any remaining data from the cipher context, + * writing it to bfd. + * Return value is true on success, false on failure. + */ +bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags, CIPHER_CONTEXT *cipher, + uint32_t cipher_block_size) +{ + uint32_t decrypted_len; + char *wbuf; /* write buffer */ + uint32_t wsize; /* write size */ + char ec1[50]; /* Buffer printing huge values */ + + /* Write out the remaining block and free the cipher context */ + jcr->crypto_buf = check_pool_memory_size(jcr->crypto_buf, jcr->crypto_buf_len + + cipher_block_size); + + if (!crypto_cipher_finalize(cipher, (uint8_t *)&jcr->crypto_buf[jcr->crypto_buf_len], + &decrypted_len)) { + /* Writing out the final, buffered block failed. Shouldn't happen. */ + Jmsg1(jcr, M_FATAL, 0, _("Decryption error for %s\n"), jcr->last_fname); + } + + /* If nothing new was decrypted, and our output buffer is empty, return */ + if (decrypted_len == 0 && jcr->crypto_buf_len == 0) { + return true; + } + + jcr->crypto_buf_len += decrypted_len; + + unser_crypto_packet_len(jcr); + Dmsg1(500, "Crypto unser block size=%d\n", jcr->crypto_packet_len - CRYPTO_LEN_SIZE); + wsize = jcr->crypto_packet_len - CRYPTO_LEN_SIZE; + wbuf = &jcr->crypto_buf[CRYPTO_LEN_SIZE]; /* Decrypted, possibly decompressed output here. */ + + if (jcr->crypto_buf_len != jcr->crypto_packet_len) { + Jmsg2(jcr, M_FATAL, 0, + _("Unexpected number of bytes remaining at end of file, received %u, expected %u\n"), + jcr->crypto_packet_len, jcr->crypto_buf_len); + return false; + } + + jcr->crypto_buf_len = 0; + jcr->crypto_packet_len = 0; + + if (flags & FO_SPARSE) { + if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) { + return false; + } + } + + if (flags & FO_GZIP) { + decompress_data(jcr, &wbuf, &wsize); + } else { + Dmsg2(30, "Write %u bytes, total before write=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1)); + } + + if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) { + return false; + } + + jcr->JobBytes += wsize; + + return true; +}