├── sftpman ├── __init__.py ├── exception.py ├── launcher.py ├── helper.py ├── cli.py └── model.py ├── .gitignore ├── MANIFEST.in ├── sleep-scripts ├── system-sleep │ └── sftpman-unmount-all.sh └── sleep.d │ └── 49-sftpman-unmount-all ├── CHANGELOG.md ├── setup.py ├── bash_completion.d └── sftpman ├── README.rst └── LICENSE.txt /sftpman/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.pyo 3 | dist 4 | *.egg-info 5 | *.egg 6 | *.swp 7 | env 8 | env* 9 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst LICENSE.txt 2 | recursive-include sleep-scripts * 3 | recursive-include bash_completion.d * 4 | -------------------------------------------------------------------------------- /sftpman/exception.py: -------------------------------------------------------------------------------- 1 | class SftpException(Exception): pass 2 | 3 | 4 | class SftpConfigException(SftpException): pass 5 | 6 | 7 | class SftpMountException(SftpException): 8 | 9 | def __init__(self, mount_cmd, mount_cmd_output): 10 | self.mount_cmd = mount_cmd 11 | self.mount_cmd_output = mount_cmd_output 12 | -------------------------------------------------------------------------------- /sftpman/launcher.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # launcher.main() is called by the sftpman executable (look at setup.py) 4 | def main(): 5 | import sys, os 6 | path = os.path.dirname(os.path.dirname(__file__)) 7 | sys.path.insert(0, path) 8 | from sftpman import cli 9 | cli.start() 10 | 11 | if __name__ == '__main__': 12 | main() 13 | -------------------------------------------------------------------------------- /sleep-scripts/system-sleep/sftpman-unmount-all.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Sleep hook for systemd. 4 | # Takes care of unmounting everything for all users on system suspend/hibernate. 5 | # To be placed in /usr/lib/systemd/system-sleep/ 6 | 7 | if [ -n "$1" ]; then 8 | if ([ "$1" = "pre" ]); then 9 | for username in $(ps aux | grep '/mnt/sshfs/' | grep -v 'grep' | grep -o -E '^(\w+)\s' | uniq); do 10 | su -l $username -c 'sftpman umount_all' 11 | done; 12 | fi 13 | fi 14 | 15 | -------------------------------------------------------------------------------- /sleep-scripts/sleep.d/49-sftpman-unmount-all: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Sleep hook for pm-utils. 4 | # Takes care of unmounting everything for all users on system suspend/hibernate. 5 | # To be placed in /etc/pm/sleep.d/ 6 | 7 | if [ -n "$1" ]; then 8 | if ([ "$1" = "suspend" ] || [ "$1" = "hibernate" ]); then 9 | for username in $(ps aux | grep '/mnt/sshfs/' | grep -v 'grep' | grep -o -E '^(\w+)\s' | uniq); do 10 | su -l $username -c 'sftpman umount_all' 11 | done; 12 | fi 13 | fi 14 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Version 1.2 2 | 3 | Adds support for SSH agent authentication. 4 | 5 | 6 | # Version 1.1 7 | 8 | Adds support for additional SSH authentication methods 9 | (keyboard-interactive, hostbased, gssapi-with-mic). 10 | 11 | 12 | # Version 1.0 13 | 14 | Relicensed under GPL v3. 15 | 16 | Renamed unmount commands: 17 | - `sftpman unmount` -> `sfptman umount` 18 | - `sftpman unmount_all` -> `sfptman umount_all` 19 | 20 | Changed the extension (`.js` -> `.json`) of configuration files stored in `~/.config/sftpman/mounts`. 21 | You need to migrate your files manually like this: 22 | 23 | ```bash 24 | for f in $(ls ~/.config/sftpman/mounts/*.js); do n=$(echo $f | sed 's/.js$/.json/'); mv $f $n; done; 25 | ``` 26 | 27 | # Versions < 1.0 28 | 29 | No documented changes. 30 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """ 2 | SftpMan 3 | ======= 4 | 5 | ⚠️ **Warning**: This CLI application and library has been rewritten in Rust. See https://github.com/spantaleev/sftpman-rs. This old Python-based software is no longer maintained. 6 | 7 | SftpMan is a command-line application (with a GUI frontend packaged separately) that makes it easy to setup and mount SSHFS/SFTP file systems. 8 | 9 | It allows you to define all your SFTP systems and easily mount/unmount them. 10 | 11 | A GTK frontend is available, named sftpman-gtk. 12 | """ 13 | 14 | from setuptools import setup 15 | 16 | setup( 17 | name = "sftpman", 18 | version = '1.3.1', 19 | description = "A command-line application that helps you mount SFTP file systems.", 20 | long_description = __doc__, 21 | author = "Slavi Pantaleev", 22 | author_email = "slavi@devture.com", 23 | url = "https://github.com/spantaleev/sftpman-python", 24 | keywords = ["sftp", "ssh", "sshfs"], 25 | license = "GPL v3", 26 | packages = ['sftpman'], 27 | entry_points=""" 28 | [console_scripts] 29 | sftpman = sftpman.launcher:main 30 | """, 31 | zip_safe = False, 32 | classifiers = [ 33 | "Programming Language :: Python", 34 | "Programming Language :: Python :: 3", 35 | "Development Status :: 5 - Production/Stable", 36 | "Environment :: Console", 37 | "Intended Audience :: Developers", 38 | "Intended Audience :: System Administrators", 39 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 40 | "Operating System :: Unix", 41 | "Topic :: Communications :: File Sharing", 42 | "Topic :: Internet", 43 | "Topic :: Internet :: File Transfer Protocol (FTP)", 44 | "Topic :: System :: Networking", 45 | "Topic :: Utilities" 46 | ] 47 | ) 48 | -------------------------------------------------------------------------------- /sftpman/helper.py: -------------------------------------------------------------------------------- 1 | import os, errno 2 | import subprocess 3 | 4 | # Try to load the best json implementation, 5 | # If json support is not available, we'll add 6 | # an object that raises a RuntimeError when used 7 | json = None 8 | try: 9 | import simplejson as json 10 | except ImportError: 11 | try: 12 | import json 13 | except ImportError: 14 | try: 15 | # Google Appengine offers simplejson via django 16 | from django.utils import simplejson as json 17 | except ImportError: 18 | pass 19 | if json is None: 20 | class _JSON(object): 21 | def __getattr__(self, name): 22 | raise RuntimeError('You need a JSON library to use sftpman!') 23 | json = _JSON() 24 | 25 | 26 | def mkdir_p(path): 27 | """NOOP if the directory exists. If not, it creates the whole directory tree.""" 28 | try: 29 | os.makedirs(path) 30 | except OSError as exc: 31 | if exc.errno != errno.EEXIST: 32 | raise 33 | 34 | 35 | def rmdir(path): 36 | """Safe rmdir (non-recursive) which doesn't throw if the directory is not empty.""" 37 | try: 38 | os.rmdir(path) 39 | except OSError as exc: 40 | print(str(exc)) 41 | 42 | 43 | def shell_exec(command): 44 | """Executes the given shell command and returns its output.""" 45 | out = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT).communicate()[0] 46 | return out.decode('utf-8') 47 | 48 | 49 | def kill_pid(pid, signal): 50 | """Sends a signal to the process with the given id.""" 51 | shell_exec("/bin/kill -%d %d" % (signal, pid)) 52 | 53 | 54 | def which(program): 55 | def is_exe(fpath): 56 | return os.path.exists(fpath) and os.access(fpath, os.X_OK) 57 | 58 | fpath, fname = os.path.split(program) 59 | if fpath: 60 | if is_exe(program): 61 | return program 62 | else: 63 | for path in os.environ["PATH"].split(os.pathsep): 64 | exe_file = os.path.join(path, program) 65 | if is_exe(exe_file): 66 | return exe_file 67 | return None 68 | -------------------------------------------------------------------------------- /bash_completion.d/sftpman: -------------------------------------------------------------------------------- 1 | _sftpman() { 2 | local first cur prev opts prefix suffix 3 | COMPREPLY=() 4 | 5 | first="${COMP_WORDS[1]}" 6 | prev="${COMP_WORDS[COMP_CWORD-1]}" 7 | cur="${COMP_WORDS[COMP_CWORD]}" 8 | 9 | prefix="" 10 | suffix="" 11 | opts="" # nothing to suggest by default 12 | 13 | if [ "$COMP_CWORD" = "1" ]; then 14 | # Suggest main sections for the first argument after the executable name 15 | opts="setup help ls mount mount_all umount umount_all rm preflight_check" 16 | else 17 | # Custom suggestions depending on the main section (first argument) 18 | case "$first" in 19 | "ls") 20 | opts="available mounted unmounted" 21 | ;; 22 | "mount") 23 | # Only suggest unmounted systems for mounting. 24 | # It doesn't make sense to suggest already mounted systems. 25 | opts=$(sftpman ls unmounted) 26 | ;; 27 | "umount") 28 | # Only suggest mounted systems for unmounting. 29 | # It doesn't make sense to suggest unmounted systems. 30 | opts=$(sftpman ls mounted) 31 | ;; 32 | "setup") 33 | # Try to recognize a known flag in the previous word 34 | # and suggest local completions for it. 35 | # If such a tag can't be recognized, assume that we should 36 | # start a new flag and suggest flag-name completions. 37 | case "$prev" in 38 | "--mount_point"|"--cmd_before_mount") 39 | # Can't provide any suggestions for --mount_point 40 | # We can provide partial support for --cmd_before_mount easily, 41 | # but it won't be very good, so we'd better not confuse people with it. 42 | opts="" 43 | ;; 44 | "--id") 45 | # This is either a new id (when adding a system) or an old one (when editing). 46 | # Let's suggest available ids in case the user wants to edit an old system. 47 | opts=$(sftpman ls available) 48 | ;; 49 | "--host") 50 | _known_hosts_real "$cur" 51 | return 0 52 | ;; 53 | "--port") 54 | # Suggest the default ssh port (22) 55 | opts="22" 56 | ;; 57 | "--user") 58 | # Suggest valid users available on this system. 59 | # There's a good chance the user to authenticate with 60 | # has an account on both systems (local, remote). 61 | _usergroup 62 | return 0 63 | ;; 64 | "--auth_method") 65 | opts="publickey password" 66 | ;; 67 | "--ssh_key") 68 | _filedir 69 | return 0 70 | ;; 71 | "--mount_opt") 72 | # Try to get all the available options from sshfs. 73 | # We're using " as prefix/suffix, because some options 74 | # contain the = sign, and --mount_opt=opt=here, is not valid, 75 | # but --mount_opt="opt=here" and --mount_opt "opt=here" always are. 76 | # Some of the options for sshfs expect some modifications, meaning 77 | # that what we would complete is invalid. 78 | # Anyways, this is still good enough assistance. 79 | opts=$(sshfs --help 2>&1 | grep "\-o" | cut -d '-' -f 2 | cut -d ' ' -f 2 | grep -vE "^$") 80 | prefix='"' 81 | suffix='"' 82 | ;; 83 | *) 84 | opts="--id --host --port --user --auth_method --ssh_key --mount_opt --mount_point --cmd_before_mount" 85 | ;; 86 | esac 87 | ;; 88 | "rm") 89 | opts=$(sftpman ls available) 90 | ;; 91 | esac 92 | fi 93 | 94 | COMPREPLY=( $(compgen -W "$opts" -P "$prefix" -S "$suffix" -- $cur) ) 95 | return 0 96 | } 97 | 98 | complete -F _sftpman sftpman 99 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | SftpMan with the GTK frontend 2 | ============================= 3 | 4 | .. image:: https://github.com/spantaleev/sftpman-gtk/raw/master/sftpman-gui.png 5 | 6 | --------------------------------------- 7 | 8 | ⚠️ **Warning**: This CLI application and library has been rewritten in Rust. See `sftpman-rs`_. This old Python-based software is no longer maintained. 9 | 10 | --------------------------------------- 11 | 12 | SftpMan consists of a Command Line and a GTK application (packaged separately) that make it simpler to setup and mount SSHFS/SFTP file systems. 13 | 14 | The idea was to develop a simple CLI/GUI application for Linux that can be used to manage SFTP systems. 15 | 16 | It relies on `sshfs`_ to do all the mounting work. 17 | SftpMan allows you to setup many remote filesystems and helps you easily mount/unmount them. 18 | 19 | Every system managed by SftpMan is identified by an id such as ``my-machine``, which is used in file paths and when managing the system. 20 | 21 | Configuration data is stored in ``~/.config/sftpman/`` as JSON files. 22 | 23 | All systems are mounted under ``/mnt/sshfs/``. For the ``my-machine`` machine, that would be ``/mnt/sshfs/my-machine``. 24 | 25 | --------------------------------------- 26 | 27 | Installing on ArchLinux 28 | ----------------------- 29 | 30 | On `ArchLinux`_, there's an official `sftpman AUR package`_. To install using ``yaourt``:: 31 | 32 | yaourt -S sftpman 33 | 34 | The package takes care of all dependencies and SftpMan should be able to start. 35 | 36 | Optional dependencies will be suggested to you upon install. 37 | 38 | Installing on other distributions 39 | --------------------------------- 40 | 41 | For other distributions you can install using **pip**:: 42 | 43 | pip install sftpman 44 | 45 | You also need to install `sshfs`_ yourself. 46 | 47 | CLI Application 48 | --------------- 49 | 50 | The CLI application (``sftpman`` executable) supports the following commands:: 51 | 52 | help: 53 | - Displays this help menu. 54 | 55 | ls: 56 | - Lists the available/mounted/unmounted sftp systems. 57 | Usage: sftpman ls {what} 58 | Where {what} is one of: available, mounted, unmounted 59 | 60 | mount: 61 | - Mounts the specified sftp system, unless it's already mounted. 62 | Usage: sftpman mount {id}.. 63 | 64 | mount_all: 65 | - Mounts all sftp file systems known to sftpman. 66 | Usage: sftpman mount_all 67 | 68 | preflight_check: 69 | - Detects whether we have everything needed to mount sshfs filesystems. 70 | 71 | rm: 72 | - Removes a system by id. 73 | Usage: sftpman rm {system_id}.. 74 | For a list of system ids, see `sftpman ls available`. 75 | 76 | setup: 77 | - Defines a new sftp file system configuration or edits an old one with the same id. 78 | Usage: sftpman setup {options} 79 | Available {options}: 80 | --id={unique system identifier} 81 | You use this to recognize and manage this sftp system. 82 | It determines what the local mount point is. 83 | If `--id=example`, the filesystem will be mounted to: `/mnt/sshfs/example` 84 | --host={host to connect to} 85 | --port={port to connect to} [default: 22] 86 | --user={username to authenticate with} [default: current user] 87 | --mount_opt={option to pass to sshfs} [optional] [can be passed more than once] 88 | Example: --mount_opt="follow_symlinks" --mount_opt="workaround=rename" 89 | `sshfs --help` tells you what sshfs options are available 90 | --mount_point={remote path to mount} 91 | --auth_method={method} 92 | Specifies the authentication method. 93 | Can be `password` or `publickey`. [default: publickey] 94 | --ssh_key={path to the ssh key to use for authentication} 95 | Only applies if auth_method is `publickey`. 96 | --cmd_before_mount={command to run before mounting} [default: /bin/true] 97 | Allows you to run a custom command every time this system is mounted. 98 | 99 | umount: 100 | - Unmounts the specified sftp system. 101 | Usage: sftpman umount {id}.. 102 | 103 | umount_all: 104 | - Unmounts all sftp file systems known to sftpman. 105 | Usage: sftpman umount_all 106 | 107 | 108 | GUI Application 109 | --------------- 110 | 111 | `sftpman-gtk`_ is a GTK frontend for sftpman, which is packaged separately. 112 | Installing the frontend automatically installs the CLI application as a dependency. 113 | 114 | 115 | Dependencies 116 | ------------ 117 | 118 | - `sshfs`_ 119 | - Python 2.7+ 120 | 121 | 122 | Known limitations 123 | ----------------- 124 | 125 | - Doesn't support mounting in a location different than ``/mnt/sshfs/`` 126 | 127 | 128 | .. _sshfs: http://fuse.sourceforge.net/sshfs.html 129 | .. _ArchLinux: http://www.archlinux.org/ 130 | .. _AUR: https://wiki.archlinux.org/index.php/AUR 131 | .. _sftpman AUR package: https://aur.archlinux.org/packages/sftpman/ 132 | .. _sftpman-gtk: https://github.com/spantaleev/sftpman-gtk 133 | .. _sftpman-rs: https://github.com/spantaleev/sftpman-rs -------------------------------------------------------------------------------- /sftpman/cli.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import getopt 3 | import collections.abc 4 | 5 | from .exception import SftpException, SftpConfigException, SftpMountException 6 | from .model import EnvironmentModel, SystemModel, SystemControllerModel 7 | 8 | 9 | class SftpCli(object): 10 | 11 | def __init__(self): 12 | self.environment = EnvironmentModel() 13 | 14 | def command_help(self, *args, **kwargs): 15 | """Displays this help menu.""" 16 | print("Commands available:\n") 17 | for name in dir(self): 18 | if not name.startswith("command_"): 19 | continue 20 | name_clean = name[len("command_"):] 21 | print("%s:\n - %s\n" % (name_clean, getattr(self, name).__doc__.strip())) 22 | 23 | def command_setup(self, *args): 24 | """Defines a new sftp file system configuration or edits an old one with the same id. 25 | Usage: sftpman setup {options} 26 | Available {options}: 27 | --id={unique system identifier} 28 | You use this to recognize and manage this sftp system. 29 | It determines what the local mount point is. 30 | If `--id=example`, the filesystem will be mounted to: `/mnt/sshfs/example` 31 | --host={host to connect to} 32 | --port={port to connect to} [default: 22] 33 | --user={username to authenticate with} 34 | --mount_opt={option to pass to sshfs} [optional] [can be passed more than once] 35 | Example: --mount_opt="follow_symlinks" --mount_opt="workaround=rename" 36 | `sshfs --help` tells you what sshfs options are available 37 | --mount_point={remote path to mount} 38 | --auth_method={method} 39 | Specifies the authentication method. 40 | Can be `password`, `publickey`, `hostbased`, `keyboard-interactive` or `gssapi-with-mic`. [default: publickey] 41 | --ssh_key={path to the ssh key to use for authentication} 42 | Only applies if auth_method is `publickey`. 43 | --cmd_before_mount={command to run before mounting} [default: /bin/true] 44 | Allows you to run a custom command every time this system is mounted. 45 | """ 46 | def usage(): 47 | print(self.command_setup.__doc__) 48 | sys.exit(1) 49 | 50 | if len(args) == 0: 51 | usage() 52 | 53 | try: 54 | # All of these (except mount_opt) map directly to the model properties 55 | # We allow several `mount_opt` flags and merge their values, before 56 | # assigning to the `mount_opts` property (which expects a list). 57 | fields = [ 58 | "id", "host", "port", "user", 59 | "mount_opt", "mount_point", 60 | "ssh_key", "cmd_before_mount", 61 | "auth_method", 62 | ] 63 | opts, _ = getopt.getopt(args, "", ["%s=" % s for s in fields]) 64 | except getopt.GetoptError as e: 65 | sys.stderr.write('Error: %s\n\n' % e) 66 | usage() 67 | 68 | system = SystemModel() 69 | mount_opts = [] 70 | for name, value in opts: 71 | name = name.lstrip('-') 72 | if name == 'mount_opt': 73 | mount_opts.append(value) 74 | continue 75 | if not hasattr(system, name): 76 | continue 77 | setattr(system, name, value) 78 | system.mount_opts = mount_opts 79 | 80 | is_valid, errors = system.validate() 81 | if not is_valid: 82 | sys.stderr.write('Invalid data found:\n') 83 | for field_name, msg in errors: 84 | sys.stderr.write(' - %s: %s\n' % (field_name, msg)) 85 | sys.stderr.write('\n') 86 | usage() 87 | sys.exit(1) 88 | 89 | system.save(self.environment) 90 | print('Configuration created.') 91 | print('You can try mounting now: `sftpman mount %s`' % system.id) 92 | 93 | def command_rm(self, system_id, *system_ids): 94 | """Removes a system by id. 95 | Usage: sftpman rm {system_id}.. 96 | For a list of system ids, see `sftpman ls available`. 97 | """ 98 | # Intentionally reading the first system_id separately, 99 | # because it's required. The others are optional. 100 | # This ensures that we'll generate an error if someone tries to call 101 | # this without the required argument. 102 | system_ids = (system_id,) + system_ids 103 | has_failed = False 104 | for system_id in system_ids: 105 | try: 106 | system = SystemModel.create_by_id(system_id, self.environment) 107 | controller = SystemControllerModel(system, self.environment) 108 | controller.unmount() 109 | system.delete(self.environment) 110 | except SftpException as e: 111 | sys.stderr.write('Cannot remove %s: %s\n' % (system_id, str(e))) 112 | has_failed = True 113 | if has_failed: 114 | sys.exit(1) 115 | 116 | def command_preflight_check(self): 117 | """Detects whether we have everything needed to mount sshfs filesystems. 118 | """ 119 | checks_pass, failures = self.environment.perform_preflight_check() 120 | if checks_pass: 121 | print('All checks pass.') 122 | else: 123 | sys.stderr.write('Problems encountered:\n') 124 | for msg in failures: 125 | sys.stderr.write(' - %s\n' % msg) 126 | sys.exit(1) 127 | 128 | def command_ls(self, list_what = 'available'): 129 | """Lists the available/mounted/unmounted sftp systems. 130 | Usage: sftpman ls {what} [default: available] 131 | Where {what} is one of: available, mounted, unmounted 132 | """ 133 | if list_what in ('available', 'mounted', 'unmounted'): 134 | callback = getattr(self.environment, 'get_%s_ids' % list_what) 135 | lst = callback() 136 | else: 137 | lst = [] 138 | if len(lst) != 0: 139 | print(("\n".join(lst))) 140 | 141 | def command_mount(self, system_id, *system_ids): 142 | """Mounts the specified sftp system, unless it's already mounted. 143 | Usage: sftpman mount {id}.. 144 | """ 145 | system_ids = (system_id,) + system_ids 146 | has_failed = False 147 | for system_id in system_ids: 148 | try: 149 | system = SystemModel.create_by_id(system_id, self.environment) 150 | controller = SystemControllerModel(system, self.environment) 151 | controller.mount() 152 | except SftpConfigException as e: 153 | sys.stderr.write('Cannot mount %s: %s\n\n' % (system_id, str(e))) 154 | has_failed = True 155 | except SftpMountException as e: 156 | sys.stderr.write('Cannot mount %s!\n\n' % system_id) 157 | sys.stderr.write('Mount command: \n%s\n\n' % e.mount_cmd) 158 | sys.stderr.write('Command output: \n%s\n\n' % e.mount_cmd_output) 159 | has_failed = True 160 | if has_failed: 161 | sys.exit(1) 162 | 163 | def command_umount(self, system_id, *system_ids): 164 | """Unmounts the specified sftp system. 165 | Usage: sftpman umount {id}.. 166 | """ 167 | system_ids = (system_id,) + system_ids 168 | has_failed = False 169 | for system_id in system_ids: 170 | try: 171 | system = SystemModel.create_by_id(system_id, self.environment) 172 | controller = SystemControllerModel(system, self.environment) 173 | controller.unmount() 174 | except SftpConfigException as e: 175 | sys.stderr.write('Cannot unmount %s: %s\n\n' % (system_id, str(e))) 176 | has_failed = True 177 | if has_failed: 178 | sys.exit(1) 179 | 180 | def command_mount_all(self): 181 | """Mounts all sftp file systems known to sftpman. 182 | Usage: sftpman mount_all 183 | """ 184 | has_failed = False 185 | for system_id in self.environment.get_unmounted_ids(): 186 | try: 187 | system = SystemModel.create_by_id(system_id, self.environment) 188 | controller = SystemControllerModel(system, self.environment) 189 | controller.mount() 190 | except SftpConfigException as e: 191 | sys.stderr.write('Cannot mount %s: %s\n\n' % (system_id, str(e))) 192 | has_failed = True 193 | except SftpMountException as e: 194 | sys.stderr.write('Cannot mount %s!\n\n' % system_id) 195 | sys.stderr.write('Mount command: \n%s\n\n' % e.mount_cmd) 196 | sys.stderr.write('Command output: \n%s\n\n' % e.mount_cmd_output) 197 | sys.exit(0 if not has_failed else 1) 198 | 199 | def command_umount_all(self): 200 | """Unmounts all sftp file systems known to sftpman. 201 | Usage: sftpman umount_all 202 | """ 203 | has_failed = False 204 | for system_id in self.environment.get_mounted_ids(): 205 | try: 206 | system = SystemModel.create_by_id(system_id, self.environment) 207 | controller = SystemControllerModel(system, self.environment) 208 | controller.unmount() 209 | except SftpConfigException as e: 210 | sys.stderr.write('Cannot unmount %s: %s\n\n' % (system_id, str(e))) 211 | has_failed = True 212 | sys.exit(0 if not has_failed else 1) 213 | 214 | 215 | def start(): 216 | try: 217 | command = sys.argv[1] 218 | except IndexError: 219 | command = 'help' 220 | if '--help' in sys.argv: 221 | command = 'help' 222 | args = sys.argv[2:] 223 | 224 | instance = SftpCli() 225 | callback = getattr(instance, "command_%s" % command, None) 226 | if isinstance(callback, collections.abc.Callable): 227 | try: 228 | callback(*args) 229 | except TypeError as e: 230 | sys.stderr.write('Bad call for %s: %s' % (command, str(e))) 231 | else: 232 | instance.command_help() 233 | -------------------------------------------------------------------------------- /sftpman/model.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | import os 4 | import re 5 | from .helper import json, shell_exec, mkdir_p, rmdir, kill_pid, which 6 | from .exception import SftpConfigException, SftpMountException 7 | 8 | 9 | class EnvironmentModel(object): 10 | """A configuration object that represents the environment 11 | with which we're now working. 12 | """ 13 | 14 | def __init__(self): 15 | self.mount_path_base = '/mnt/sshfs/' 16 | cfg_home = os.getenv('XDG_CONFIG_HOME', os.path.expanduser('~/.config')) 17 | self.config_path_base = "%s/" % os.path.join(cfg_home, 'sftpman') 18 | self.config_path_mounts = '%smounts/' % self.config_path_base 19 | 20 | def get_system_config_path(self, system_id): 21 | return '%s%s.json' % (self.config_path_mounts, system_id) 22 | 23 | def get_system_mount_dest(self, system_id): 24 | """The local path where the system will be mounted.""" 25 | return '%s%s' % (self.mount_path_base, system_id) 26 | 27 | def is_mounted(self, system_id): 28 | return system_id in self.get_mounted_ids() 29 | 30 | def get_pid_by_system_id(self, system_id): 31 | # Matching in `{PID} blah blah {mount_dest}` 32 | mount_dest = self.get_system_mount_dest(system_id) 33 | regex = re.compile("^(\\d+)\\s+(?:.+?)\\s%s$" % re.escape(mount_dest)) 34 | 35 | processes = shell_exec("pgrep --list-full sshfs") 36 | for line in processes.split("\n"): 37 | match_object = regex.match(line) 38 | if match_object is not None: 39 | return int(match_object.group(1)) 40 | return None 41 | 42 | def get_available_ids(self): 43 | if not os.path.exists(self.config_path_mounts): 44 | return [] 45 | cfg_files = shell_exec('ls %s' % self.config_path_mounts).strip().split('\n') 46 | return [file_name[0:-5] for file_name in cfg_files if file_name.endswith('.json')] 47 | 48 | def get_mounted_ids(self): 49 | # Looking for /mnt/sshfs/{id} in output that looks like this: 50 | # user@host:/remote/path on /mnt/sshfs/id type fuse.sshfs ... 51 | # "mount -l -t fuse.sshfs" cannot be used, as it requires root privileges 52 | mounted = shell_exec('mount -l') 53 | regex = re.compile(' %s(.+?) type fuse\\.sshfs' % self.mount_path_base) 54 | return regex.findall(mounted) 55 | 56 | def get_unmounted_ids(self): 57 | ids_mounted = self.get_mounted_ids() 58 | return [id for id in self.get_available_ids() if id not in ids_mounted] 59 | 60 | def perform_preflight_check(self): 61 | """Performs checks to see if we have everything needed to mount 62 | sshfs filesystems. 63 | :return: two-tuple (boolean checks_pass, list failure messages) 64 | """ 65 | failures = [] 66 | if not os.access(self.mount_path_base, os.W_OK): 67 | msg = ("Mount path `{path}` doesn't exist or is not writable" 68 | " by the current user.") 69 | failures.append(msg.format( 70 | path = self.mount_path_base 71 | )) 72 | if which('sshfs') is None: 73 | msg = ("SSHFS (http://fuse.sourceforge.net/sshfs.html)" 74 | " does not seem to be installed.") 75 | failures.append(msg) 76 | 77 | return len(failures) == 0, failures 78 | 79 | 80 | class SystemModel(object): 81 | """Represents a system (mount point) that sftpman manages.""" 82 | 83 | PORT_RANGE_MIN = 0 84 | PORT_RANGE_MAX = 65535 85 | 86 | SSH_PORT_DEFAULT = 22 87 | 88 | AUTH_METHOD_PUBLIC_KEY = 'publickey' 89 | # AUTH_METHOD_AUTHENTICATION_AGENT is a placeholder authentication method. 90 | # It's not recognized by the `ssh` command (as a valid PreferredAuthentications choice), 91 | # # but instructs us to avoid specifying a preferred authentication and SSH key (`-i ..`), 92 | # thus delegating to an SSH agent, if available. 93 | AUTH_METHOD_AUTHENTICATION_AGENT = 'authentication-agent' 94 | AUTH_METHOD_PASSWORD = 'password' 95 | AUTH_METHOD_INTERACTIVE = 'keyboard-interactive' 96 | AUTH_METHOD_HOSTBASED = 'hostbased' 97 | AUTH_METHOD_GSSAPI_WITH_MIC = 'gssapi-with-mic' 98 | 99 | AUTH_METHODS = ( 100 | AUTH_METHOD_PUBLIC_KEY, 101 | AUTH_METHOD_AUTHENTICATION_AGENT, 102 | AUTH_METHOD_PASSWORD, 103 | AUTH_METHOD_INTERACTIVE, 104 | AUTH_METHOD_HOSTBASED, 105 | AUTH_METHOD_GSSAPI_WITH_MIC 106 | ) 107 | 108 | # libfuse (>=3.0.0) dropped support for big_writes 109 | UNSUPPORTED_MOUNT_OPTS = ['big_writes'] 110 | 111 | def __init__(self, **kwargs): 112 | self.id = kwargs.get('id', None) 113 | self.host = kwargs.get('host', None) 114 | self.port = kwargs.get('port', SystemModel.SSH_PORT_DEFAULT) 115 | self.user = kwargs.get('user', None) 116 | self.mount_opts = list(kwargs.get('mountOptions', [])) 117 | self.mount_opts = [v for v in self.mount_opts if v not in SystemModel.UNSUPPORTED_MOUNT_OPTS] 118 | self.mount_point = kwargs.get('mountPoint', None) 119 | self.auth_method = kwargs.get('authType', self.AUTH_METHOD_PUBLIC_KEY) 120 | self.ssh_key = kwargs.get('sshKey', None) 121 | self.cmd_before_mount = kwargs.get('beforeMount', '') 122 | 123 | def _set_port(self, value): 124 | self._port = int(value) 125 | 126 | port = property(lambda self: self._port, _set_port) 127 | 128 | def _set_ssh_key(self, value): 129 | if value is not None: 130 | value = os.path.expanduser(value) 131 | self._ssh_key = value 132 | 133 | ssh_key = property(lambda self: self._ssh_key, _set_ssh_key) 134 | 135 | def validate(self): 136 | def is_valid_id(value): 137 | if value is None: 138 | return False 139 | if value in ('.', '..'): 140 | return False 141 | return re.compile('^[a-zA-Z0-9\\.\\-_@]+$').match(value) is not None 142 | 143 | def is_alphanumeric(value): 144 | if value is None: 145 | return False 146 | # Well, not really alphanumeric, but close enough to call it that 147 | return re.compile('^[a-zA-Z0-9\\.\\-]+$').match(value) is not None 148 | 149 | def is_valid_username(value): 150 | if value is None: 151 | return False 152 | return re.compile('^[a-zA-Z0-9\\.\\-_@]+$').match(value) is not None 153 | 154 | def is_valid_path(value): 155 | if value is None: 156 | return False 157 | return re.compile('^/(([a-zA-Z0-9\\.\\-_]+)/?)*?$').match(value) is not None 158 | 159 | errors = [] 160 | if not is_valid_id(self.id): 161 | errors.append(('id', 'IDs can only contain letters, digits, dot, @, dash and underscore.')) 162 | if not is_alphanumeric(self.host): 163 | errors.append(('host', 'Hosts can only contain letters, digits, dot and dash.')) 164 | if not is_valid_path(self.mount_point): 165 | errors.append(('mount_point', 'Invalid remote mount point.')) 166 | if self.auth_method not in self.AUTH_METHODS: 167 | errors.append(('auth_method', 'Unknown auth type.')) 168 | else: 169 | if self.auth_method == self.AUTH_METHOD_PUBLIC_KEY: 170 | if self.ssh_key is None or not os.path.exists(self.ssh_key): 171 | errors.append(('ssh_key', 'Invalid ssh key path.')) 172 | if not is_valid_username(self.user): 173 | errors.append(('user', 'Usernames can only contain letters, at signs and digits.')) 174 | if not(self.PORT_RANGE_MIN < self.port <= self.PORT_RANGE_MAX): 175 | msg = 'Ports need to be numbers between %d and %d.' % ( 176 | self.PORT_RANGE_MIN, 177 | self.PORT_RANGE_MAX, 178 | ) 179 | errors.append(('port', msg)) 180 | if not isinstance(self.mount_opts, list): 181 | errors.append(('mount_opts', 'Bad options received.')) 182 | if not isinstance(self.cmd_before_mount, str): 183 | errors.append(('cmd_before_mount', 'Invalid before mount command.')) 184 | 185 | return (len(errors) == 0, errors) 186 | 187 | def export(self): 188 | """Serializes to JSON.""" 189 | fields = ['id', 'host', 'port', 'user'] 190 | out = {} 191 | for field in fields: 192 | out[field] = getattr(self, field, None) 193 | out['mountOptions'] = self.mount_opts 194 | out['mountPoint'] = self.mount_point 195 | out['beforeMount'] = self.cmd_before_mount 196 | out['authType'] = self.auth_method 197 | out['sshKey'] = self.ssh_key 198 | return json.dumps(out, indent=4) 199 | 200 | def save(self, environment): 201 | path = environment.get_system_config_path(self.id) 202 | mkdir_p(os.path.dirname(path)) 203 | with open(path, 'w') as f: 204 | f.write(self.export()) 205 | 206 | def delete(self, environment): 207 | path = environment.get_system_config_path(self.id) 208 | os.unlink(path) 209 | 210 | @staticmethod 211 | def create_by_id(id, environment): 212 | path = environment.get_system_config_path(id) 213 | return SystemModel.create_from_file(path) 214 | 215 | @staticmethod 216 | def create_from_file(path): 217 | try: 218 | with open(path) as f: 219 | config = json.loads(f.read()) 220 | return SystemModel(**config) 221 | except (ValueError, IOError) as e: 222 | msg = 'Failed finding or parsing config at %s.' 223 | raise SftpConfigException(msg % path, e) 224 | 225 | 226 | class SystemControllerModel(object): 227 | """Controls a given system within the environment. 228 | The controller manages mounting, unmounting, cleaning up, etc. 229 | """ 230 | 231 | SIGNAL_SIGTERM = 15 232 | SIGNAL_SIGKILL = 9 233 | 234 | #: Time to wait when unmounting before forcefully killing the mount process 235 | KILL_WAIT_TIME_SECONDS = 2 236 | 237 | #: Time to wait for sshfs (ssh) to establish a connection 238 | SSH_CONNECT_TIMEOUT = 8 239 | 240 | def __init__(self, system, environment): 241 | self.system = system 242 | self.environment = environment 243 | 244 | @property 245 | def mounted(self): 246 | return self.environment.is_mounted(self.system.id) 247 | 248 | @property 249 | def mount_point_local(self): 250 | return self.environment.get_system_mount_dest(self.system.id) 251 | 252 | @property 253 | def mount_point_remote(self): 254 | return self.system.mount_point 255 | 256 | def _mount_point_local_create(self): 257 | """Ensures the mount location exists, so we can start using it.""" 258 | 259 | # Ensure nothing's mounted there right now.. 260 | shell_exec('fusermount -u %s' % self.mount_point_local) 261 | 262 | # Ensure the directory path exists 263 | mkdir_p(self.mount_point_local) 264 | 265 | def _mount_point_local_delete(self): 266 | rmdir(self.mount_point_local) 267 | 268 | def mount(self): 269 | """Mounts the sftp system if it's not already mounted.""" 270 | if self.mounted: 271 | return 272 | 273 | self._mount_point_local_create() 274 | 275 | if len(self.system.mount_opts) == 0: 276 | sshfs_opts = "" 277 | else: 278 | sshfs_opts = " -o %s" % " -o ".join(self.system.mount_opts) 279 | 280 | if self.system.auth_method == self.system.AUTH_METHOD_PUBLIC_KEY: 281 | ssh_opts = '-o PreferredAuthentications=publickey -i %s' % self.system.ssh_key 282 | elif self.system.auth_method == self.system.AUTH_METHOD_AUTHENTICATION_AGENT: 283 | # By not specifying a key and preferred authentication method, 284 | # we're hoping to delegate all this to an already running SSH agent, if available. 285 | ssh_opts = "" 286 | elif self.system.auth_method: 287 | ssh_opts = '-o PreferredAuthentications=%s' % self.system.auth_method 288 | else: 289 | ssh_opts = '-o PreferredAuthentications=password' 290 | 291 | ssh_cmd = "ssh -o ConnectTimeout={timeout} -p {port} {ssh_opts}".format( 292 | timeout = self.SSH_CONNECT_TIMEOUT, 293 | port = self.system.port, 294 | ssh_opts = ssh_opts, 295 | ) 296 | ssh_cmd = ssh_cmd.rstrip() 297 | 298 | cmd = (" sshfs -o ssh_command=" 299 | "'{ssh_cmd}'" 300 | " {sshfs_opts} {user}@{host}:{remote_path} {local_path}") 301 | cmd = cmd.format( 302 | cmd_before_mount = self.system.cmd_before_mount, 303 | ssh_cmd = ssh_cmd, 304 | sshfs_opts = sshfs_opts, 305 | host = self.system.host, 306 | user = self.system.user, 307 | remote_path = self.mount_point_remote, 308 | local_path = self.mount_point_local, 309 | ) 310 | 311 | if self.system.cmd_before_mount: 312 | cmd = f"{self.system.cmd_before_mount} && {cmd}" 313 | 314 | output = shell_exec(cmd).strip() 315 | 316 | if not self.mounted: 317 | # Clean up the directory tree 318 | self._mount_point_local_delete() 319 | if output == '': 320 | output = 'Mounting failed for a reason unknown to sftpman.' 321 | raise SftpMountException(cmd, output) 322 | 323 | def unmount(self): 324 | """Unmounts the sftp system if it's currently mounted.""" 325 | if not self.mounted: 326 | return 327 | 328 | # Try to unmount properly. 329 | cmd = 'fusermount -u %s' % self.mount_point_local 330 | shell_exec(cmd) 331 | 332 | # The filesystem is probably still in use. 333 | # kill sshfs and re-run this same command (which will work then). 334 | if self.mounted: 335 | self._kill() 336 | shell_exec(cmd) 337 | 338 | self._mount_point_local_delete() 339 | 340 | def _kill(self): 341 | pid = self.environment.get_pid_by_system_id(self.system.id) 342 | if pid is None: 343 | return 344 | kill_pid(pid, SystemControllerModel.SIGNAL_SIGTERM) 345 | 346 | from time import sleep 347 | sleep(SystemControllerModel.KILL_WAIT_TIME_SECONDS) 348 | 349 | pid = self.environment.get_pid_by_system_id(self.system.id) 350 | if pid is not None: 351 | kill_pid(pid, SystemControllerModel.SIGNAL_SIGKILL) 352 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------