1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38 """
39 Store-type extension that writes data to Amazon S3.
40
41 This extension requires a new configuration section <amazons3> and is intended
42 to be run immediately after the standard stage action, replacing the standard
43 store action. Aside from its own configuration, it requires the options and
44 staging configuration sections in the standard Cedar Backup configuration file.
45 Since it is intended to replace the store action, it does not rely on any store
46 configuration.
47
48 The underlying functionality relies on the U{AWS CLI interface
49 <http://aws.amazon.com/documentation/cli/>}. Before you use this extension,
50 you need to set up your Amazon S3 account and configure the AWS CLI connection
51 per Amazon's documentation. The extension assumes that the backup is being
52 executed as root, and switches over to the configured backup user to
53 communicate with AWS. So, make sure you configure AWS CLI as the backup user
54 and not root.
55
56 You can optionally configure Cedar Backup to encrypt data before sending it
57 to S3. To do that, provide a complete command line using the C{${input}} and
58 C{${output}} variables to represent the original input file and the encrypted
59 output file. This command will be executed as the backup user.
60
61 For instance, you can use something like this with GPG::
62
63 /usr/bin/gpg -c --no-use-agent --batch --yes --passphrase-file /home/backup/.passphrase -o ${output} ${input}
64
65 The GPG mechanism depends on a strong passphrase for security. One way to
66 generate a strong passphrase is using your system random number generator, i.e.::
67
68 dd if=/dev/urandom count=20 bs=1 | xxd -ps
69
70 (See U{StackExchange <http://security.stackexchange.com/questions/14867/gpg-encryption-security>}
71 for more details about that advice.) If you decide to use encryption, make sure
72 you save off the passphrase in a safe place, so you can get at your backup data
73 later if you need to. And obviously, make sure to set permissions on the
74 passphrase file so it can only be read by the backup user.
75
76 This extension was written for and tested on Linux. It will throw an exception
77 if run on Windows.
78
79 @author: Kenneth J. Pronovici <pronovic@ieee.org>
80 """
81
82
83
84
85
86
87 import sys
88 import os
89 import logging
90 import tempfile
91 import datetime
92 import json
93 import shutil
94 from functools import total_ordering
95
96
97 from CedarBackup3.filesystem import FilesystemList, BackupFileList
98 from CedarBackup3.util import resolveCommand, executeCommand, isRunningAsRoot, changeOwnership, isStartOfWeek
99 from CedarBackup3.util import displayBytes, UNIT_BYTES
100 from CedarBackup3.xmlutil import createInputDom, addContainerNode, addBooleanNode, addStringNode
101 from CedarBackup3.xmlutil import readFirstChild, readString, readBoolean
102 from CedarBackup3.actions.util import writeIndicatorFile
103 from CedarBackup3.actions.constants import DIR_TIME_FORMAT, STAGE_INDICATOR
104 from CedarBackup3.config import ByteQuantity, readByteQuantity, addByteQuantityNode
105
106
107
108
109
110
111 logger = logging.getLogger("CedarBackup3.log.extend.amazons3")
112
113 SU_COMMAND = [ "su" ]
114 AWS_COMMAND = [ "aws" ]
115
116 STORE_INDICATOR = "cback.amazons3"
117
118
119
120
121
122
123 @total_ordering
124 -class AmazonS3Config(object):
125
126 """
127 Class representing Amazon S3 configuration.
128
129 Amazon S3 configuration is used for storing backup data in Amazon's S3 cloud
130 storage using the C{s3cmd} tool.
131
132 The following restrictions exist on data in this class:
133
134 - The s3Bucket value must be a non-empty string
135 - The encryptCommand value, if set, must be a non-empty string
136 - The full backup size limit, if set, must be a ByteQuantity >= 0
137 - The incremental backup size limit, if set, must be a ByteQuantity >= 0
138
139 @sort: __init__, __repr__, __str__, __cmp__, __eq__, __lt__, __gt__,
140 warnMidnite, s3Bucket
141 """
142
143 - def __init__(self, warnMidnite=None, s3Bucket=None, encryptCommand=None,
144 fullBackupSizeLimit=None, incrementalBackupSizeLimit=None):
145 """
146 Constructor for the C{AmazonS3Config} class.
147
148 @param warnMidnite: Whether to generate warnings for crossing midnite.
149 @param s3Bucket: Name of the Amazon S3 bucket in which to store the data
150 @param encryptCommand: Command used to encrypt backup data before upload to S3
151 @param fullBackupSizeLimit: Maximum size of a full backup, a ByteQuantity
152 @param incrementalBackupSizeLimit: Maximum size of an incremental backup, a ByteQuantity
153
154 @raise ValueError: If one of the values is invalid.
155 """
156 self._warnMidnite = None
157 self._s3Bucket = None
158 self._encryptCommand = None
159 self._fullBackupSizeLimit = None
160 self._incrementalBackupSizeLimit = None
161 self.warnMidnite = warnMidnite
162 self.s3Bucket = s3Bucket
163 self.encryptCommand = encryptCommand
164 self.fullBackupSizeLimit = fullBackupSizeLimit
165 self.incrementalBackupSizeLimit = incrementalBackupSizeLimit
166
173
175 """
176 Informal string representation for class instance.
177 """
178 return self.__repr__()
179
181 """Equals operator, iplemented in terms of original Python 2 compare operator."""
182 return self.__cmp__(other) == 0
183
185 """Less-than operator, iplemented in terms of original Python 2 compare operator."""
186 return self.__cmp__(other) < 0
187
189 """Greater-than operator, iplemented in terms of original Python 2 compare operator."""
190 return self.__cmp__(other) > 0
191
226
228 """
229 Property target used to set the midnite warning flag.
230 No validations, but we normalize the value to C{True} or C{False}.
231 """
232 if value:
233 self._warnMidnite = True
234 else:
235 self._warnMidnite = False
236
238 """
239 Property target used to get the midnite warning flag.
240 """
241 return self._warnMidnite
242
244 """
245 Property target used to set the S3 bucket.
246 """
247 if value is not None:
248 if len(value) < 1:
249 raise ValueError("S3 bucket must be non-empty string.")
250 self._s3Bucket = value
251
253 """
254 Property target used to get the S3 bucket.
255 """
256 return self._s3Bucket
257
259 """
260 Property target used to set the encrypt command.
261 """
262 if value is not None:
263 if len(value) < 1:
264 raise ValueError("Encrypt command must be non-empty string.")
265 self._encryptCommand = value
266
268 """
269 Property target used to get the encrypt command.
270 """
271 return self._encryptCommand
272
274 """
275 Property target used to set the full backup size limit.
276 The value must be an integer >= 0.
277 @raise ValueError: If the value is not valid.
278 """
279 if value is None:
280 self._fullBackupSizeLimit = None
281 else:
282 if isinstance(value, ByteQuantity):
283 self._fullBackupSizeLimit = value
284 else:
285 self._fullBackupSizeLimit = ByteQuantity(value, UNIT_BYTES)
286
288 """
289 Property target used to get the full backup size limit.
290 """
291 return self._fullBackupSizeLimit
292
294 """
295 Property target used to set the incremental backup size limit.
296 The value must be an integer >= 0.
297 @raise ValueError: If the value is not valid.
298 """
299 if value is None:
300 self._incrementalBackupSizeLimit = None
301 else:
302 if isinstance(value, ByteQuantity):
303 self._incrementalBackupSizeLimit = value
304 else:
305 self._incrementalBackupSizeLimit = ByteQuantity(value, UNIT_BYTES)
306
308 """
309 Property target used to get the incremental backup size limit.
310 """
311 return self._incrementalBackupSizeLimit
312
313 warnMidnite = property(_getWarnMidnite, _setWarnMidnite, None, "Whether to generate warnings for crossing midnite.")
314 s3Bucket = property(_getS3Bucket, _setS3Bucket, None, doc="Amazon S3 Bucket in which to store data")
315 encryptCommand = property(_getEncryptCommand, _setEncryptCommand, None, doc="Command used to encrypt data before upload to S3")
316 fullBackupSizeLimit = property(_getFullBackupSizeLimit, _setFullBackupSizeLimit, None,
317 doc="Maximum size of a full backup, as a ByteQuantity")
318 incrementalBackupSizeLimit = property(_getIncrementalBackupSizeLimit, _setIncrementalBackupSizeLimit, None,
319 doc="Maximum size of an incremental backup, as a ByteQuantity")
320
321
322
323
324
325
326 @total_ordering
327 -class LocalConfig(object):
328
329 """
330 Class representing this extension's configuration document.
331
332 This is not a general-purpose configuration object like the main Cedar
333 Backup configuration object. Instead, it just knows how to parse and emit
334 amazons3-specific configuration values. Third parties who need to read and
335 write configuration related to this extension should access it through the
336 constructor, C{validate} and C{addConfig} methods.
337
338 @note: Lists within this class are "unordered" for equality comparisons.
339
340 @sort: __init__, __repr__, __str__, __cmp__, __eq__, __lt__, __gt__,
341 amazons3, validate, addConfig
342 """
343
344 - def __init__(self, xmlData=None, xmlPath=None, validate=True):
345 """
346 Initializes a configuration object.
347
348 If you initialize the object without passing either C{xmlData} or
349 C{xmlPath} then configuration will be empty and will be invalid until it
350 is filled in properly.
351
352 No reference to the original XML data or original path is saved off by
353 this class. Once the data has been parsed (successfully or not) this
354 original information is discarded.
355
356 Unless the C{validate} argument is C{False}, the L{LocalConfig.validate}
357 method will be called (with its default arguments) against configuration
358 after successfully parsing any passed-in XML. Keep in mind that even if
359 C{validate} is C{False}, it might not be possible to parse the passed-in
360 XML document if lower-level validations fail.
361
362 @note: It is strongly suggested that the C{validate} option always be set
363 to C{True} (the default) unless there is a specific need to read in
364 invalid configuration from disk.
365
366 @param xmlData: XML data representing configuration.
367 @type xmlData: String data.
368
369 @param xmlPath: Path to an XML file on disk.
370 @type xmlPath: Absolute path to a file on disk.
371
372 @param validate: Validate the document after parsing it.
373 @type validate: Boolean true/false.
374
375 @raise ValueError: If both C{xmlData} and C{xmlPath} are passed-in.
376 @raise ValueError: If the XML data in C{xmlData} or C{xmlPath} cannot be parsed.
377 @raise ValueError: If the parsed configuration document is not valid.
378 """
379 self._amazons3 = None
380 self.amazons3 = None
381 if xmlData is not None and xmlPath is not None:
382 raise ValueError("Use either xmlData or xmlPath, but not both.")
383 if xmlData is not None:
384 self._parseXmlData(xmlData)
385 if validate:
386 self.validate()
387 elif xmlPath is not None:
388 with open(xmlPath) as f:
389 xmlData = f.read()
390 self._parseXmlData(xmlData)
391 if validate:
392 self.validate()
393
395 """
396 Official string representation for class instance.
397 """
398 return "LocalConfig(%s)" % (self.amazons3)
399
401 """
402 Informal string representation for class instance.
403 """
404 return self.__repr__()
405
407 """Equals operator, iplemented in terms of original Python 2 compare operator."""
408 return self.__cmp__(other) == 0
409
411 """Less-than operator, iplemented in terms of original Python 2 compare operator."""
412 return self.__cmp__(other) < 0
413
415 """Greater-than operator, iplemented in terms of original Python 2 compare operator."""
416 return self.__cmp__(other) > 0
417
419 """
420 Original Python 2 comparison operator.
421 Lists within this class are "unordered" for equality comparisons.
422 @param other: Other object to compare to.
423 @return: -1/0/1 depending on whether self is C{<}, C{=} or C{>} other.
424 """
425 if other is None:
426 return 1
427 if self.amazons3 != other.amazons3:
428 if self.amazons3 < other.amazons3:
429 return -1
430 else:
431 return 1
432 return 0
433
435 """
436 Property target used to set the amazons3 configuration value.
437 If not C{None}, the value must be a C{AmazonS3Config} object.
438 @raise ValueError: If the value is not a C{AmazonS3Config}
439 """
440 if value is None:
441 self._amazons3 = None
442 else:
443 if not isinstance(value, AmazonS3Config):
444 raise ValueError("Value must be a C{AmazonS3Config} object.")
445 self._amazons3 = value
446
448 """
449 Property target used to get the amazons3 configuration value.
450 """
451 return self._amazons3
452
453 amazons3 = property(_getAmazonS3, _setAmazonS3, None, "AmazonS3 configuration in terms of a C{AmazonS3Config} object.")
454
456 """
457 Validates configuration represented by the object.
458
459 AmazonS3 configuration must be filled in. Within that, the s3Bucket target must be filled in
460
461 @raise ValueError: If one of the validations fails.
462 """
463 if self.amazons3 is None:
464 raise ValueError("AmazonS3 section is required.")
465 if self.amazons3.s3Bucket is None:
466 raise ValueError("AmazonS3 s3Bucket must be set.")
467
469 """
470 Adds an <amazons3> configuration section as the next child of a parent.
471
472 Third parties should use this function to write configuration related to
473 this extension.
474
475 We add the following fields to the document::
476
477 warnMidnite //cb_config/amazons3/warn_midnite
478 s3Bucket //cb_config/amazons3/s3_bucket
479 encryptCommand //cb_config/amazons3/encrypt
480 fullBackupSizeLimit //cb_config/amazons3/full_size_limit
481 incrementalBackupSizeLimit //cb_config/amazons3/incr_size_limit
482
483 @param xmlDom: DOM tree as from C{impl.createDocument()}.
484 @param parentNode: Parent that the section should be appended to.
485 """
486 if self.amazons3 is not None:
487 sectionNode = addContainerNode(xmlDom, parentNode, "amazons3")
488 addBooleanNode(xmlDom, sectionNode, "warn_midnite", self.amazons3.warnMidnite)
489 addStringNode(xmlDom, sectionNode, "s3_bucket", self.amazons3.s3Bucket)
490 addStringNode(xmlDom, sectionNode, "encrypt", self.amazons3.encryptCommand)
491 addByteQuantityNode(xmlDom, sectionNode, "full_size_limit", self.amazons3.fullBackupSizeLimit)
492 addByteQuantityNode(xmlDom, sectionNode, "incr_size_limit", self.amazons3.incrementalBackupSizeLimit)
493
495 """
496 Internal method to parse an XML string into the object.
497
498 This method parses the XML document into a DOM tree (C{xmlDom}) and then
499 calls a static method to parse the amazons3 configuration section.
500
501 @param xmlData: XML data to be parsed
502 @type xmlData: String data
503
504 @raise ValueError: If the XML cannot be successfully parsed.
505 """
506 (xmlDom, parentNode) = createInputDom(xmlData)
507 self._amazons3 = LocalConfig._parseAmazonS3(parentNode)
508
509 @staticmethod
537
538
539
540
541
542
543
544
545
546
547 -def executeAction(configPath, options, config):
548 """
549 Executes the amazons3 backup action.
550
551 @param configPath: Path to configuration file on disk.
552 @type configPath: String representing a path on disk.
553
554 @param options: Program command-line options.
555 @type options: Options object.
556
557 @param config: Program configuration.
558 @type config: Config object.
559
560 @raise ValueError: Under many generic error conditions
561 @raise IOError: If there are I/O problems reading or writing files
562 """
563 logger.debug("Executing amazons3 extended action.")
564 if not isRunningAsRoot():
565 logger.error("Error: the amazons3 extended action must be run as root.")
566 raise ValueError("The amazons3 extended action must be run as root.")
567 if sys.platform == "win32":
568 logger.error("Error: the amazons3 extended action is not supported on Windows.")
569 raise ValueError("The amazons3 extended action is not supported on Windows.")
570 if config.options is None or config.stage is None:
571 raise ValueError("Cedar Backup configuration is not properly filled in.")
572 local = LocalConfig(xmlPath=configPath)
573 stagingDirs = _findCorrectDailyDir(options, config, local)
574 _applySizeLimits(options, config, local, stagingDirs)
575 _writeToAmazonS3(config, local, stagingDirs)
576 _writeStoreIndicator(config, stagingDirs)
577 logger.info("Executed the amazons3 extended action successfully.")
578
589 """
590 Finds the correct daily staging directory to be written to Amazon S3.
591
592 This is substantially similar to the same function in store.py. The
593 main difference is that it doesn't rely on store configuration at all.
594
595 @param options: Options object.
596 @param config: Config object.
597 @param local: Local config object.
598
599 @return: Correct staging dir, as a dict mapping directory to date suffix.
600 @raise IOError: If the staging directory cannot be found.
601 """
602 oneDay = datetime.timedelta(days=1)
603 today = datetime.date.today()
604 yesterday = today - oneDay
605 tomorrow = today + oneDay
606 todayDate = today.strftime(DIR_TIME_FORMAT)
607 yesterdayDate = yesterday.strftime(DIR_TIME_FORMAT)
608 tomorrowDate = tomorrow.strftime(DIR_TIME_FORMAT)
609 todayPath = os.path.join(config.stage.targetDir, todayDate)
610 yesterdayPath = os.path.join(config.stage.targetDir, yesterdayDate)
611 tomorrowPath = os.path.join(config.stage.targetDir, tomorrowDate)
612 todayStageInd = os.path.join(todayPath, STAGE_INDICATOR)
613 yesterdayStageInd = os.path.join(yesterdayPath, STAGE_INDICATOR)
614 tomorrowStageInd = os.path.join(tomorrowPath, STAGE_INDICATOR)
615 todayStoreInd = os.path.join(todayPath, STORE_INDICATOR)
616 yesterdayStoreInd = os.path.join(yesterdayPath, STORE_INDICATOR)
617 tomorrowStoreInd = os.path.join(tomorrowPath, STORE_INDICATOR)
618 if options.full:
619 if os.path.isdir(todayPath) and os.path.exists(todayStageInd):
620 logger.info("Amazon S3 process will use current day's staging directory [%s]", todayPath)
621 return { todayPath:todayDate }
622 raise IOError("Unable to find staging directory to process (only tried today due to full option).")
623 else:
624 if os.path.isdir(todayPath) and os.path.exists(todayStageInd) and not os.path.exists(todayStoreInd):
625 logger.info("Amazon S3 process will use current day's staging directory [%s]", todayPath)
626 return { todayPath:todayDate }
627 elif os.path.isdir(yesterdayPath) and os.path.exists(yesterdayStageInd) and not os.path.exists(yesterdayStoreInd):
628 logger.info("Amazon S3 process will use previous day's staging directory [%s]", yesterdayPath)
629 if local.amazons3.warnMidnite:
630 logger.warn("Warning: Amazon S3 process crossed midnite boundary to find data.")
631 return { yesterdayPath:yesterdayDate }
632 elif os.path.isdir(tomorrowPath) and os.path.exists(tomorrowStageInd) and not os.path.exists(tomorrowStoreInd):
633 logger.info("Amazon S3 process will use next day's staging directory [%s]", tomorrowPath)
634 if local.amazons3.warnMidnite:
635 logger.warn("Warning: Amazon S3 process crossed midnite boundary to find data.")
636 return { tomorrowPath:tomorrowDate }
637 raise IOError("Unable to find unused staging directory to process (tried today, yesterday, tomorrow).")
638
645 """
646 Apply size limits, throwing an exception if any limits are exceeded.
647
648 Size limits are optional. If a limit is set to None, it does not apply.
649 The full size limit applies if the full option is set or if today is the
650 start of the week. The incremental size limit applies otherwise. Limits
651 are applied to the total size of all the relevant staging directories.
652
653 @param options: Options object.
654 @param config: Config object.
655 @param local: Local config object.
656 @param stagingDirs: Dictionary mapping directory path to date suffix.
657
658 @raise ValueError: Under many generic error conditions
659 @raise ValueError: If a size limit has been exceeded
660 """
661 if options.full or isStartOfWeek(config.options.startingDay):
662 logger.debug("Using Amazon S3 size limit for full backups.")
663 limit = local.amazons3.fullBackupSizeLimit
664 else:
665 logger.debug("Using Amazon S3 size limit for incremental backups.")
666 limit = local.amazons3.incrementalBackupSizeLimit
667 if limit is None:
668 logger.debug("No Amazon S3 size limit will be applied.")
669 else:
670 logger.debug("Amazon S3 size limit is: %s", limit)
671 contents = BackupFileList()
672 for stagingDir in stagingDirs:
673 contents.addDirContents(stagingDir)
674 total = contents.totalSize()
675 logger.debug("Amazon S3 backup size is: %s", displayBytes(total))
676 if total > limit:
677 logger.error("Amazon S3 size limit exceeded: %s > %s", displayBytes(total), limit)
678 raise ValueError("Amazon S3 size limit exceeded: %s > %s" % (displayBytes(total), limit))
679 else:
680 logger.info("Total size does not exceed Amazon S3 size limit, so backup can continue.")
681
688 """
689 Writes the indicated staging directories to an Amazon S3 bucket.
690
691 Each of the staging directories listed in C{stagingDirs} will be written to
692 the configured Amazon S3 bucket from local configuration. The directories
693 will be placed into the image at the root by date, so staging directory
694 C{/opt/stage/2005/02/10} will be placed into the S3 bucket at C{/2005/02/10}.
695 If an encrypt commmand is provided, the files will be encrypted first.
696
697 @param config: Config object.
698 @param local: Local config object.
699 @param stagingDirs: Dictionary mapping directory path to date suffix.
700
701 @raise ValueError: Under many generic error conditions
702 @raise IOError: If there is a problem writing to Amazon S3
703 """
704 for stagingDir in list(stagingDirs.keys()):
705 logger.debug("Storing stage directory to Amazon S3 [%s].", stagingDir)
706 dateSuffix = stagingDirs[stagingDir]
707 s3BucketUrl = "s3://%s/%s" % (local.amazons3.s3Bucket, dateSuffix)
708 logger.debug("S3 bucket URL is [%s]", s3BucketUrl)
709 _clearExistingBackup(config, s3BucketUrl)
710 if local.amazons3.encryptCommand is None:
711 logger.debug("Encryption is disabled; files will be uploaded in cleartext.")
712 _uploadStagingDir(config, stagingDir, s3BucketUrl)
713 _verifyUpload(config, stagingDir, s3BucketUrl)
714 else:
715 logger.debug("Encryption is enabled; files will be uploaded after being encrypted.")
716 encryptedDir = tempfile.mkdtemp(dir=config.options.workingDir)
717 changeOwnership(encryptedDir, config.options.backupUser, config.options.backupGroup)
718 try:
719 _encryptStagingDir(config, local, stagingDir, encryptedDir)
720 _uploadStagingDir(config, encryptedDir, s3BucketUrl)
721 _verifyUpload(config, encryptedDir, s3BucketUrl)
722 finally:
723 if os.path.exists(encryptedDir):
724 shutil.rmtree(encryptedDir)
725
741
748 """
749 Clear any existing backup files for an S3 bucket URL.
750 @param config: Config object.
751 @param s3BucketUrl: S3 bucket URL associated with the staging directory
752 """
753 suCommand = resolveCommand(SU_COMMAND)
754 awsCommand = resolveCommand(AWS_COMMAND)
755 actualCommand = "%s s3 rm --recursive %s/" % (awsCommand[0], s3BucketUrl)
756 result = executeCommand(suCommand, [config.options.backupUser, "-c", actualCommand])[0]
757 if result != 0:
758 raise IOError("Error [%d] calling AWS CLI to clear existing backup for [%s]." % (result, s3BucketUrl))
759 logger.debug("Completed clearing any existing backup in S3 for [%s]", s3BucketUrl)
760
767 """
768 Upload the contents of a staging directory out to the Amazon S3 cloud.
769 @param config: Config object.
770 @param stagingDir: Staging directory to upload
771 @param s3BucketUrl: S3 bucket URL associated with the staging directory
772 """
773 suCommand = resolveCommand(SU_COMMAND)
774 awsCommand = resolveCommand(AWS_COMMAND)
775 actualCommand = "%s s3 cp --recursive %s/ %s/" % (awsCommand[0], stagingDir, s3BucketUrl)
776 result = executeCommand(suCommand, [config.options.backupUser, "-c", actualCommand])[0]
777 if result != 0:
778 raise IOError("Error [%d] calling AWS CLI to upload staging directory to [%s]." % (result, s3BucketUrl))
779 logger.debug("Completed uploading staging dir [%s] to [%s]", stagingDir, s3BucketUrl)
780
781
782
783
784
785
786 -def _verifyUpload(config, stagingDir, s3BucketUrl):
787 """
788 Verify that a staging directory was properly uploaded to the Amazon S3 cloud.
789 @param config: Config object.
790 @param stagingDir: Staging directory to verify
791 @param s3BucketUrl: S3 bucket URL associated with the staging directory
792 """
793 (bucket, prefix) = s3BucketUrl.replace("s3://", "").split("/", 1)
794 suCommand = resolveCommand(SU_COMMAND)
795 awsCommand = resolveCommand(AWS_COMMAND)
796 query = "Contents[].{Key: Key, Size: Size}"
797 actualCommand = "%s s3api list-objects --bucket %s --prefix %s --query '%s'" % (awsCommand[0], bucket, prefix, query)
798 (result, data) = executeCommand(suCommand, [config.options.backupUser, "-c", actualCommand], returnOutput=True)
799 if result != 0:
800 raise IOError("Error [%d] calling AWS CLI verify upload to [%s]." % (result, s3BucketUrl))
801 contents = { }
802 for entry in json.loads("".join(data)):
803 key = entry["Key"].replace(prefix, "")
804 size = int(entry["Size"])
805 contents[key] = size
806 files = FilesystemList()
807 files.addDirContents(stagingDir)
808 for entry in files:
809 if os.path.isfile(entry):
810 key = entry.replace(stagingDir, "")
811 size = int(os.stat(entry).st_size)
812 if not key in contents:
813 raise IOError("File was apparently not uploaded: [%s]" % entry)
814 else:
815 if size != contents[key]:
816 raise IOError("File size differs [%s], expected %s bytes but got %s bytes" % (entry, size, contents[key]))
817 logger.debug("Completed verifying upload from [%s] to [%s].", stagingDir, s3BucketUrl)
818
825 """
826 Encrypt a staging directory, creating a new directory in the process.
827 @param config: Config object.
828 @param stagingDir: Staging directory to use as source
829 @param encryptedDir: Target directory into which encrypted files should be written
830 """
831 suCommand = resolveCommand(SU_COMMAND)
832 files = FilesystemList()
833 files.addDirContents(stagingDir)
834 for cleartext in files:
835 if os.path.isfile(cleartext):
836 encrypted = "%s%s" % (encryptedDir, cleartext.replace(stagingDir, ""))
837 if int(os.stat(cleartext).st_size) == 0:
838 with open(encrypted, 'a') as f:
839 f.close()
840 else:
841 actualCommand = local.amazons3.encryptCommand.replace("${input}", cleartext).replace("${output}", encrypted)
842 subdir = os.path.dirname(encrypted)
843 if not os.path.isdir(subdir):
844 os.makedirs(subdir)
845 changeOwnership(subdir, config.options.backupUser, config.options.backupGroup)
846 result = executeCommand(suCommand, [config.options.backupUser, "-c", actualCommand])[0]
847 if result != 0:
848 raise IOError("Error [%d] encrypting [%s]." % (result, cleartext))
849 logger.debug("Completed encrypting staging directory [%s] into [%s]", stagingDir, encryptedDir)
850