2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 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 plus additions
11 that are listed in the file LICENSE.
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 John Walker.
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
44 #if defined(HAVE_CRYPTO)
45 const bool have_crypto = true;
47 const bool have_crypto = false;
50 /* Data received from Storage Daemon */
51 static char rec_header[] = "rechdr %ld %ld %ld %ld %ld";
53 /* Forward referenced functions */
54 #if defined(HAVE_LIBZ)
55 static const char *zlib_strerror(int stat);
56 const bool have_libz = true;
58 const bool have_libz = false;
61 typedef struct restore_cipher_ctx {
62 CIPHER_CONTEXT *cipher;
65 POOLMEM *buf; /* Pointer to descryption buffer */
66 int32_t buf_len; /* Count of bytes currently in buf */
67 int32_t packet_len; /* Total bytes in packet */
70 static bool verify_signature(JCR *jcr, SIGNATURE *sig);
71 int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen,
72 uint64_t *addr, int flags, RESTORE_CIPHER_CTX *cipher_ctx);
73 bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags, RESTORE_CIPHER_CTX *cipher_ctx);
75 #define RETRY 10 /* retry wait time */
78 * Close a bfd check that we are at the expected file offset.
79 * Makes some code in set_attributes().
81 int bclose_chksize(JCR *jcr, BFILE *bfd, boffset_t osize)
83 char ec1[50], ec2[50];
86 fsize = blseek(bfd, 0, SEEK_CUR);
87 bclose(bfd); /* first close file */
88 if (fsize > 0 && fsize != osize) {
89 Qmsg3(jcr, M_ERROR, 0, _("Size of data or stream of %s not correct. Original %s, restored %s.\n"),
90 jcr->last_fname, edit_uint64(osize, ec1),
91 edit_uint64(fsize, ec2));
98 * Restore the requested files.
101 void do_restore(JCR *jcr)
106 uint32_t VolSessionId, VolSessionTime;
107 bool extract = false;
109 char ec1[50]; /* Buffer printing huge values */
110 BFILE bfd; /* File content */
111 uint64_t fileAddr = 0; /* file write address */
112 uint32_t size; /* Size of file */
113 BFILE altbfd; /* Alternative data stream */
114 uint64_t alt_addr = 0; /* Write address for alternative stream */
115 intmax_t alt_size = 0; /* Size of alternate stream */
116 SIGNATURE *sig = NULL; /* Cryptographic signature (if any) for file */
117 CRYPTO_SESSION *cs = NULL; /* Cryptographic session data (if any) for file */
118 RESTORE_CIPHER_CTX cipher_ctx; /* Cryptographic restore context (if any) for file */
119 RESTORE_CIPHER_CTX alt_cipher_ctx; /* Cryptographic restore context (if any) for alternative stream */
120 int flags = 0; /* Options for extract_data() */
121 int alt_flags = 0; /* Options for extract_data() */
125 /* The following variables keep track of "known unknowns" */
126 int non_support_data = 0;
127 int non_support_attr = 0;
128 int non_support_rsrc = 0;
129 int non_support_finfo = 0;
130 int non_support_acl = 0;
131 int non_support_progname = 0;
133 /* Finally, set up for special configurations */
134 #ifdef HAVE_DARWIN_OS
135 intmax_t rsrc_len = 0; /* Original length of resource fork */
136 struct attrlist attrList;
138 memset(&attrList, 0, sizeof(attrList));
139 attrList.bitmapcount = ATTR_BIT_MAP_COUNT;
140 attrList.commonattr = ATTR_CMN_FNDRINFO;
143 sd = jcr->store_bsock;
144 set_jcr_job_status(jcr, JS_Running);
147 CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL);
151 buf_size = client->max_network_buffer_size;
153 buf_size = 0; /* use default */
155 if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) {
156 set_jcr_job_status(jcr, JS_ErrorTerminated);
159 jcr->buf_size = sd->msglen;
161 #ifdef stbernard_implemented
162 / #if defined(HAVE_WIN32)
163 bool bResumeOfmOnExit = FALSE;
164 if (isOpenFileManagerRunning()) {
165 if ( pauseOpenFileManager() ) {
166 Jmsg(jcr, M_INFO, 0, _("Open File Manager paused\n") );
167 bResumeOfmOnExit = TRUE;
170 Jmsg(jcr, M_ERROR, 0, _("FAILED to pause Open File Manager\n") );
174 char username[UNLEN+1];
175 DWORD usize = sizeof(username);
176 int privs = enable_backup_privileges(NULL, 1);
177 if (GetUserName(username, &usize)) {
178 Jmsg2(jcr, M_INFO, 0, _("Running as '%s'. Privmask=%#08x\n"), username,
180 Jmsg(jcr, M_WARNING, 0, _("Failed to retrieve current UserName\n"));
186 uint32_t compress_buf_size = jcr->buf_size + 12 + ((jcr->buf_size+999) / 1000) + 100;
187 jcr->compress_buf = (char *)bmalloc(compress_buf_size);
188 jcr->compress_buf_size = compress_buf_size;
191 cipher_ctx.cipher = NULL;
192 alt_cipher_ctx.cipher = NULL;
194 cipher_ctx.buf = get_memory(CRYPTO_CIPHER_MAX_BLOCK_SIZE);
195 cipher_ctx.buf_len = 0;
196 cipher_ctx.packet_len = 0;
198 alt_cipher_ctx.buf = get_memory(CRYPTO_CIPHER_MAX_BLOCK_SIZE);
199 alt_cipher_ctx.buf_len = 0;
200 alt_cipher_ctx.packet_len = 0;
202 cipher_ctx.buf = NULL;
203 alt_cipher_ctx.buf = NULL;
207 * Get a record from the Storage daemon. We are guaranteed to
208 * receive records in the following order:
209 * 1. Stream record header
211 * a. Attributes (Unix or Win32)
212 * b. Possibly stream encryption session data (e.g., symmetric session key)
213 * or c. File data for the file
214 * or d. Alternate data stream (e.g. Resource Fork)
217 * or g. Possibly a cryptographic signature
218 * or h. Possibly MD5 or SHA1 record
221 * NOTE: We keep track of two bacula file descriptors:
222 * 1. bfd for file data.
223 * This fd is opened for non empty files when an attribute stream is
224 * encountered and closed when we find the next attribute stream.
225 * 2. alt_bfd for alternate data streams
226 * This fd is opened every time we encounter a new alternate data
227 * stream for the current file. When we find any other stream, we
229 * The expected size of the stream, alt_len, should be set when
235 jcr->acl_text = get_pool_memory(PM_MESSAGE);
237 while (bget_msg(sd) >= 0 && !job_canceled(jcr)) {
238 /* Remember previous stream type */
239 prev_stream = stream;
241 /* First we expect a Stream Record Header */
242 if (sscanf(sd->msg, rec_header, &VolSessionId, &VolSessionTime, &file_index,
243 &stream, &size) != 5) {
244 Jmsg1(jcr, M_FATAL, 0, _("Record header scan error: %s\n"), sd->msg);
247 Dmsg4(30, "Got hdr: Files=%d FilInx=%d Stream=%d, %s.\n",
248 jcr->JobFiles, file_index, stream, stream_to_ascii(stream));
250 /* * Now we expect the Stream Data */
251 if (bget_msg(sd) < 0) {
252 Jmsg1(jcr, M_FATAL, 0, _("Data record error. ERR=%s\n"), bnet_strerror(sd));
255 if (size != (uint32_t)sd->msglen) {
256 Jmsg2(jcr, M_FATAL, 0, _("Actual data size %d not same as header %d\n"), sd->msglen, size);
259 Dmsg3(30, "Got stream: %s len=%d extract=%d\n", stream_to_ascii(stream),
260 sd->msglen, extract);
262 /* If we change streams, close and reset alternate data streams */
263 if (prev_stream != stream) {
264 if (is_bopen(&altbfd)) {
265 if (alt_cipher_ctx.cipher) {
266 flush_cipher(jcr, &altbfd, &alt_addr, alt_flags, &alt_cipher_ctx);
267 crypto_cipher_free(alt_cipher_ctx.cipher);
268 alt_cipher_ctx.cipher = NULL;
270 bclose_chksize(jcr, &altbfd, alt_size);
272 alt_size = -1; /* Use an impossible value and set a proper one below */
276 /* File Attributes stream */
278 case STREAM_UNIX_ATTRIBUTES:
279 case STREAM_UNIX_ATTRIBUTES_EX:
281 * If extracting, it was from previous stream, so
282 * close the output file and validate the signature.
285 if (size > 0 && !is_bopen(&bfd)) {
286 Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should be open\n"));
288 /* Flush and deallocate previous stream's cipher context */
289 if (cipher_ctx.cipher && prev_stream != STREAM_ENCRYPTED_SESSION_DATA) {
290 flush_cipher(jcr, &bfd, &fileAddr, flags, &cipher_ctx);
291 crypto_cipher_free(cipher_ctx.cipher);
292 cipher_ctx.cipher = NULL;
295 /* Flush and deallocate previous stream's alt cipher context */
296 if (alt_cipher_ctx.cipher && prev_stream != STREAM_ENCRYPTED_SESSION_DATA) {
297 flush_cipher(jcr, &altbfd, &alt_addr, alt_flags, &alt_cipher_ctx);
298 crypto_cipher_free(alt_cipher_ctx.cipher);
299 alt_cipher_ctx.cipher = NULL;
301 set_attributes(jcr, attr, &bfd);
304 /* Verify the cryptographic signature, if any */
305 verify_signature(jcr, sig);
309 crypto_sign_free(sig);
313 crypto_session_free(cs);
317 Dmsg0(30, "Stop extracting.\n");
318 } else if (is_bopen(&bfd)) {
319 Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should not be open\n"));
324 * Unpack and do sanity check fo attributes.
326 if (!unpack_attributes_record(jcr, stream, sd->msg, attr)) {
329 if (file_index != attr->file_index) {
330 Jmsg(jcr, M_FATAL, 0, _("Record header file index %ld not equal record index %ld\n"),
331 file_index, attr->file_index);
332 Dmsg0(100, "File index error\n");
336 Dmsg3(200, "File %s\nattrib=%s\nattribsEx=%s\n", attr->fname,
337 attr->attr, attr->attrEx);
339 attr->data_stream = decode_stat(attr->attr, &attr->statp, &attr->LinkFI);
341 if (!is_restore_stream_supported(attr->data_stream)) {
342 if (!non_support_data++) {
343 Jmsg(jcr, M_ERROR, 0, _("%s stream not supported on this Client.\n"),
344 stream_to_ascii(attr->data_stream));
349 build_attr_output_fnames(jcr, attr);
352 * Now determine if we are extracting or not.
354 jcr->num_files_examined++;
356 stat = create_file(jcr, attr, &bfd, jcr->replace);
357 Dmsg2(30, "Outfile=%s create_file stat=%d\n", attr->ofname, stat);
362 case CF_EXTRACT: /* File created and we expect file data */
365 case CF_CREATED: /* File created, but there is no content */
367 pm_strcpy(jcr->last_fname, attr->ofname);
368 jcr->last_type = attr->type;
372 print_ls_output(jcr, attr);
374 #ifdef HAVE_DARWIN_OS
375 /* Only restore the resource fork for regular files */
376 from_base64(&rsrc_len, attr->attrEx);
377 if (attr->type == FT_REG && rsrc_len > 0) {
382 /* set attributes now because file will not be extracted */
383 set_attributes(jcr, attr, &bfd);
390 case STREAM_ENCRYPTED_SESSION_DATA:
391 crypto_error_t cryptoerr;
393 /* Is this an unexpected session data entry? */
395 Jmsg0(jcr, M_ERROR, 0, _("Unexpected cryptographic session data stream.\n"));
401 /* Do we have any keys at all? */
402 if (!jcr->pki_recipients) {
403 Jmsg(jcr, M_ERROR, 0, _("No private decryption keys have been defined to decrypt encrypted backup data.\n"));
409 /* Decode and save session keys. */
410 cryptoerr = crypto_session_decode((uint8_t *)sd->msg, (uint32_t)sd->msglen, jcr->pki_recipients, &cs);
412 case CRYPTO_ERROR_NONE:
415 case CRYPTO_ERROR_NORECIPIENT:
416 Jmsg(jcr, M_ERROR, 0, _("Missing private key required to decrypt encrypted backup data.\n"));
418 case CRYPTO_ERROR_DECRYPTION:
419 Jmsg(jcr, M_ERROR, 0, _("Decrypt of the session key failed.\n"));
422 /* Shouldn't happen */
423 Jmsg1(jcr, M_ERROR, 0, _("An error occurred while decoding encrypted session data stream: %s\n"), crypto_strerror(cryptoerr));
427 if (cryptoerr != CRYPTO_ERROR_NONE) {
435 case STREAM_FILE_DATA:
436 case STREAM_SPARSE_DATA:
437 case STREAM_WIN32_DATA:
438 case STREAM_GZIP_DATA:
439 case STREAM_SPARSE_GZIP_DATA:
440 case STREAM_WIN32_GZIP_DATA:
441 case STREAM_ENCRYPTED_FILE_DATA:
442 case STREAM_ENCRYPTED_WIN32_DATA:
443 case STREAM_ENCRYPTED_FILE_GZIP_DATA:
444 case STREAM_ENCRYPTED_WIN32_GZIP_DATA:
445 /* Force an expected, consistent stream type here */
446 if (extract && (prev_stream == stream || prev_stream == STREAM_UNIX_ATTRIBUTES
447 || prev_stream == STREAM_UNIX_ATTRIBUTES_EX
448 || prev_stream == STREAM_ENCRYPTED_SESSION_DATA)) {
451 if (stream == STREAM_SPARSE_DATA || stream == STREAM_SPARSE_GZIP_DATA) {
455 if (stream == STREAM_GZIP_DATA || stream == STREAM_SPARSE_GZIP_DATA
456 || stream == STREAM_WIN32_GZIP_DATA || stream == STREAM_ENCRYPTED_FILE_GZIP_DATA
457 || stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) {
461 if (stream == STREAM_ENCRYPTED_FILE_DATA
462 || stream == STREAM_ENCRYPTED_FILE_GZIP_DATA
463 || stream == STREAM_ENCRYPTED_WIN32_DATA
464 || stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) {
465 /* Set up a decryption context */
466 if (!cipher_ctx.cipher) {
468 Jmsg1(jcr, M_ERROR, 0, _("Missing encryption session data stream for %s\n"), jcr->last_fname);
474 if ((cipher_ctx.cipher = crypto_cipher_new(cs, false, &cipher_ctx.block_size)) == NULL) {
475 Jmsg1(jcr, M_ERROR, 0, _("Failed to initialize decryption context for %s\n"), jcr->last_fname);
476 crypto_session_free(cs);
486 if (is_win32_stream(stream) && !have_win32_api()) {
487 set_portable_backup(&bfd);
488 flags |= FO_WIN32DECOMP; /* "decompose" BackupWrite data */
491 if (extract_data(jcr, &bfd, sd->msg, sd->msglen, &fileAddr, flags,
500 /* Resource fork stream - only recorded after a file to be restored */
501 /* Silently ignore if we cannot write - we already reported that */
502 case STREAM_ENCRYPTED_MACOS_FORK_DATA:
503 case STREAM_MACOS_FORK_DATA:
504 #ifdef HAVE_DARWIN_OS
506 jcr->ff->flags |= FO_HFSPLUS;
508 if (stream == STREAM_ENCRYPTED_MACOS_FORK_DATA) {
509 alt_flags |= FO_ENCRYPT;
511 /* Set up a decryption context */
512 if (extract && !alt_cipher_ctx.cipher) {
514 Jmsg1(jcr, M_ERROR, 0, _("Missing encryption session data stream for %s\n"), jcr->last_fname);
520 if ((alt_cipher_ctx.cipher = crypto_cipher_new(cs, false, &alt_cipher_ctx.block_size)) == NULL) {
521 Jmsg1(jcr, M_ERROR, 0, _("Failed to initialize decryption context for %s\n"), jcr->last_fname);
522 crypto_session_free(cs);
532 if (prev_stream != stream) {
533 if (bopen_rsrc(&altbfd, jcr->last_fname, O_WRONLY | O_TRUNC | O_BINARY, 0) < 0) {
534 Jmsg(jcr, M_ERROR, 0, _(" Cannot open resource fork for %s.\n"), jcr->last_fname);
540 Dmsg0(30, "Restoring resource fork\n");
543 if (extract_data(jcr, &altbfd, sd->msg, sd->msglen, &alt_addr, alt_flags,
544 &alt_cipher_ctx) < 0) {
555 case STREAM_HFSPLUS_ATTRIBUTES:
556 #ifdef HAVE_DARWIN_OS
557 Dmsg0(30, "Restoring Finder Info\n");
558 jcr->ff->flags |= FO_HFSPLUS;
559 if (sd->msglen != 32) {
560 Jmsg(jcr, M_ERROR, 0, _(" Invalid length of Finder Info (got %d, not 32)\n"), sd->msglen);
563 if (setattrlist(jcr->last_fname, &attrList, sd->msg, sd->msglen, 0) != 0) {
564 Jmsg(jcr, M_ERROR, 0, _(" Could not set Finder Info on %s\n"), jcr->last_fname);
572 case STREAM_UNIX_ATTRIBUTES_ACCESS_ACL:
574 pm_strcpy(jcr->acl_text, sd->msg);
575 Dmsg2(400, "Restoring ACL type 0x%2x <%s>\n", BACL_TYPE_ACCESS, jcr->acl_text);
576 if (bacl_set(jcr, BACL_TYPE_ACCESS) != 0) {
577 Qmsg1(jcr, M_WARNING, 0, _("Can't restore ACL of %s\n"), jcr->last_fname);
584 case STREAM_UNIX_ATTRIBUTES_DEFAULT_ACL:
586 pm_strcpy(jcr->acl_text, sd->msg);
587 Dmsg2(400, "Restoring ACL type 0x%2x <%s>\n", BACL_TYPE_DEFAULT, jcr->acl_text);
588 if (bacl_set(jcr, BACL_TYPE_DEFAULT) != 0) {
589 Qmsg1(jcr, M_WARNING, 0, _("Can't restore default ACL of %s\n"), jcr->last_fname);
596 case STREAM_SIGNED_DIGEST:
598 /* Is this an unexpected signature? */
600 Jmsg0(jcr, M_ERROR, 0, _("Unexpected cryptographic signature data stream.\n"));
601 crypto_sign_free(sig);
606 /* Save signature. */
607 if (extract && (sig = crypto_sign_decode((uint8_t *)sd->msg, (uint32_t)sd->msglen)) == NULL) {
608 Jmsg1(jcr, M_ERROR, 0, _("Failed to decode message signature for %s\n"), jcr->last_fname);
612 case STREAM_MD5_DIGEST:
613 case STREAM_SHA1_DIGEST:
614 case STREAM_SHA256_DIGEST:
615 case STREAM_SHA512_DIGEST:
618 case STREAM_PROGRAM_NAMES:
619 case STREAM_PROGRAM_DATA:
620 if (!non_support_progname) {
621 Pmsg0(000, "Got Program Name or Data Stream. Ignored.\n");
622 non_support_progname++;
627 /* If extracting, wierd stream (not 1 or 2), close output file anyway */
629 Dmsg1(30, "Found wierd stream %d\n", stream);
630 if (size > 0 && !is_bopen(&bfd)) {
631 Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should be open\n"));
633 /* Flush and deallocate cipher context */
634 if (cipher_ctx.cipher) {
635 flush_cipher(jcr, &bfd, &fileAddr, flags, &cipher_ctx);
636 crypto_cipher_free(cipher_ctx.cipher);
637 cipher_ctx.cipher = NULL;
640 /* Flush and deallocate alt cipher context */
641 if (alt_cipher_ctx.cipher) {
642 flush_cipher(jcr, &altbfd, &alt_addr, alt_flags, &alt_cipher_ctx);
643 crypto_cipher_free(alt_cipher_ctx.cipher);
644 alt_cipher_ctx.cipher = NULL;
647 set_attributes(jcr, attr, &bfd);
649 /* Verify the cryptographic signature if any */
650 verify_signature(jcr, sig);
652 } else if (is_bopen(&bfd)) {
653 Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should not be open\n"));
656 Jmsg(jcr, M_ERROR, 0, _("Unknown stream=%d ignored. This shouldn't happen!\n"), stream);
657 Dmsg2(0, "None of above!!! stream=%d data=%s\n", stream,sd->msg);
659 } /* end switch(stream) */
661 } /* end while get_msg() */
663 /* If output file is still open, it was the last one in the
664 * archive since we just hit an end of file, so close the file.
666 if (is_bopen(&altbfd)) {
667 bclose_chksize(jcr, &altbfd, alt_size);
670 /* Flush and deallocate cipher context */
671 if (cipher_ctx.cipher) {
672 flush_cipher(jcr, &bfd, &fileAddr, flags, &cipher_ctx);
673 crypto_cipher_free(cipher_ctx.cipher);
674 cipher_ctx.cipher = NULL;
677 /* Flush and deallocate alt cipher context */
678 if (alt_cipher_ctx.cipher) {
679 flush_cipher(jcr, &altbfd, &alt_addr, alt_flags, &alt_cipher_ctx);
680 crypto_cipher_free(alt_cipher_ctx.cipher);
681 alt_cipher_ctx.cipher = NULL;
684 set_attributes(jcr, attr, &bfd);
686 /* Verify the cryptographic signature on the last file, if any */
687 verify_signature(jcr, sig);
690 if (is_bopen(&bfd)) {
694 set_jcr_job_status(jcr, JS_Terminated);
698 set_jcr_job_status(jcr, JS_ErrorTerminated);
701 /* Free Signature & Crypto Data */
703 crypto_sign_free(sig);
707 crypto_session_free(cs);
711 /* Free file cipher restore context */
712 if (cipher_ctx.cipher) {
713 crypto_cipher_free(cipher_ctx.cipher);
714 cipher_ctx.cipher = NULL;
716 if (cipher_ctx.buf) {
717 free_pool_memory(cipher_ctx.buf);
718 cipher_ctx.buf = NULL;
721 /* Free alternate stream cipher restore context */
722 if (alt_cipher_ctx.cipher) {
723 crypto_cipher_free(alt_cipher_ctx.cipher);
724 alt_cipher_ctx.cipher = NULL;
726 if (alt_cipher_ctx.buf) {
727 free_pool_memory(alt_cipher_ctx.buf);
728 alt_cipher_ctx.buf = NULL;
731 if (jcr->compress_buf) {
732 free(jcr->compress_buf);
733 jcr->compress_buf = NULL;
734 jcr->compress_buf_size = 0;
739 free_pool_memory(jcr->acl_text);
740 Dmsg2(10, "End Do Restore. Files=%d Bytes=%s\n", jcr->JobFiles,
741 edit_uint64(jcr->JobBytes, ec1));
742 if (non_support_data > 1 || non_support_attr > 1) {
743 Jmsg(jcr, M_ERROR, 0, _("%d non-supported data streams and %d non-supported attrib streams ignored.\n"),
744 non_support_data, non_support_attr);
746 if (non_support_rsrc) {
747 Jmsg(jcr, M_INFO, 0, _("%d non-supported resource fork streams ignored.\n"), non_support_rsrc);
749 if (non_support_finfo) {
750 Jmsg(jcr, M_INFO, 0, _("%d non-supported Finder Info streams ignored.\n"), non_support_rsrc);
752 if (non_support_acl) {
753 Jmsg(jcr, M_INFO, 0, _("%d non-supported acl streams ignored.\n"), non_support_acl);
760 * Convert ZLIB error code into an ASCII message
762 static const char *zlib_strerror(int stat)
769 return _("Zlib errno");
771 return _("Zlib stream error");
773 return _("Zlib data error");
775 return _("Zlib memory error");
777 return _("Zlib buffer error");
778 case Z_VERSION_ERROR:
779 return _("Zlib version error");
786 static int do_file_digest(FF_PKT *ff_pkt, void *pkt, bool top_level)
788 JCR *jcr = (JCR *)pkt;
789 return (digest_file(jcr, ff_pkt, jcr->digest));
793 * Verify the signature for the last restored file
794 * Return value is either true (signature correct)
795 * or false (signature could not be verified).
796 * TODO landonf: Implement without using find_one_file and
797 * without re-reading the file.
799 static bool verify_signature(JCR *jcr, SIGNATURE *sig)
801 X509_KEYPAIR *keypair;
802 DIGEST *digest = NULL;
804 uint64_t saved_bytes;
806 if (!jcr->pki_sign) {
807 return true; /* no signature OK */
810 Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"),
814 /* Iterate through the trusted signers */
815 foreach_alist(keypair, jcr->pki_signers) {
816 err = crypto_sign_get_digest(sig, jcr->pki_keypair, &digest);
818 case CRYPTO_ERROR_NONE:
819 /* Signature found, digest allocated */
820 jcr->digest = digest;
822 /* Checksum the entire file */
823 /* Make sure we don't modify JobBytes by saving and restoring it */
824 saved_bytes = jcr->JobBytes;
825 if (find_one_file(jcr, jcr->ff, do_file_digest, jcr, jcr->last_fname, (dev_t)-1, 1) != 0) {
826 Jmsg(jcr, M_ERROR, 0, _("Digest one file failed for file: %s\n"),
828 jcr->JobBytes = saved_bytes;
831 jcr->JobBytes = saved_bytes;
833 /* Verify the signature */
834 if ((err = crypto_sign_verify(sig, keypair, digest)) != CRYPTO_ERROR_NONE) {
835 Dmsg1(100, "Bad signature on %s\n", jcr->last_fname);
836 Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for file %s: ERR=%s\n"),
837 jcr->last_fname, crypto_strerror(err));
841 /* Valid signature */
842 Dmsg1(100, "Signature good on %s\n", jcr->last_fname);
843 crypto_digest_free(digest);
847 case CRYPTO_ERROR_NOSIGNER:
848 /* Signature not found, try again */
850 crypto_digest_free(digest);
855 /* Something strange happened (that shouldn't happen!)... */
856 Qmsg2(jcr, M_ERROR, 0, _("Signature validation failed for %s: %s\n"), jcr->last_fname, crypto_strerror(err));
862 Dmsg1(100, "Could not find a valid public key for signature on %s\n", jcr->last_fname);
866 crypto_digest_free(digest);
872 bool sparse_data(JCR *jcr, BFILE *bfd, uint64_t *addr, char **data, uint32_t *length)
877 unser_begin(*data, SPARSE_FADDR_SIZE);
879 if (*addr != faddr) {
881 if (blseek(bfd, (boffset_t)*addr, SEEK_SET) < 0) {
883 Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"),
884 edit_uint64(*addr, ec1), jcr->last_fname,
885 be.strerror(bfd->berrno));
889 *data += SPARSE_FADDR_SIZE;
890 *length -= SPARSE_FADDR_SIZE;
894 bool decompress_data(JCR *jcr, char **data, uint32_t *length)
899 char ec1[50]; /* Buffer printing huge values */
902 * NOTE! We only use uLong and Byte because they are
903 * needed by the zlib routines, they should not otherwise
906 compress_len = jcr->compress_buf_size;
907 Dmsg2(100, "Comp_len=%d msglen=%d\n", compress_len, *length);
908 if ((stat=uncompress((Byte *)jcr->compress_buf, &compress_len,
909 (const Byte *)*data, (uLong)*length)) != Z_OK) {
910 Qmsg(jcr, M_ERROR, 0, _("Uncompression error on file %s. ERR=%s\n"),
911 jcr->last_fname, zlib_strerror(stat));
914 *data = jcr->compress_buf;
915 *length = compress_len;
916 Dmsg2(100, "Write uncompressed %d bytes, total before write=%s\n", compress_len, edit_uint64(jcr->JobBytes, ec1));
919 Qmsg(jcr, M_ERROR, 0, _("GZIP data stream found, but GZIP not configured!\n"));
924 static void unser_crypto_packet_len(RESTORE_CIPHER_CTX *ctx)
927 if (ctx->packet_len == 0 && ctx->buf_len >= CRYPTO_LEN_SIZE) {
928 unser_begin(&ctx->buf[0], CRYPTO_LEN_SIZE);
929 unser_uint32(ctx->packet_len);
930 ctx->packet_len += CRYPTO_LEN_SIZE;
934 bool store_data(JCR *jcr, BFILE *bfd, char *data, const int32_t length, bool win32_decomp)
937 if (!processWin32BackupAPIBlock(bfd, data, length)) {
939 Jmsg2(jcr, M_ERROR, 0, _("Write error in Win32 Block Decomposition on %s: %s\n"),
940 jcr->last_fname, be.strerror(bfd->berrno));
943 } else if (bwrite(bfd, data, length) != (ssize_t)length) {
945 Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: %s\n"),
946 jcr->last_fname, be.strerror(bfd->berrno));
954 * In the context of jcr, write data to bfd.
955 * We write buflen bytes in buf at addr. addr is updated in place.
956 * The flags specify whether to use sparse files or compression.
957 * Return value is the number of bytes written, or -1 on errors.
959 int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen,
960 uint64_t *addr, int flags, RESTORE_CIPHER_CTX *cipher_ctx)
962 char *wbuf; /* write buffer */
963 uint32_t wsize; /* write size */
964 uint32_t rsize; /* read size */
965 uint32_t decrypted_len = 0; /* Decryption output length */
966 char ec1[50]; /* Buffer printing huge values */
969 jcr->ReadBytes += rsize;
973 if (flags & FO_ENCRYPT) {
974 ASSERT(cipher_ctx->cipher);
976 /* NOTE: We must implement block preserving semantics for the
977 * non-streaming compression and sparse code. */
980 * Grow the crypto buffer, if necessary.
981 * crypto_cipher_update() will process only whole blocks,
982 * buffering the remaining input.
984 cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf,
985 cipher_ctx->buf_len + wsize + cipher_ctx->block_size);
987 /* Decrypt the input block */
988 if (!crypto_cipher_update(cipher_ctx->cipher,
989 (const u_int8_t *)wbuf,
991 (u_int8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
993 /* Decryption failed. Shouldn't happen. */
994 Jmsg(jcr, M_FATAL, 0, _("Decryption error\n"));
998 if (decrypted_len == 0) {
999 /* No full block of encrypted data available, write more data */
1003 Dmsg2(100, "decrypted len=%d encrypted len=%d\n", decrypted_len, wsize);
1005 cipher_ctx->buf_len += decrypted_len;
1006 wbuf = cipher_ctx->buf;
1008 /* If one full preserved block is available, write it to disk,
1009 * and then buffer any remaining data. This should be effecient
1010 * as long as Bacula's block size is not significantly smaller than the
1011 * encryption block size (extremely unlikely!) */
1012 unser_crypto_packet_len(cipher_ctx);
1013 Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1015 if (cipher_ctx->packet_len == 0 || cipher_ctx->buf_len < cipher_ctx->packet_len) {
1016 /* No full preserved block is available. */
1020 /* We have one full block, set up the filter input buffers */
1021 wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1022 wbuf = &wbuf[CRYPTO_LEN_SIZE]; /* Skip the block length header */
1023 cipher_ctx->buf_len -= cipher_ctx->packet_len;
1024 Dmsg2(30, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1027 if (flags & FO_SPARSE) {
1028 if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1033 if (flags & FO_GZIP) {
1034 if (!decompress_data(jcr, &wbuf, &wsize)) {
1039 if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1042 jcr->JobBytes += wsize;
1044 Dmsg2(30, "Write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1046 /* Clean up crypto buffers */
1047 if (flags & FO_ENCRYPT) {
1048 /* Move any remaining data to start of buffer */
1049 if (cipher_ctx->buf_len > 0) {
1050 Dmsg1(30, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1051 memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1052 cipher_ctx->buf_len);
1054 /* The packet was successfully written, reset the length so that the next
1055 * packet length may be re-read by unser_crypto_packet_len() */
1056 cipher_ctx->packet_len = 0;
1063 * In the context of jcr, flush any remaining data from the cipher context,
1064 * writing it to bfd.
1065 * Return value is true on success, false on failure.
1067 bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags,
1068 RESTORE_CIPHER_CTX *cipher_ctx)
1070 uint32_t decrypted_len = 0;
1071 char *wbuf; /* write buffer */
1072 uint32_t wsize; /* write size */
1073 char ec1[50]; /* Buffer printing huge values */
1074 bool second_pass = false;
1077 /* Write out the remaining block and free the cipher context */
1078 cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf, cipher_ctx->buf_len +
1079 cipher_ctx->block_size);
1081 if (!crypto_cipher_finalize(cipher_ctx->cipher, (uint8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1083 /* Writing out the final, buffered block failed. Shouldn't happen. */
1084 Jmsg3(jcr, M_ERROR, 0, _("Decryption error. buf_len=%d decrypt_len=%d on file %s\n"),
1085 cipher_ctx->buf_len, decrypted_len, jcr->last_fname);
1088 Dmsg2(30, "Flush decrypt len=%d buf_len=%d\n", decrypted_len, cipher_ctx->buf_len);
1089 /* If nothing new was decrypted, and our output buffer is empty, return */
1090 if (decrypted_len == 0 && cipher_ctx->buf_len == 0) {
1094 cipher_ctx->buf_len += decrypted_len;
1096 unser_crypto_packet_len(cipher_ctx);
1097 Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1098 wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1099 wbuf = &cipher_ctx->buf[CRYPTO_LEN_SIZE]; /* Decrypted, possibly decompressed output here. */
1100 cipher_ctx->buf_len -= cipher_ctx->packet_len;
1101 Dmsg2(30, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1103 if (flags & FO_SPARSE) {
1104 if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1109 if (flags & FO_GZIP) {
1110 if (!decompress_data(jcr, &wbuf, &wsize)) {
1115 Dmsg0(30, "Call store_data\n");
1116 if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1119 jcr->JobBytes += wsize;
1120 Dmsg2(30, "Flush write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1122 /* Move any remaining data to start of buffer */
1123 if (cipher_ctx->buf_len > 0) {
1124 Dmsg1(30, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1125 memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1126 cipher_ctx->buf_len);
1128 /* The packet was successfully written, reset the length so that the next
1129 * packet length may be re-read by unser_crypto_packet_len() */
1130 cipher_ctx->packet_len = 0;
1132 if (cipher_ctx->buf_len >0 && !second_pass) {
1137 /* Stop decryption */
1138 cipher_ctx->buf_len = 0;
1139 cipher_ctx->packet_len = 0;