├── src ├── __init__.py ├── tests │ ├── __init__.py │ └── test_authorized_keys.py ├── config.schema.yml ├── scp.py ├── worker.py ├── config.py ├── authorized_keys.py └── main.py ├── .gitignore ├── MANIFEST.in ├── docs └── return-codes.yml ├── .travis.yml ├── setup.py ├── CHANGES.rst ├── README.rst └── LICENSE /src/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyo 2 | *.pyc 3 | *.swp 4 | /*.egg-info 5 | /.eggs 6 | /build 7 | /dist 8 | /MANIFEST 9 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst 2 | include CHANGES.rst 3 | include LICENSE 4 | recursive-include docs *.yml 5 | -------------------------------------------------------------------------------- /docs/return-codes.yml: -------------------------------------------------------------------------------- 1 | 0: everything ok 2 | 1: configfile does not exist 3 | 2: unexpected exception 4 | 3: problem with configfile 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: python 3 | python: 4 | - "2.7" 5 | - "3.5" 6 | - "3.6" 7 | install: 8 | - "python setup.py install" 9 | script: 10 | - "python setup.py test" 11 | -------------------------------------------------------------------------------- /src/config.schema.yml: -------------------------------------------------------------------------------- 1 | # TODO generate documention from schema? 2 | type: object 3 | required: [keys, servers] 4 | properties: 5 | keys: 6 | type: object 7 | default: {} 8 | additionalProperties: 9 | type: string 10 | # TODO ... or with object with keys {comment, key, keyname, options} 11 | servers: 12 | type: object 13 | additionalProperties: 14 | type: object 15 | properties: 16 | name: { type: string } 17 | hostname: { type: string } 18 | port: { type: integer } 19 | user: { type: string } 20 | ssh_user: { type: string } 21 | absent: 22 | type: array 23 | items: 24 | type: string 25 | present: 26 | type: array 27 | items: 28 | type: string 29 | allow: 30 | type: array 31 | items: 32 | type: string 33 | like: { type: string } 34 | keepOtherKeys: { type: boolean} 35 | additionalProperties: false 36 | additionalProperties: false 37 | # vim: sw=2 ts=2 et 38 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | from setuptools import setup 5 | 6 | setup( 7 | name='claviger', 8 | version='0.2.2.dev0', 9 | description='Synchronizes remote SSH authorized_keys', 10 | long_description="{0:s}\n{1:s}". format( 11 | open('README.rst').read(), 12 | open('CHANGES.rst').read()), 13 | author='Bas Westerbaan', 14 | author_email='bas@westerbaan.name', 15 | url='http://github.com/bwesterb/claviger/', 16 | packages=['claviger', 'claviger.tests'], 17 | package_dir={'claviger': 'src'}, 18 | package_data={'claviger': [ 19 | 'config.schema.yml']}, 20 | test_suite='claviger.tests', 21 | license='GPL 3.0', 22 | zip_safe=False, 23 | install_requires=['demandimport >=0.3.0', 24 | 'PyYAML', 25 | 'six', 26 | 'tarjan', 27 | 'jsonschema', 28 | ], 29 | entry_points = { 30 | 'console_scripts': [ 31 | 'claviger = claviger.main:entrypoint', 32 | ] 33 | }, 34 | classifiers=[ 35 | # TODO 36 | ] 37 | ), 38 | -------------------------------------------------------------------------------- /CHANGES.rst: -------------------------------------------------------------------------------- 1 | claviger Changelog 2 | ****************** 3 | 4 | 0.2.2 (unreleased) 5 | ================== 6 | 7 | - Do not present configuration file errors as unhandled exceptions. 8 | 9 | 10 | 0.2.1 (2016-03-15) 11 | ================== 12 | 13 | - Add missing dependency to jsonschema. (Thanks-to: Joost Rijneveld) 14 | - Properly decode output of `scp`. (Thanks-to: Joost Rijneveld) 15 | 16 | 17 | 0.2 (2016-01-14) 18 | ================ 19 | 20 | - Add ``allow``-list to server stanza. 21 | 22 | If ``keepOtherKeys`` is set to false, claviger will remove any keys present 23 | except for those in the ``present`` and ``allow`` list. 24 | - Add *abstract servers*. Let every server inherit from the hidden 25 | abstract server ``$default``. 26 | - Allow 27 | 28 | .. code:: yaml 29 | 30 | servers: 31 | server1: 32 | server2: 33 | 34 | which is prettier than 35 | 36 | .. code:: yaml 37 | 38 | servers: 39 | server1: {} 40 | server2: {} 41 | 42 | - bugfix: actually set server name with ``name`` option. 43 | 44 | 45 | 0.1.2 (2016-01-08) 46 | ================== 47 | 48 | - Show the correct number of keys actually removed. 49 | 50 | 51 | 0.1.1 (2015-12-21) 52 | ================== 53 | 54 | - Some cosmetic changes. 55 | - Show example configuration file, if claviger isn't configured yet. 56 | - Python 3 compatibility. 57 | 58 | 0.1.0 (2015-12-14) 59 | ================== 60 | 61 | - Initial release. 62 | -------------------------------------------------------------------------------- /src/tests/test_authorized_keys.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import textwrap 3 | 4 | import six 5 | 6 | import claviger.authorized_keys 7 | 8 | SSHD_MAN_PAGE_EXAMPLE = six.b(textwrap.dedent(""" 9 | # Comments allowed at start of line 10 | ssh-rsa AAAAB3NzaC1yc2EAAAA= user@example.net 11 | from="*.sales.example.net,!pc.sales.example.net" ssh-rsa AAAAB3NzaC1yc2EAAAA= john@example.net 12 | command="dump /home",no-pty,no-port-forwarding ssh-dss AAAAB3NzaC1kc3MAAA== example.net 13 | permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss AAAAB3NzaC1kc3MAAA== 14 | tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAAB3NzaC1yc2EAAAA= jane@example.net 15 | restrict,command="uptime" ssh-rsa AAAAB3NzaC1yc2EAAAA= user@example.net 16 | restrict,pty,command="nethack" ssh-rsa AAAAB3NzaC1yc2EAAAA= user@example.net 17 | """)) 18 | 19 | GRAWITY_EXAMPLE = six.b('ssh-foo="echo \\"Here\'s ssh-rsa for you\\"" '+ 20 | 'future-algo AAAAC2Z1dHVyZS1hbGdv X y z.') 21 | 22 | class TestAuthorizedKeys(unittest.TestCase): 23 | def test_man_page_examples(self): 24 | f = six.BytesIO(SSHD_MAN_PAGE_EXAMPLE) 25 | ak = claviger.authorized_keys.parse(f, False) 26 | self.assertTrue(ak.contains(b'AAAAB3NzaC1yc2EAAAA=')) 27 | self.assertTrue(ak.contains(b'AAAAB3NzaC1kc3MAAA==')) 28 | self.assertEqual(len(ak.entries), 7) 29 | 30 | g = six.BytesIO() 31 | ak.store(g) 32 | self.assertEqual(f.getvalue(), g.getvalue()) 33 | 34 | def test_grawity_hard_line(self): 35 | e = claviger.authorized_keys.Entry.parse(GRAWITY_EXAMPLE) 36 | self.assertEqual(e.keytype, b'future-algo') 37 | 38 | def test_getters(self): 39 | f = six.BytesIO(SSHD_MAN_PAGE_EXAMPLE) 40 | ak = claviger.authorized_keys.parse(f, False) 41 | self.assertEqual(len(ak.entries), 7) 42 | self.assertEqual(ak.get(b'doesnotexist'), None) 43 | 44 | def test_remove(self): 45 | f = six.BytesIO(SSHD_MAN_PAGE_EXAMPLE) 46 | ak = claviger.authorized_keys.parse(f, False) 47 | self.assertTrue(ak.contains(b'AAAAB3NzaC1yc2EAAAA=')) 48 | ak.remove(b'AAAAB3NzaC1yc2EAAAA=') 49 | self.assertFalse(ak.contains(b'AAAAB3NzaC1yc2EAAAA=')) 50 | self.assertTrue(ak.contains(b'AAAAB3NzaC1kc3MAAA==')) 51 | ak.removeAllKeys() 52 | self.assertEqual(len(ak.entries), 0) 53 | 54 | if __name__ == '__main__': 55 | unittest.main() 56 | -------------------------------------------------------------------------------- /src/scp.py: -------------------------------------------------------------------------------- 1 | import os.path 2 | import logging 3 | import tempfile 4 | import subprocess 5 | 6 | l = logging.getLogger(__name__) 7 | 8 | class SCP(object): 9 | def connect(self, hostname, port, ssh_user): 10 | return SCPSession(hostname, port, ssh_user) 11 | 12 | 13 | def interpret_scp_error(exitcode, stderr, stdout): 14 | """ Interpret the output of `scp' and create a suitable exception """ 15 | if 'Host key verification failed' in stderr: 16 | return HostKeyVerificationFailed() 17 | msg = 'scp failed: exitcode {0}'.format(exitcode) 18 | if stderr.strip(): 19 | msg += '; stderr {0}'.format(repr(stderr)) 20 | if stdout.strip(): 21 | msg += '; stdout {0}'.format(repr(stdout)) 22 | return SCPError(msg) 23 | 24 | class SCPError(Exception): 25 | pass 26 | class HostKeyVerificationFailed(SCPError): 27 | pass 28 | 29 | class SCPSession(object): 30 | def __init__(self, hostname, port, ssh_user): 31 | self.hostname = hostname 32 | self.port = port if port else 22 33 | self.ssh_user = ssh_user 34 | def _path_for(self, user): 35 | # TODO read passwd or use SSH session to find home 36 | return os.path.join('~' + user, '.ssh', 'authorized_keys') 37 | def _scp(self, src, trg): 38 | cmd = ['scp', '-B', '-P', str(self.port), src, trg] 39 | l.debug('executing %s', cmd) 40 | p = subprocess.Popen(cmd, stdout=subprocess.PIPE, 41 | stderr=subprocess.PIPE) 42 | stdout_txt, stderr_txt = [x.decode('utf-8') for x in p.communicate()] 43 | if p.returncode != 0: 44 | raise interpret_scp_error(p.returncode, stderr_txt, stdout_txt) 45 | 46 | def get(self, user): 47 | with tempfile.NamedTemporaryFile() as tempf: 48 | # FIXME escaping 49 | # TODO check for error 50 | self._scp('{0}@{1}:{2}'.format(self.ssh_user, self.hostname, 51 | self._path_for(user)), tempf.name) 52 | return tempf.read() 53 | # TODO create .ssh if it does not exist 54 | # TODO check permissions 55 | # TODO backup? 56 | def put(self, user, authorized_keys): 57 | with tempfile.NamedTemporaryFile() as tempf: 58 | tempf.write(authorized_keys) 59 | tempf.flush() 60 | self._scp(tempf.name, '{0}@{1}:{2}'.format(self.ssh_user, 61 | self.hostname, self._path_for(user))) 62 | -------------------------------------------------------------------------------- /src/worker.py: -------------------------------------------------------------------------------- 1 | """ Contains the code to check the authorized_keys file on a server. 2 | 3 | We run several checks in parallel using the multiprocessing module. 4 | To avoid serialization (and other) issues, we separate the worker 5 | environment in this module with the rest of the program. """ 6 | 7 | import sys 8 | import difflib 9 | import traceback 10 | import collections 11 | 12 | import six 13 | 14 | import claviger.scp 15 | import claviger.authorized_keys 16 | 17 | # arguments send by the main process 18 | Job = collections.namedtuple('Job', 19 | ('server', 'keys', 'dry_run', 'no_diff')) 20 | 21 | # this is what we return 22 | JobReturn = collections.namedtuple('JobReturn', 23 | ('server_name', 'ok', 'result')) 24 | # if everything is ok, the result field is of the following type ... 25 | JobResult = collections.namedtuple('JobResult', 26 | ('n_keys_added', 'n_keys_removed', 'n_keys_ignored')) 27 | # ... otherwise it is an exception 28 | 29 | def check_server(job): 30 | try: 31 | scp = claviger.scp.SCP() 32 | n_keys_removed = 0 33 | n_keys_added = 0 34 | n_keys_ignored = 0 35 | server = job.server 36 | conn = scp.connect(server['hostname'], server['port'], 37 | server['ssh_user']) 38 | 39 | # First pull the current authorized_keys 40 | original_raw_ak = conn.get(server['user']) 41 | ak = claviger.authorized_keys.parse(original_raw_ak) 42 | 43 | # Check which keys to add 44 | for key_name in server['present']: 45 | key = job.keys[key_name] 46 | # TODO update comment/options 47 | if ak.contains(key['key']): 48 | continue 49 | n_keys_added += 1 50 | ak.add(key['options'], key['keytype'], key['key'], key['comment']) 51 | 52 | # Check which keys to remove 53 | if server['keepOtherKeys']: 54 | for key_name in server['absent']: 55 | if not ak.contains(job.keys[key_name]['key']): 56 | continue 57 | ak.remove(job.keys[key_name]['key']) 58 | n_keys_removed += 1 59 | allowed = {job.keys[key_name]['key'] 60 | for key_name in server['present'] + server['allow']} 61 | 62 | for entry in ak.entries: 63 | if entry.key in allowed: 64 | continue 65 | if not server['keepOtherKeys']: 66 | ak.remove(entry.key) 67 | n_keys_removed += 1 68 | else: 69 | n_keys_ignored += 1 70 | 71 | # Did things change? 72 | raw_ak = six.binary_type(ak) 73 | if n_keys_added or n_keys_removed: 74 | if job.dry_run: 75 | if not job.no_diff: 76 | print(''.join(difflib.unified_diff( 77 | original_raw_ak.decode('utf-8').splitlines(True), 78 | raw_ak.decode('utf-8').splitlines(True), 79 | server['name']))) 80 | else: 81 | conn.put(server['user'], raw_ak) 82 | 83 | return JobReturn(server_name=server['name'], ok=True, 84 | result=JobResult(n_keys_added=n_keys_added, 85 | n_keys_removed=n_keys_removed, 86 | n_keys_ignored=n_keys_ignored)) 87 | except claviger.scp.SCPError as e: 88 | return JobReturn(server_name=server['name'], ok=False, result=e) 89 | except Exception as e: 90 | # multiprocessing does not pass the stacktrace to the parent process. 91 | # ( see http://stackoverflow.com/questions/6126007 ) 92 | # Thus we force the stacktrace in the message. 93 | raise Exception(''.join(traceback.format_exception(*sys.exc_info()))) 94 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | claviger 2 | ******** 3 | 4 | ``claviger`` manages the SSH ``authorized_keys`` files for you. 5 | 6 | Quick introduction 7 | ================== 8 | 9 | Tell ``claviger`` which keys you want to put on which server 10 | by creating a ``~/.claviger``-file. An example 11 | 12 | .. code:: yaml 13 | 14 | keys: 15 | laptop: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINYZEwjtu8w9Hsvx85TlYE95MLV9Whc3N1ajrH7+gu7A 16 | desktop: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAICUef9frJIX7tjvZkYYMtr4IdD/GcKz6/X5qvLxM1Z8O desktop 17 | work: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAICrycv44eyFwWJ7QQsGOnjEiAsFSdxIoAEzBPSO/AQB5 work 18 | servers: 19 | myprivateserver.com: 20 | user: myusername 21 | present: 22 | - laptop 23 | - desktop 24 | root@myotherserver.com: 25 | like: myprivateserver.com 26 | present: 27 | - work 28 | keepOtherKeys: false 29 | workuser@workserver.com: 30 | present: 31 | - work 32 | - desktop 33 | absent: 34 | - laptop 35 | 36 | Then run ``claviger``. By default ``claviger`` only tells which changes 37 | it wants to make, but does not make them. If the changes seem fine, 38 | run ``claviger -f``, which allows ``claviger`` to make changes. 39 | 40 | Installation 41 | ============ 42 | 43 | To install ``claviger``, simply run:: 44 | 45 | pip install claviger 46 | 47 | 48 | Claviger config file 49 | ==================== 50 | 51 | A ``.claviger`` is written in YAML_. It consists of two maps: the ``keys`` 52 | map and the ``servers`` map. 53 | 54 | .. code:: yaml 55 | 56 | servers: 57 | server_key: 58 | # ... (server stanza) 59 | server_key2: 60 | # ... (server stanza) 61 | keys: 62 | key_name: # ... (ssh public key) 63 | key_name2: # ... (ssh public key) 64 | 65 | As seen in the example at the top, the ``keys`` map has as values SSH 66 | public keys as they would appear in an ``authorized_keys`` file. 67 | 68 | The ``servers`` map consists of key-stanza pairs. Each stanza is a map 69 | of option name/value pairs, like: 70 | 71 | .. code:: yaml 72 | 73 | server_key: 74 | option_name: option_value 75 | option_name2: option_value 76 | # ... 77 | 78 | See below for the available options in the server-stanza's. 79 | 80 | Server key 81 | ---------- 82 | 83 | The key of a server stanza is of the following form:: 84 | 85 | [user@]hostname[:port] 86 | 87 | Examples of keys are 88 | 89 | - ``just-a-hostname.nl`` 90 | - ``user@some-server.com`` 91 | - ``some-server.nl:1234`` 92 | - ``user@and-port.com:22022`` 93 | 94 | You can also specify ``user``, ``hostname`` and ``port`` explicitly. 95 | See below. 96 | 97 | If a server key starts with a dollar sign (for instance ``$work``), 98 | then it is considered ``abstract`` --- see below. 99 | 100 | Server stanzas 101 | -------------- 102 | 103 | A server stanza is a map which may have the following entries. 104 | 105 | ================== ============================================================= 106 | ``name`` | The name of the server. 107 | | *Default*: stanza key. 108 | ``hostname`` | The hostname of the server. 109 | | *Default*: derived from stanza key. 110 | ``user`` | The user for which to manage the ``authorized_keys`` file 111 | | *Default*: ``root`` if not derived from stanza key. 112 | ``present`` | A list of key names that must be in the 113 | ``authorized_keys`` file. 114 | | *Default*: the empty list ``[]`` 115 | ``absent`` | A list of SSH-keys that should be removed from the 116 | ``authorized_keys`` file. 117 | | *Default*: the empty list ``[]`` 118 | ``keepOtherKeys`` | ``true`` or ``false``. If set to ``false``, ``claviger`` 119 | will remove all keys not explicitly allowed form the 120 | ``authorized_keys`` file. 121 | | *Default*: ``true``. 122 | ``allow`` | A list of SSH-keys that are also allowed to be in the 123 | ``authorized_keys`` file if ``keepOtherKeys`` is set 124 | to ``false``. These keys will not be added, if 125 | not present already. 126 | | *Default*: the empty list ``[]`` 127 | ``like`` | Name of another server stanza. If set, the entries of 128 | the other server stanza will be used as default values 129 | for this server stanza. 130 | | *Default*: ``$default`` 131 | ``ssh_user`` | The user to use to get and put the 132 | ``authorized_keys`` file. 133 | | *Default*: the same as ``user`` 134 | ``port`` | The port to use to connect to the server. 135 | | *Default*: 22. 136 | ``abstract`` | ``true`` or ``false``. If set to ``true``, ``claviger`` 137 | will not check this server. See below. 138 | | *Default*: ``false`` 139 | ================== ============================================================= 140 | 141 | 142 | Abstract servers and ``$default`` 143 | --------------------------------- 144 | 145 | ``claviger`` will not check an *abstract* server. This is useful to cleanly 146 | configure multiple server. 147 | 148 | .. code:: yaml 149 | 150 | servers: 151 | $mine: 152 | keepOthers: false 153 | present: 154 | - my_first_key 155 | - my_second_key 156 | $work: 157 | present: 158 | - my_work_key 159 | absent: 160 | - my_first_key 161 | 162 | my-first-server.tld: 163 | like: $mine 164 | my-second-server.tld: 165 | like: $mine 166 | alpha.at-work.tld: 167 | like: $work 168 | beta.at_work.tld: 169 | like: $work 170 | 171 | By default, server inherits from the hidden ``$default`` abstract server. 172 | 173 | .. code:: yaml 174 | 175 | servers: 176 | $default: 177 | user: myname 178 | present: 179 | - this_key_is_put_everywhere 180 | host1.tld: # will use myname as user 181 | host2.tld: # " 182 | root@host3.tld # will use root as user 183 | host4.tld: 184 | absent: 185 | - this_key_is_put_everywhere # except here 186 | 187 | 188 | .. _YAML: http://yaml.org 189 | -------------------------------------------------------------------------------- /src/config.py: -------------------------------------------------------------------------------- 1 | """ Reads claviger's configuration file. """ 2 | import yaml 3 | import logging 4 | import os.path 5 | import textwrap 6 | import itertools 7 | import collections 8 | 9 | import six 10 | import tarjan 11 | import jsonschema 12 | 13 | import claviger.authorized_keys 14 | 15 | class ConfigError(Exception): 16 | pass 17 | 18 | ParsedServerKey = collections.namedtuple('ParsedServerKey', 19 | ('hostname', 'user', 'port', 'abstract')) 20 | 21 | l = logging.getLogger(__name__) 22 | 23 | # Schema for the configuration file. 24 | _SCHEMA = None 25 | 26 | def get_schema(): 27 | global _SCHEMA 28 | if not _SCHEMA: 29 | l.debug('loading scheme ...') 30 | with open(os.path.join(os.path.dirname(os.path.realpath(__file__)), 31 | 'config.schema.yml')) as f: 32 | _SCHEMA = yaml.load(f) 33 | l.debug(' ... done!') 34 | return _SCHEMA 35 | 36 | class ConfigurationError(Exception): 37 | pass 38 | 39 | def parse_server_key(key): 40 | """ Converts a server key like (root@host:1234 or just host) 41 | to a triplet (user, port, hostname, abstract) """ 42 | port = None 43 | user = None 44 | abstract = False 45 | hostname = None 46 | if key.startswith('$'): 47 | abstract = True 48 | else: 49 | hostname = key 50 | if ':' in hostname: 51 | hostname, _port = hostname.rsplit(':', 1) 52 | port = int(_port) 53 | if '@' in hostname: 54 | user, hostname = hostname.split('@', 1) 55 | return ParsedServerKey(user=user, port=port, hostname=hostname, 56 | abstract=abstract) 57 | 58 | def load(path): 59 | """ Loads the configuration file. 60 | 61 | A lot of the work is done by YAML. We validate the easy bits with 62 | a JSON schema. The rest by hand. """ 63 | # TODO Cache schema and configuration file 64 | l.debug('loading configuration file ...') 65 | with open(path) as f: 66 | cfg = yaml.load(f) 67 | 68 | if not isinstance(cfg, dict): 69 | raise ConfigurationError('Configuration file is empty') 70 | 71 | l.debug(' - checking schema') 72 | # First small fixes which the schema can't handle 73 | cfg.setdefault('servers', {}) 74 | cfg['servers'].setdefault('$default', {}) 75 | for key in cfg['servers']: 76 | if cfg['servers'][key] is None: 77 | cfg['servers'][key] = dict() 78 | 79 | # Now check the schema 80 | jsonschema.validate(cfg, get_schema()) 81 | # TODO format into pretty error message 82 | 83 | l.debug(' - processing keys') 84 | new_keys = {} 85 | cfg.setdefault('keys', {}) 86 | for key_name, key in six.iteritems(cfg['keys']): 87 | # TODO handle error 88 | entry = claviger.authorized_keys.Entry.parse(key) 89 | new_key = {'key': entry.key, 90 | 'options': entry.options, 91 | 'comment': entry.comment, 92 | 'keytype': entry.keytype} 93 | new_keys[key_name] = new_key 94 | cfg['keys'] = new_keys 95 | 96 | l.debug(' - processing server stanza short-hands') 97 | new_servers = {} 98 | for server_key, server in six.iteritems(cfg['servers']): 99 | parsed_server_key = parse_server_key(server_key) 100 | server.setdefault('name', server_key) 101 | server_name = server['name'] 102 | server.setdefault('port', parsed_server_key.port) 103 | server.setdefault('user', parsed_server_key.user) 104 | server.setdefault('hostname', parsed_server_key.hostname) 105 | server.setdefault('ssh_user', server['user']) 106 | server.setdefault('present', []) 107 | server.setdefault('absent', []) 108 | server.setdefault('allow', []) 109 | server.setdefault('keepOtherKeys') 110 | server.setdefault('like', '$default' if server_key != '$default' 111 | else None) 112 | server.setdefault('abstract', parsed_server_key.abstract) 113 | prabsent = frozenset(server['present']) & frozenset(server['absent']) 114 | if prabsent: 115 | raise ConfigurationError( 116 | "Keys {0} are required to be both present and absent on {1}" 117 | .format(tuple(prabsent), server_name)) 118 | ablow = frozenset(server['allow']) & frozenset(server['absent']) 119 | if ablow: 120 | raise ConfigurationError( 121 | "Keys {0} are listed allowed and absent on {1}" 122 | .format(tuple(ablow), server_name)) 123 | for key_name in itertools.chain(server['present'], server['absent'], 124 | server['allow']): 125 | if not key_name in cfg['keys']: 126 | "Key {0} (on {1}) does not exist".format(key_name, server_name) 127 | if server_name in new_servers: 128 | raise ConfigurationError( 129 | "Duplicate server name {0}".format(server_name)) 130 | new_servers[server_name] = server 131 | cfg['servers'] = new_servers 132 | 133 | l.debug(' - resolving server stanza inheritance') 134 | # create dependancy graph and use Tarjan's algorithm to find a possible 135 | # order to evaluate the server stanzas. 136 | server_dg = {server_name: [server['like']] if server['like'] else [] 137 | for server_name, server in six.iteritems(cfg['servers'])} 138 | for server_cycle_names in tarjan.tarjan(server_dg): 139 | if len(server_cycle_names) != 1: 140 | raise ConfigurationError( 141 | "There is a cyclic dependacy among the servers {0}".format( 142 | server_cycle_names)) 143 | target_server = cfg['servers'][server_cycle_names[0]] 144 | if not target_server['like']: 145 | continue 146 | if not target_server['like'] in cfg['servers']: 147 | pass 148 | source_server = cfg['servers'][target_server['like']] 149 | 150 | # First the simple attributes 151 | for attr in ('port', 'user', 'hostname', 'ssh_user', 152 | 'keepOtherKeys'): 153 | if attr in source_server: 154 | if target_server[attr] is None: 155 | target_server[attr] = source_server[attr] 156 | 157 | # Now, the present/absent/allow lists 158 | for key in source_server['present']: 159 | if key in target_server['absent']: 160 | continue 161 | if key not in target_server['present']: 162 | target_server['present'].append(key) 163 | for key in source_server['absent']: 164 | if (key in target_server['present'] 165 | or key in target_server['allow']): 166 | continue 167 | if key not in target_server['absent']: 168 | target_server['absent'].append(key) 169 | for key in source_server['allow']: 170 | if key in target_server['absent']: 171 | continue 172 | if key not in target_server['allow']: 173 | target_server['allow'].append(key) 174 | 175 | l.debug(' - setting defaults on server stanzas') 176 | for server in six.itervalues(cfg['servers']): 177 | for attr, dflt in (('port', 22), 178 | ('user', 'root'), 179 | ('keepOtherKeys', True)): 180 | if server[attr] is None: 181 | server[attr] = dflt 182 | 183 | l.debug(' ... done') 184 | 185 | return cfg 186 | -------------------------------------------------------------------------------- /src/authorized_keys.py: -------------------------------------------------------------------------------- 1 | """ Lenient parser for authorized_keys. """ 2 | from six.moves import range 3 | 4 | import six 5 | 6 | import base64 7 | import binascii 8 | import struct 9 | 10 | class InvalidLineError(Exception): 11 | def __init__(self, line, message): 12 | self.message = message 13 | self.line = line 14 | def __str__(self): 15 | return "{0}: {1}".format( 16 | repr(self.line), self.message) 17 | 18 | class ParseError(Exception): 19 | def __init__(self, message): 20 | self.message = message 21 | 22 | class CouldNotParseLine(Exception): 23 | def __init__(self, message): 24 | self.message = message 25 | 26 | class Line(object): 27 | def __init__(self, raw_line): 28 | self._raw_line = raw_line 29 | def store(self, f): 30 | f.write(self._raw_line) 31 | @property 32 | def raw_line(self): 33 | return self._raw_line 34 | 35 | class Comment(Line): 36 | pass 37 | 38 | class InvalidLine(Line): 39 | pass 40 | 41 | class Entry(Line): 42 | def __init__(self, options, keytype, key, comment, raw_line=None): 43 | super(Entry, self).__init__(raw_line) 44 | self._options = options 45 | self._keytype = keytype 46 | self._key = key 47 | self._comment = comment 48 | if raw_line is None: 49 | self._update_rawline() 50 | 51 | @property 52 | def options(self): 53 | return self._options 54 | 55 | @options.setter 56 | def options(self, v): 57 | self._options = v 58 | self._update_rawline() 59 | 60 | @property 61 | def key(self): 62 | return self._key 63 | 64 | @key.setter 65 | def key(self, v): 66 | self._key = v 67 | self._update_rawline() 68 | 69 | @property 70 | def keytype(self): 71 | return self._keytype 72 | 73 | @keytype.setter 74 | def keytype(self, v): 75 | self._keytype = v 76 | self._update_rawline() 77 | 78 | @property 79 | def comment(self): 80 | return self._comment 81 | 82 | @comment.setter 83 | def comment(self, v): 84 | self._comment = v 85 | self._update_rawline() 86 | 87 | def _update_rawline(self): 88 | ret = b'' 89 | if self._options: 90 | ret += self._options + b' ' 91 | ret += self._keytype + b' ' + self._key 92 | if self._comment: 93 | ret += b' ' + self._comment 94 | self._raw_line = ret 95 | 96 | @staticmethod 97 | def parse(raw_line): 98 | # An entry consists of three or four fields: 99 | # [options] keytype key comment 100 | # The options field may contain spaces within quotes. First 101 | # find where it ends. 102 | if isinstance(raw_line, six.text_type): 103 | raw_line = raw_line.encode('utf-8') 104 | l = raw_line.strip() 105 | in_quote = False 106 | after_slash = False 107 | i = 0 108 | while i < len(l): 109 | cur = l[i:i+1] # In Python3 l[i] is an int 110 | if cur == b' ' and not in_quote: 111 | break 112 | if cur == b'"' and not after_slash: 113 | in_quote = not in_quote 114 | elif cur == b'\\': 115 | after_slash = True 116 | else: 117 | after_slash = False 118 | i += 1 119 | first_field, rest = l[:i], l[i:].strip() 120 | # Now the hard part: how to distinguish between options and keytype. 121 | # The trick: key actually also encodes keytype. 122 | # First case: first_field is keytype 123 | if check_key(rest.split(b' ')[0], first_field): 124 | bits = rest.split(b' ', 1) 125 | return Entry(keytype=first_field, 126 | key=bits[0], 127 | options=None, 128 | comment=(None if len(bits) == 1 else bits[1].strip()), 129 | raw_line=raw_line) 130 | # We are in the second case: 131 | bits = rest.split(b' ', 1) 132 | if not len(bits) == 2: 133 | raise CouldNotParseLine("Missing key field") 134 | keytype = bits[0] 135 | last_fields = bits[1].strip().split(b' ', 1) 136 | key = last_fields[0] 137 | if not check_key(key, keytype): 138 | raise CouldNotParseLine("key field is malformed") 139 | return Entry(options=first_field, 140 | key=key, 141 | keytype=keytype, 142 | comment=(None if len(last_fields) == 1 143 | else last_fields[1].strip()), 144 | raw_line=raw_line) 145 | 146 | def check_key(b64key, keytype): 147 | """ Check whether key seems to be a valid base64-encoded string 148 | with the given keytype. """ 149 | try: 150 | key = base64.b64decode(b64key) 151 | except (TypeError, binascii.Error): 152 | return False 153 | if len(key) < 5: 154 | return False 155 | keytype_len = struct.unpack('>I', key[:4])[0] 156 | if keytype_len != len(keytype): 157 | return False 158 | if not key[4:].startswith(keytype): 159 | return False 160 | return True 161 | 162 | class AuthorizedKeysFile(object): 163 | def __init__(self, lines): 164 | self.lines = lines 165 | def get(self, key): 166 | """ Returns the first occurance of key """ 167 | for line in self.lines: 168 | if not isinstance(line, Entry): 169 | continue 170 | if line.key == key: 171 | return key 172 | def contains(self, key): 173 | """ Checks whether a key occurs """ 174 | for line in self.lines: 175 | if not isinstance(line, Entry): 176 | continue 177 | if line.key == key: 178 | return True 179 | return False 180 | def remove(self, key): 181 | """ Removes all occurances of the given key. """ 182 | self.lines = [line for line in self.lines 183 | if not isinstance(line, Entry) or 184 | line.key != key] 185 | def removeAllKeys(self): 186 | """ Remove all keys, but leave the other entries. """ 187 | self.lines = [line for line in self.lines 188 | if not isinstance(line, Entry)] 189 | def add(self, options, keytype, key, comment): 190 | self.lines.append(Entry(options, keytype, key, comment)) 191 | @property 192 | def entries(self): 193 | """ Returns a list of all entries """ 194 | return [line for line in self.lines if isinstance(line, Entry)] 195 | def store(self, f): 196 | """ Writes to file-like object f. """ 197 | for line in self.lines: 198 | line.store(f) 199 | f.write(b'\n') 200 | def __bytes__(self): 201 | f = six.BytesIO() 202 | self.store(f) 203 | return f.getvalue() 204 | __str__ = __bytes__ 205 | 206 | def parse(file_or_str, ignoreInvalidLines=True): 207 | """ Parse authorized_keys from file-like-object or string f. 208 | 209 | If ignoreInvalidLines is set (default), the parser will ignore 210 | lines it cannot succesfully parse. """ 211 | parsed_lines = [] 212 | if isinstance(file_or_str, six.binary_type): 213 | f = six.BytesIO(file_or_str) 214 | else: 215 | f = file_or_str 216 | while True: 217 | l = f.readline() 218 | assert isinstance(l, six.binary_type) 219 | if not l: 220 | break 221 | if l.endswith(b'\n'): 222 | l = l[:-1] 223 | stripped_line = l.strip() 224 | if stripped_line.startswith(b'#') or not stripped_line: 225 | parsed_lines.append(Comment(l)) 226 | continue 227 | try: 228 | parsed_lines.append(Entry.parse(l)) 229 | except CouldNotParseLine as e: 230 | if not ignoreInvalidLines: 231 | raise InvalidLineError(l, e.message) 232 | parsed_lines.append(InvalidLine(l)) 233 | return AuthorizedKeysFile(parsed_lines) 234 | 235 | -------------------------------------------------------------------------------- /src/main.py: -------------------------------------------------------------------------------- 1 | import demandimport 2 | demandimport.enable() 3 | 4 | import multiprocessing.dummy 5 | import itertools 6 | import traceback 7 | import argparse 8 | import textwrap 9 | import os.path 10 | import logging 11 | import sys 12 | import os 13 | 14 | import claviger.authorized_keys 15 | import claviger.config 16 | import claviger.worker 17 | import claviger.scp 18 | 19 | import six 20 | import yaml 21 | 22 | l = logging.getLogger(__name__) 23 | 24 | class Claviger(object): 25 | """ main object for claviger """ 26 | def main(self, args): 27 | try: 28 | self.parse_commandline_args() 29 | 30 | extra_logging_config = {} 31 | if self.args.verbosity >= 2: 32 | level = logging.DEBUG 33 | extra_logging_config['format'] = ('%(relativeCreated)d '+ 34 | '%(levelname)s %(name)s %(message)s') 35 | elif self.args.verbosity == 1: 36 | level = logging.INFO 37 | else: 38 | level = logging.WARNING 39 | logging.basicConfig(level=level, **extra_logging_config) 40 | 41 | if not os.path.exists(self.args.configfile): 42 | return self.show_configuration_instructions() 43 | self.cfg = claviger.config.load(self.args.configfile) 44 | self.check_servers() 45 | except claviger.config.ConfigurationError as e: 46 | s = 'There was a problem with your configfile {0}:\n {1}\n' 47 | sys.stderr.write(s.format(self.args.configfile, e)) 48 | return 3 49 | except Exception: 50 | return self.handle_uncaught_exception() 51 | 52 | def check_servers(self): 53 | if self.args.parallel_connections == 1: 54 | # If we want one worker, the current thread will do just fine. 55 | the_map = itertools.imap 56 | else: 57 | # As check_server is iobound, threads are better than processes. 58 | pool = multiprocessing.dummy.Pool( 59 | processes=self.args.parallel_connections) 60 | the_map = pool.imap_unordered 61 | 62 | global_changes = False 63 | errors_occured = False 64 | for ret in the_map(claviger.worker.check_server, 65 | (claviger.worker.Job(server=self.cfg['servers'][server_name], 66 | keys=self.cfg['keys'], 67 | dry_run=self.args.dry_run, 68 | no_diff=self.args.no_diff) 69 | for server_name in self.cfg['servers'] 70 | if not self.cfg['servers'][server_name]['abstract'])): 71 | if not ret.ok: 72 | errors_occured = True 73 | if isinstance(ret.result, 74 | claviger.scp.HostKeyVerificationFailed): 75 | print("{0:<40} host key verification failed".format( 76 | ret.server_name)) 77 | else: 78 | print("") 79 | print("{0:<40} error".format(ret.server_name)) 80 | print(" {0}".format(ret.result)) 81 | print("") 82 | continue 83 | res = ret.result 84 | changes = any([res.n_keys_added, res.n_keys_removed]) 85 | global_changes |= changes 86 | l.debug(' %s: done', ret.server_name) 87 | if not changes and not self.args.verbosity: 88 | continue 89 | print ("{0:<40} +{1:<2} -{2:<2} ?{3:<2}".format(ret.server_name, 90 | res.n_keys_added, res.n_keys_removed, 91 | res.n_keys_ignored)) 92 | if not global_changes and not errors_occured: 93 | print('Everything is in order.') 94 | elif self.args.dry_run and not errors_occured: 95 | print('') 96 | print("This is a dry run: no changes have been made.") 97 | print("Rerun with `-f' to apply changes.") 98 | elif errors_occured: 99 | print('') 100 | print('Checking some servers failed. See above.') 101 | if self.args.dry_run: 102 | print("This is a dry run: no changes have been made.") 103 | 104 | def find_ssh_pubkeys(self): 105 | """ Searches for SSH public keys in the user's homedir. 106 | 107 | Return a list of (unique_name, pubkey) pairs. """ 108 | ret = [] 109 | names = set() 110 | ssh_dir = os.path.expanduser("~/.ssh") 111 | if not os.path.isdir(ssh_dir): 112 | return ret 113 | for fn in os.listdir(ssh_dir): 114 | if not fn.startswith('id_') or not fn.endswith('.pub'): 115 | continue 116 | with open(os.path.join(ssh_dir, fn), 'rb') as f: 117 | raw_pubkey = f.readline() 118 | if not raw_pubkey: 119 | continue 120 | raw_pubkey = raw_pubkey[:-1] 121 | try: 122 | pubkey = claviger.authorized_keys.Entry.parse(raw_pubkey) 123 | except claviger.authorized_keys.CouldNotParseLine: 124 | continue 125 | name = pubkey.comment if pubkey.comment else 'mykey' 126 | if name in names: 127 | i = 2 128 | while name + str(i) in names: 129 | i += 1 130 | name = name + str(i) 131 | names.add(name) 132 | ret.append((name, raw_pubkey)) 133 | return ret 134 | 135 | def show_configuration_instructions(self): 136 | keys = self.find_ssh_pubkeys() 137 | if not keys: 138 | keys = [('exampleKey', 'ssh-rsa AAAAHitsanexamplekey comment')] 139 | print(textwrap.dedent(""" 140 | The configuration file {configfile} does not exist. 141 | 142 | An example config file is: 143 | 144 | keys: """).format(configfile=self.args.configfile)) 145 | for name, key in keys: 146 | print(" {0}: {1}".format(yaml_str(name), yaml_str(key))) 147 | print(textwrap.dedent(""" 148 | servers: 149 | user@example.com: 150 | present:""").replace('\n','\n ')[1:]) 151 | for name, keys in keys: 152 | print(" - {0}".format(yaml_str(name))) 153 | return 1 154 | 155 | def parse_commandline_args(self): 156 | parser = argparse.ArgumentParser( 157 | description='Synchronize remote SSH authorized_keys') 158 | parser.add_argument('-c', '--configfile', metavar='PATH', 159 | type=os.path.expanduser, default='~/.claviger', 160 | help='Configuration file') 161 | parser.add_argument('--verbose', '-v', action='count', 162 | dest='verbosity', default=0, 163 | help='Add to increase make claviger chatty') 164 | parser.add_argument('--parallel-connections', '-p', metavar='N', 165 | type=int, default=8, 166 | help='Number of parallel connections') 167 | parser.add_argument('--apply-changes', '-f', action='store_false', 168 | dest='dry_run', 169 | help='Apply changes') 170 | parser.add_argument('--no-diff', '-s', action='store_true', 171 | help='Do not show a diff during the dry run') 172 | self.args = parser.parse_args() 173 | 174 | def handle_uncaught_exception(self): 175 | sys.stderr.write('\n') 176 | sys.stderr.write('An unexpected exception occured:\n') 177 | sys.stderr.write('\n ') 178 | sys.stderr.write(traceback.format_exc().replace('\n', '\n ')) 179 | sys.stderr.write('\n') 180 | sys.stderr.write('Please report this error:\n') 181 | sys.stderr.write('\n') 182 | sys.stderr.write(' https://github.com/bwesterb/claviger/issues\n') 183 | sys.stderr.write('\n') 184 | sys.stderr.flush() 185 | return 2 186 | 187 | def yaml_str(s): 188 | """ Escapes the string for inclusion in YAML. """ 189 | if not isinstance(s, six.string_types): 190 | s = s.decode('utf-8') 191 | ret = yaml.dump(s) 192 | if ret.endswith('\n'): 193 | ret = ret[:-1] 194 | if ret.endswith('\n...'): 195 | ret = ret[:-4] 196 | return ret 197 | 198 | def entrypoint(): 199 | """ entry-point of claviger """ 200 | return Claviger().main(sys.argv[1:]) 201 | 202 | if __name__ == '__main__': 203 | entrypoint() 204 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | . 675 | --------------------------------------------------------------------------------