2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 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 two of the GNU 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 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(50, "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 */
324 * Unpack attributes and do sanity check them
326 if (!unpack_attributes_record(jcr, rctx.stream, sd->msg, attr)) {
330 if (file_index != attr->file_index) {
331 Jmsg(jcr, M_FATAL, 0, _("Record header file index %ld not equal record index %ld\n"),
332 file_index, attr->file_index);
333 Dmsg0(200, "File index error\n");
338 Dmsg3(200, "File %s\nattrib=%s\nattribsEx=%s\n", attr->fname,
339 attr->attr, attr->attrEx);
341 attr->data_stream = decode_stat(attr->attr, &attr->statp, &attr->LinkFI);
343 if (!is_restore_stream_supported(attr->data_stream)) {
344 if (!non_support_data++) {
345 Jmsg(jcr, M_ERROR, 0, _("%s stream not supported on this Client.\n"),
346 stream_to_ascii(attr->data_stream));
351 build_attr_output_fnames(jcr, attr);
354 * Try to actually create the file, which returns a status telling
355 * us if we need to extract or not.
357 jcr->num_files_examined++;
358 rctx.extract = false;
360 stat = plugin_create_file(jcr, attr, &rctx.bfd, jcr->replace);
362 stat = create_file(jcr, attr, &rctx.bfd, jcr->replace);
365 pm_strcpy(jcr->last_fname, attr->ofname);
366 jcr->last_type = attr->type;
368 Dmsg2(130, "Outfile=%s create_file stat=%d\n", attr->ofname, stat);
372 pm_strcpy(jcr->last_fname, attr->ofname);
373 jcr->last_type = attr->type;
377 * File created and we expect file data
385 * File created, but there is no content
388 print_ls_output(jcr, attr);
390 if (have_darwin_os) {
392 * Only restore the resource fork for regular files
394 from_base64(&rsrc_len, attr->attrEx);
395 if (attr->type == FT_REG && rsrc_len > 0) {
400 * Count the resource forks not as regular files being restored.
411 * set attributes now because file will not be extracted
414 plugin_set_attributes(jcr, attr, &rctx.bfd);
416 set_attributes(jcr, attr, &rctx.bfd);
426 case STREAM_ENCRYPTED_SESSION_DATA:
427 crypto_error_t cryptoerr;
430 * Is this an unexpected session data entry?
433 Jmsg0(jcr, M_ERROR, 0, _("Unexpected cryptographic session data stream.\n"));
434 rctx.extract = false;
440 * Do we have any keys at all?
442 if (!jcr->crypto.pki_recipients) {
443 Jmsg(jcr, M_ERROR, 0, _("No private decryption keys have been defined to decrypt encrypted backup data.\n"));
444 rctx.extract = false;
449 if (jcr->crypto.digest) {
450 crypto_digest_free(jcr->crypto.digest);
452 jcr->crypto.digest = crypto_digest_new(jcr, signing_algorithm);
453 if (!jcr->crypto.digest) {
454 Jmsg0(jcr, M_FATAL, 0, _("Could not create digest.\n"));
455 rctx.extract = false;
461 * Decode and save session keys.
463 cryptoerr = crypto_session_decode((uint8_t *)sd->msg, (uint32_t)sd->msglen,
464 jcr->crypto.pki_recipients, &rctx.cs);
466 case CRYPTO_ERROR_NONE:
471 case CRYPTO_ERROR_NORECIPIENT:
472 Jmsg(jcr, M_ERROR, 0, _("Missing private key required to decrypt encrypted backup data.\n"));
474 case CRYPTO_ERROR_DECRYPTION:
475 Jmsg(jcr, M_ERROR, 0, _("Decrypt of the session key failed.\n"));
481 Jmsg1(jcr, M_ERROR, 0, _("An error occurred while decoding encrypted session data stream: %s\n"), crypto_strerror(cryptoerr));
485 if (cryptoerr != CRYPTO_ERROR_NONE) {
486 rctx.extract = false;
493 case STREAM_FILE_DATA:
494 case STREAM_SPARSE_DATA:
495 case STREAM_WIN32_DATA:
496 case STREAM_GZIP_DATA:
497 case STREAM_SPARSE_GZIP_DATA:
498 case STREAM_WIN32_GZIP_DATA:
499 case STREAM_ENCRYPTED_FILE_DATA:
500 case STREAM_ENCRYPTED_WIN32_DATA:
501 case STREAM_ENCRYPTED_FILE_GZIP_DATA:
502 case STREAM_ENCRYPTED_WIN32_GZIP_DATA:
504 * Force an expected, consistent stream type here
506 if (rctx.extract && (rctx.prev_stream == rctx.stream
507 || rctx.prev_stream == STREAM_UNIX_ATTRIBUTES
508 || rctx.prev_stream == STREAM_UNIX_ATTRIBUTES_EX
509 || rctx.prev_stream == STREAM_ENCRYPTED_SESSION_DATA)) {
512 if (rctx.stream == STREAM_SPARSE_DATA ||
513 rctx.stream == STREAM_SPARSE_GZIP_DATA) {
514 rctx.flags |= FO_SPARSE;
517 if (rctx.stream == STREAM_GZIP_DATA
518 || rctx.stream == STREAM_SPARSE_GZIP_DATA
519 || rctx.stream == STREAM_WIN32_GZIP_DATA
520 || rctx.stream == STREAM_ENCRYPTED_FILE_GZIP_DATA
521 || rctx.stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) {
522 rctx.flags |= FO_GZIP;
525 if (rctx.stream == STREAM_ENCRYPTED_FILE_DATA
526 || rctx.stream == STREAM_ENCRYPTED_FILE_GZIP_DATA
527 || rctx.stream == STREAM_ENCRYPTED_WIN32_DATA
528 || rctx.stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) {
530 * Set up a decryption context
532 if (!rctx.cipher_ctx.cipher) {
534 Jmsg1(jcr, M_ERROR, 0, _("Missing encryption session data stream for %s\n"), jcr->last_fname);
535 rctx.extract = false;
540 if ((rctx.cipher_ctx.cipher = crypto_cipher_new(rctx.cs, false,
541 &rctx.cipher_ctx.block_size)) == NULL) {
542 Jmsg1(jcr, M_ERROR, 0, _("Failed to initialize decryption context for %s\n"), jcr->last_fname);
544 rctx.extract = false;
549 rctx.flags |= FO_ENCRYPT;
552 if (is_win32_stream(rctx.stream) && !have_win32_api()) {
553 set_portable_backup(&rctx.bfd);
555 * "decompose" BackupWrite data
557 rctx.flags |= FO_WIN32DECOMP;
560 if (extract_data(jcr, &rctx.bfd, sd->msg, sd->msglen, &rctx.fileAddr,
561 rctx.flags, &rctx.cipher_ctx) < 0) {
562 rctx.extract = false;
570 * Resource fork stream - only recorded after a file to be restored
571 * Silently ignore if we cannot write - we already reported that
573 case STREAM_ENCRYPTED_MACOS_FORK_DATA:
574 case STREAM_MACOS_FORK_DATA:
575 if (have_darwin_os) {
577 jcr->ff->flags |= FO_HFSPLUS;
579 if (rctx.stream == STREAM_ENCRYPTED_MACOS_FORK_DATA) {
580 rctx.fork_flags |= FO_ENCRYPT;
583 * Set up a decryption context
585 if (rctx.extract && !rctx.fork_cipher_ctx.cipher) {
587 Jmsg1(jcr, M_ERROR, 0, _("Missing encryption session data stream for %s\n"), jcr->last_fname);
588 rctx.extract = false;
593 if ((rctx.fork_cipher_ctx.cipher = crypto_cipher_new(rctx.cs, false, &rctx.fork_cipher_ctx.block_size)) == NULL) {
594 Jmsg1(jcr, M_ERROR, 0, _("Failed to initialize decryption context for %s\n"), jcr->last_fname);
596 rctx.extract = false;
604 if (rctx.prev_stream != rctx.stream) {
605 if (bopen_rsrc(&rctx.forkbfd, jcr->last_fname, O_WRONLY | O_TRUNC | O_BINARY, 0) < 0) {
606 Jmsg(jcr, M_ERROR, 0, _("Cannot open resource fork for %s.\n"), jcr->last_fname);
607 rctx.extract = false;
611 rctx.fork_size = rsrc_len;
612 Dmsg0(130, "Restoring resource fork\n");
615 if (extract_data(jcr, &rctx.forkbfd, sd->msg, sd->msglen, &rctx.fork_addr, rctx.fork_flags,
616 &rctx.fork_cipher_ctx) < 0) {
617 rctx.extract = false;
618 bclose(&rctx.forkbfd);
627 case STREAM_HFSPLUS_ATTRIBUTES:
628 if (have_darwin_os) {
629 if (!restore_finderinfo(jcr, sd->msg, sd->msglen)) {
637 case STREAM_UNIX_ACCESS_ACL:
638 case STREAM_UNIX_DEFAULT_ACL:
639 case STREAM_ACL_AIX_TEXT:
640 case STREAM_ACL_DARWIN_ACCESS_ACL:
641 case STREAM_ACL_FREEBSD_DEFAULT_ACL:
642 case STREAM_ACL_FREEBSD_ACCESS_ACL:
643 case STREAM_ACL_HPUX_ACL_ENTRY:
644 case STREAM_ACL_IRIX_DEFAULT_ACL:
645 case STREAM_ACL_IRIX_ACCESS_ACL:
646 case STREAM_ACL_LINUX_DEFAULT_ACL:
647 case STREAM_ACL_LINUX_ACCESS_ACL:
648 case STREAM_ACL_TRU64_DEFAULT_ACL:
649 case STREAM_ACL_TRU64_DEFAULT_DIR_ACL:
650 case STREAM_ACL_TRU64_ACCESS_ACL:
651 case STREAM_ACL_SOLARIS_ACLENT:
652 case STREAM_ACL_SOLARIS_ACE:
654 * Do not restore ACLs when
655 * a) The current file is not extracted
656 * b) and it is not a directory (they are never "extracted")
657 * c) or the file name is empty
659 if ((!rctx.extract && jcr->last_type != FT_DIREND) || (*jcr->last_fname == 0)) {
663 pm_memcpy(jcr->acl_data->content, sd->msg, sd->msglen);
664 jcr->acl_data->content_length = sd->msglen;
665 switch (parse_acl_streams(jcr, rctx.stream)) {
666 case bacl_exit_fatal:
668 case bacl_exit_error:
670 * Non-fatal errors, count them and when the number is under ACL_REPORT_ERR_MAX_PER_JOB
671 * print the error message set by the lower level routine in jcr->errmsg.
673 if (jcr->acl_data->nr_errors < ACL_REPORT_ERR_MAX_PER_JOB) {
674 Qmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
676 jcr->acl_data->nr_errors++;
686 case STREAM_XATTR_SOLARIS_SYS:
687 case STREAM_XATTR_SOLARIS:
688 case STREAM_XATTR_DARWIN:
689 case STREAM_XATTR_FREEBSD:
690 case STREAM_XATTR_LINUX:
691 case STREAM_XATTR_NETBSD:
693 * Do not restore Extended Attributes when
694 * a) The current file is not extracted
695 * b) and it is not a directory (they are never "extracted")
696 * c) or the file name is empty
698 if ((!rctx.extract && jcr->last_type != FT_DIREND) || (*jcr->last_fname == 0)) {
702 pm_memcpy(jcr->xattr_data->content, sd->msg, sd->msglen);
703 jcr->xattr_data->content_length = sd->msglen;
704 switch (parse_xattr_streams(jcr, rctx.stream)) {
705 case bxattr_exit_fatal:
707 case bxattr_exit_error:
709 * Non-fatal errors, count them and when the number is under XATTR_REPORT_ERR_MAX_PER_JOB
710 * print the error message set by the lower level routine in jcr->errmsg.
712 if (jcr->xattr_data->nr_errors < XATTR_REPORT_ERR_MAX_PER_JOB) {
713 Qmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
715 jcr->xattr_data->nr_errors++;
725 case STREAM_SIGNED_DIGEST:
727 * Is this an unexpected signature?
730 Jmsg0(jcr, M_ERROR, 0, _("Unexpected cryptographic signature data stream.\n"));
731 free_signature(rctx);
737 if (rctx.extract && (rctx.sig = crypto_sign_decode(jcr, (uint8_t *)sd->msg, (uint32_t)sd->msglen)) == NULL) {
738 Jmsg1(jcr, M_ERROR, 0, _("Failed to decode message signature for %s\n"), jcr->last_fname);
742 case STREAM_MD5_DIGEST:
743 case STREAM_SHA1_DIGEST:
744 case STREAM_SHA256_DIGEST:
745 case STREAM_SHA512_DIGEST:
748 case STREAM_PROGRAM_NAMES:
749 case STREAM_PROGRAM_DATA:
750 if (!non_support_progname) {
751 Pmsg0(000, "Got Program Name or Data Stream. Ignored.\n");
752 non_support_progname++;
756 case STREAM_PLUGIN_NAME:
757 close_previous_stream(rctx);
758 Dmsg1(50, "restore stream_plugin_name=%s\n", sd->msg);
759 plugin_name_stream(jcr, sd->msg);
763 close_previous_stream(rctx);
764 Jmsg(jcr, M_ERROR, 0, _("Unknown stream=%d ignored. This shouldn't happen!\n"),
766 Dmsg2(0, "Unknown stream=%d data=%s\n", rctx.stream, sd->msg);
768 } /* end switch(stream) */
769 } /* end while get_msg() */
772 * If output file is still open, it was the last one in the
773 * archive since we just hit an end of file, so close the file.
775 if (is_bopen(&rctx.forkbfd)) {
776 bclose_chksize(jcr, &rctx.forkbfd, rctx.fork_size);
779 close_previous_stream(rctx);
780 set_jcr_job_status(jcr, JS_Terminated);
784 set_jcr_job_status(jcr, JS_ErrorTerminated);
788 * First output the statistics.
790 Dmsg2(10, "End Do Restore. Files=%d Bytes=%s\n", jcr->JobFiles,
791 edit_uint64(jcr->JobBytes, ec1));
792 if (have_acl && jcr->acl_data->nr_errors > 0) {
793 Jmsg(jcr, M_ERROR, 0, _("Encountered %ld acl errors while doing restore\n"),
794 jcr->acl_data->nr_errors);
796 if (have_xattr && jcr->xattr_data->nr_errors > 0) {
797 Jmsg(jcr, M_ERROR, 0, _("Encountered %ld xattr errors while doing restore\n"),
798 jcr->xattr_data->nr_errors);
800 if (non_support_data > 1 || non_support_attr > 1) {
801 Jmsg(jcr, M_ERROR, 0, _("%d non-supported data streams and %d non-supported attrib streams ignored.\n"),
802 non_support_data, non_support_attr);
804 if (non_support_rsrc) {
805 Jmsg(jcr, M_INFO, 0, _("%d non-supported resource fork streams ignored.\n"), non_support_rsrc);
807 if (non_support_finfo) {
808 Jmsg(jcr, M_INFO, 0, _("%d non-supported Finder Info streams ignored.\n"), non_support_rsrc);
810 if (non_support_acl) {
811 Jmsg(jcr, M_INFO, 0, _("%d non-supported acl streams ignored.\n"), non_support_acl);
813 if (non_support_crypto) {
814 Jmsg(jcr, M_INFO, 0, _("%d non-supported crypto streams ignored.\n"), non_support_acl);
816 if (non_support_xattr) {
817 Jmsg(jcr, M_INFO, 0, _("%d non-supported xattr streams ignored.\n"), non_support_xattr);
821 * Free Signature & Crypto Data
823 free_signature(rctx);
825 if (jcr->crypto.digest) {
826 crypto_digest_free(jcr->crypto.digest);
827 jcr->crypto.digest = NULL;
831 * Free file cipher restore context
833 if (rctx.cipher_ctx.cipher) {
834 crypto_cipher_free(rctx.cipher_ctx.cipher);
835 rctx.cipher_ctx.cipher = NULL;
838 if (rctx.cipher_ctx.buf) {
839 free_pool_memory(rctx.cipher_ctx.buf);
840 rctx.cipher_ctx.buf = NULL;
844 * Free alternate stream cipher restore context
846 if (rctx.fork_cipher_ctx.cipher) {
847 crypto_cipher_free(rctx.fork_cipher_ctx.cipher);
848 rctx.fork_cipher_ctx.cipher = NULL;
850 if (rctx.fork_cipher_ctx.buf) {
851 free_pool_memory(rctx.fork_cipher_ctx.buf);
852 rctx.fork_cipher_ctx.buf = NULL;
855 if (jcr->compress_buf) {
856 free_pool_memory(jcr->compress_buf);
857 jcr->compress_buf = NULL;
858 jcr->compress_buf_size = 0;
861 if (have_acl && jcr->acl_data) {
862 free_pool_memory(jcr->acl_data->content);
864 jcr->acl_data = NULL;
867 if (have_xattr && jcr->xattr_data) {
868 free_pool_memory(jcr->xattr_data->content);
869 free(jcr->xattr_data);
870 jcr->xattr_data = NULL;
873 bclose(&rctx.forkbfd);
875 free_attr(rctx.attr);
880 * Convert ZLIB error code into an ASCII message
882 static const char *zlib_strerror(int stat)
889 return _("Zlib errno");
891 return _("Zlib stream error");
893 return _("Zlib data error");
895 return _("Zlib memory error");
897 return _("Zlib buffer error");
898 case Z_VERSION_ERROR:
899 return _("Zlib version error");
906 static int do_file_digest(JCR *jcr, FF_PKT *ff_pkt, bool top_level)
908 Dmsg1(50, "do_file_digest jcr=%p\n", jcr);
909 return (digest_file(jcr, ff_pkt, jcr->crypto.digest));
913 * Verify the signature for the last restored file
914 * Return value is either true (signature correct)
915 * or false (signature could not be verified).
916 * TODO landonf: Implement without using find_one_file and
917 * without re-reading the file.
919 static bool verify_signature(JCR *jcr, r_ctx &rctx)
921 X509_KEYPAIR *keypair;
922 DIGEST *digest = NULL;
924 uint64_t saved_bytes;
925 crypto_digest_t signing_algorithm = have_sha2 ?
926 CRYPTO_DIGEST_SHA256 : CRYPTO_DIGEST_SHA1;
927 crypto_digest_t algorithm;
928 SIGNATURE *sig = rctx.sig;
931 if (!jcr->crypto.pki_sign) {
938 if (rctx.type == FT_REGE || rctx.type == FT_REG || rctx.type == FT_RAW) {
939 Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"),
947 * Iterate through the trusted signers
949 foreach_alist(keypair, jcr->crypto.pki_signers) {
950 err = crypto_sign_get_digest(sig, jcr->crypto.pki_keypair, algorithm, &digest);
952 case CRYPTO_ERROR_NONE:
953 Dmsg0(50, "== Got digest\n");
955 * We computed jcr->crypto.digest using signing_algorithm while writing
956 * the file. If it is not the same as the algorithm used for
957 * this file, punt by releasing the computed algorithm and
958 * computing by re-reading the file.
960 if (algorithm != signing_algorithm) {
961 if (jcr->crypto.digest) {
962 crypto_digest_free(jcr->crypto.digest);
963 jcr->crypto.digest = NULL;
966 if (jcr->crypto.digest) {
968 * Use digest computed while writing the file to verify the signature
970 if ((err = crypto_sign_verify(sig, keypair, jcr->crypto.digest)) != CRYPTO_ERROR_NONE) {
971 Dmsg1(50, "Bad signature on %s\n", jcr->last_fname);
972 Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for file %s: ERR=%s\n"),
973 jcr->last_fname, crypto_strerror(err));
978 * Signature found, digest allocated. Old method,
979 * re-read the file and compute the digest
981 jcr->crypto.digest = digest;
984 * Checksum the entire file
985 * Make sure we don't modify JobBytes by saving and restoring it
987 saved_bytes = jcr->JobBytes;
988 if (find_one_file(jcr, jcr->ff, do_file_digest, jcr->last_fname, (dev_t)-1, 1) != 0) {
989 Jmsg(jcr, M_ERROR, 0, _("Digest one file failed for file: %s\n"),
991 jcr->JobBytes = saved_bytes;
994 jcr->JobBytes = saved_bytes;
997 * Verify the signature
999 if ((err = crypto_sign_verify(sig, keypair, digest)) != CRYPTO_ERROR_NONE) {
1000 Dmsg1(50, "Bad signature on %s\n", jcr->last_fname);
1001 Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for file %s: ERR=%s\n"),
1002 jcr->last_fname, crypto_strerror(err));
1005 jcr->crypto.digest = NULL;
1011 Dmsg1(50, "Signature good on %s\n", jcr->last_fname);
1012 crypto_digest_free(digest);
1015 case CRYPTO_ERROR_NOSIGNER:
1017 * Signature not found, try again
1020 crypto_digest_free(digest);
1026 * Something strange happened (that shouldn't happen!)...
1028 Qmsg2(jcr, M_ERROR, 0, _("Signature validation failed for %s: %s\n"), jcr->last_fname, crypto_strerror(err));
1036 Dmsg1(50, "Could not find a valid public key for signature on %s\n", jcr->last_fname);
1040 crypto_digest_free(digest);
1045 bool sparse_data(JCR *jcr, BFILE *bfd, uint64_t *addr, char **data, uint32_t *length)
1050 unser_begin(*data, SPARSE_FADDR_SIZE);
1051 unser_uint64(faddr);
1052 if (*addr != faddr) {
1054 if (blseek(bfd, (boffset_t)*addr, SEEK_SET) < 0) {
1056 Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"),
1057 edit_uint64(*addr, ec1), jcr->last_fname,
1058 be.bstrerror(bfd->berrno));
1062 *data += SPARSE_FADDR_SIZE;
1063 *length -= SPARSE_FADDR_SIZE;
1067 bool decompress_data(JCR *jcr, char **data, uint32_t *length)
1072 char ec1[50]; /* Buffer printing huge values */
1075 * NOTE! We only use uLong and Byte because they are
1076 * needed by the zlib routines, they should not otherwise
1077 * be used in Bacula.
1079 compress_len = jcr->compress_buf_size;
1080 Dmsg2(200, "Comp_len=%d msglen=%d\n", compress_len, *length);
1081 while ((stat=uncompress((Byte *)jcr->compress_buf, &compress_len,
1082 (const Byte *)*data, (uLong)*length)) == Z_BUF_ERROR)
1085 * The buffer size is too small, try with a bigger one
1087 compress_len = jcr->compress_buf_size = jcr->compress_buf_size + (jcr->compress_buf_size >> 1);
1088 Dmsg2(200, "Comp_len=%d msglen=%d\n", compress_len, *length);
1089 jcr->compress_buf = check_pool_memory_size(jcr->compress_buf,
1093 Qmsg(jcr, M_ERROR, 0, _("Uncompression error on file %s. ERR=%s\n"),
1094 jcr->last_fname, zlib_strerror(stat));
1097 *data = jcr->compress_buf;
1098 *length = compress_len;
1099 Dmsg2(200, "Write uncompressed %d bytes, total before write=%s\n", compress_len, edit_uint64(jcr->JobBytes, ec1));
1102 Qmsg(jcr, M_ERROR, 0, _("GZIP data stream found, but GZIP not configured!\n"));
1107 static void unser_crypto_packet_len(RESTORE_CIPHER_CTX *ctx)
1110 if (ctx->packet_len == 0 && ctx->buf_len >= CRYPTO_LEN_SIZE) {
1111 unser_begin(&ctx->buf[0], CRYPTO_LEN_SIZE);
1112 unser_uint32(ctx->packet_len);
1113 ctx->packet_len += CRYPTO_LEN_SIZE;
1117 bool store_data(JCR *jcr, BFILE *bfd, char *data, const int32_t length, bool win32_decomp)
1119 if (jcr->crypto.digest) {
1120 crypto_digest_update(jcr->crypto.digest, (uint8_t *)data, length);
1123 if (!processWin32BackupAPIBlock(bfd, data, length)) {
1125 Jmsg2(jcr, M_ERROR, 0, _("Write error in Win32 Block Decomposition on %s: %s\n"),
1126 jcr->last_fname, be.bstrerror(bfd->berrno));
1129 } else if (bwrite(bfd, data, length) != (ssize_t)length) {
1131 Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: %s\n"),
1132 jcr->last_fname, be.bstrerror(bfd->berrno));
1140 * In the context of jcr, write data to bfd.
1141 * We write buflen bytes in buf at addr. addr is updated in place.
1142 * The flags specify whether to use sparse files or compression.
1143 * Return value is the number of bytes written, or -1 on errors.
1145 int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen,
1146 uint64_t *addr, int flags, RESTORE_CIPHER_CTX *cipher_ctx)
1148 char *wbuf; /* write buffer */
1149 uint32_t wsize; /* write size */
1150 uint32_t rsize; /* read size */
1151 uint32_t decrypted_len = 0; /* Decryption output length */
1152 char ec1[50]; /* Buffer printing huge values */
1155 jcr->ReadBytes += rsize;
1159 if (flags & FO_ENCRYPT) {
1160 ASSERT(cipher_ctx->cipher);
1163 * NOTE: We must implement block preserving semantics for the
1164 * non-streaming compression and sparse code.
1166 * Grow the crypto buffer, if necessary.
1167 * crypto_cipher_update() will process only whole blocks,
1168 * buffering the remaining input.
1170 cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf,
1171 cipher_ctx->buf_len + wsize + cipher_ctx->block_size);
1174 * Decrypt the input block
1176 if (!crypto_cipher_update(cipher_ctx->cipher,
1177 (const u_int8_t *)wbuf,
1179 (u_int8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1182 * Decryption failed. Shouldn't happen.
1184 Jmsg(jcr, M_FATAL, 0, _("Decryption error\n"));
1188 if (decrypted_len == 0) {
1190 * No full block of encrypted data available, write more data
1195 Dmsg2(200, "decrypted len=%d encrypted len=%d\n", decrypted_len, wsize);
1197 cipher_ctx->buf_len += decrypted_len;
1198 wbuf = cipher_ctx->buf;
1201 * If one full preserved block is available, write it to disk,
1202 * and then buffer any remaining data. This should be effecient
1203 * as long as Bacula's block size is not significantly smaller than the
1204 * encryption block size (extremely unlikely!)
1206 unser_crypto_packet_len(cipher_ctx);
1207 Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1209 if (cipher_ctx->packet_len == 0 || cipher_ctx->buf_len < cipher_ctx->packet_len) {
1211 * No full preserved block is available.
1217 * We have one full block, set up the filter input buffers
1219 wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1220 wbuf = &wbuf[CRYPTO_LEN_SIZE]; /* Skip the block length header */
1221 cipher_ctx->buf_len -= cipher_ctx->packet_len;
1222 Dmsg2(130, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1225 if (flags & FO_SPARSE) {
1226 if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1231 if (flags & FO_GZIP) {
1232 if (!decompress_data(jcr, &wbuf, &wsize)) {
1237 if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1240 jcr->JobBytes += wsize;
1242 Dmsg2(130, "Write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1245 * Clean up crypto buffers
1247 if (flags & FO_ENCRYPT) {
1248 /* Move any remaining data to start of buffer */
1249 if (cipher_ctx->buf_len > 0) {
1250 Dmsg1(130, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1251 memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1252 cipher_ctx->buf_len);
1255 * The packet was successfully written, reset the length so that the next
1256 * packet length may be re-read by unser_crypto_packet_len()
1258 cipher_ctx->packet_len = 0;
1268 * If extracting, close any previous stream
1270 static void close_previous_stream(r_ctx &rctx)
1273 * If extracting, it was from previous stream, so
1274 * close the output file and validate the signature.
1277 if (rctx.size > 0 && !is_bopen(&rctx.bfd)) {
1278 Jmsg0(rctx.jcr, M_ERROR, 0, _("Logic error: output file should be open\n"));
1279 Dmsg2(000, "=== logic error size=%d bopen=%d\n", rctx.size,
1280 is_bopen(&rctx.bfd));
1283 if (rctx.prev_stream != STREAM_ENCRYPTED_SESSION_DATA) {
1284 deallocate_cipher(rctx);
1285 deallocate_fork_cipher(rctx);
1288 if (rctx.jcr->plugin) {
1289 plugin_set_attributes(rctx.jcr, rctx.attr, &rctx.bfd);
1291 set_attributes(rctx.jcr, rctx.attr, &rctx.bfd);
1293 rctx.extract = false;
1296 * Verify the cryptographic signature, if any
1298 rctx.type = rctx.attr->type;
1299 verify_signature(rctx.jcr, rctx);
1304 free_signature(rctx);
1306 rctx.jcr->ff->flags = 0;
1307 Dmsg0(130, "Stop extracting.\n");
1308 } else if (is_bopen(&rctx.bfd)) {
1309 Jmsg0(rctx.jcr, M_ERROR, 0, _("Logic error: output file should not be open\n"));
1310 Dmsg0(000, "=== logic error !open\n");
1317 * In the context of jcr, flush any remaining data from the cipher context,
1318 * writing it to bfd.
1319 * Return value is true on success, false on failure.
1321 bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags,
1322 RESTORE_CIPHER_CTX *cipher_ctx)
1324 uint32_t decrypted_len = 0;
1325 char *wbuf; /* write buffer */
1326 uint32_t wsize; /* write size */
1327 char ec1[50]; /* Buffer printing huge values */
1328 bool second_pass = false;
1332 * Write out the remaining block and free the cipher context
1334 cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf, cipher_ctx->buf_len +
1335 cipher_ctx->block_size);
1337 if (!crypto_cipher_finalize(cipher_ctx->cipher, (uint8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1340 * Writing out the final, buffered block failed. Shouldn't happen.
1342 Jmsg3(jcr, M_ERROR, 0, _("Decryption error. buf_len=%d decrypt_len=%d on file %s\n"),
1343 cipher_ctx->buf_len, decrypted_len, jcr->last_fname);
1346 Dmsg2(130, "Flush decrypt len=%d buf_len=%d\n", decrypted_len, cipher_ctx->buf_len);
1348 * If nothing new was decrypted, and our output buffer is empty, return
1350 if (decrypted_len == 0 && cipher_ctx->buf_len == 0) {
1354 cipher_ctx->buf_len += decrypted_len;
1356 unser_crypto_packet_len(cipher_ctx);
1357 Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1358 wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1360 * Decrypted, possibly decompressed output here.
1362 wbuf = &cipher_ctx->buf[CRYPTO_LEN_SIZE];
1363 cipher_ctx->buf_len -= cipher_ctx->packet_len;
1364 Dmsg2(130, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1366 if (flags & FO_SPARSE) {
1367 if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1372 if (flags & FO_GZIP) {
1373 if (!decompress_data(jcr, &wbuf, &wsize)) {
1378 Dmsg0(130, "Call store_data\n");
1379 if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1382 jcr->JobBytes += wsize;
1383 Dmsg2(130, "Flush write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1386 * Move any remaining data to start of buffer
1388 if (cipher_ctx->buf_len > 0) {
1389 Dmsg1(130, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1390 memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1391 cipher_ctx->buf_len);
1394 * The packet was successfully written, reset the length so that the next
1395 * packet length may be re-read by unser_crypto_packet_len()
1397 cipher_ctx->packet_len = 0;
1399 if (cipher_ctx->buf_len >0 && !second_pass) {
1407 cipher_ctx->buf_len = 0;
1408 cipher_ctx->packet_len = 0;
1413 static void deallocate_cipher(r_ctx &rctx)
1416 * Flush and deallocate previous stream's cipher context
1418 if (rctx.cipher_ctx.cipher) {
1419 flush_cipher(rctx.jcr, &rctx.bfd, &rctx.fileAddr, rctx.flags, &rctx.cipher_ctx);
1420 crypto_cipher_free(rctx.cipher_ctx.cipher);
1421 rctx.cipher_ctx.cipher = NULL;
1425 static void deallocate_fork_cipher(r_ctx &rctx)
1429 * Flush and deallocate previous stream's fork cipher context
1431 if (rctx.fork_cipher_ctx.cipher) {
1432 flush_cipher(rctx.jcr, &rctx.forkbfd, &rctx.fork_addr, rctx.fork_flags, &rctx.fork_cipher_ctx);
1433 crypto_cipher_free(rctx.fork_cipher_ctx.cipher);
1434 rctx.fork_cipher_ctx.cipher = NULL;
1438 static void free_signature(r_ctx &rctx)
1441 crypto_sign_free(rctx.sig);
1446 static void free_session(r_ctx &rctx)
1449 crypto_session_free(rctx.cs);
1456 * This code if implemented goes above
1458 #ifdef stbernard_implemented
1459 / #if defined(HAVE_WIN32)
1460 bool bResumeOfmOnExit = FALSE;
1461 if (isOpenFileManagerRunning()) {
1462 if ( pauseOpenFileManager() ) {
1463 Jmsg(jcr, M_INFO, 0, _("Open File Manager paused\n") );
1464 bResumeOfmOnExit = TRUE;
1467 Jmsg(jcr, M_ERROR, 0, _("FAILED to pause Open File Manager\n") );
1471 char username[UNLEN+1];
1472 DWORD usize = sizeof(username);
1473 int privs = enable_backup_privileges(NULL, 1);
1474 if (GetUserName(username, &usize)) {
1475 Jmsg2(jcr, M_INFO, 0, _("Running as '%s'. Privmask=%#08x\n"), username,
1477 Jmsg(jcr, M_WARNING, 0, _("Failed to retrieve current UserName\n"));