encfstools module

class encfstools.Bounce[source]

Bases: object

Dummy class that will simply return all input. This is the standard for config.ENCODE

close()[source]
exclude(path)[source]
include(path)[source]
path(path)[source]
remote(path)[source]
class encfstools.Decode(cfg, string=True)[source]

Bases: object

decode path with encfsctl.

close()[source]

stop encfsctl process

list(list_)[source]

decode a list of paths

log(line)[source]

decode paths in takesnapshot.log

path(path)[source]

write crypted path to encfsctl stdin and read plain path from stdout if stdout is empty (most likly because there was an error) return crypt path

pathMatch(m)[source]

return decoded path of a match object

pathWithArrow(path)[source]

rsync print symlinks like ‘dest -> src’. This will decode both and also normal paths

remote(path)[source]

decode the path on remote host starting from backintime/host/user/...

replace(m)[source]

return decoded string for re.sub

startProcess()[source]

start ‘encfsctl decode’ process in pipe mode.

class encfstools.EncFS_SSH(cfg=None, profile_id=None, mode=None, parent=None, *args, **kwargs)[source]

Bases: encfstools.EncFS_mount

Mount encrypted remote path with sshfs and encfs. Mount / with encfs –reverse. rsync will then sync the encrypted view on / to the remote path

mount(*args, **kwargs)[source]

call mount for sshfs, encfs –reverse and encfs register ‘encfsctl encode’ in config.ENCODE

preMountCheck(*args, **kwargs)[source]

call preMountCheck for sshfs, encfs –reverse and encfs

splitKwargs(mode)[source]

split all given arguments for the desired mount class

umount(*args, **kwargs)[source]

close ‘encfsctl encode’ process and set config.ENCODE back to the dummy class. call umount for encfs, encfs –reverse and sshfs

class encfstools.EncFS_mount(*args, **kwargs)[source]

Bases: mount.MountControl

Mount encrypted paths with encfs.

_mount()[source]

mount the service

backupConfig()[source]

create a backup of encfs config file into local config folder so in cases of the config file get deleted or corrupt user can restore it from there

checkVersion()[source]

check encfs version. 1.7.2 had a bug with –reverse that will create corrupt files

configFile()[source]

return encfs config file

env()[source]

return environment with encfs configfile

init()[source]

init the cipher path

isConfigured()[source]

check if encfs config file exist. If not and if we are in settingsdialog ask for password confirmation. _mount will then create a new config

preMountCheck(first_run=False)[source]

check what ever conditions must be given for the mount

class encfstools.Encode(encfs)[source]

Bases: object

encode path with encfsctl. ENCFS_SSH will replace config.ENCODE whit this

close()[source]

stop encfsctl process

exclude(path)[source]

encrypt paths for snapshots.takeSnapshot exclude list. After encoding the path a wildcard would not match anymore so all paths with wildcards are ignored. Only single and double asterisk that will match a full file or folder name will work.

include(path)[source]

encrypt paths for snapshots.takeSnapshot include list.

path(path)[source]

write plain path to encfsctl stdin and read encrypted path from stdout

remote(path)[source]

encode the path on remote host starting from backintime/host/user/...

startProcess()[source]

start ‘encfsctl encode’ process in pipe mode.