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 int 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 */
307 // Failure is reported in verify_signature() ...
308 verify_signature(jcr, sig);
310 Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"), jcr->last_fname);
315 crypto_sign_free(sig);
319 crypto_session_free(cs);
323 Dmsg0(30, "Stop extracting.\n");
324 } else if (is_bopen(&bfd)) {
325 Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should not be open\n"));
330 * Unpack and do sanity check fo attributes.
332 if (!unpack_attributes_record(jcr, stream, sd->msg, attr)) {
335 if (file_index != attr->file_index) {
336 Jmsg(jcr, M_FATAL, 0, _("Record header file index %ld not equal record index %ld\n"),
337 file_index, attr->file_index);
338 Dmsg0(100, "File index error\n");
342 Dmsg3(200, "File %s\nattrib=%s\nattribsEx=%s\n", attr->fname,
343 attr->attr, attr->attrEx);
345 attr->data_stream = decode_stat(attr->attr, &attr->statp, &attr->LinkFI);
347 if (!is_restore_stream_supported(attr->data_stream)) {
348 if (!non_support_data++) {
349 Jmsg(jcr, M_ERROR, 0, _("%s stream not supported on this Client.\n"),
350 stream_to_ascii(attr->data_stream));
355 build_attr_output_fnames(jcr, attr);
358 * Now determine if we are extracting or not.
360 jcr->num_files_examined++;
362 stat = create_file(jcr, attr, &bfd, jcr->replace);
363 Dmsg2(30, "Outfile=%s create_file stat=%d\n", attr->ofname, stat);
368 case CF_EXTRACT: /* File created and we expect file data */
371 case CF_CREATED: /* File created, but there is no content */
373 pm_strcpy(jcr->last_fname, attr->ofname);
374 jcr->last_type = attr->type;
378 print_ls_output(jcr, attr);
380 #ifdef HAVE_DARWIN_OS
381 /* Only restore the resource fork for regular files */
382 from_base64(&rsrc_len, attr->attrEx);
383 if (attr->type == FT_REG && rsrc_len > 0) {
388 /* set attributes now because file will not be extracted */
389 set_attributes(jcr, attr, &bfd);
396 case STREAM_ENCRYPTED_SESSION_DATA:
397 crypto_error_t cryptoerr;
399 /* Do we have any keys at all? */
400 if (!jcr->pki_recipients) {
401 Jmsg(jcr, M_ERROR, 0, _("No private decryption keys have been defined to decrypt encrypted backup data.\n"));
407 /* Decode and save session keys. */
408 cryptoerr = crypto_session_decode((uint8_t *)sd->msg, (uint32_t)sd->msglen, jcr->pki_recipients, &cs);
410 case CRYPTO_ERROR_NONE:
413 case CRYPTO_ERROR_NORECIPIENT:
414 Jmsg(jcr, M_ERROR, 0, _("Missing private key required to decrypt encrypted backup data.\n"));
416 case CRYPTO_ERROR_DECRYPTION:
417 Jmsg(jcr, M_ERROR, 0, _("Decrypt of the session key failed.\n"));
420 /* Shouldn't happen */
421 Jmsg1(jcr, M_ERROR, 0, _("An error occurred while decoding encrypted session data stream: %s\n"), crypto_strerror(cryptoerr));
425 if (cryptoerr != CRYPTO_ERROR_NONE) {
431 /* Set up a decryption context */
432 if ((cipher_ctx.cipher = crypto_cipher_new(cs, false, &cipher_ctx.block_size)) == NULL) {
433 Jmsg1(jcr, M_ERROR, 0, _("Failed to initialize decryption context for %s\n"), jcr->last_fname);
434 crypto_session_free(cs);
443 case STREAM_FILE_DATA:
444 case STREAM_SPARSE_DATA:
445 case STREAM_WIN32_DATA:
446 case STREAM_GZIP_DATA:
447 case STREAM_SPARSE_GZIP_DATA:
448 case STREAM_WIN32_GZIP_DATA:
449 case STREAM_ENCRYPTED_FILE_DATA:
450 case STREAM_ENCRYPTED_WIN32_DATA:
451 case STREAM_ENCRYPTED_FILE_GZIP_DATA:
452 case STREAM_ENCRYPTED_WIN32_GZIP_DATA:
453 /* Force an expected, consistent stream type here */
454 if (extract && (prev_stream == stream || prev_stream == STREAM_UNIX_ATTRIBUTES
455 || prev_stream == STREAM_UNIX_ATTRIBUTES_EX
456 || prev_stream == STREAM_ENCRYPTED_SESSION_DATA)) {
459 if (stream == STREAM_SPARSE_DATA || stream == STREAM_SPARSE_GZIP_DATA) {
463 if (stream == STREAM_GZIP_DATA || stream == STREAM_SPARSE_GZIP_DATA
464 || stream == STREAM_WIN32_GZIP_DATA || stream == STREAM_ENCRYPTED_FILE_GZIP_DATA
465 || stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) {
469 if (stream == STREAM_ENCRYPTED_FILE_DATA
470 || stream == STREAM_ENCRYPTED_FILE_GZIP_DATA
471 || stream == STREAM_ENCRYPTED_WIN32_DATA
472 || stream == STREAM_ENCRYPTED_WIN32_GZIP_DATA) {
476 if (is_win32_stream(stream) && !have_win32_api()) {
477 set_portable_backup(&bfd);
478 flags |= FO_WIN32DECOMP; /* "decompose" BackupWrite data */
481 if (extract_data(jcr, &bfd, sd->msg, sd->msglen, &fileAddr, flags,
490 /* Resource fork stream - only recorded after a file to be restored */
491 /* Silently ignore if we cannot write - we already reported that */
492 case STREAM_ENCRYPTED_MACOS_FORK_DATA:
493 case STREAM_MACOS_FORK_DATA:
494 #ifdef HAVE_DARWIN_OS
496 jcr->ff->flags |= FO_HFSPLUS;
498 if (stream == STREAM_ENCRYPTED_MACOS_FORK_DATA) {
499 alt_flags |= FO_ENCRYPT;
501 /* Set up a decryption context */
502 if (!alt_cipher_ctx.cipher) {
503 if ((alt_cipher_ctx.cipher = crypto_cipher_new(cs, false, &alt_cipher_ctx.block_size)) == NULL) {
504 Jmsg1(jcr, M_ERROR, 0, _("Failed to initialize decryption context for %s\n"), jcr->last_fname);
505 crypto_session_free(cs);
514 if (prev_stream != stream) {
515 if (bopen_rsrc(&altbfd, jcr->last_fname, O_WRONLY | O_TRUNC | O_BINARY, 0) < 0) {
516 Jmsg(jcr, M_ERROR, 0, _(" Cannot open resource fork for %s.\n"), jcr->last_fname);
522 Dmsg0(30, "Restoring resource fork\n");
525 if (extract_data(jcr, &altbfd, sd->msg, sd->msglen, &alt_addr, alt_flags,
526 &alt_cipher_ctx) < 0) {
537 case STREAM_HFSPLUS_ATTRIBUTES:
538 #ifdef HAVE_DARWIN_OS
539 Dmsg0(30, "Restoring Finder Info\n");
540 jcr->ff->flags |= FO_HFSPLUS;
541 if (sd->msglen != 32) {
542 Jmsg(jcr, M_ERROR, 0, _(" Invalid length of Finder Info (got %d, not 32)\n"), sd->msglen);
545 if (setattrlist(jcr->last_fname, &attrList, sd->msg, sd->msglen, 0) != 0) {
546 Jmsg(jcr, M_ERROR, 0, _(" Could not set Finder Info on %s\n"), jcr->last_fname);
554 case STREAM_UNIX_ATTRIBUTES_ACCESS_ACL:
556 pm_strcpy(jcr->acl_text, sd->msg);
557 Dmsg2(400, "Restoring ACL type 0x%2x <%s>\n", BACL_TYPE_ACCESS, jcr->acl_text);
558 if (bacl_set(jcr, BACL_TYPE_ACCESS) != 0) {
559 Qmsg1(jcr, M_WARNING, 0, _("Can't restore ACL of %s\n"), jcr->last_fname);
566 case STREAM_UNIX_ATTRIBUTES_DEFAULT_ACL:
568 pm_strcpy(jcr->acl_text, sd->msg);
569 Dmsg2(400, "Restoring ACL type 0x%2x <%s>\n", BACL_TYPE_DEFAULT, jcr->acl_text);
570 if (bacl_set(jcr, BACL_TYPE_DEFAULT) != 0) {
571 Qmsg1(jcr, M_WARNING, 0, _("Can't restore default ACL of %s\n"), jcr->last_fname);
578 case STREAM_SIGNED_DIGEST:
579 /* Save signature. */
580 if (extract && (sig = crypto_sign_decode((uint8_t *)sd->msg, (uint32_t)sd->msglen)) == NULL) {
581 Jmsg1(jcr, M_ERROR, 0, _("Failed to decode message signature for %s\n"), jcr->last_fname);
585 case STREAM_MD5_DIGEST:
586 case STREAM_SHA1_DIGEST:
587 case STREAM_SHA256_DIGEST:
588 case STREAM_SHA512_DIGEST:
591 case STREAM_PROGRAM_NAMES:
592 case STREAM_PROGRAM_DATA:
593 if (!non_support_progname) {
594 Pmsg0(000, "Got Program Name or Data Stream. Ignored.\n");
595 non_support_progname++;
600 /* If extracting, wierd stream (not 1 or 2), close output file anyway */
602 Dmsg1(30, "Found wierd stream %d\n", stream);
603 if (size > 0 && !is_bopen(&bfd)) {
604 Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should be open\n"));
606 /* Flush and deallocate cipher context */
607 if (cipher_ctx.cipher) {
608 flush_cipher(jcr, &bfd, &fileAddr, flags, &cipher_ctx);
609 crypto_cipher_free(cipher_ctx.cipher);
610 cipher_ctx.cipher = NULL;
613 /* Flush and deallocate alt cipher context */
614 if (alt_cipher_ctx.cipher) {
615 flush_cipher(jcr, &altbfd, &alt_addr, alt_flags, &alt_cipher_ctx);
616 crypto_cipher_free(alt_cipher_ctx.cipher);
617 alt_cipher_ctx.cipher = NULL;
620 set_attributes(jcr, attr, &bfd);
622 /* Verify the cryptographic signature if any */
625 // Failure is reported in verify_signature() ...
626 verify_signature(jcr, sig);
628 Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"), jcr->last_fname);
633 } else if (is_bopen(&bfd)) {
634 Jmsg0(jcr, M_ERROR, 0, _("Logic error: output file should not be open\n"));
637 Jmsg(jcr, M_ERROR, 0, _("Unknown stream=%d ignored. This shouldn't happen!\n"), stream);
638 Dmsg2(0, "None of above!!! stream=%d data=%s\n", stream,sd->msg);
640 } /* end switch(stream) */
642 } /* end while get_msg() */
644 /* If output file is still open, it was the last one in the
645 * archive since we just hit an end of file, so close the file.
647 if (is_bopen(&altbfd)) {
648 bclose_chksize(jcr, &altbfd, alt_size);
651 /* Flush and deallocate cipher context */
652 if (cipher_ctx.cipher) {
653 flush_cipher(jcr, &bfd, &fileAddr, flags, &cipher_ctx);
654 crypto_cipher_free(cipher_ctx.cipher);
655 cipher_ctx.cipher = NULL;
658 /* Flush and deallocate alt cipher context */
659 if (alt_cipher_ctx.cipher) {
660 flush_cipher(jcr, &altbfd, &alt_addr, alt_flags, &alt_cipher_ctx);
661 crypto_cipher_free(alt_cipher_ctx.cipher);
662 alt_cipher_ctx.cipher = NULL;
665 set_attributes(jcr, attr, &bfd);
667 /* Verify the cryptographic signature on the last file, if any */
670 // Failure is reported in verify_signature() ...
671 verify_signature(jcr, sig);
673 Jmsg1(jcr, M_ERROR, 0, _("Missing cryptographic signature for %s\n"), jcr->last_fname);
678 if (is_bopen(&bfd)) {
682 set_jcr_job_status(jcr, JS_Terminated);
686 set_jcr_job_status(jcr, JS_ErrorTerminated);
689 /* Free Signature & Crypto Data */
691 crypto_sign_free(sig);
695 crypto_session_free(cs);
699 /* Free file cipher restore context */
700 if (cipher_ctx.cipher) {
701 crypto_cipher_free(cipher_ctx.cipher);
702 cipher_ctx.cipher = NULL;
704 if (cipher_ctx.buf) {
705 free_pool_memory(cipher_ctx.buf);
706 cipher_ctx.buf = NULL;
709 /* Free alternate stream cipher restore context */
710 if (alt_cipher_ctx.cipher) {
711 crypto_cipher_free(alt_cipher_ctx.cipher);
712 alt_cipher_ctx.cipher = NULL;
714 if (alt_cipher_ctx.buf) {
715 free_pool_memory(alt_cipher_ctx.buf);
716 alt_cipher_ctx.buf = NULL;
719 if (jcr->compress_buf) {
720 free(jcr->compress_buf);
721 jcr->compress_buf = NULL;
722 jcr->compress_buf_size = 0;
727 free_pool_memory(jcr->acl_text);
728 Dmsg2(10, "End Do Restore. Files=%d Bytes=%s\n", jcr->JobFiles,
729 edit_uint64(jcr->JobBytes, ec1));
730 if (non_support_data > 1 || non_support_attr > 1) {
731 Jmsg(jcr, M_ERROR, 0, _("%d non-supported data streams and %d non-supported attrib streams ignored.\n"),
732 non_support_data, non_support_attr);
734 if (non_support_rsrc) {
735 Jmsg(jcr, M_INFO, 0, _("%d non-supported resource fork streams ignored.\n"), non_support_rsrc);
737 if (non_support_finfo) {
738 Jmsg(jcr, M_INFO, 0, _("%d non-supported Finder Info streams ignored.\n"), non_support_rsrc);
740 if (non_support_acl) {
741 Jmsg(jcr, M_INFO, 0, _("%d non-supported acl streams ignored.\n"), non_support_acl);
748 * Convert ZLIB error code into an ASCII message
750 static const char *zlib_strerror(int stat)
757 return _("Zlib errno");
759 return _("Zlib stream error");
761 return _("Zlib data error");
763 return _("Zlib memory error");
765 return _("Zlib buffer error");
766 case Z_VERSION_ERROR:
767 return _("Zlib version error");
774 static int do_file_digest(FF_PKT *ff_pkt, void *pkt, bool top_level)
776 JCR *jcr = (JCR *)pkt;
777 return (digest_file(jcr, ff_pkt, jcr->digest));
781 * Verify the signature for the last restored file
782 * Return value is either true (signature correct)
783 * or false (signature could not be verified).
784 * TODO landonf: Implement without using find_one_file and
785 * without re-reading the file.
787 int verify_signature(JCR *jcr, SIGNATURE *sig)
789 X509_KEYPAIR *keypair;
790 DIGEST *digest = NULL;
792 uint64_t saved_bytes;
794 /* Iterate through the trusted signers */
795 foreach_alist(keypair, jcr->pki_signers) {
796 err = crypto_sign_get_digest(sig, jcr->pki_keypair, &digest);
799 case CRYPTO_ERROR_NONE:
800 /* Signature found, digest allocated */
801 jcr->digest = digest;
803 /* Checksum the entire file */
804 /* Make sure we don't modify JobBytes by saving and restoring it */
805 saved_bytes = jcr->JobBytes;
806 if (find_one_file(jcr, jcr->ff, do_file_digest, jcr, jcr->last_fname, (dev_t)-1, 1) != 0) {
807 Jmsg(jcr, M_ERROR, 0, _("Signature validation failed for %s: \n"), jcr->last_fname);
808 jcr->JobBytes = saved_bytes;
811 jcr->JobBytes = saved_bytes;
813 /* Verify the signature */
814 if ((err = crypto_sign_verify(sig, keypair, digest)) != CRYPTO_ERROR_NONE) {
815 Dmsg1(100, "Bad signature on %s\n", jcr->last_fname);
816 Jmsg2(jcr, M_ERROR, 0, _("Signature validation failed for %s: %s\n"), jcr->last_fname, crypto_strerror(err));
817 crypto_digest_free(digest);
821 /* Valid signature */
822 Dmsg1(100, "Signature good on %s\n", jcr->last_fname);
823 crypto_digest_free(digest);
826 case CRYPTO_ERROR_NOSIGNER:
827 /* Signature not found, try again */
830 /* Something strange happened (that shouldn't happen!)... */
831 Qmsg2(jcr, M_ERROR, 0, _("Signature validation failed for %s: %s\n"), jcr->last_fname, crypto_strerror(err));
833 crypto_digest_free(digest);
840 Dmsg1(100, "Could not find a valid public key for signature on %s\n", jcr->last_fname);
841 crypto_digest_free(digest);
845 bool sparse_data(JCR *jcr, BFILE *bfd, uint64_t *addr, char **data, uint32_t *length)
850 unser_begin(*data, SPARSE_FADDR_SIZE);
852 if (*addr != faddr) {
854 if (blseek(bfd, (boffset_t)*addr, SEEK_SET) < 0) {
856 Jmsg3(jcr, M_ERROR, 0, _("Seek to %s error on %s: ERR=%s\n"),
857 edit_uint64(*addr, ec1), jcr->last_fname,
858 be.strerror(bfd->berrno));
862 *data += SPARSE_FADDR_SIZE;
863 *length -= SPARSE_FADDR_SIZE;
867 bool decompress_data(JCR *jcr, char **data, uint32_t *length)
872 char ec1[50]; /* Buffer printing huge values */
875 * NOTE! We only use uLong and Byte because they are
876 * needed by the zlib routines, they should not otherwise
879 compress_len = jcr->compress_buf_size;
880 Dmsg2(100, "Comp_len=%d msglen=%d\n", compress_len, *length);
881 if ((stat=uncompress((Byte *)jcr->compress_buf, &compress_len,
882 (const Byte *)*data, (uLong)*length)) != Z_OK) {
883 Qmsg(jcr, M_ERROR, 0, _("Uncompression error on file %s. ERR=%s\n"),
884 jcr->last_fname, zlib_strerror(stat));
887 *data = jcr->compress_buf;
888 *length = compress_len;
889 Dmsg2(100, "Write uncompressed %d bytes, total before write=%s\n", compress_len, edit_uint64(jcr->JobBytes, ec1));
892 Qmsg(jcr, M_ERROR, 0, _("GZIP data stream found, but GZIP not configured!\n"));
897 static void unser_crypto_packet_len(RESTORE_CIPHER_CTX *ctx)
900 if (ctx->packet_len == 0 && ctx->buf_len >= CRYPTO_LEN_SIZE) {
901 unser_begin(&ctx->buf[0], CRYPTO_LEN_SIZE);
902 unser_uint32(ctx->packet_len);
903 ctx->packet_len += CRYPTO_LEN_SIZE;
907 bool store_data(JCR *jcr, BFILE *bfd, char *data, const int32_t length, bool win32_decomp)
910 if (!processWin32BackupAPIBlock(bfd, data, length)) {
912 Jmsg2(jcr, M_ERROR, 0, _("Write error in Win32 Block Decomposition on %s: %s\n"),
913 jcr->last_fname, be.strerror(bfd->berrno));
916 } else if (bwrite(bfd, data, length) != (ssize_t)length) {
918 Jmsg2(jcr, M_ERROR, 0, _("Write error on %s: %s\n"),
919 jcr->last_fname, be.strerror(bfd->berrno));
927 * In the context of jcr, write data to bfd.
928 * We write buflen bytes in buf at addr. addr is updated in place.
929 * The flags specify whether to use sparse files or compression.
930 * Return value is the number of bytes written, or -1 on errors.
932 int32_t extract_data(JCR *jcr, BFILE *bfd, POOLMEM *buf, int32_t buflen,
933 uint64_t *addr, int flags, RESTORE_CIPHER_CTX *cipher_ctx)
935 char *wbuf; /* write buffer */
936 uint32_t wsize; /* write size */
937 uint32_t rsize; /* read size */
938 uint32_t decrypted_len = 0; /* Decryption output length */
939 char ec1[50]; /* Buffer printing huge values */
942 jcr->ReadBytes += rsize;
946 if (flags & FO_ENCRYPT) {
947 ASSERT(cipher_ctx->cipher);
949 /* NOTE: We must implement block preserving semantics for the
950 * non-streaming compression and sparse code. */
953 * Grow the crypto buffer, if necessary.
954 * crypto_cipher_update() will process only whole blocks,
955 * buffering the remaining input.
957 cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf,
958 cipher_ctx->buf_len + wsize + cipher_ctx->block_size);
960 /* Decrypt the input block */
961 if (!crypto_cipher_update(cipher_ctx->cipher,
962 (const u_int8_t *)wbuf,
964 (u_int8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
966 /* Decryption failed. Shouldn't happen. */
967 Jmsg(jcr, M_FATAL, 0, _("Decryption error\n"));
971 if (decrypted_len == 0) {
972 /* No full block of encrypted data available, write more data */
976 Dmsg2(100, "decrypted len=%d encrypted len=%d\n", decrypted_len, wsize);
978 cipher_ctx->buf_len += decrypted_len;
979 wbuf = cipher_ctx->buf;
981 /* If one full preserved block is available, write it to disk,
982 * and then buffer any remaining data. This should be effecient
983 * as long as Bacula's block size is not significantly smaller than the
984 * encryption block size (extremely unlikely!) */
985 unser_crypto_packet_len(cipher_ctx);
986 Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
988 if (cipher_ctx->packet_len == 0 || cipher_ctx->buf_len < cipher_ctx->packet_len) {
989 /* No full preserved block is available. */
993 /* We have one full block, set up the filter input buffers */
994 wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
995 wbuf = &wbuf[CRYPTO_LEN_SIZE]; /* Skip the block length header */
996 cipher_ctx->buf_len -= cipher_ctx->packet_len;
997 Dmsg2(30, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1000 if (flags & FO_SPARSE) {
1001 if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1006 if (flags & FO_GZIP) {
1007 if (!decompress_data(jcr, &wbuf, &wsize)) {
1012 if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1015 jcr->JobBytes += wsize;
1017 Dmsg2(30, "Write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1019 /* Clean up crypto buffers */
1020 if (flags & FO_ENCRYPT) {
1021 /* Move any remaining data to start of buffer */
1022 if (cipher_ctx->buf_len > 0) {
1023 Dmsg1(30, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1024 memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1025 cipher_ctx->buf_len);
1027 /* The packet was successfully written, reset the length so that the next
1028 * packet length may be re-read by unser_crypto_packet_len() */
1029 cipher_ctx->packet_len = 0;
1036 * In the context of jcr, flush any remaining data from the cipher context,
1037 * writing it to bfd.
1038 * Return value is true on success, false on failure.
1040 bool flush_cipher(JCR *jcr, BFILE *bfd, uint64_t *addr, int flags,
1041 RESTORE_CIPHER_CTX *cipher_ctx)
1043 uint32_t decrypted_len;
1044 char *wbuf; /* write buffer */
1045 uint32_t wsize; /* write size */
1046 char ec1[50]; /* Buffer printing huge values */
1047 bool second_pass = false;
1050 /* Write out the remaining block and free the cipher context */
1051 cipher_ctx->buf = check_pool_memory_size(cipher_ctx->buf, cipher_ctx->buf_len +
1052 cipher_ctx->block_size);
1054 if (!crypto_cipher_finalize(cipher_ctx->cipher, (uint8_t *)&cipher_ctx->buf[cipher_ctx->buf_len],
1056 /* Writing out the final, buffered block failed. Shouldn't happen. */
1057 Jmsg1(jcr, M_FATAL, 0, _("Decryption error for %s\n"), jcr->last_fname);
1060 Dmsg2(30, "Flush decrypt len=%d buf_len=%d\n", decrypted_len, cipher_ctx->buf_len);
1061 /* If nothing new was decrypted, and our output buffer is empty, return */
1062 if (decrypted_len == 0 && cipher_ctx->buf_len == 0) {
1066 cipher_ctx->buf_len += decrypted_len;
1068 unser_crypto_packet_len(cipher_ctx);
1069 Dmsg1(500, "Crypto unser block size=%d\n", cipher_ctx->packet_len - CRYPTO_LEN_SIZE);
1070 wsize = cipher_ctx->packet_len - CRYPTO_LEN_SIZE;
1071 wbuf = &cipher_ctx->buf[CRYPTO_LEN_SIZE]; /* Decrypted, possibly decompressed output here. */
1072 cipher_ctx->buf_len -= cipher_ctx->packet_len;
1073 Dmsg2(30, "Encryption writing full block, %u bytes, remaining %u bytes in buffer\n", wsize, cipher_ctx->buf_len);
1076 Dmsg2(30, "check buf_len=%d pkt_len=%d\n", cipher_ctx->buf_len, cipher_ctx->packet_len);
1077 if (second_pass && cipher_ctx->buf_len != cipher_ctx->packet_len) {
1078 Jmsg2(jcr, M_FATAL, 0,
1079 _("Unexpected number of bytes remaining at end of file, received %u, expected %u\n"),
1080 cipher_ctx->packet_len, cipher_ctx->buf_len);
1085 if (flags & FO_SPARSE) {
1086 if (!sparse_data(jcr, bfd, addr, &wbuf, &wsize)) {
1091 if (flags & FO_GZIP) {
1092 if (!decompress_data(jcr, &wbuf, &wsize)) {
1097 Dmsg0(30, "Call store_data\n");
1098 if (!store_data(jcr, bfd, wbuf, wsize, (flags & FO_WIN32DECOMP) != 0)) {
1101 jcr->JobBytes += wsize;
1102 Dmsg2(30, "Flush write %u bytes, JobBytes=%s\n", wsize, edit_uint64(jcr->JobBytes, ec1));
1104 /* Move any remaining data to start of buffer */
1105 if (cipher_ctx->buf_len > 0) {
1106 Dmsg1(30, "Moving %u buffered bytes to start of buffer\n", cipher_ctx->buf_len);
1107 memmove(cipher_ctx->buf, &cipher_ctx->buf[cipher_ctx->packet_len],
1108 cipher_ctx->buf_len);
1110 /* The packet was successfully written, reset the length so that the next
1111 * packet length may be re-read by unser_crypto_packet_len() */
1112 cipher_ctx->packet_len = 0;
1114 if (cipher_ctx->buf_len >0 && !second_pass) {
1119 /* Stop decryption */
1120 cipher_ctx->buf_len = 0;
1121 cipher_ctx->packet_len = 0;