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 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 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 backup.c send file attributes and data
30 * to the Storage daemon.
32 * Kern Sibbald, March MM
41 /* Forward referenced functions */
42 static int save_file(FF_PKT *ff_pkt, void *pkt, bool top_level);
43 static void strip_path(FF_PKT *ff_pkt);
44 static void unstrip_path(FF_PKT *ff_pkt);
45 static int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, DIGEST *digest, DIGEST *signature_digest);
46 static bool encode_and_send_attributes(JCR *jcr, FF_PKT *ff_pkt, int &data_stream);
47 static bool read_and_send_acl(JCR *jcr, int acltype, int stream);
50 * Find all the requested files and send them
51 * to the Storage daemon.
53 * Note, we normally carry on a one-way
54 * conversation from this point on with the SD, simply blasting
55 * data to him. To properly know what is going on, we
56 * also run a "heartbeat" monitor which reads the socket and
57 * reacts accordingly (at the moment it has nothing to do
58 * except echo the heartbeat to the Director).
61 bool blast_data_to_storage_daemon(JCR *jcr, char *addr)
65 // TODO landonf: Allow user to specify encryption algorithm
66 crypto_cipher_t cipher = CRYPTO_CIPHER_AES_128_CBC;
69 sd = jcr->store_bsock;
71 set_jcr_job_status(jcr, JS_Running);
73 Dmsg1(300, "bfiled: opened data connection %d to stored\n", sd->m_fd);
76 CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL);
80 buf_size = client->max_network_buffer_size;
82 buf_size = 0; /* use default */
84 if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) {
85 set_jcr_job_status(jcr, JS_ErrorTerminated);
86 Jmsg(jcr, M_FATAL, 0, _("Cannot set buffer size FD->SD.\n"));
90 jcr->buf_size = sd->msglen;
91 /* Adjust for compression so that output buffer is
92 * 12 bytes + 0.1% larger than input buffer plus 18 bytes.
93 * This gives a bit extra plus room for the sparse addr if any.
94 * Note, we adjust the read size to be smaller so that the
95 * same output buffer can be used without growing it.
97 * The zlib compression workset is initialized here to minimise
98 * the "per file" load. The jcr member is only set, if the init was successful.
100 jcr->compress_buf_size = jcr->buf_size + ((jcr->buf_size+999) / 1000) + 30;
101 jcr->compress_buf = get_memory(jcr->compress_buf_size);
104 z_stream *pZlibStream = (z_stream*)malloc(sizeof(z_stream));
106 pZlibStream->zalloc = Z_NULL;
107 pZlibStream->zfree = Z_NULL;
108 pZlibStream->opaque = Z_NULL;
109 pZlibStream->state = Z_NULL;
111 if (deflateInit(pZlibStream, Z_DEFAULT_COMPRESSION) == Z_OK)
112 jcr->pZLIB_compress_workset = pZlibStream;
118 /* Create encryption session data and a cached, DER-encoded session data
119 * structure. We use a single session key for each backup, so we'll encode
120 * the session data only once. */
121 if (jcr->pki_encrypt) {
124 /* Create per-job session encryption context */
125 jcr->pki_session = crypto_session_new(cipher, jcr->pki_recipients);
127 /* Get the session data size */
128 if (crypto_session_encode(jcr->pki_session, (uint8_t *)0, &size) == false) {
129 Jmsg(jcr, M_FATAL, 0, _("An error occurred while encrypting the stream.\n"));
133 /* Allocate buffer */
134 jcr->pki_session_encoded = (uint8_t *)malloc(size);
136 /* Encode session data */
137 if (crypto_session_encode(jcr->pki_session, jcr->pki_session_encoded, &size) == false) {
138 Jmsg(jcr, M_FATAL, 0, _("An error occurred while encrypting the stream.\n"));
142 /* ... and store the encoded size */
143 jcr->pki_session_encoded_size = size;
145 /* Allocate the encryption/decryption buffer */
146 jcr->crypto_buf = get_memory(CRYPTO_CIPHER_MAX_BLOCK_SIZE);
149 Dmsg1(300, "set_find_options ff=%p\n", jcr->ff);
150 set_find_options((FF_PKT *)jcr->ff, jcr->incremental, jcr->mtime);
151 Dmsg0(300, "start find files\n");
153 start_heartbeat_monitor(jcr);
155 jcr->acl_text = get_pool_memory(PM_MESSAGE);
157 /* Subroutine save_file() is called for each file */
158 if (!find_files(jcr, (FF_PKT *)jcr->ff, save_file, (void *)jcr)) {
159 ok = false; /* error */
160 set_jcr_job_status(jcr, JS_ErrorTerminated);
163 free_pool_memory(jcr->acl_text);
165 stop_heartbeat_monitor(jcr);
167 sd->signal(BNET_EOD); /* end of sending data */
173 if (jcr->compress_buf) {
174 free_pool_memory(jcr->compress_buf);
175 jcr->compress_buf = NULL;
177 if (jcr->pZLIB_compress_workset) {
178 /* Free the zlib stream */
180 deflateEnd((z_stream *)jcr->pZLIB_compress_workset);
182 free (jcr->pZLIB_compress_workset);
183 jcr->pZLIB_compress_workset = NULL;
185 if (jcr->crypto_buf) {
186 free_pool_memory(jcr->crypto_buf);
187 jcr->crypto_buf = NULL;
189 if (jcr->pki_session) {
190 crypto_session_free(jcr->pki_session);
192 if (jcr->pki_session_encoded) {
193 free(jcr->pki_session_encoded);
194 jcr->pki_session_encoded = NULL;
197 Dmsg1(100, "end blast_data ok=%d\n", ok);
202 * Called here by find() for each file included.
203 * This is a callback. The original is find_files() above.
205 * Send the file and its data to the Storage daemon.
209 * -1 to ignore file/directory (not used here)
211 static int save_file(FF_PKT *ff_pkt, void *vjcr, bool top_level)
213 bool do_read = false;
214 int stat, data_stream;
216 DIGEST *digest = NULL;
217 DIGEST *signing_digest = NULL;
218 int digest_stream = STREAM_NONE;
219 SIGNATURE *sig = NULL;
220 bool has_file_data = false;
221 // TODO landonf: Allow the user to specify the digest algorithm
223 crypto_digest_t signing_algorithm = CRYPTO_DIGEST_SHA256;
225 crypto_digest_t signing_algorithm = CRYPTO_DIGEST_SHA1;
227 JCR *jcr = (JCR *)vjcr;
228 BSOCK *sd = jcr->store_bsock;
230 if (job_canceled(jcr)) {
234 jcr->num_files_examined++; /* bump total file count */
236 switch (ff_pkt->type) {
237 case FT_LNKSAVED: /* Hard linked, file already saved */
238 Dmsg2(130, "FT_LNKSAVED hard link: %s => %s\n", ff_pkt->fname, ff_pkt->link);
241 Dmsg1(130, "FT_REGE saving: %s\n", ff_pkt->fname);
242 has_file_data = true;
245 Dmsg1(130, "FT_REG saving: %s\n", ff_pkt->fname);
246 has_file_data = true;
249 Dmsg2(130, "FT_LNK saving: %s -> %s\n", ff_pkt->fname, ff_pkt->link);
252 jcr->num_files_examined--; /* correct file count */
253 return 1; /* not used */
255 Jmsg(jcr, M_INFO, 1, _(" Recursion turned off. Will not descend from %s into %s\n"),
256 ff_pkt->top_fname, ff_pkt->fname);
257 ff_pkt->type = FT_DIREND; /* Backup only the directory entry */
260 /* Suppress message for /dev filesystems */
261 if (strncmp(ff_pkt->fname, "/dev/", 5) != 0) {
262 Jmsg(jcr, M_INFO, 1, _(" %s is a different filesystem. Will not descend from %s into %s\n"),
263 ff_pkt->fname, ff_pkt->top_fname, ff_pkt->fname);
265 ff_pkt->type = FT_DIREND; /* Backup only the directory entry */
268 Jmsg(jcr, M_INFO, 1, _(" Disallowed filesystem. Will not descend from %s into %s\n"),
269 ff_pkt->top_fname, ff_pkt->fname);
270 ff_pkt->type = FT_DIREND; /* Backup only the directory entry */
273 Jmsg(jcr, M_INFO, 1, _(" Disallowed drive type. Will not descend into %s\n"),
277 Dmsg1(130, "FT_DIREND: %s\n", ff_pkt->link);
280 Dmsg1(130, "FT_SPEC saving: %s\n", ff_pkt->fname);
283 Dmsg1(130, "FT_RAW saving: %s\n", ff_pkt->fname);
284 has_file_data = true;
287 Dmsg1(130, "FT_FIFO saving: %s\n", ff_pkt->fname);
291 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not access %s: ERR=%s\n"), ff_pkt->fname,
292 be.bstrerror(ff_pkt->ff_errno));
298 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not follow link %s: ERR=%s\n"),
299 ff_pkt->fname, be.bstrerror(ff_pkt->ff_errno));
305 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not stat %s: ERR=%s\n"), ff_pkt->fname,
306 be.bstrerror(ff_pkt->ff_errno));
312 Jmsg(jcr, M_SKIPPED, 1, _(" Unchanged file skipped: %s\n"), ff_pkt->fname);
315 Jmsg(jcr, M_NOTSAVED, 0, _(" Archive file not saved: %s\n"), ff_pkt->fname);
319 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not open directory %s: ERR=%s\n"),
320 ff_pkt->fname, be.bstrerror(ff_pkt->ff_errno));
325 Jmsg(jcr, M_NOTSAVED, 0, _(" Unknown file type %d; not saved: %s\n"),
326 ff_pkt->type, ff_pkt->fname);
331 Dmsg1(130, "bfiled: sending %s to stored\n", ff_pkt->fname);
333 /* Digests and encryption are only useful if there's file data */
336 * Setup for digest handling. If this fails, the digest will be set to NULL
337 * and not used. Note, the digest (file hash) can be any one of the four
340 * The signing digest is a single algorithm depending on
341 * whether or not we have SHA2.
342 * ****FIXME**** the signing algoritm should really be
343 * determined a different way!!!!!! What happens if
344 * sha2 was available during backup but not restore?
346 if (ff_pkt->flags & FO_MD5) {
347 digest = crypto_digest_new(jcr, CRYPTO_DIGEST_MD5);
348 digest_stream = STREAM_MD5_DIGEST;
350 } else if (ff_pkt->flags & FO_SHA1) {
351 digest = crypto_digest_new(jcr, CRYPTO_DIGEST_SHA1);
352 digest_stream = STREAM_SHA1_DIGEST;
354 } else if (ff_pkt->flags & FO_SHA256) {
355 digest = crypto_digest_new(jcr, CRYPTO_DIGEST_SHA256);
356 digest_stream = STREAM_SHA256_DIGEST;
358 } else if (ff_pkt->flags & FO_SHA512) {
359 digest = crypto_digest_new(jcr, CRYPTO_DIGEST_SHA512);
360 digest_stream = STREAM_SHA512_DIGEST;
363 /* Did digest initialization fail? */
364 if (digest_stream != STREAM_NONE && digest == NULL) {
365 Jmsg(jcr, M_WARNING, 0, _("%s digest initialization failed\n"),
366 stream_to_ascii(digest_stream));
370 * Set up signature digest handling. If this fails, the signature digest will be set to
373 // TODO landonf: We should really only calculate the digest once, for both verification and signing.
375 signing_digest = crypto_digest_new(jcr, signing_algorithm);
377 /* Full-stop if a failure occurred initializing the signature digest */
378 if (signing_digest == NULL) {
379 Jmsg(jcr, M_NOTSAVED, 0, _("%s signature digest initialization failed\n"),
380 stream_to_ascii(signing_algorithm));
386 /* Enable encryption */
387 if (jcr->pki_encrypt) {
388 ff_pkt->flags |= FO_ENCRYPT;
392 /* Initialise the file descriptor we use for data and other streams. */
394 if (ff_pkt->flags & FO_PORTABLE) {
395 set_portable_backup(&ff_pkt->bfd); /* disable Win32 BackupRead() */
397 if (ff_pkt->reader) {
398 if (!set_prog(&ff_pkt->bfd, ff_pkt->reader, jcr)) {
399 Jmsg(jcr, M_FATAL, 0, _("Python reader program \"%s\" not found.\n"),
405 /* Send attributes -- must be done after binit() */
406 if (!encode_and_send_attributes(jcr, ff_pkt, data_stream)) {
410 /* Set up the encryption context and send the session data to the SD */
411 if (has_file_data && jcr->pki_encrypt) {
412 /* Send our header */
413 Dmsg2(100, "Send hdr fi=%ld stream=%d\n", jcr->JobFiles, STREAM_ENCRYPTED_SESSION_DATA);
414 sd->fsend("%ld %d 0", jcr->JobFiles, STREAM_ENCRYPTED_SESSION_DATA);
416 /* Grow the bsock buffer to fit our message if necessary */
417 if (sizeof_pool_memory(sd->msg) < jcr->pki_session_encoded_size) {
418 sd->msg = realloc_pool_memory(sd->msg, jcr->pki_session_encoded_size);
421 /* Copy our message over and send it */
422 memcpy(sd->msg, jcr->pki_session_encoded, jcr->pki_session_encoded_size);
423 sd->msglen = jcr->pki_session_encoded_size;
424 jcr->JobBytes += sd->msglen;
426 Dmsg1(100, "Send data len=%d\n", sd->msglen);
428 sd->signal(BNET_EOD);
432 * Open any file with data that we intend to save, then save it.
434 * Note, if is_win32_backup, we must open the Directory so that
435 * the BackupRead will save its permissions and ownership streams.
437 if (ff_pkt->type != FT_LNKSAVED && S_ISREG(ff_pkt->statp.st_mode)) {
439 do_read = !is_portable_backup(&ff_pkt->bfd) || ff_pkt->statp.st_size > 0;
441 do_read = ff_pkt->statp.st_size > 0;
443 } else if (ff_pkt->type == FT_RAW || ff_pkt->type == FT_FIFO ||
444 (!is_portable_backup(&ff_pkt->bfd) && ff_pkt->type == FT_DIREND)) {
450 if (ff_pkt->type == FT_FIFO) {
451 tid = start_thread_timer(pthread_self(), 60);
455 int noatime = ff_pkt->flags & FO_NOATIME ? O_NOATIME : 0;
456 if (bopen(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY | noatime, 0) < 0) {
457 ff_pkt->ff_errno = errno;
459 Jmsg(jcr, M_NOTSAVED, 0, _(" Cannot open %s: ERR=%s.\n"), ff_pkt->fname,
463 stop_thread_timer(tid);
469 stop_thread_timer(tid);
473 stat = send_data(jcr, data_stream, ff_pkt, digest, signing_digest);
475 if (ff_pkt->flags & FO_CHKCHANGES) {
476 has_file_changed(jcr, ff_pkt);
479 bclose(&ff_pkt->bfd);
486 #ifdef HAVE_DARWIN_OS
487 /* Regular files can have resource forks and Finder Info */
488 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
489 ff_pkt->flags & FO_HFSPLUS)) {
490 if (ff_pkt->hfsinfo.rsrclength > 0) {
493 if (!bopen_rsrc(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
494 ff_pkt->ff_errno = errno;
496 Jmsg(jcr, M_NOTSAVED, -1, _(" Cannot open resource fork for %s: ERR=%s.\n"),
497 ff_pkt->fname, be.bstrerror());
499 if (is_bopen(&ff_pkt->bfd)) {
500 bclose(&ff_pkt->bfd);
504 flags = ff_pkt->flags;
505 ff_pkt->flags &= ~(FO_GZIP|FO_SPARSE);
506 if (flags & FO_ENCRYPT) {
507 rsrc_stream = STREAM_ENCRYPTED_MACOS_FORK_DATA;
509 rsrc_stream = STREAM_MACOS_FORK_DATA;
511 stat = send_data(jcr, rsrc_stream, ff_pkt, digest, signing_digest);
512 ff_pkt->flags = flags;
513 bclose(&ff_pkt->bfd);
519 Dmsg1(300, "Saving Finder Info for \"%s\"\n", ff_pkt->fname);
520 sd->fsend("%ld %d 0", jcr->JobFiles, STREAM_HFSPLUS_ATTRIBUTES);
521 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
522 memcpy(sd->msg, ff_pkt->hfsinfo.fndrinfo, 32);
525 crypto_digest_update(digest, (uint8_t *)sd->msg, sd->msglen);
527 if (signing_digest) {
528 crypto_digest_update(signing_digest, (uint8_t *)sd->msg, sd->msglen);
531 sd->signal(BNET_EOD);
535 if (ff_pkt->flags & FO_ACL) {
536 /* Read access ACLs for files, dirs and links */
537 if (!read_and_send_acl(jcr, BACL_TYPE_ACCESS, STREAM_UNIX_ATTRIBUTES_ACCESS_ACL)) {
540 /* Directories can have default ACLs too */
541 if (ff_pkt->type == FT_DIREND && (BACL_CAP & BACL_CAP_DEFAULTS_DIR)) {
542 if (!read_and_send_acl(jcr, BACL_TYPE_DEFAULT, STREAM_UNIX_ATTRIBUTES_DEFAULT_ACL)) {
548 /* Terminate the signing digest and send it to the Storage daemon */
549 if (signing_digest) {
552 if ((sig = crypto_sign_new(jcr)) == NULL) {
553 Jmsg(jcr, M_FATAL, 0, _("Failed to allocate memory for crypto signature.\n"));
557 if (!crypto_sign_add_signer(sig, signing_digest, jcr->pki_keypair)) {
558 Jmsg(jcr, M_FATAL, 0, _("An error occurred while signing the stream.\n"));
562 /* Get signature size */
563 if (!crypto_sign_encode(sig, NULL, &size)) {
564 Jmsg(jcr, M_FATAL, 0, _("An error occurred while signing the stream.\n"));
568 /* Grow the bsock buffer to fit our message if necessary */
569 if (sizeof_pool_memory(sd->msg) < (int32_t)size) {
570 sd->msg = realloc_pool_memory(sd->msg, size);
573 /* Send our header */
574 sd->fsend("%ld %d 0", jcr->JobFiles, STREAM_SIGNED_DIGEST);
575 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
577 /* Encode signature data */
578 if (!crypto_sign_encode(sig, (uint8_t *)sd->msg, &size)) {
579 Jmsg(jcr, M_FATAL, 0, _("An error occurred while signing the stream.\n"));
585 sd->signal(BNET_EOD); /* end of checksum */
588 /* Terminate any digest and send it to Storage daemon and the Director */
592 sd->fsend("%ld %d 0", jcr->JobFiles, digest_stream);
593 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
595 size = sizeof(CRYPTO_DIGEST_MAX_SIZE);
596 /* Grow the bsock buffer to fit our message if necessary */
597 if (sizeof_pool_memory(sd->msg) < (int32_t)size) {
598 sd->msg = realloc_pool_memory(sd->msg, size);
601 if (!crypto_digest_finalize(digest, (uint8_t *)sd->msg, &size)) {
602 Jmsg(jcr, M_FATAL, 0, _("An error occurred finalizing signing the stream.\n"));
608 sd->signal(BNET_EOD); /* end of checksum */
612 rtnstat = 1; /* good return */
616 crypto_digest_free(digest);
618 if (signing_digest) {
619 crypto_digest_free(signing_digest);
622 crypto_sign_free(sig);
628 * Send data read from an already open file descriptor.
630 * We return 1 on sucess and 0 on errors.
633 * We use ff_pkt->statp.st_size when FO_SPARSE to know when to stop
635 * Currently this is not a problem as the only other stream, resource forks,
636 * are not handled as sparse files.
638 int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, DIGEST *digest,
639 DIGEST *signing_digest)
641 BSOCK *sd = jcr->store_bsock;
642 uint64_t fileAddr = 0; /* file address */
644 int32_t rsize = jcr->buf_size; /* read buffer size */
646 CIPHER_CONTEXT *cipher_ctx = NULL; /* Quell bogus uninitialized warnings */
647 const uint8_t *cipher_input;
648 uint32_t cipher_input_len;
649 uint32_t cipher_block_size;
650 uint32_t encrypted_len;
651 #ifdef FD_NO_SEND_TEST
656 rbuf = sd->msg; /* read buffer */
657 wbuf = sd->msg; /* write buffer */
658 cipher_input = (uint8_t *)rbuf; /* encrypt uncompressed data */
660 Dmsg1(300, "Saving data, type=%d\n", ff_pkt->type);
663 uLong compress_len = 0;
664 uLong max_compress_len = 0;
665 const Bytef *cbuf = NULL;
668 if (ff_pkt->flags & FO_GZIP) {
669 if (ff_pkt->flags & FO_SPARSE) {
670 cbuf = (Bytef *)jcr->compress_buf + SPARSE_FADDR_SIZE;
671 max_compress_len = jcr->compress_buf_size - SPARSE_FADDR_SIZE;
673 cbuf = (Bytef *)jcr->compress_buf;
674 max_compress_len = jcr->compress_buf_size; /* set max length */
676 wbuf = jcr->compress_buf; /* compressed output here */
677 cipher_input = (uint8_t *)jcr->compress_buf; /* encrypt compressed data */
680 * Only change zlib parameters if there is no pending operation.
681 * This should never happen as deflatereset is called after each
685 if (((z_stream*)jcr->pZLIB_compress_workset)->total_in == 0) {
686 /* set gzip compression level - must be done per file */
687 if ((zstat=deflateParams((z_stream*)jcr->pZLIB_compress_workset,
688 ff_pkt->GZIP_level, Z_DEFAULT_STRATEGY)) != Z_OK) {
689 Jmsg(jcr, M_FATAL, 0, _("Compression deflateParams error: %d\n"), zstat);
690 set_jcr_job_status(jcr, JS_ErrorTerminated);
696 const uint32_t max_compress_len = 0;
699 if (ff_pkt->flags & FO_ENCRYPT) {
700 if (ff_pkt->flags & FO_SPARSE) {
701 Jmsg0(jcr, M_FATAL, 0, _("Encrypting sparse data not supported.\n"));
704 /* Allocate the cipher context */
705 if ((cipher_ctx = crypto_cipher_new(jcr->pki_session, true,
706 &cipher_block_size)) == NULL) {
707 /* Shouldn't happen! */
708 Jmsg0(jcr, M_FATAL, 0, _("Failed to initialize encryption context.\n"));
713 * Grow the crypto buffer, if necessary.
714 * crypto_cipher_update() will buffer up to (cipher_block_size - 1).
715 * We grow crypto_buf to the maximum number of blocks that
716 * could be returned for the given read buffer size.
717 * (Using the larger of either rsize or max_compress_len)
719 jcr->crypto_buf = check_pool_memory_size(jcr->crypto_buf,
720 (MAX(rsize + (int)sizeof(uint32_t), (int32_t)max_compress_len) +
721 cipher_block_size - 1) / cipher_block_size * cipher_block_size);
723 wbuf = jcr->crypto_buf; /* Encrypted, possibly compressed output here. */
727 * Send Data header to Storage daemon
728 * <file-index> <stream> <info>
730 if (!sd->fsend("%ld %d 0", jcr->JobFiles, stream)) {
731 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
735 Dmsg1(300, ">stored: datahdr %s\n", sd->msg);
738 * Make space at beginning of buffer for fileAddr because this
739 * same buffer will be used for writing if compression is off.
741 if (ff_pkt->flags & FO_SPARSE) {
742 rbuf += SPARSE_FADDR_SIZE;
743 rsize -= SPARSE_FADDR_SIZE;
744 #ifdef HAVE_FREEBSD_OS
746 * To read FreeBSD partitions, the read size must be
749 rsize = (rsize/512) * 512;
753 /* a RAW device read on win32 only works if the buffer is a multiple of 512 */
755 if (S_ISBLK(ff_pkt->statp.st_mode))
756 rsize = (rsize/512) * 512;
762 while ((sd->msglen=(uint32_t)bread(&ff_pkt->bfd, rbuf, rsize)) > 0) {
764 /* Check for sparse blocks */
765 if (ff_pkt->flags & FO_SPARSE) {
767 bool haveBlock = true;
768 if (sd->msglen == rsize &&
769 fileAddr+sd->msglen < (uint64_t)ff_pkt->statp.st_size ||
770 ((ff_pkt->type == FT_RAW || ff_pkt->type == FT_FIFO) &&
771 (uint64_t)ff_pkt->statp.st_size == 0)) {
772 haveBlock = !is_buf_zero(rbuf, rsize);
775 ser_begin(wbuf, SPARSE_FADDR_SIZE);
776 ser_uint64(fileAddr); /* store fileAddr in begin of buffer */
778 fileAddr += sd->msglen; /* update file address */
780 continue; /* skip block of zeros */
784 jcr->ReadBytes += sd->msglen; /* count bytes read */
786 /* Uncompressed cipher input length */
787 cipher_input_len = sd->msglen;
789 /* Update checksum if requested */
791 crypto_digest_update(digest, (uint8_t *)rbuf, sd->msglen);
794 /* Update signing digest if requested */
795 if (signing_digest) {
796 crypto_digest_update(signing_digest, (uint8_t *)rbuf, sd->msglen);
800 /* Do compression if turned on */
801 if (ff_pkt->flags & FO_GZIP && jcr->pZLIB_compress_workset) {
802 Dmsg3(400, "cbuf=0x%x rbuf=0x%x len=%u\n", cbuf, rbuf, sd->msglen);
804 ((z_stream*)jcr->pZLIB_compress_workset)->next_in = (Bytef *)rbuf;
805 ((z_stream*)jcr->pZLIB_compress_workset)->avail_in = sd->msglen;
806 ((z_stream*)jcr->pZLIB_compress_workset)->next_out = (Bytef *)cbuf;
807 ((z_stream*)jcr->pZLIB_compress_workset)->avail_out = max_compress_len;
809 if ((zstat=deflate((z_stream*)jcr->pZLIB_compress_workset, Z_FINISH)) != Z_STREAM_END) {
810 Jmsg(jcr, M_FATAL, 0, _("Compression deflate error: %d\n"), zstat);
811 set_jcr_job_status(jcr, JS_ErrorTerminated);
814 compress_len = ((z_stream*)jcr->pZLIB_compress_workset)->total_out;
815 /* reset zlib stream to be able to begin from scratch again */
816 if ((zstat=deflateReset((z_stream*)jcr->pZLIB_compress_workset)) != Z_OK) {
817 Jmsg(jcr, M_FATAL, 0, _("Compression deflateReset error: %d\n"), zstat);
818 set_jcr_job_status(jcr, JS_ErrorTerminated);
822 Dmsg2(400, "compressed len=%d uncompressed len=%d\n", compress_len,
825 sd->msglen = compress_len; /* set compressed length */
826 cipher_input_len = compress_len;
830 * Note, here we prepend the current record length to the beginning
831 * of the encrypted data. This is because both sparse and compression
832 * restore handling want records returned to them with exactly the
833 * same number of bytes that were processed in the backup handling.
834 * That is, both are block filters rather than a stream. When doing
835 * compression, the compression routines may buffer data, so that for
836 * any one record compressed, when it is decompressed the same size
837 * will not be obtained. Of course, the buffered data eventually comes
838 * out in subsequent crypto_cipher_update() calls or at least
839 * when crypto_cipher_finalize() is called. Unfortunately, this
840 * "feature" of encryption enormously complicates the restore code.
842 if (ff_pkt->flags & FO_ENCRYPT) {
843 uint32_t initial_len = 0;
846 if (ff_pkt->flags & FO_SPARSE) {
847 cipher_input_len += SPARSE_FADDR_SIZE;
850 /* Encrypt the length of the input block */
851 uint8_t packet_len[sizeof(uint32_t)];
853 ser_begin(packet_len, sizeof(uint32_t));
854 ser_uint32(cipher_input_len); /* store data len in begin of buffer */
855 Dmsg1(20, "Encrypt len=%d\n", cipher_input_len);
857 if (!crypto_cipher_update(cipher_ctx, packet_len, sizeof(packet_len),
858 (u_int8_t *)jcr->crypto_buf, &initial_len)) {
859 /* Encryption failed. Shouldn't happen. */
860 Jmsg(jcr, M_FATAL, 0, _("Encryption error\n"));
864 /* Encrypt the input block */
865 if (crypto_cipher_update(cipher_ctx, cipher_input, cipher_input_len,
866 (u_int8_t *)&jcr->crypto_buf[initial_len], &encrypted_len)) {
867 if ((initial_len + encrypted_len) == 0) {
868 /* No full block of data available, read more data */
871 Dmsg2(400, "encrypted len=%d unencrypted len=%d\n", encrypted_len,
873 sd->msglen = initial_len + encrypted_len; /* set encrypted length */
875 /* Encryption failed. Shouldn't happen. */
876 Jmsg(jcr, M_FATAL, 0, _("Encryption error\n"));
881 /* Send the buffer to the Storage daemon */
882 if (ff_pkt->flags & FO_SPARSE) {
883 sd->msglen += SPARSE_FADDR_SIZE; /* include fileAddr in size */
885 sd->msg = wbuf; /* set correct write buffer */
887 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
891 Dmsg1(130, "Send data to SD len=%d\n", sd->msglen);
893 jcr->JobBytes += sd->msglen; /* count bytes saved possibly compressed/encrypted */
894 sd->msg = msgsave; /* restore read buffer */
896 } /* end while read file data */
898 if (sd->msglen < 0) { /* error */
900 Jmsg(jcr, M_ERROR, 0, _("Read error on file %s. ERR=%s\n"),
901 ff_pkt->fname, be.bstrerror(ff_pkt->bfd.berrno));
902 if (jcr->Errors++ > 1000) { /* insanity check */
903 Jmsg(jcr, M_FATAL, 0, _("Too many errors.\n"));
905 } else if (ff_pkt->flags & FO_ENCRYPT) {
907 * For encryption, we must call finalize to push out any
910 if (!crypto_cipher_finalize(cipher_ctx, (uint8_t *)jcr->crypto_buf,
912 /* Padding failed. Shouldn't happen. */
913 Jmsg(jcr, M_FATAL, 0, _("Encryption padding error\n"));
917 /* Note, on SSL pre-0.9.7, there is always some output */
918 if (encrypted_len > 0) {
919 sd->msglen = encrypted_len; /* set encrypted length */
920 sd->msg = jcr->crypto_buf; /* set correct write buffer */
922 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
926 Dmsg1(130, "Send data to SD len=%d\n", sd->msglen);
927 jcr->JobBytes += sd->msglen; /* count bytes saved possibly compressed/encrypted */
928 sd->msg = msgsave; /* restore bnet buffer */
932 if (!sd->signal(BNET_EOD)) { /* indicate end of file data */
933 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
938 /* Free the cipher context */
940 crypto_cipher_free(cipher_ctx);
945 /* Free the cipher context */
947 crypto_cipher_free(cipher_ctx);
950 sd->msg = msgsave; /* restore bnet buffer */
956 * Read and send an ACL for the last encountered file.
958 static bool read_and_send_acl(JCR *jcr, int acltype, int stream)
961 BSOCK *sd = jcr->store_bsock;
964 #ifdef FD_NO_SEND_TEST
968 len = bacl_get(jcr, acltype);
970 Jmsg1(jcr, M_WARNING, 0, _("Error reading ACL of %s\n"), jcr->last_fname);
974 return true; /* no ACL */
978 if (!sd->fsend("%ld %d 0", jcr->JobFiles, stream)) {
979 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
984 /* Send the buffer to the storage deamon */
985 Dmsg2(400, "Backing up ACL type 0x%2x <%s>\n", acltype, jcr->acl_text);
987 sd->msg = jcr->acl_text;
988 sd->msglen = len + 1;
992 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
997 jcr->JobBytes += sd->msglen;
999 if (!sd->signal(BNET_EOD)) {
1000 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
1005 Dmsg1(200, "ACL of file: %s successfully backed up!\n", jcr->last_fname);
1010 static bool encode_and_send_attributes(JCR *jcr, FF_PKT *ff_pkt, int &data_stream)
1012 BSOCK *sd = jcr->store_bsock;
1013 char attribs[MAXSTRING];
1014 char attribsEx[MAXSTRING];
1017 #ifdef FD_NO_SEND_TEST
1021 Dmsg1(300, "encode_and_send_attrs fname=%s\n", ff_pkt->fname);
1022 /* Find what data stream we will use, then encode the attributes */
1023 if ((data_stream = select_data_stream(ff_pkt)) == STREAM_NONE) {
1024 /* This should not happen */
1025 Jmsg0(jcr, M_FATAL, 0, _("Invalid file flags, no supported data stream type.\n"));
1028 encode_stat(attribs, ff_pkt, data_stream);
1030 /* Now possibly extend the attributes */
1031 attr_stream = encode_attribsEx(jcr, attribsEx, ff_pkt);
1033 Dmsg3(300, "File %s\nattribs=%s\nattribsEx=%s\n", ff_pkt->fname, attribs, attribsEx);
1036 jcr->JobFiles++; /* increment number of files sent */
1037 ff_pkt->FileIndex = jcr->JobFiles; /* return FileIndex */
1038 pm_strcpy(jcr->last_fname, ff_pkt->fname);
1042 * Send Attributes header to Storage daemon
1043 * <file-index> <stream> <info>
1045 if (!sd->fsend("%ld %d 0", jcr->JobFiles, attr_stream)) {
1046 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
1050 Dmsg1(300, ">stored: attrhdr %s\n", sd->msg);
1053 * Send file attributes to Storage daemon
1056 * Filename (full path)
1057 * Encoded attributes
1058 * Link name (if type==FT_LNK or FT_LNKSAVED)
1059 * Encoded extended-attributes (for Win32)
1061 * For a directory, link is the same as fname, but with trailing
1062 * slash. For a linked file, link is the link.
1065 if (ff_pkt->type == FT_LNK || ff_pkt->type == FT_LNKSAVED) {
1066 Dmsg2(300, "Link %s to %s\n", ff_pkt->fname, ff_pkt->link);
1067 stat = sd->fsend("%ld %d %s%c%s%c%s%c%s%c", jcr->JobFiles,
1068 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, ff_pkt->link, 0,
1070 } else if (ff_pkt->type == FT_DIREND) {
1071 /* Here link is the canonical filename (i.e. with trailing slash) */
1072 stat = sd->fsend("%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
1073 ff_pkt->type, ff_pkt->link, 0, attribs, 0, 0, attribsEx, 0);
1075 stat = sd->fsend("%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
1076 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, 0, attribsEx, 0);
1078 unstrip_path(ff_pkt);
1080 Dmsg2(300, ">stored: attr len=%d: %s\n", sd->msglen, sd->msg);
1082 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
1086 sd->signal(BNET_EOD); /* indicate end of attributes data */
1091 * Do in place strip of path
1093 static bool do_strip(int count, char *in)
1099 /* Copy to first path separator -- Win32 might have c: ... */
1100 while (*in && !IsPathSeparator(*in)) {
1104 numsep++; /* one separator seen */
1105 for (stripped=0; stripped<count && *in; stripped++) {
1106 while (*in && !IsPathSeparator(*in)) {
1107 in++; /* skip chars */
1110 numsep++; /* count separators seen */
1111 in++; /* skip separator */
1115 while (*in) { /* copy to end */
1116 if (IsPathSeparator(*in)) {
1122 Dmsg4(500, "stripped=%d count=%d numsep=%d sep>count=%d\n",
1123 stripped, count, numsep, numsep>count);
1124 return stripped==count && numsep>count;
1128 * If requested strip leading components of the path
1130 static void strip_path(FF_PKT *ff_pkt)
1132 if (!(ff_pkt->flags & FO_STRIPPATH) || ff_pkt->strip_path <= 0) {
1133 Dmsg1(200, "No strip for %s\n", ff_pkt->fname);
1136 if (!ff_pkt->fname_save) {
1137 ff_pkt->fname_save = get_pool_memory(PM_FNAME);
1138 ff_pkt->link_save = get_pool_memory(PM_FNAME);
1140 pm_strcpy(ff_pkt->fname_save, ff_pkt->fname);
1143 * Strip path. If it doesn't succeed put it back. If
1144 * it does, and there is a different link string,
1145 * attempt to strip the link. If it fails, but them
1147 * I.e. if either stripping fails don't strip anything.
1149 if (do_strip(ff_pkt->strip_path, ff_pkt->fname)) {
1150 if (ff_pkt->fname != ff_pkt->link) {
1151 pm_strcpy(ff_pkt->link_save, ff_pkt->link);
1152 if (!do_strip(ff_pkt->strip_path, ff_pkt->link)) {
1153 strcpy(ff_pkt->link, ff_pkt->link_save);
1154 strcpy(ff_pkt->fname, ff_pkt->fname_save);
1158 strcpy(ff_pkt->fname, ff_pkt->fname_save);
1160 Dmsg2(200, "fname=%s stripped=%s\n", ff_pkt->fname_save, ff_pkt->fname);
1163 static void unstrip_path(FF_PKT *ff_pkt)
1165 if (!(ff_pkt->flags & FO_STRIPPATH) || ff_pkt->strip_path <= 0) {
1168 strcpy(ff_pkt->fname, ff_pkt->fname_save);
1169 if (ff_pkt->fname != ff_pkt->link) {
1170 strcpy(ff_pkt->link, ff_pkt->link_save);