encfstools module

class encfstools.Bounce

Bases: object

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

close()

exclude(path)

include(path)

path(path)

remote(path)

class encfstools.Decode(cfg, string=True)

Bases: object

decode path with encfsctl.

close()

stop encfsctl process

list(list_)

decode a list of paths

log(line)

decode paths in takesnapshot.log

path(path)

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

pathMatch(m)

return decoded path of a match object

pathWithArrow(path)

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

remote(path)

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

replace(m)

return decoded string for re.sub

startProcess()

start ‘encfsctl decode’ process in pipe mode.

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

Bases: 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)

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

preMountCheck(*args, **kwargs)

call preMountCheck for sshfs, encfs –reverse and encfs

splitKwargs(mode)

split all given arguments for the desired mount class

umount(*args, **kwargs)

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)

Bases: MountControl

Mount encrypted paths with encfs.

_mount()

mount the service

backupConfig()

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()

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

configFile()

return encfs config file

env()

return environment with encfs configfile

isConfigured()

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)

check what ever conditions must be given for the mount

class encfstools.Encode(encfs)

Bases: object

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

close()

stop encfsctl process

exclude(path)

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)

encrypt paths for snapshots.takeSnapshot include list.

path(path)

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

remote(path)

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

startProcess()

start ‘encfsctl encode’ process in pipe mode.