2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
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
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.
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
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.
29 * Bacula File Daemon restore.c Restorefiles.
31 * Kern Sibbald, November MM
41 const bool have_darwin_os = true;
43 const bool have_darwin_os = false;
46 #if defined(HAVE_CRYPTO)
47 const bool have_crypto = true;
49 const bool have_crypto = false;
53 const bool have_acl = true;
55 const bool have_acl = false;
59 const bool have_sha2 = true;
61 const bool have_sha2 = false;
64 #if defined(HAVE_XATTR)
65 const bool have_xattr = true;
67 const bool have_xattr = false;
71 * Data received from Storage Daemon
73 static char rec_header[] = "rechdr %ld %ld %ld %ld %ld";
76 * Forward referenced functions
78 #if defined(HAVE_LIBZ)
79 static const char *zlib_strerror(int stat);
80 const bool have_libz = true;
82 const bool have_libz = false;
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);
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);
98 * Close a bfd check that we are at the expected file offset.
99 * Makes use of some code from set_attributes().
101 static int bclose_chksize(JCR *jcr, BFILE *bfd, boffset_t osize)
103 char ec1[50], ec2[50];
106 fsize = blseek(bfd, 0, SEEK_CUR);
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));
117 #ifdef HAVE_DARWIN_OS
118 bool restore_finderinfo(JCR *jcr, POOLMEM *buf, int32_t buflen)
120 struct attrlist attrList;
122 memset(&attrList, 0, sizeof(attrList));
123 attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
124 attrList.commonattr = ATTR_CMN_FNDRINFO;
126 Dmsg0(130, "Restoring Finder Info\n");
127 jcr->ff->flags |= FO_HFSPLUS;
129 Jmsg(jcr, M_ERROR, 0, _("Invalid length of Finder Info (got %d, not 32)\n"), buflen);
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);
141 bool restore_finderinfo(JCR *jcr, POOLMEM *buf, int32_t buflen)
148 * Restore the requested files.
150 void do_restore(JCR *jcr)
153 uint32_t VolSessionId, VolSessionTime;
155 char ec1[50]; /* Buffer printing huge values */
156 uint32_t buf_size; /* client buffer size */
158 intmax_t rsrc_len = 0; /* Original length of resource fork */
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));
168 * The following variables keep track of "known unknowns"
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;
179 sd = jcr->store_bsock;
180 set_jcr_job_status(jcr, JS_Running);
183 CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL);
186 buf_size = client->max_network_buffer_size;
188 buf_size = 0; /* use default */
190 if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) {
191 set_jcr_job_status(jcr, JS_ErrorTerminated);
194 jcr->buf_size = sd->msglen;
197 * St Bernard code goes here if implemented -- see end of file
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;
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);
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)
225 * h. Possibly a cryptographic signature
226 * i. Possibly MD5 or SHA1 record
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
237 * The expected size of the stream, fork_len, should be set when
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, ...
243 binit(&rctx.forkbfd);
244 attr = rctx.attr = new_attr(jcr);
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);
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);
256 while (bget_msg(sd) >= 0 && !job_canceled(jcr)) {
258 * Remember previous stream type
260 rctx.prev_stream = rctx.stream;
263 * First we expect a Stream Record Header
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);
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));
274 * Now we expect the Stream Data
276 if (bget_msg(sd) < 0) {
277 Jmsg1(jcr, M_FATAL, 0, _("Data record error. ERR=%s\n"), sd->bstrerror());
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);
287 Dmsg3(130, "Got stream: %s len=%d extract=%d\n", stream_to_ascii(rctx.stream),
288 sd->msglen, rctx.extract);
291 * If we change streams, close and reset alternate data streams
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);
299 * Use an impossible value and set a proper one below
306 * File Attributes stream
308 switch (rctx.stream) {
309 case STREAM_UNIX_ATTRIBUTES:
310 case STREAM_UNIX_ATTRIBUTES_EX:
312 * if any previous stream open, close it
314 close_previous_stream(rctx);
317 * TODO: manage deleted files
319 if (rctx.type == FT_DELETED) { /* deleted file */
323 * Restore objects should be ignored here -- they are
324 * returned at the beginning of the restore.
326 if (rctx.type == FT_RESTORE_FIRST) {
331 * Unpack attributes and do sanity check them
333 if (!unpack_attributes_record(jcr, rctx.stream, sd->msg, sd->msglen, attr)) {
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);
342 attr->data_stream = decode_stat(attr->attr, &attr->statp, &attr->LinkFI);
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));
352 build_attr_output_fnames(jcr, attr);
355 * Try to actually create the file, which returns a status telling
356 * us if we need to extract or not.
358 jcr->num_files_examined++;
359 rctx.extract = false;
361 stat = plugin_create_file(jcr, attr, &rctx.bfd, jcr->replace);
363 stat = create_file(jcr, attr, &rctx.bfd, jcr->replace);
366 pm_strcpy(jcr->last_fname, attr->ofname);
367 jcr->last_type = attr->type;
369 Dmsg2(130, "Outfile=%s create_file stat=%d\n", attr->ofname, stat);
373 pm_strcpy(jcr->last_fname, attr->ofname);
374 jcr->last_type = attr->type;
378 * File created and we expect file data
386 * File created, but there is no content
389 print_ls_output(jcr, attr);
391 if (have_darwin_os) {
393 * Only restore the resource fork for regular files
395 from_base64(&rsrc_len, attr->attrEx);
396 if (attr->type == FT_REG && rsrc_len > 0) {
401 * Count the resource forks not as regular files being restored.
412 * set attributes now because file will not be extracted
415 plugin_set_attributes(jcr, attr, &rctx.bfd);
417 set_attributes(jcr, attr, &rctx.bfd);
427 case STREAM_ENCRYPTED_SESSION_DATA:
428 crypto_error_t cryptoerr;
431 * Is this an unexpected session data entry?
434 Jmsg0(jcr, M_ERROR, 0, _("Unexpected cryptographic session data stream.\n"));
435 rctx.extract = false;
441 * Do we have any keys at all?
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;
450 if (jcr->crypto.digest) {
451 crypto_digest_free(jcr->crypto.digest);
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;
462 * Decode and save session keys.
464 cryptoerr = crypto_session_decode((uint8_t *)sd->msg, (uint32_t)sd->msglen,
465 jcr->crypto.pki_recipients, &rctx.cs);
467 case CRYPTO_ERROR_NONE:
472 case CRYPTO_ERROR_NORECIPIENT:
473 Jmsg(jcr, M_ERROR, 0, _("Missing private key required to decrypt encrypted backup data.\n"));
475 case CRYPTO_ERROR_DECRYPTION:
476 Jmsg(jcr, M_ERROR, 0, _("Decrypt of the session key failed.\n"));
482 Jmsg1(jcr, M_ERROR, 0, _("An error occurred while decoding encrypted session data stream: %s\n"), crypto_strerror(cryptoerr));
486 if (cryptoerr != CRYPTO_ERROR_NONE) {
487 rctx.extract = false;
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:
505 * Force an expected, consistent stream type here
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)) {
513 if (rctx.stream == STREAM_SPARSE_DATA ||
514 rctx.stream == STREAM_SPARSE_GZIP_DATA) {
515 rctx.flags |= FO_SPARSE;
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;
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) {
531 * Set up a decryption context
533 if (!rctx.cipher_ctx.cipher) {
535 Jmsg1(jcr, M_ERROR, 0, _("Missing encryption session data stream for %s\n"), jcr->last_fname);
536 rctx.extract = false;
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);
545 rctx.extract = false;
550 rctx.flags |= FO_ENCRYPT;
553 if (is_win32_stream(rctx.stream) && !have_win32_api()) {
554 set_portable_backup(&rctx.bfd);
556 * "decompose" BackupWrite data
558 rctx.flags |= FO_WIN32DECOMP;
561 if (extract_data(jcr, &rctx.bfd, sd->msg, sd->msglen, &rctx.fileAddr,
562 rctx.flags, &rctx.cipher_ctx) < 0) {
563 rctx.extract = false;
571 * Resource fork stream - only recorded after a file to be restored
572 * Silently ignore if we cannot write - we already reported that
574 case STREAM_ENCRYPTED_MACOS_FORK_DATA:
575 case STREAM_MACOS_FORK_DATA:
576 if (have_darwin_os) {
578 jcr->ff->flags |= FO_HFSPLUS;
580 if (rctx.stream == STREAM_ENCRYPTED_MACOS_FORK_DATA) {
581 rctx.fork_flags |= FO_ENCRYPT;
584 * Set up a decryption context
586 if (rctx.extract && !rctx.fork_cipher_ctx.cipher) {
588 Jmsg1(jcr, M_ERROR, 0, _("Missing encryption session data stream for %s\n"), jcr->last_fname);
589 rctx.extract = false;
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);
597 rctx.extract = false;
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;
612 rctx.fork_size = rsrc_len;
613 Dmsg0(130, "Restoring resource fork\n");
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);
628 case STREAM_HFSPLUS_ATTRIBUTES:
629 if (have_darwin_os) {
630 if (!restore_finderinfo(jcr, sd->msg, sd->msglen)) {
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:
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
663 if ((!rctx.extract && jcr->last_type != FT_DIREND) || (*jcr->last_fname == 0)) {
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:
672 case bacl_exit_error:
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.
677 if (jcr->acl_data->nr_errors < ACL_REPORT_ERR_MAX_PER_JOB) {
678 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
680 jcr->acl_data->nr_errors++;
690 case STREAM_XATTR_TRU64:
691 case STREAM_XATTR_AIX:
692 case STREAM_XATTR_OPENBSD:
693 case STREAM_XATTR_SOLARIS_SYS:
694 case STREAM_XATTR_SOLARIS:
695 case STREAM_XATTR_DARWIN:
696 case STREAM_XATTR_FREEBSD:
697 case STREAM_XATTR_LINUX:
698 case STREAM_XATTR_NETBSD:
700 * Do not restore Extended Attributes when
701 * a) The current file is not extracted
702 * b) and it is not a directory (they are never "extracted")
703 * c) or the file name is empty
705 if ((!rctx.extract && jcr->last_type != FT_DIREND) || (*jcr->last_fname == 0)) {
709 pm_memcpy(jcr->xattr_data->content, sd->msg, sd->msglen);
710 jcr->xattr_data->content_length = sd->msglen;
711 switch (parse_xattr_streams(jcr, rctx.stream)) {
712 case bxattr_exit_fatal:
714 case bxattr_exit_error:
716 * Non-fatal errors, count them and when the number is under XATTR_REPORT_ERR_MAX_PER_JOB
717 * print the error message set by the lower level routine in jcr->errmsg.
719 if (jcr->xattr_data->nr_errors < XATTR_REPORT_ERR_MAX_PER_JOB) {
720 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
722 jcr->xattr_data->nr_errors++;
732 case STREAM_SIGNED_DIGEST:
734 * Is this an unexpected signature?
737 Jmsg0(jcr, M_ERROR, 0, _("Unexpected cryptographic signature data stream.\n"));
738 free_signature(rctx);
744 if (rctx.extract && (rctx.sig = crypto_sign_decode(jcr, (uint8_t *)sd->msg, (uint32_t)sd->msglen)) == NULL) {
745 Jmsg1(jcr, M_ERROR, 0, _("Failed to decode message signature for %s\n"), jcr->last_fname);
749 case STREAM_MD5_DIGEST:
750 case STREAM_SHA1_DIGEST:
751 case STREAM_SHA256_DIGEST:
752 case STREAM_SHA512_DIGEST:
755 case STREAM_PROGRAM_NAMES:
756 case STREAM_PROGRAM_DATA:
757 if (!non_support_progname) {
758 Pmsg0(000, "Got Program Name or Data Stream. Ignored.\n");
759 non_support_progname++;
763 case STREAM_PLUGIN_NAME:
764 close_previous_stream(rctx);
765 Dmsg1(50, "restore stream_plugin_name=%s\n", sd->msg);
766 plugin_name_stream(jcr, sd->msg);
769 case STREAM_RESTORE_OBJECT:
770 break; /* these are sent by Director */
773 close_previous_stream(rctx);
774 Jmsg(jcr, M_ERROR, 0, _("Unknown stream=%d ignored. This shouldn't happen!\n"),
776 Dmsg2(0, "Unknown stream=%d data=%s\n", rctx.stream, sd->msg);
778 } /* end switch(stream) */
779 } /* end while get_msg() */
782 * If output file is still open, it was the last one in the
783 * archive since we just hit an end of file, so close the file.
785 if (is_bopen(&rctx.forkbfd)) {
786 bclose_chksize(jcr, &rctx.forkbfd, rctx.fork_size);
789 close_previous_stream(rctx);
790 set_jcr_job_status(jcr, JS_Terminated);
794 set_jcr_job_status(jcr, JS_ErrorTerminated);
798 * First output the statistics.
800 Dmsg2(10, "End Do Restore. Files=%d Bytes=%s\n", jcr->JobFiles,
801 edit_uint64(jcr->JobBytes, ec1));
802 if (have_acl && jcr->acl_data->nr_errors > 0) {
803 Jmsg(jcr, M_ERROR, 0, _("Encountered %ld acl errors while doing restore\n"),
804 jcr->acl_data->nr_errors);
806 if (have_xattr && jcr->xattr_data->nr_errors > 0) {
807 Jmsg(jcr, M_ERROR, 0, _("Encountered %ld xattr errors while doing restore\n"),
808 jcr->xattr_data->nr_errors);
810 if (non_support_data > 1 || non_support_attr > 1) {
811 Jmsg(jcr, M_ERROR, 0, _("%d non-supported data streams and %d non-supported attrib streams ignored.\n"),
812 non_support_data, non_support_attr);
814 if (non_support_rsrc) {
815 Jmsg(jcr, M_INFO, 0, _("%d non-supported resource fork streams ignored.\n"), non_support_rsrc);
817 if (non_support_finfo) {
818 Jmsg(jcr, M_INFO, 0, _("%d non-supported Finder Info streams ignored.\n"), non_support_rsrc);
820 if (non_support_acl) {
821 Jmsg(jcr, M_INFO, 0, _("%d non-supported acl streams ignored.\n"), non_support_acl);
823 if (non_support_crypto) {
824 Jmsg(jcr, M_INFO, 0, _("%d non-supported crypto streams ignored.\n"), non_support_acl);
826 if (non_support_xattr) {
827 Jmsg(jcr, M_INFO, 0, _("%d non-supported xattr streams ignored.\n"), non_support_xattr);
831 * Free Signature & Crypto Data
833 free_signature(rctx);
835 if (jcr->crypto.digest) {
836 crypto_digest_free(jcr->crypto.digest);
837 jcr->crypto.digest = NULL;
841 * Free file cipher restore context
843 if (rctx.cipher_ctx.cipher) {
844 crypto_cipher_free(rctx.cipher_ctx.cipher);
845 rctx.cipher_ctx.cipher = NULL;
848 if (rctx.cipher_ctx.buf) {
849 free_pool_memory(rctx.cipher_ctx.buf);
850 rctx.cipher_ctx.buf = NULL;
854 * Free alternate stream cipher restore context
856 if (rctx.fork_cipher_ctx.cipher) {
857 crypto_cipher_free(rctx.fork_cipher_ctx.cipher);
858 rctx.fork_cipher_ctx.cipher = NULL;
860 if (rctx.fork_cipher_ctx.buf) {
861 free_pool_memory(rctx.fork_cipher_ctx.buf);
862 rctx.fork_cipher_ctx.buf = NULL;
865 if (jcr->compress_buf) {
866 free_pool_memory(jcr->compress_buf);
867 jcr->compress_buf = NULL;
868 jcr->compress_buf_size = 0;
871 if (have_acl && jcr->acl_data) {
872 free_pool_memory(jcr->acl_data->content);
874 jcr->acl_data = NULL;
877 if (have_xattr && jcr->xattr_data) {
878 free_pool_memory(jcr->xattr_data->content);
879 free(jcr->xattr_data);
880 jcr->xattr_data = NULL;
883 bclose(&rctx.forkbfd);
885 free_attr(rctx.attr);
890 * Convert ZLIB error code into an ASCII message
892 static const char *zlib_strerror(int stat)
899 return _("Zlib errno");
901 return _("Zlib stream error");
903 return _("Zlib data error");
905 return _("Zlib memory error");
907 return _("Zlib buffer error");
908 case Z_VERSION_ERROR:
909 return _("Zlib version error");
916 static int do_file_digest(JCR *jcr, FF_PKT *ff_pkt, bool top_level)
918 Dmsg1(50, "do_file_digest jcr=%p\n", jcr);
919 return (digest_file(jcr, ff_pkt, jcr->crypto.digest));
923 * Verify the signature for the last restored file
924 * Return value is either true (signature correct)
925 * or false (signature could not be verified).
926 * TODO landonf: Implement without using find_one_file and
927 * without re-reading the file.
929 static bool verify_signature(JCR *jcr, r_ctx &rctx)
931 X509_KEYPAIR *keypair;
932 DIGEST *digest = NULL;
934 uint64_t saved_bytes;
935 crypto_digest_t signing_algorithm = have_sha2 ?
936 CRYPTO_DIGEST_SHA256 : CRYPTO_DIGEST_SHA1;
937 crypto_digest_t algorithm;
938 SIGNATURE *sig = rctx.sig;
941 if (!jcr->crypto.pki_sign) {
948 if (rctx.type == FT_REGE || rctx.type == FT_REG || rctx.type == FT_RAW) {
949 Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"),
957 * Iterate through the trusted signers
959 foreach_alist(keypair, jcr->crypto.pki_signers) {
960 err = crypto_sign_get_digest(sig, jcr->crypto.pki_keypair, algorithm, &digest);
962 case CRYPTO_ERROR_NONE:
963 Dmsg0(50, "== Got digest\n");
965 * We computed jcr->crypto.digest using signing_algorithm while writing
966 * the file. If it is not the same as the algorithm used for
967 * this file, punt by releasing the computed algorithm and
968 * computing by re-reading the file.
970 if (algorithm != signing_algorithm) {
971 if (jcr->crypto.digest) {
972 crypto_digest_free(jcr->crypto.digest);
973 jcr->crypto.digest = NULL;
976 if (jcr->crypto.digest) {
978 * Use digest computed while writing the file to verify the signature
980 if ((err = crypto_sign_verify(sig, keypair, jcr->crypto.digest)) != CRYPTO_ERROR_NONE) {
981 Dmsg1(50, "Bad signature on %s\n", jcr->last_fname);
982 Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for file %s: ERR=%s\n"),
983 jcr->last_fname, crypto_strerror(err));
988 * Signature found, digest allocated. Old method,
989 * re-read the file and compute the digest
991 jcr->crypto.digest = digest;
994 * Checksum the entire file
995 * Make sure we don't modify JobBytes by saving and restoring it
997 saved_bytes = jcr->JobBytes;
998 if (find_one_file(jcr, jcr->ff, do_file_digest, jcr->last_fname, (dev_t)-1, 1) != 0) {
999 Jmsg(jcr, M_ERROR, 0, _("Digest one file failed for file: %s\n"),
1001 jcr->JobBytes = saved_bytes;
1004 jcr->JobBytes = saved_bytes;
1007 * Verify the signature
1009 if ((err = crypto_sign_verify(sig, keypair, digest)) != CRYPTO_ERROR_NONE) {
1010 Dmsg1(50, "Bad signature on %s\n", jcr->last_fname);
1011 Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for file %s: ERR=%s\n"),
1012 jcr->last_fname, crypto_strerror(err));
1015 jcr->crypto.digest = NULL;
1021 Dmsg1(50, "Signature good on %s\n", jcr->last_fname);
1022 crypto_digest_free(digest);
1025 case CRYPTO_ERROR_NOSIGNER:
1027 * Signature not found, try again
1030 crypto_digest_free(digest);
1036 * Something strange happened (that shouldn't happen!)...
1038 Qmsg2(jcr, M_ERROR, 0, _("Signature validation failed for %s: %s\n"), jcr->last_fname, crypto_strerror(err));
1046 Dmsg1(50, "Could not find a valid public key for signature on %s\n", jcr->last_fname);
1050 crypto_digest_free(digest);
1055 bool sparse_data(JCR *jcr, BFILE *bfd, uint64_t *addr, char **data, uint32_t *length)
1060 unser_begin(*data, SPARSE_FADDR_SIZE);
1061 unser_uint64(faddr);
1062 if (*addr != faddr) {
1064 if (blseek(bfd, (boffset_t)*addr, SEEK_SET) < 0) {
1066 Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"),
1067 edit_uint64(*addr, ec1), jcr->last_fname,
1068 be.bstrerror(bfd->berrno));
1072 *data += SPARSE_FADDR_SIZE;
1073 *length -= SPARSE_FADDR_SIZE;
1077 bool decompress_data(JCR *jcr, char **data, uint32_t *length)
1082 char ec1[50]; /* Buffer printing huge values */
1085 * NOTE! We only use uLong and Byte because they are
1086 * needed by the zlib routines, they should not otherwise
1087 * be used in Bacula.
1089 compress_len = jcr->compress_buf_size;
1090 Dmsg2(200, "Comp_len=%d msglen=%d\n", compress_len, *length);
1091 while ((stat=uncompress((Byte *)jcr->compress_buf, &compress_len,
1092 (const Byte *)*data, (uLong)*length)) == Z_BUF_ERROR)
1095 * The buffer size is too small, try with a bigger one
1097 compress_len = jcr->compress_buf_size = jcr->compress_buf_size + (jcr->compress_buf_size >> 1);
1098 Dmsg2(200, "Comp_len=%d msglen=%d\n", compress_len, *length);
1099 jcr->compress_buf = check_pool_memory_size(jcr->compress_buf,
1103 Qmsg(jcr, M_ERROR, 0, _("Uncompression error on file %s. ERR=%s\n"),
1104 jcr->last_fname, zlib_strerror(stat));
1107 *data = jcr->compress_buf;
1108 *length = compress_len;
1109 Dmsg2(200, "Write uncompressed %d bytes, total before write=%s\n", compress_len, edit_uint64(jcr->JobBytes, ec1));
1112 Qmsg(jcr, M_ERROR, 0, _("GZIP data stream found, but GZIP not configured!\n"));
1117 static void unser_crypto_packet_len(RESTORE_CIPHER_CTX *ctx)
1120 if (ctx->packet_len == 0 && ctx->buf_len >= CRYPTO_LEN_SIZE) {
1121 unser_begin(&ctx->buf[0], CRYPTO_LEN_SIZE);
1122 unser_uint32(ctx->packet_len);
1123 ctx->packet_len += CRYPTO_LEN_SIZE;
1127 bool store_data(JCR *jcr, BFILE *bfd, char *data, const int32_t length, bool win32_decomp)
1129 if (jcr->crypto.digest) {
1130 crypto_digest_update(jcr->crypto.digest, (uint8_t *)data, length);
1133 if (!processWin32BackupAPIBlock(bfd, data, length)) {
1135 Jmsg2(jcr, M_ERROR, 0, _("Write error in Win32 Block Decomposition on %s: %s\n"),
1136 jcr->last_fname, be.bstrerror(bfd->berrno));
1139 } else if (bwrite(bfd, data, length) != (ssize_t)length) {
1141 Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: %s\n"),
1142 jcr->last_fname, be.bstrerror(bfd->berrno));
1150 * In the context of jcr, write data to bfd.
1151 * We write buflen bytes in buf at addr. addr is updated in place.
1152 * The flags specify whether to use sparse files or compression.
1153 * Return value is the number of bytes written, or -1 on errors.
1155 int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen,
1156 uint64_t *addr, int flags, RESTORE_CIPHER_CTX *cipher_ctx)
1158 char *wbuf; /* write buffer */
1159 uint32_t wsize; /* write size */
1160 uint32_t rsize; /* read size */
1161 uint32_t decrypted_len = 0; /* Decryption output length */
1162 char ec1[50]; /* Buffer printing huge values */
1165 jcr->ReadBytes += rsize;
1169 if (flags & FO_ENCRYPT) {
1170 ASSERT(cipher_ctx->cipher);
1173 * NOTE: We must implement block preserving semantics for the
1174 * non-streaming compression and sparse code.
1176 * Grow the crypto buffer, if necessary.
1177 * crypto_cipher_update() will process only whole blocks,
1178 * buffering the remaining input.
1180 cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf,
1181 cipher_ctx->buf_len + wsize + cipher_ctx->block_size);
1184 * Decrypt the input block
1186 if (!crypto_cipher_update(cipher_ctx->cipher,
1187 (const u_int8_t *)wbuf,
1189 (u_int8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1192 * Decryption failed. Shouldn't happen.
1194 Jmsg(jcr, M_FATAL, 0, _("Decryption error\n"));
1198 if (decrypted_len == 0) {
1200 * No full block of encrypted data available, write more data
1205 Dmsg2(200, "decrypted len=%d encrypted len=%d\n", decrypted_len, wsize);
1207 cipher_ctx->buf_len += decrypted_len;
1208 wbuf = cipher_ctx->buf;
1211 * If one full preserved block is available, write it to disk,
1212 * and then buffer any remaining data. This should be effecient
1213 * as long as Bacula's block size is not significantly smaller than the
1214 * encryption block size (extremely unlikely!)
1216 unser_crypto_packet_len(cipher_ctx);
1217 Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1219 if (cipher_ctx->packet_len == 0 || cipher_ctx->buf_len < cipher_ctx->packet_len) {
1221 * No full preserved block is available.
1227 * We have one full block, set up the filter input buffers
1229 wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1230 wbuf = &wbuf[CRYPTO_LEN_SIZE]; /* Skip the block length header */
1231 cipher_ctx->buf_len -= cipher_ctx->packet_len;
1232 Dmsg2(130, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1235 if (flags & FO_SPARSE) {
1236 if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1241 if (flags & FO_GZIP) {
1242 if (!decompress_data(jcr, &wbuf, &wsize)) {
1247 if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1250 jcr->JobBytes += wsize;
1252 Dmsg2(130, "Write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1255 * Clean up crypto buffers
1257 if (flags & FO_ENCRYPT) {
1258 /* Move any remaining data to start of buffer */
1259 if (cipher_ctx->buf_len > 0) {
1260 Dmsg1(130, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1261 memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1262 cipher_ctx->buf_len);
1265 * The packet was successfully written, reset the length so that the next
1266 * packet length may be re-read by unser_crypto_packet_len()
1268 cipher_ctx->packet_len = 0;
1278 * If extracting, close any previous stream
1280 static void close_previous_stream(r_ctx &rctx)
1283 * If extracting, it was from previous stream, so
1284 * close the output file and validate the signature.
1287 if (rctx.size > 0 && !is_bopen(&rctx.bfd)) {
1288 Jmsg0(rctx.jcr, M_ERROR, 0, _("Logic error: output file should be open\n"));
1289 Dmsg2(000, "=== logic error size=%d bopen=%d\n", rctx.size,
1290 is_bopen(&rctx.bfd));
1293 if (rctx.prev_stream != STREAM_ENCRYPTED_SESSION_DATA) {
1294 deallocate_cipher(rctx);
1295 deallocate_fork_cipher(rctx);
1298 if (rctx.jcr->plugin) {
1299 plugin_set_attributes(rctx.jcr, rctx.attr, &rctx.bfd);
1301 set_attributes(rctx.jcr, rctx.attr, &rctx.bfd);
1303 rctx.extract = false;
1306 * Verify the cryptographic signature, if any
1308 rctx.type = rctx.attr->type;
1309 verify_signature(rctx.jcr, rctx);
1314 free_signature(rctx);
1316 rctx.jcr->ff->flags = 0;
1317 Dmsg0(130, "Stop extracting.\n");
1318 } else if (is_bopen(&rctx.bfd)) {
1319 Jmsg0(rctx.jcr, M_ERROR, 0, _("Logic error: output file should not be open\n"));
1320 Dmsg0(000, "=== logic error !open\n");
1327 * In the context of jcr, flush any remaining data from the cipher context,
1328 * writing it to bfd.
1329 * Return value is true on success, false on failure.
1331 bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags,
1332 RESTORE_CIPHER_CTX *cipher_ctx)
1334 uint32_t decrypted_len = 0;
1335 char *wbuf; /* write buffer */
1336 uint32_t wsize; /* write size */
1337 char ec1[50]; /* Buffer printing huge values */
1338 bool second_pass = false;
1342 * Write out the remaining block and free the cipher context
1344 cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf, cipher_ctx->buf_len +
1345 cipher_ctx->block_size);
1347 if (!crypto_cipher_finalize(cipher_ctx->cipher, (uint8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1350 * Writing out the final, buffered block failed. Shouldn't happen.
1352 Jmsg3(jcr, M_ERROR, 0, _("Decryption error. buf_len=%d decrypt_len=%d on file %s\n"),
1353 cipher_ctx->buf_len, decrypted_len, jcr->last_fname);
1356 Dmsg2(130, "Flush decrypt len=%d buf_len=%d\n", decrypted_len, cipher_ctx->buf_len);
1358 * If nothing new was decrypted, and our output buffer is empty, return
1360 if (decrypted_len == 0 && cipher_ctx->buf_len == 0) {
1364 cipher_ctx->buf_len += decrypted_len;
1366 unser_crypto_packet_len(cipher_ctx);
1367 Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1368 wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1370 * Decrypted, possibly decompressed output here.
1372 wbuf = &cipher_ctx->buf[CRYPTO_LEN_SIZE];
1373 cipher_ctx->buf_len -= cipher_ctx->packet_len;
1374 Dmsg2(130, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1376 if (flags & FO_SPARSE) {
1377 if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1382 if (flags & FO_GZIP) {
1383 if (!decompress_data(jcr, &wbuf, &wsize)) {
1388 Dmsg0(130, "Call store_data\n");
1389 if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1392 jcr->JobBytes += wsize;
1393 Dmsg2(130, "Flush write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1396 * Move any remaining data to start of buffer
1398 if (cipher_ctx->buf_len > 0) {
1399 Dmsg1(130, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1400 memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1401 cipher_ctx->buf_len);
1404 * The packet was successfully written, reset the length so that the next
1405 * packet length may be re-read by unser_crypto_packet_len()
1407 cipher_ctx->packet_len = 0;
1409 if (cipher_ctx->buf_len >0 && !second_pass) {
1417 cipher_ctx->buf_len = 0;
1418 cipher_ctx->packet_len = 0;
1423 static void deallocate_cipher(r_ctx &rctx)
1426 * Flush and deallocate previous stream's cipher context
1428 if (rctx.cipher_ctx.cipher) {
1429 flush_cipher(rctx.jcr, &rctx.bfd, &rctx.fileAddr, rctx.flags, &rctx.cipher_ctx);
1430 crypto_cipher_free(rctx.cipher_ctx.cipher);
1431 rctx.cipher_ctx.cipher = NULL;
1435 static void deallocate_fork_cipher(r_ctx &rctx)
1439 * Flush and deallocate previous stream's fork cipher context
1441 if (rctx.fork_cipher_ctx.cipher) {
1442 flush_cipher(rctx.jcr, &rctx.forkbfd, &rctx.fork_addr, rctx.fork_flags, &rctx.fork_cipher_ctx);
1443 crypto_cipher_free(rctx.fork_cipher_ctx.cipher);
1444 rctx.fork_cipher_ctx.cipher = NULL;
1448 static void free_signature(r_ctx &rctx)
1451 crypto_sign_free(rctx.sig);
1456 static void free_session(r_ctx &rctx)
1459 crypto_session_free(rctx.cs);
1466 * This code if implemented goes above
1468 #ifdef stbernard_implemented
1469 / #if defined(HAVE_WIN32)
1470 bool bResumeOfmOnExit = FALSE;
1471 if (isOpenFileManagerRunning()) {
1472 if ( pauseOpenFileManager() ) {
1473 Jmsg(jcr, M_INFO, 0, _("Open File Manager paused\n") );
1474 bResumeOfmOnExit = TRUE;
1477 Jmsg(jcr, M_ERROR, 0, _("FAILED to pause Open File Manager\n") );
1481 char username[UNLEN+1];
1482 DWORD usize = sizeof(username);
1483 int privs = enable_backup_privileges(NULL, 1);
1484 if (GetUserName(username, &usize)) {
1485 Jmsg2(jcr, M_INFO, 0, _("Running as '%s'. Privmask=%#08x\n"), username,
1487 Jmsg(jcr, M_WARNING, 0, _("Failed to retrieve current UserName\n"));