Package CedarBackup2 :: Package extend :: Module encrypt
[show private | hide private]
[frames | no frames]

Module CedarBackup2.extend.encrypt

Provides an extension to encrypt staging directories.

When this extension is executed, all backed-up files in the configured Cedar Backup staging directory will be encrypted using gpg. Any directory which has already been encrypted (as indicated by the cback.encrypt file) will be ignored.

This extension requires a new configuration section <encrypt> and is intended to be run immediately after the standard stage action or immediately before the standard store action. Aside from its own configuration, it requires the options and staging configuration sections in the standard Cedar Backup configuration file.

Author: Kenneth J. Pronovici <pronovic@ieee.org>

Classes
EncryptConfig Class representing encrypt configuration.
LocalConfig Class representing this extension's configuration document.

Function Summary
  executeAction(configPath, options, config)
Executes the encrypt backup action.

Variable Summary
str ENCRYPT_INDICATOR = 'cback.encrypt'
list GPG_COMMAND = ['gpg']
Logger logger = <logging.Logger instance at 0x402dce2c>
list VALID_ENCRYPT_MODES = ['gpg']

Function Details

executeAction(configPath, options, config)

Executes the encrypt backup action.
Parameters:
configPath - Path to configuration file on disk.
           (type=String representing a path on disk.)
options - Program command-line options.
           (type=Options object.)
config - Program configuration.
           (type=Config object.)
Raises:
ValueError - Under many generic error conditions
IOError - If there are I/O problems reading or writing files

Variable Details

ENCRYPT_INDICATOR

Type:
str
Value:
'cback.encrypt'                                                        

GPG_COMMAND

Type:
list
Value:
['gpg']                                                                

logger

Type:
Logger
Value:
<logging.Logger instance at 0x402dce2c>                                

VALID_ENCRYPT_MODES

Type:
list
Value:
['gpg']                                                                

Generated by Epydoc 2.1 on Thu Mar 29 20:58:27 2007 http://epydoc.sf.net