From ef35681ac236bfce050fa9bbfb0c7710967911ad Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 17 Jan 2013 18:10:06 +0000 Subject: Adding NOTES.md file for keeping track of design questions and resolution ideas during development process, as well as ongoing progress for tickets and feature implementations. --- NOTES.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 NOTES.md diff --git a/NOTES.md b/NOTES.md new file mode 100644 index 0000000..996995c --- /dev/null +++ b/NOTES.md @@ -0,0 +1,6 @@ + +# Questions # +------------- + + 1. What is the lowest available RAM for a target server running a leap_mx? + 1.a. Do we want to store all id_keys and/or aliases in memory? -- cgit v1.2.3 From e28d5bf452b025357ae23f87ec34b8ae6897e1fd Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Wed, 23 Jan 2013 19:26:56 +0000 Subject: Updated NOTES, which contains ticket updates and tickets which need to be created, due to network availability being unreliable on airports and in planes. --- NOTES.md | 11 ++++++++++- leap/mx/alias_resolver.py | 13 +++++++++---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/NOTES.md b/NOTES.md index fd462b1..a53f49d 100644 --- a/NOTES.md +++ b/NOTES.md @@ -22,9 +22,12 @@ page](https://we.riseup.net/leap/mx) : 3. How do get it to go faster? Should we create some mockups and benchmark them? Could we attempt to learn which aliases are most often resolved and -prioritize keeping those in in-memory mappings? +prioritize keeping those in in-memory mappings? Is +[memcache](http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt) +a viable protocol for this, and how would it interact with CouchDB? 4. What lib should we use for Python + Twisted + GPG/PGP ? + 4.a. It looks like most people are using python-gnupg... ## Tickets ## @@ -48,3 +51,9 @@ ticket for feature-check_recipient: ticket for feature-virtual_alias_map: o Get the recipient's userid from couchdb. + +ticket for feature-evaluate_python_gnupg: + + o Briefly audit library in order to assess if it has the necessary + features, as well as its general code quality. + diff --git a/leap/mx/alias_resolver.py b/leap/mx/alias_resolver.py index 2263de5..1ffeb5a 100644 --- a/leap/mx/alias_resolver.py +++ b/leap/mx/alias_resolver.py @@ -7,17 +7,17 @@ Classes for resolving postfix aliases. @authors: Isis Agora Lovecruft @version: 0.0.1-beta -@license: WTFPL see included LICENSE file +@license: see included LICENSE file @copyright: copyright 2013 Isis Agora Lovecruft ''' import os from twisted.internet import address -from twisted.mail import maildir +from twisted.mail import maildir, alias from twisted.protocols import postfix -from leap.mx import net, log +from leap.mx import net, log ## xxx implement log def checkIPaddress(addr): @@ -39,6 +39,10 @@ def checkIPaddress(addr): else: return True +def query_couch(file_desc): + if not os.path.isfile (file_desc): + + class PostfixAliasResolver(postfix.PostfixTCPMapServer): """ Resolve postfix aliases, similarly to using "$ postmap -q ". @@ -89,7 +93,8 @@ class PostfixAliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactor super(postfix.PostfixTCPMapDeferringDictServerFactory, self).__init__(data=data) self.timeout = timeout - self.noisy = False ## xxx get config value + ## xxx get config value, should be something like verbose = no + self.noisy = False try: assert isinstance(port, int), "Port number must be an integer" -- cgit v1.2.3 From 2b4dfb24b70ae61cd83904cca756c05e3cb781e4 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Wed, 23 Jan 2013 19:29:08 +0000 Subject: Moved a check on IP addresses to utils/net.py. --- leap/util/net.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/leap/util/net.py b/leap/util/net.py index 10e72a4..a4104d0 100644 --- a/leap/util/net.py +++ b/leap/util/net.py @@ -38,6 +38,23 @@ class PermissionsError(SystemExit): """This test requires admin or root privileges to run. Exiting...""" +def checkIPaddress(addr): + """ + Check that a given string is a valid IPv4 or IPv6 address. + + @param addr: Any string defining an IP address, i.e. '1.2.3.4' or '::1'. + @returns: True if :param:`addr` defines a valid IPAddress, else False. + """ + import ipaddr + + try: + check = ipaddr.IPAddress(addr) + except ValueError, ve: + log.warn(ve.message) + return False + else: + return True + def getClientPlatform(platform_name=None): for name, test in PLATFORMS.items(): if not platform_name or platform_name.upper() == name: -- cgit v1.2.3 From da15176bfb75122ce22922a670fe23afd2895178 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 24 Jan 2013 00:22:01 +0000 Subject: Began implementing CouchDB connection classes with standard query utilities for the alias_resolver. --- leap/mx/alias_resolver.py | 89 ++++++++++++++++++++++++++++++++++++----------- 1 file changed, 69 insertions(+), 20 deletions(-) diff --git a/leap/mx/alias_resolver.py b/leap/mx/alias_resolver.py index 1ffeb5a..5010f63 100644 --- a/leap/mx/alias_resolver.py +++ b/leap/mx/alias_resolver.py @@ -13,35 +13,83 @@ Classes for resolving postfix aliases. import os -from twisted.internet import address -from twisted.mail import maildir, alias -from twisted.protocols import postfix +try: + from paisley import client +except ImportError: + print "This software requires paisley. Please see the README file" + print "for instructions on getting required dependencies." + +try: + from twisted.internet import address, defer, reactor + from twisted.mail import maildir, alias + from twisted.protocols import postfix +except ImportError: + print "This software requires paisley. Please see the README file" + print "for instructions on getting required dependencies." from leap.mx import net, log ## xxx implement log -def checkIPaddress(addr): +class ConnectedCouchDB(client.CouchDB): """ - Check that a given string is a valid IPv4 or IPv6 address. + Connect to a CouchDB instance. - @param addr: - Any string defining an IP address, i.e. '0.0.0.0', '::1', or '1.2.3.4'. - @returns: - True if :param:`addr` defines a valid IPAddress, False otherwise. + ## xxx will we need to open CouchDB documents and views? """ - import ipaddr + def __init__(self, host, port, dbName=None, + username=None, password=None, *args, **kwargs): + """ + Connect to a CouchDB instance. + + @param host: A hostname string for the CouchDB server. + @param port: The port of the CouchDB server, as an integer. + @param dbName: (optional) The default database to connect to. + @param username: (optional) The username for authorization. + @param password: (optional) The password for authorization. + @returns: A :class:`twisted.internet.defer.Deferred` representing the + the client connection to the CouchDB instance. + """ + super(client.CouchDB, self).__init__(host, port, + dbName=dbName, + username=username, + password=password, + *args, **kwargs) + + def query(self, uri): + """ + Query a CouchDB instance that we are connected to. + """ + try: + self.checkURI(uri) ## xxx write checkURI() + ## xxx we might be able to use self._parseURI() + except SchemeNotSupported, sns: ## xxx where in paisley is this? + log.exception(sns) ## xxx need log.exception() - try: - check = ipaddr.IPAddress(addr) - except ValueError, ve: - log.warn(ve.message) - return False - else: - return True + d = self.get(uri) + @d.addCallback + def parse_answer(answer): + return answer -def query_couch(file_desc): - if not os.path.isfile (file_desc): + return answer + @defer.inlineCallbacks + def listUsersAndEmails(self, limit=1000, reverse=False): + """ + List all users and email addresses, up to the given limit. + """ + query = "/users/_design/User/_view/by_email_or_alias/?reduce=false" + answer = yield self.query(query, limit=limit, reverse=reverse) + + if answer: + parsed = yield self.parseResult(answer) + if parsed: + log.msg("%s" % parsed) + else: + log.msg("No answer from database, perhaps there are no users.") + else: + log.msg("Problem querying CouchDB instance...") + log.debug("Host: %s" % host) + log.debug("Port: %d" % port) class PostfixAliasResolver(postfix.PostfixTCPMapServer): """ @@ -62,6 +110,7 @@ class PostfixAliasResolver(postfix.PostfixTCPMapServer): """ super(postfix.PostfixTCPMapServer, self).__init__(*args, **kwargs) + class PostfixAliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): """ A Factory for creating PostfixAliasResolver servers, which handles inputs @@ -102,7 +151,7 @@ class PostfixAliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactor except AssertionError, ae: raise SystemExit(ae.message) - if checkIPaddress(addr): + if net.checkIPaddress(addr): self.addr = address._IPAddress('TCP', addr, int(port)) else: log.debug("Using default address for Postfix: 127.0.0.1:%s" % port) -- cgit v1.2.3 From 0911ec5330e460f79daca557bb03114276def026 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 00:56:12 +0000 Subject: Clean up directory structure to be better aligned with other leap python project, add __init__.py to modules directories, and add query callback function to couchdb in alias_resolver.py for check_recipient feature. --- leap/__init__.py | 9 -- leap/mx/alias_resolver.py | 172 ----------------------------------- leap/util/net.py | 126 ------------------------- leap/util/version.py | 69 -------------- src/leap/__init__.py | 9 ++ src/leap/mx/__init__.py | 0 src/leap/mx/alias_resolver.py | 207 ++++++++++++++++++++++++++++++++++++++++++ src/leap/util/__init__.py | 0 src/leap/util/net.py | 126 +++++++++++++++++++++++++ src/leap/util/version.py | 69 ++++++++++++++ 10 files changed, 411 insertions(+), 376 deletions(-) delete mode 100644 leap/__init__.py delete mode 100644 leap/mx/alias_resolver.py delete mode 100644 leap/util/net.py delete mode 100644 leap/util/version.py create mode 100644 src/leap/__init__.py create mode 100644 src/leap/mx/__init__.py create mode 100644 src/leap/mx/alias_resolver.py create mode 100644 src/leap/util/__init__.py create mode 100644 src/leap/util/net.py create mode 100644 src/leap/util/version.py diff --git a/leap/__init__.py b/leap/__init__.py deleted file mode 100644 index 370676e..0000000 --- a/leap/__init__.py +++ /dev/null @@ -1,9 +0,0 @@ -# -*- encoding: utf-8 -*- - -from . import mx -from . import util -from . import tests - -__author__ = util.version.authors -__version__ = util.version.getVersion() -__all__ = ['mx', 'util', 'tests'] diff --git a/leap/mx/alias_resolver.py b/leap/mx/alias_resolver.py deleted file mode 100644 index 5010f63..0000000 --- a/leap/mx/alias_resolver.py +++ /dev/null @@ -1,172 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- -''' -alias_resolver.py -================= -Classes for resolving postfix aliases. - -@authors: Isis Agora Lovecruft -@version: 0.0.1-beta -@license: see included LICENSE file -@copyright: copyright 2013 Isis Agora Lovecruft -''' - -import os - -try: - from paisley import client -except ImportError: - print "This software requires paisley. Please see the README file" - print "for instructions on getting required dependencies." - -try: - from twisted.internet import address, defer, reactor - from twisted.mail import maildir, alias - from twisted.protocols import postfix -except ImportError: - print "This software requires paisley. Please see the README file" - print "for instructions on getting required dependencies." - -from leap.mx import net, log ## xxx implement log - - -class ConnectedCouchDB(client.CouchDB): - """ - Connect to a CouchDB instance. - - ## xxx will we need to open CouchDB documents and views? - """ - def __init__(self, host, port, dbName=None, - username=None, password=None, *args, **kwargs): - """ - Connect to a CouchDB instance. - - @param host: A hostname string for the CouchDB server. - @param port: The port of the CouchDB server, as an integer. - @param dbName: (optional) The default database to connect to. - @param username: (optional) The username for authorization. - @param password: (optional) The password for authorization. - @returns: A :class:`twisted.internet.defer.Deferred` representing the - the client connection to the CouchDB instance. - """ - super(client.CouchDB, self).__init__(host, port, - dbName=dbName, - username=username, - password=password, - *args, **kwargs) - - def query(self, uri): - """ - Query a CouchDB instance that we are connected to. - """ - try: - self.checkURI(uri) ## xxx write checkURI() - ## xxx we might be able to use self._parseURI() - except SchemeNotSupported, sns: ## xxx where in paisley is this? - log.exception(sns) ## xxx need log.exception() - - d = self.get(uri) - @d.addCallback - def parse_answer(answer): - return answer - - return answer - - @defer.inlineCallbacks - def listUsersAndEmails(self, limit=1000, reverse=False): - """ - List all users and email addresses, up to the given limit. - """ - query = "/users/_design/User/_view/by_email_or_alias/?reduce=false" - answer = yield self.query(query, limit=limit, reverse=reverse) - - if answer: - parsed = yield self.parseResult(answer) - if parsed: - log.msg("%s" % parsed) - else: - log.msg("No answer from database, perhaps there are no users.") - else: - log.msg("Problem querying CouchDB instance...") - log.debug("Host: %s" % host) - log.debug("Port: %d" % port) - -class PostfixAliasResolver(postfix.PostfixTCPMapServer): - """ - Resolve postfix aliases, similarly to using "$ postmap -q ". - - This class starts a simple LineReceiver server which listens for a string - specifying an alias to look up, :param:`key`, and which will be used to - query the local Postfix server. You can test it with: - - $ ./alias_resolver.py & - $ /usr/bin/postmap -q tcp:localhost:4242 - - """ - def __init__(self, *args, **kwargs): - """ - Create a local LineReceiver server which listens for Postfix aliases - to resolve. - """ - super(postfix.PostfixTCPMapServer, self).__init__(*args, **kwargs) - - -class PostfixAliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): - """ - A Factory for creating PostfixAliasResolver servers, which handles inputs - and outputs, and keeps an in-memory mapping of Postfix aliases in the form - of a dict. - - xxx fill me in - - """ - protocol = PostfixAliasResolver - - def __init__(self, addr='127.0.0.1', port=4242, timeout=120, data=None): - """ - Create a Factory which returns :class:`PostfixAliasResolver` servers. - - @param addr: - (optional) A string giving the IP address of the Postfix server. - Default: '127.0.0.1' - @param port: - (optional) An integer that specifies the port number of the - Postfix server. Default: 4242 - @param timeout: - (optional) An integer specifying the number of seconds to wait - until we should time out. Default: 120 - @param data: - (optional) A dict to use to initialise or update the alias - mapping. - """ - super(postfix.PostfixTCPMapDeferringDictServerFactory, - self).__init__(data=data) - self.timeout = timeout - ## xxx get config value, should be something like verbose = no - self.noisy = False - - try: - assert isinstance(port, int), "Port number must be an integer" - assert isinstance(timeout, int), "Timeout must be an integer" - except AssertionError, ae: - raise SystemExit(ae.message) - - if net.checkIPaddress(addr): - self.addr = address._IPAddress('TCP', addr, int(port)) - else: - log.debug("Using default address for Postfix: 127.0.0.1:%s" % port) - self.addr = address._IPAddress('TCP', '127.0.0.1', int(port)) - - def buildProtocol(self): - """ - Create an instance of the :class:`PostfixAliasResolver` server. - """ - proto = self.protocol() - proto.timeout = self.timeout - proto.factory = self - return proto - - -if __name__ == "__main__": - - print "To test alias_resolver.py, please use /test/test_alias_resolver.py" diff --git a/leap/util/net.py b/leap/util/net.py deleted file mode 100644 index a4104d0..0000000 --- a/leap/util/net.py +++ /dev/null @@ -1,126 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- -''' -net.py -------- -Utilities for networking. - -@authors: Isis Agora Lovecruft, 0x2cdb8b35 -@license: see included LICENSE file -@copyright: 2013 Isis Agora Lovecruft -''' - -import ipaddr -import sys -import socket - -from random import randint - -from leap.mx.utils import log - - -PLATFORMS = {'LINUX': sys.platform.startswith("linux"), - 'OPENBSD': sys.platform.startswith("openbsd"), - 'FREEBSD': sys.platform.startswith("freebsd"), - 'NETBSD': sys.platform.startswith("netbsd"), - 'DARWIN': sys.platform.startswith("darwin"), - 'SOLARIS': sys.platform.startswith("sunos"), - 'WINDOWS': sys.platform.startswith("win32")} - - -class UnsupportedPlatform(Exception): - """Support for this platform is not currently available.""" - -class IfaceError(Exception): - """Could not find default network interface.""" - -class PermissionsError(SystemExit): - """This test requires admin or root privileges to run. Exiting...""" - - -def checkIPaddress(addr): - """ - Check that a given string is a valid IPv4 or IPv6 address. - - @param addr: Any string defining an IP address, i.e. '1.2.3.4' or '::1'. - @returns: True if :param:`addr` defines a valid IPAddress, else False. - """ - import ipaddr - - try: - check = ipaddr.IPAddress(addr) - except ValueError, ve: - log.warn(ve.message) - return False - else: - return True - -def getClientPlatform(platform_name=None): - for name, test in PLATFORMS.items(): - if not platform_name or platform_name.upper() == name: - if test: - return name, test - -def getPosixIfaces(): - from twisted.internet.test import _posixifaces - log.msg("Attempting to discover network interfaces...") - ifaces = _posixifaces._interfaces() - return ifaces - -def getWindowsIfaces(): - from twisted.internet.test import _win32ifaces - log.msg("Attempting to discover network interfaces...") - ifaces = _win32ifaces._interfaces() - return ifaces - -def getIfaces(platform_name=None): - client, test = getClientPlatform(platform_name) - if client: - if client == ('LINUX' or 'DARWIN') or client[-3:] == 'BSD': - return getPosixIfaces() - elif client == 'WINDOWS': - return getWindowsIfaces() - ## XXX fixme figure out how to get iface for Solaris - else: - raise UnsupportedPlatform - else: - raise UnsupportedPlatform - -def getRandomUnusedPort(addr=None): - free = False - while not free: - port = randint(1024, 65535) - s = socket.socket() - try: - s.bind((addr, port)) - free = True - except: - pass - s.close() - return port - -def getNonLoopbackIfaces(platform_name=None): - try: - ifaces = getIfaces(platform_name) - except UnsupportedPlatform, up: - log.err(up) - - if not ifaces: - log.msg("Unable to discover network interfaces...") - return None - else: - found = [{i[0]: i[2]} for i in ifaces if i[0] != 'lo'] - log.debug("Found non-loopback interfaces: %s" % found) - for iface in ifaces: - try: - interface = checkInterfaces(found) - except IfaceError, ie: - log.err(ie) - return None - else: - return interfaces - - -def getLocalAddress(): - default_iface = getDefaultIface() - return default_iface.ipaddr diff --git a/leap/util/version.py b/leap/util/version.py deleted file mode 100644 index ecf8a22..0000000 --- a/leap/util/version.py +++ /dev/null @@ -1,69 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- -''' -version.py ----------- -Version information for leap_mx. - -@authors: Isis Agora Lovecruft, 0x2cdb8b35 -@licence: see included LICENSE file -@copyright: 2013 Isis Agora Lovecruft -''' - -import os - -from twisted.python import versions - -name = 'leap_mx' -version = versions.Version(name, 0, 0, 1, None) -authors = [('Isis Agora Lovecruft', '', '0x2cdb8b35'),] -git_url = 'https://github.com/isislovecruft/leap_mx/' -website = 'https://leap.se' - -def getVersion(): - version.authors = authors - version.git_url = git_url - version.website = website - return version - -def getRepoDir(): - here = os.getcwd() - base = here.rsplit(name, 1)[0] - repo = os.path.join(base, name) - return repo - -def __make_text__(extra_text=None): - splitter = "-" * len(version.__str__()) - header = ["\n%s\n" % version.__str__(), "%s\n" % splitter] - footer = ["Website: \t%s\n" % website, "Github: \t%s\n" % git_url, "\n"] - contacts = ["\t%s, %s %s\n" % (a[0], a[1], a[2]) for a in authors] - contacts.insert(0, "Authors: ") - - with_contacts = header + contacts - - if extra_text is not None: - if isinstance(extra_text, iter): - with_contacts.extend((e for e in extra_text)) - elif isinstance(extra_text, str): - with_contacts.append(extra_text) - else: - print "Couldn't add extra text..." - - text = with_contacts + footer - return text - -def __update_version__(): - repo = getRepoDir() - version_file = os.path.join(repo, 'VERSION') - version_text = __make_text__() - - with open(version_file, 'w+') as fh: - fh.writelines((line for line in version_text)) - fh.flush() - fh.truncate() - - -if __name__ == "__main__": - print "Generating new VERSION file..." - __update_version__() - print "Done." diff --git a/src/leap/__init__.py b/src/leap/__init__.py new file mode 100644 index 0000000..5fefbbf --- /dev/null +++ b/src/leap/__init__.py @@ -0,0 +1,9 @@ +# -*- encoding: utf-8 -*- + +from leap import mx +from leap import util +from leap import tests + +__all__ = ['mx', 'util', 'tests'] +__author__ = util.version.authors +__version__ = util.version.getVersion() diff --git a/src/leap/mx/__init__.py b/src/leap/mx/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py new file mode 100644 index 0000000..3d20ff7 --- /dev/null +++ b/src/leap/mx/alias_resolver.py @@ -0,0 +1,207 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +alias_resolver.py +================= +Classes for resolving postfix aliases. + +@authors: Isis Agora Lovecruft +@version: 0.0.1-beta +@license: see included LICENSE file +@copyright: copyright 2013 Isis Agora Lovecruft +''' + +import os + +try: + from paisley import client +except ImportError: + print "This software requires paisley. Please see the README file" + print "for instructions on getting required dependencies." + +try: + from twisted.internet import address, defer, reactor + from twisted.mail import maildir, alias + from twisted.protocols import postfix +except ImportError: + print "This software requires paisley. Please see the README file" + print "for instructions on getting required dependencies." + +from leap.mx import net, log ## xxx implement log + + +class ConnectedCouchDB(client.CouchDB): + """ + Connect to a CouchDB instance. + + ## xxx will we need to open CouchDB documents and views? + ## yes, these are in a _design document + ## + + """ + def __init__(self, host, port, dbName=None, + username=None, password=None, *args, **kwargs): + """ + Connect to a CouchDB instance. + + @param host: A hostname string for the CouchDB server. + @param port: The port of the CouchDB server, as an integer. + @param dbName: (optional) The default database to connect to. + @param username: (optional) The username for authorization. + @param password: (optional) The password for authorization. + @returns: A :class:`twisted.internet.defer.Deferred` representing the + the client connection to the CouchDB instance. + """ + super(client.CouchDB, self).__init__(host, port, + dbName=dbName, + username=username, + password=password, + *args, **kwargs) + if dbName: + self.bindToDB(dbName) + else: + databases = self.listDB() + log.msg("Available databases: %s" % databases) + + def queryByEmailOrAlias(self, alias, dbDoc="User", + view="by_email_or_alias"): + """ + Check to see if a particular email or alias exists. + + @param alias: A string representing the email or alias to check. + @param dbDoc: The CouchDB document to open. + @param view: The view of the CouchDB document to use. + """ + assert isinstance(alias, str), "Email or alias queries must be string" + + ## Prepend a forward slash, in case we forgot it: + if not alias.startswith('/'): + alias = '/' + alias + + d = self.openDoc(dbDoc) + d.addCallbacks(self.openView, log.err, (view)) + d.addCallbacks(self.get, log.err, (alias)) + d.addCallbacks(self.parseResult, log.err) + + @d.addCallback + def show_answer(result): + log.msg("Query: %s" % alias) + log.msg("Answer: %s" % alias) + + return d + + def query(self, uri): + """ + Query a CouchDB instance that we are connected to. + """ + try: + self.checkURI(uri) ## xxx write checkURI() + ## xxx we might be able to use self._parseURI() + except SchemeNotSupported, sns: ## xxx where in paisley is this? + log.exception(sns) ## xxx need log.exception() + + d = self.get(uri) + @d.addCallback + def parse_answer(answer): + return answer + + return answer + + @defer.inlineCallbacks + def listUsersAndEmails(self, limit=1000, reverse=False): + """ + List all users and email addresses, up to the given limit. + """ + query = "/users/_design/User/_view/by_email_or_alias/?reduce=false" + answer = yield self.query(query, limit=limit, reverse=reverse) + + if answer: + parsed = yield self.parseResult(answer) + if parsed: + log.msg("%s" % parsed) + else: + log.msg("No answer from database, perhaps there are no users.") + else: + log.msg("Problem querying CouchDB instance...") + log.debug("Host: %s" % host) + log.debug("Port: %d" % port) + +class PostfixAliasResolver(postfix.PostfixTCPMapServer): + """ + Resolve postfix aliases, similarly to using "$ postmap -q ". + + This class starts a simple LineReceiver server which listens for a string + specifying an alias to look up, :param:`key`, and which will be used to + query the local Postfix server. You can test it with: + + $ ./alias_resolver.py & + $ /usr/bin/postmap -q tcp:localhost:4242 + + """ + def __init__(self, *args, **kwargs): + """ + Create a local LineReceiver server which listens for Postfix aliases + to resolve. + """ + super(postfix.PostfixTCPMapServer, self).__init__(*args, **kwargs) + + +class PostfixAliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): + """ + A Factory for creating PostfixAliasResolver servers, which handles inputs + and outputs, and keeps an in-memory mapping of Postfix aliases in the form + of a dict. + + xxx fill me in + + """ + protocol = PostfixAliasResolver + + def __init__(self, addr='127.0.0.1', port=4242, timeout=120, data=None): + """ + Create a Factory which returns :class:`PostfixAliasResolver` servers. + + @param addr: + (optional) A string giving the IP address of the Postfix server. + Default: '127.0.0.1' + @param port: + (optional) An integer that specifies the port number of the + Postfix server. Default: 4242 + @param timeout: + (optional) An integer specifying the number of seconds to wait + until we should time out. Default: 120 + @param data: + (optional) A dict to use to initialise or update the alias + mapping. + """ + super(postfix.PostfixTCPMapDeferringDictServerFactory, + self).__init__(data=data) + self.timeout = timeout + ## xxx get config value, should be something like verbose = no + self.noisy = False + + try: + assert isinstance(port, int), "Port number must be an integer" + assert isinstance(timeout, int), "Timeout must be an integer" + except AssertionError, ae: + raise SystemExit(ae.message) + + if net.checkIPaddress(addr): + self.addr = address._IPAddress('TCP', addr, int(port)) + else: + log.debug("Using default address for Postfix: 127.0.0.1:%s" % port) + self.addr = address._IPAddress('TCP', '127.0.0.1', int(port)) + + def buildProtocol(self): + """ + Create an instance of the :class:`PostfixAliasResolver` server. + """ + proto = self.protocol() + proto.timeout = self.timeout + proto.factory = self + return proto + + +if __name__ == "__main__": + + print "To test alias_resolver.py, please use /test/test_alias_resolver.py" diff --git a/src/leap/util/__init__.py b/src/leap/util/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/leap/util/net.py b/src/leap/util/net.py new file mode 100644 index 0000000..a4104d0 --- /dev/null +++ b/src/leap/util/net.py @@ -0,0 +1,126 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +net.py +------- +Utilities for networking. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@license: see included LICENSE file +@copyright: 2013 Isis Agora Lovecruft +''' + +import ipaddr +import sys +import socket + +from random import randint + +from leap.mx.utils import log + + +PLATFORMS = {'LINUX': sys.platform.startswith("linux"), + 'OPENBSD': sys.platform.startswith("openbsd"), + 'FREEBSD': sys.platform.startswith("freebsd"), + 'NETBSD': sys.platform.startswith("netbsd"), + 'DARWIN': sys.platform.startswith("darwin"), + 'SOLARIS': sys.platform.startswith("sunos"), + 'WINDOWS': sys.platform.startswith("win32")} + + +class UnsupportedPlatform(Exception): + """Support for this platform is not currently available.""" + +class IfaceError(Exception): + """Could not find default network interface.""" + +class PermissionsError(SystemExit): + """This test requires admin or root privileges to run. Exiting...""" + + +def checkIPaddress(addr): + """ + Check that a given string is a valid IPv4 or IPv6 address. + + @param addr: Any string defining an IP address, i.e. '1.2.3.4' or '::1'. + @returns: True if :param:`addr` defines a valid IPAddress, else False. + """ + import ipaddr + + try: + check = ipaddr.IPAddress(addr) + except ValueError, ve: + log.warn(ve.message) + return False + else: + return True + +def getClientPlatform(platform_name=None): + for name, test in PLATFORMS.items(): + if not platform_name or platform_name.upper() == name: + if test: + return name, test + +def getPosixIfaces(): + from twisted.internet.test import _posixifaces + log.msg("Attempting to discover network interfaces...") + ifaces = _posixifaces._interfaces() + return ifaces + +def getWindowsIfaces(): + from twisted.internet.test import _win32ifaces + log.msg("Attempting to discover network interfaces...") + ifaces = _win32ifaces._interfaces() + return ifaces + +def getIfaces(platform_name=None): + client, test = getClientPlatform(platform_name) + if client: + if client == ('LINUX' or 'DARWIN') or client[-3:] == 'BSD': + return getPosixIfaces() + elif client == 'WINDOWS': + return getWindowsIfaces() + ## XXX fixme figure out how to get iface for Solaris + else: + raise UnsupportedPlatform + else: + raise UnsupportedPlatform + +def getRandomUnusedPort(addr=None): + free = False + while not free: + port = randint(1024, 65535) + s = socket.socket() + try: + s.bind((addr, port)) + free = True + except: + pass + s.close() + return port + +def getNonLoopbackIfaces(platform_name=None): + try: + ifaces = getIfaces(platform_name) + except UnsupportedPlatform, up: + log.err(up) + + if not ifaces: + log.msg("Unable to discover network interfaces...") + return None + else: + found = [{i[0]: i[2]} for i in ifaces if i[0] != 'lo'] + log.debug("Found non-loopback interfaces: %s" % found) + for iface in ifaces: + try: + interface = checkInterfaces(found) + except IfaceError, ie: + log.err(ie) + return None + else: + return interfaces + + +def getLocalAddress(): + default_iface = getDefaultIface() + return default_iface.ipaddr diff --git a/src/leap/util/version.py b/src/leap/util/version.py new file mode 100644 index 0000000..ecf8a22 --- /dev/null +++ b/src/leap/util/version.py @@ -0,0 +1,69 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +version.py +---------- +Version information for leap_mx. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@licence: see included LICENSE file +@copyright: 2013 Isis Agora Lovecruft +''' + +import os + +from twisted.python import versions + +name = 'leap_mx' +version = versions.Version(name, 0, 0, 1, None) +authors = [('Isis Agora Lovecruft', '', '0x2cdb8b35'),] +git_url = 'https://github.com/isislovecruft/leap_mx/' +website = 'https://leap.se' + +def getVersion(): + version.authors = authors + version.git_url = git_url + version.website = website + return version + +def getRepoDir(): + here = os.getcwd() + base = here.rsplit(name, 1)[0] + repo = os.path.join(base, name) + return repo + +def __make_text__(extra_text=None): + splitter = "-" * len(version.__str__()) + header = ["\n%s\n" % version.__str__(), "%s\n" % splitter] + footer = ["Website: \t%s\n" % website, "Github: \t%s\n" % git_url, "\n"] + contacts = ["\t%s, %s %s\n" % (a[0], a[1], a[2]) for a in authors] + contacts.insert(0, "Authors: ") + + with_contacts = header + contacts + + if extra_text is not None: + if isinstance(extra_text, iter): + with_contacts.extend((e for e in extra_text)) + elif isinstance(extra_text, str): + with_contacts.append(extra_text) + else: + print "Couldn't add extra text..." + + text = with_contacts + footer + return text + +def __update_version__(): + repo = getRepoDir() + version_file = os.path.join(repo, 'VERSION') + version_text = __make_text__() + + with open(version_file, 'w+') as fh: + fh.writelines((line for line in version_text)) + fh.flush() + fh.truncate() + + +if __name__ == "__main__": + print "Generating new VERSION file..." + __update_version__() + print "Done." -- cgit v1.2.3 From 52d8c96998b348c9baa1ca8b22f0ad191efbcffc Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 00:59:45 +0000 Subject: Update .gitignore to exclude temp files. --- .gitignore | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.gitignore b/.gitignore index 283f175..2f7e605 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,7 @@ nosetests.xml # Don't upload private things *.private + +# Ignore emacs temporary files +*~ +\#*\# -- cgit v1.2.3 From a849cdf75955e110b5ed9ceabfcbcdbd219cbcc6 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 01:29:41 +0000 Subject: Add the logger. --- src/leap/util/log.py | 113 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 src/leap/util/log.py diff --git a/src/leap/util/log.py b/src/leap/util/log.py new file mode 100644 index 0000000..661b0a1 --- /dev/null +++ b/src/leap/util/log.py @@ -0,0 +1,113 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +log.py +------ +Logging for leap_mx. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@licence: see included LICENSE file +@copyright: 2013 Isis Agora Lovecruft +''' + +from functools import wraps + +import logging +import os +import sys +import traceback + +from twisted.python import log as txlog +from twisted.python import util as txutil +from twisted.python.logfile import DailyLogFile +from twisted.python.failure import Failure + +from leap.util import version, config + + +class UnprefixedLogfile(txlog.FileLogObserver): + def emit(self, eventDict): + text = txlog.textFromEventDict(eventDict) + if text is None: + return + + txutil.untilConcludes(self.write, "%s\n" % text) + txutil.untilConcludes(self.flush) + + +def start(logfile=None, application_name=None): + if not application_name: + application_name = version.name + print "application name: %s" % application_name + + daily_logfile = None + + if not logfile: + logfile = config.basic.logfile + + repo_dir = version.getRepoDir() + logfile_dir = os.path.join(repo_dir, 'log') + logfile_name = logfile + + daily_logfile = DailyLogFile(logfile_name, logfile_dir) + + txlog.startLoggingWithObserver(UnprefixedLogfile(sys.stdout).emit) + txlog.addObserver(txlog.FileLogObserver(daily_logfile).emit) + txlog.msg("Starting %s on %s (%s UTC)" % (application_name, + prettyDateNow(), + utcPrettyDateNow())) + ## xxx need these functions! ^^ + +def msg(msg, *arg, **kwarg): + print "[*] %s" % msg + +def debug(msg *arg, **kwarg): + if config.basic.debug: + print "[d] %s" % msg + +def warn(msg, *arg, **kwarg): + if config.basic.show_warnings: + txlog.logging.captureWarnings('true') + print "[#] %s" % msg + +def err(msg, *arg, **kwarg): + print "[!] %s" % msg + +def fail(*failure): + logging.critical(failure) + ## xxx should we take steps to exit here? + +def exception(error): + """ + Catch an exception and print only the error message, then continue normal + program execution. + + @param error: Can be error messages printed to stdout and to the + logfile, or can be a twisted.python.failure.Failure instance. + """ + if isinstance(error, Failure): + error.printTraceback() + else: + exc_type, exc_value, exc_traceback = sys.exc_info() + traceback.print_exception(exc_type, exc_value, exc_traceback) + +def catch(func): + """ + Quick wrapper to add around test methods for debugging purposes, + catches the given Exception. Use like so: + + >>> @log.catch + def foo(bar): + if bar == 'baz': + raise Exception("catch me no matter what I am") + >>> foo("baz") + [!] catch me no matter what I am + + """ + @wraps(func) + def _catch(*args, **kwargs): + try: + func(*args, **kwargs) + except Exception, exc: + exception(exc) + return _catch -- cgit v1.2.3 From 383e614b3fc53ca2d59104988d8ec1a3a9cba14d Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 01:50:19 +0000 Subject: Added timestamp formatting functions to logger. --- src/leap/util/log.py | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/src/leap/util/log.py b/src/leap/util/log.py index 661b0a1..62ac113 100644 --- a/src/leap/util/log.py +++ b/src/leap/util/log.py @@ -10,11 +10,13 @@ Logging for leap_mx. @copyright: 2013 Isis Agora Lovecruft ''' +from datetime import datetime from functools import wraps import logging import os import sys +import time import traceback from twisted.python import log as txlog @@ -24,8 +26,13 @@ from twisted.python.failure import Failure from leap.util import version, config +## xxx TODO finish docstrings + +class InvalidTimestampFormat(Exception): + pass class UnprefixedLogfile(txlog.FileLogObserver): + """Logfile with plain messages, without timestamp prefixes.""" def emit(self, eventDict): text = txlog.textFromEventDict(eventDict) if text is None: @@ -35,6 +42,29 @@ class UnprefixedLogfile(txlog.FileLogObserver): txutil.untilConcludes(self.flush) +def utcDateNow(): + """The current date for UTC time.""" + return datetime.utcnow() + +def utcTimeNow(): + """Seconds since epoch in UTC time, as type float.""" + return time.mktime(time.gmtime()) + +def dateToTime(date): + """Convert datetime to seconds since epoch.""" + return time.mktime(date.timetuple()) + +def prettyDateNow(): + """Pretty string for the local time.""" + return datetime.now().ctime() + +def utcPrettyDateNow(): + """Pretty string for utc time.""" + return datetime.utcnow().ctime() + +def timeToPrettyDate(time_val): + return time.ctime(time_val) + def start(logfile=None, application_name=None): if not application_name: application_name = version.name -- cgit v1.2.3 From fe1bd860aacc72028afbcdb90a6d800b72651518 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 11:13:12 +0000 Subject: Cleaned up logging functions and added docstrings. --- src/leap/util/log.py | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/src/leap/util/log.py b/src/leap/util/log.py index 62ac113..15db367 100644 --- a/src/leap/util/log.py +++ b/src/leap/util/log.py @@ -26,7 +26,6 @@ from twisted.python.failure import Failure from leap.util import version, config -## xxx TODO finish docstrings class InvalidTimestampFormat(Exception): pass @@ -59,13 +58,21 @@ def prettyDateNow(): return datetime.now().ctime() def utcPrettyDateNow(): - """Pretty string for utc time.""" + """Pretty string for UTC.""" return datetime.utcnow().ctime() def timeToPrettyDate(time_val): + """Convert seconds since epoch to date.""" return time.ctime(time_val) def start(logfile=None, application_name=None): + """ + Start logging to stdout, and optionally to a logfile as well. + + @param logfile: The filename to store logs in, which is placed in + /leap_mx/logs/. + @param application_name: The name of the running application. + """ if not application_name: application_name = version.name print "application name: %s" % application_name @@ -86,24 +93,28 @@ def start(logfile=None, application_name=None): txlog.msg("Starting %s on %s (%s UTC)" % (application_name, prettyDateNow(), utcPrettyDateNow())) - ## xxx need these functions! ^^ def msg(msg, *arg, **kwarg): + """Log a message at the INFO level.""" print "[*] %s" % msg def debug(msg *arg, **kwarg): + """Log a message at the DEBUG level.""" if config.basic.debug: print "[d] %s" % msg def warn(msg, *arg, **kwarg): + """Log a message at the WARN level.""" if config.basic.show_warnings: txlog.logging.captureWarnings('true') print "[#] %s" % msg def err(msg, *arg, **kwarg): + """Log a message at the ERROR level.""" print "[!] %s" % msg def fail(*failure): + """Log a message at the CRITICAL level.""" logging.critical(failure) ## xxx should we take steps to exit here? -- cgit v1.2.3 From 463bd7ea638aed1e5dc64131b3c324e83b0af18d Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 14:35:52 +0000 Subject: Move pip requirements.txt file to be in /pkg, in order to be similar to leap_client dir structure. Renamed VERSION to VERSION.md so that github will recognise it. --- VERSION | 7 ------- VERSION.md | 7 +++++++ pkg/mx-requirement.pip | 2 ++ requirements.txt | 2 -- 4 files changed, 9 insertions(+), 9 deletions(-) delete mode 100644 VERSION create mode 100644 VERSION.md create mode 100644 pkg/mx-requirement.pip delete mode 100644 requirements.txt diff --git a/VERSION b/VERSION deleted file mode 100644 index b756111..0000000 --- a/VERSION +++ /dev/null @@ -1,7 +0,0 @@ - -[leap_mx, version 0.0.1] ------------------------- -Authors: Isis Agora Lovecruft, 0x2cdb8b35 -Website: https://leap.se -Github: https://github.com/isislovecruft/leap_mx/ - diff --git a/VERSION.md b/VERSION.md new file mode 100644 index 0000000..b756111 --- /dev/null +++ b/VERSION.md @@ -0,0 +1,7 @@ + +[leap_mx, version 0.0.1] +------------------------ +Authors: Isis Agora Lovecruft, 0x2cdb8b35 +Website: https://leap.se +Github: https://github.com/isislovecruft/leap_mx/ + diff --git a/pkg/mx-requirement.pip b/pkg/mx-requirement.pip new file mode 100644 index 0000000..33b9b54 --- /dev/null +++ b/pkg/mx-requirement.pip @@ -0,0 +1,2 @@ +Twisted==12.2.0 +paisley>=0.3.1 diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 33b9b54..0000000 --- a/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -Twisted==12.2.0 -paisley>=0.3.1 -- cgit v1.2.3 From 687eca3f8e6b6f04d89c606726d65b0861c55e57 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 15:59:43 +0000 Subject: Updated leap module structure in /src/leap/__init__.py. --- src/leap/__init__.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/leap/__init__.py b/src/leap/__init__.py index 5fefbbf..cf897e4 100644 --- a/src/leap/__init__.py +++ b/src/leap/__init__.py @@ -1,9 +1,8 @@ # -*- encoding: utf-8 -*- -from leap import mx -from leap import util -from leap import tests +import mx +import util -__all__ = ['mx', 'util', 'tests'] +__all__ = ['mx', 'util'] __author__ = util.version.authors __version__ = util.version.getVersion() -- cgit v1.2.3 From 5274edd31752e1e388add70d68128373e30a5cc2 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 25 Jan 2013 16:06:28 +0000 Subject: Updated __init__.py files for new structure. --- src/leap/mx/__init__.py | 1 + src/leap/util/__init__.py | 1 + 2 files changed, 2 insertions(+) diff --git a/src/leap/mx/__init__.py b/src/leap/mx/__init__.py index e69de29..10d8ee7 100644 --- a/src/leap/mx/__init__.py +++ b/src/leap/mx/__init__.py @@ -0,0 +1 @@ +__all__ = ['alias_resolver', 'runner', 'tests'] diff --git a/src/leap/util/__init__.py b/src/leap/util/__init__.py index e69de29..d54801b 100644 --- a/src/leap/util/__init__.py +++ b/src/leap/util/__init__.py @@ -0,0 +1 @@ +__all__ = ['net', 'log', 'version'] -- cgit v1.2.3 From e1e9b3b9982f56cee322a05d97529d55d75cb629 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Mon, 28 Jan 2013 18:00:16 +0000 Subject: Moved mx-requirements.pip to /pkg/ dir. --- pkg/mx-requirement.pip | 2 -- pkg/mx-requirements.pip | 2 ++ 2 files changed, 2 insertions(+), 2 deletions(-) delete mode 100644 pkg/mx-requirement.pip create mode 100644 pkg/mx-requirements.pip diff --git a/pkg/mx-requirement.pip b/pkg/mx-requirement.pip deleted file mode 100644 index 33b9b54..0000000 --- a/pkg/mx-requirement.pip +++ /dev/null @@ -1,2 +0,0 @@ -Twisted==12.2.0 -paisley>=0.3.1 diff --git a/pkg/mx-requirements.pip b/pkg/mx-requirements.pip new file mode 100644 index 0000000..33b9b54 --- /dev/null +++ b/pkg/mx-requirements.pip @@ -0,0 +1,2 @@ +Twisted==12.2.0 +paisley>=0.3.1 -- cgit v1.2.3 From 2d0170b51a064788eb68af75d5f0d4efb40e386f Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Mon, 28 Jan 2013 18:01:00 +0000 Subject: Fixed module structure, again, due to directory layout change. --- src/leap/__init__.py | 12 ++++++++---- src/leap/util/__init__.py | 1 - 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/src/leap/__init__.py b/src/leap/__init__.py index cf897e4..99a951f 100644 --- a/src/leap/__init__.py +++ b/src/leap/__init__.py @@ -1,8 +1,12 @@ # -*- encoding: utf-8 -*- -import mx -import util +from leap import mx +from leap import util +from leap.util import version as mxversion __all__ = ['mx', 'util'] -__author__ = util.version.authors -__version__ = util.version.getVersion() +__author__ = mxversion.authors +__version__ = mxversion.getVersion() + +print "Authors: %s" % __author__ +print "Version: %s" % __version__ diff --git a/src/leap/util/__init__.py b/src/leap/util/__init__.py index d54801b..e69de29 100644 --- a/src/leap/util/__init__.py +++ b/src/leap/util/__init__.py @@ -1 +0,0 @@ -__all__ = ['net', 'log', 'version'] -- cgit v1.2.3 From df0d6098761df65f1f67ad247fdf259c262aeb0a Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Mon, 28 Jan 2013 18:02:24 +0000 Subject: Fixed a missing comma in the logger in util/log.py. --- src/leap/util/log.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/leap/util/log.py b/src/leap/util/log.py index 15db367..ef54605 100644 --- a/src/leap/util/log.py +++ b/src/leap/util/log.py @@ -98,7 +98,7 @@ def msg(msg, *arg, **kwarg): """Log a message at the INFO level.""" print "[*] %s" % msg -def debug(msg *arg, **kwarg): +def debug(msg, *arg, **kwarg): """Log a message at the DEBUG level.""" if config.basic.debug: print "[d] %s" % msg -- cgit v1.2.3 From e9133ed025208f57e33bddf7b1873d8f9ddf980b Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Mon, 28 Jan 2013 18:03:47 +0000 Subject: Added main file for starting the remailer, still need to finish check_recipient, added logging functionality, and config is halfway done, but it will need to use JSON rather than Yaml. --- src/leap/mx.py | 154 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 154 insertions(+) create mode 100755 src/leap/mx.py diff --git a/src/leap/mx.py b/src/leap/mx.py new file mode 100755 index 0000000..60968bc --- /dev/null +++ b/src/leap/mx.py @@ -0,0 +1,154 @@ +#!/usr/bin/env python +#-*- coding: utf-8 -*- +""" + ____ + | mx | + |____|_______________________ + | | + | An encrypting remailer. | + |_________________________| + +@author Isis Agora Lovecruft , 0x2cdb8b35 +@version 0.0.1 + +""" + +import os, sys + + +application_name = "leap_mx" + +def __get_repo_dir__(): + """Get the absolute path of the top-level repository directory.""" + here = os.getcwd() + base = here.rsplit(application_name, 1)[0] + repo = os.path.join(base, application_name) + return repo + +## Set the $PYTHONPATH: +src_dir = os.path.join(__get_repo_dir__(), 'src/') +sys.path[:] = map(os.path.abspath, sys.path) +sys.path.insert(0, src_dir) + +## Now we should be able to import ourselves without installation: +try: + from mx import runner + from util import log, version +except ImportError, ie: + print "%s\nExiting..." % ie.message + sys.exit(1) + + +class CheckRequirements(ImportError): + """ + Raised when we're missing something from requirements.pip. + """ + def __init__(self, message=None, missing=None, pipfile=None): + """ + Display an error message with instructions for obtaining missing + dependencies. + + @param message: A string describing the error. + @param missing: A string indicating which dependency is missing. + @param pipfile: The path and filename of the pip requirements file, + relative to the top-level repository directory. + """ + if message: + self.message = message + return self + + self.pipfile = pipfile + + if isinstance(missing, str): + missing = [missing] + else: + missing = [] + dependencies = self.__read_pip_requirements__() + for package, version in dependencies: + pkg = package.lower() if package == "Twisted" else package + try: + __import__(pkg) + except ImportError: + missing.append(package) + + self.message = application_name + " requires " + if len(missing) > 1: + for missed in missing[:-1]: + self.message += missed + ", " + self.message += "and " + if len(missing) == 1: + self.message += missing[0] + "." + self.message += "\nPlease see %s for ".format(pipfile) + self.message += "instruction on installing dependencies." + raise self + elif len(missing) <= 0: + return + + def __read_pip_requirements__(self, file=None): + """ + Check the pip requirements file to determine our dependencies. + + @param file: The name of the pip requirements.txt file. + @returns: A list of tuple(package_name, package_version). + """ + import re + + if not file: + file = self.pipfile + + filepath = os.path.join(__get_repo_dir__(), file) + requirement = re.compile('[^0-9=><]+') + dependencies = [] + + print filepath + assert os.path.isfile(filepath), \ + "Couldn't find requirements.pip file!" + + with open(filepath) as pipfile: + for line in pipfile.readlines(): + shortened = line.strip() + matched = requirement.match(shortened) + package_name = matched.group() + package_version = shortened.split(package_name, 1)[1] + dependencies.append((package_name, package_version)) + + return dependencies + +dependency_check = CheckRequirements(pipfile='pkg/mx-requirements.pip') + +try: + from twisted.python import usage, runtime + from twisted.internet import reactor +except: + print "the CheckRequirements class is broken!" + + +if __name__ == "__main__": + + log.start() + log.debug("Running %s, with Python %s" % (application_name, + runtime.shortPythonVersion())) + log.debug("Platform: %s" % runtime.platform.getType()) + log.debug("Thread support: %s" % str(runtime.platform.supportsThreads())) + + mx_options = MXOptions() + mx_options.parseOptions(sys.argv) + + if len(sys.argv) <= 0: + print mx_options.getUsage() + sys.exit(0) + else: + options = mx_options + + if options['verbose']: + config.basic.debug = True + + if options['test']: + from leap.mx import tests ## xxx this needs an __init__.py + tests.run() ## xxx need /leap/mx/tests.py + elif options['conf'] and os.path.isfile(options['conf']): + config.parse() ## xxx need /leap/mx/config.py + runner.run() ## xxx need /leap/mx/runner.py + else: + mx_options.getUsage() + sys.exit(1) -- cgit v1.2.3 From 1bed2439923405998725abbfc4527433822bcf0e Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Mon, 28 Jan 2013 18:18:22 +0000 Subject: Need to switch the config to JSON following leap_client. --- src/leap/util/config.py | 69 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 src/leap/util/config.py diff --git a/src/leap/util/config.py b/src/leap/util/config.py new file mode 100644 index 0000000..ab91a60 --- /dev/null +++ b/src/leap/util/config.py @@ -0,0 +1,69 @@ +#! -*- encoding: utf-8 -*- +""" +xxx fill me in +""" +import os +import yaml + +from leap.util import log, version + +config_filename = 'mx.conf' + +class MissingConfig(Exception): + """Raised when the config file cannot be found.""" + def __init__(self, message=None, config_file=None): + if message: + return + else: + self.message = "Cannot locate config file" + if config_file: + self.message += " %s" % config_file + self.message += "." + +def getConfigFilename(dir=None, file=None): + """ + xxx fill me in + """ + if not dir: + dir = version.getRepoDir() + if not file: + file = config_filename + return os.path.join(dir, file) + +def createConfigFile(config_file=None): + """ + xxx fill me in + """ + if not config_file: + config_file = getConfigFilename() + + if not os.path.isfile(config_file): + with open(config_file, 'w+') as conf: + conf.write(""" +# +# mx.conf +# ======= +# Configurable options for the leap_mx encrypting mail exchange. +# +""") + conf.flush() + else: + log.debug("Config file %s already present." % config_file) + +def loadConfigFile(config_file=None): + """ + xxx fill me in + """ + if not config_file: + config_file = getConfigFilename() + + if os.path.isfile(config_file): + with open(config_file, 'a+') as conf: + config_contents = '\n'.join(conf.readlines()) + configuration = yaml.safe_load(config_contents) + else: + createConfigFile(config_file) + + ## xxx finish load config + ## ask kali if we're using yaml or json or what? + ## xxx kali says json, so ixnay on the amlya bits -- cgit v1.2.3 From 9a338dfb7ada40bb13c1e3105ffec62b08a2eaf5 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 01:50:02 +0000 Subject: Add storage dictionary class (for config files) to mx/util/__init__.py. --- src/leap/util/__init__.py | 50 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/src/leap/util/__init__.py b/src/leap/util/__init__.py index e69de29..35e1297 100644 --- a/src/leap/util/__init__.py +++ b/src/leap/util/__init__.py @@ -0,0 +1,50 @@ +# -*- encoding: utf-8 -*- +""" + mx/util/__init__.py + ------------------- + Initialization file for leap_mx utilities. Some miscellaneous things are + stored here also. +""" + + +class Storage(dict): + """ + A Storage object is like a dictionary except `obj.foo` can be used + in addition to `obj['foo']`. + + >>> o = Storage(a=1) + >>> o.a + 1 + >>> o['a'] + 1 + >>> o.a = 2 + >>> o['a'] + 2 + >>> del o.a + >>> o.a + None + """ + def __getattr__(self, key): + try: + return self[key] + except KeyError, k: + return None + + def __setattr__(self, key, value): + self[key] = value + + def __delattr__(self, key): + try: + del self[key] + except KeyError, k: + raise AttributeError, k + + def __repr__(self): + return '' + + def __getstate__(self): + return dict(self) + + def __setstate__(self, value): + for (k, v) in value.items(): + self[k] = v -- cgit v1.2.3 From ead06179e62087785bc0ffe50c87169eadb58f2e Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 01:51:12 +0000 Subject: Add docstrings and client OS detection functions to mx/util/version.py. --- src/leap/util/version.py | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/src/leap/util/version.py b/src/leap/util/version.py index ecf8a22..215876c 100644 --- a/src/leap/util/version.py +++ b/src/leap/util/version.py @@ -11,6 +11,7 @@ Version information for leap_mx. ''' import os +import sys from twisted.python import versions @@ -20,13 +21,44 @@ authors = [('Isis Agora Lovecruft', '', '0x2cdb8b35'),] git_url = 'https://github.com/isislovecruft/leap_mx/' website = 'https://leap.se' +PLATFORMS = {'LINUX': sys.platform.startswith("linux"), + 'OPENBSD': sys.platform.startswith("openbsd"), + 'FREEBSD': sys.platform.startswith("freebsd"), + 'NETBSD': sys.platform.startswith("netbsd"), + 'DARWIN': sys.platform.startswith("darwin"), + 'SOLARIS': sys.platform.startswith("sunos"), + 'WINDOWS': sys.platform.startswith("win32")} + +def getClientPlatform(platform_name=None): + """ + Determine the client's operating system platform. Optionally, if + :param:`platform_name` is given, check that this is indeed the platform + we're operating on. + + @param platform_name: A string, upper-, lower-, or mixed case, of one of + the keys in the :attr:`leap.util.version.PLATFORMS` dictionary. E.g. + 'Linux' or 'OPENBSD', etc. + @returns: A string specifying the platform name, and the boolean test used + to determine it. + """ + for name, test in PLATFORMS.items(): + if not platform_name or platform_name.upper() == name: + if test: + return name, test + def getVersion(): + """ + Returns a version object, with attributes authors, git_url, and website. + """ version.authors = authors version.git_url = git_url version.website = website return version def getRepoDir(): + """ + Get the top-level repository directory. + """ here = os.getcwd() base = here.rsplit(name, 1)[0] repo = os.path.join(base, name) -- cgit v1.2.3 From dca903db11f899aa19e43a060edbe0a093fbbd39 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 01:52:12 +0000 Subject: Config file parsing and creating utility. This will need to be refactored to use JSON, following leap_client, and may tie into soledad. --- src/leap/util/config.py | 170 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 128 insertions(+), 42 deletions(-) diff --git a/src/leap/util/config.py b/src/leap/util/config.py index ab91a60..a762853 100644 --- a/src/leap/util/config.py +++ b/src/leap/util/config.py @@ -1,69 +1,155 @@ #! -*- encoding: utf-8 -*- """ -xxx fill me in +Config file utilities. + +This module has an :attr:`config_filename`, which can be used to set the +filename outside of function calls: + + >>> from leap.mx.util import config + >>> config.config_filename = "blahblah.yaml" + +If not set anywhere, it will default to using the top level repository +directory, i.e. "/.../leap_mx/leap_mx.conf", and will create that file with +the default settings if it does not exist. + +The config file can be loaded/created with :func:`config.loadConfig`: + + >>> config.loadConfig() + +Once the config file is loaded, this module presents a highly object-oriented +interface, so that sections taken from the config file become attribute of +this module, and the name of their respective settings become attributes of +the section names. Like this: + + >>> print config.basic.postfix_port + 465 + +@authors: Isis Lovecruft, 0x2cdb8b35 +@version: 0.0.1 +@license: see included LICENSE file """ + import os import yaml -from leap.util import log, version +## xxx only install/import this in *nix +from xdg import BaseDirectory -config_filename = 'mx.conf' +from leap.util import log, version, Storage +from leap.util.exceptions import MissingConfig, UnsupportedOS -class MissingConfig(Exception): - """Raised when the config file cannot be found.""" - def __init__(self, message=None, config_file=None): - if message: - return - else: - self.message = "Cannot locate config file" - if config_file: - self.message += " %s" % config_file - self.message += "." -def getConfigFilename(dir=None, file=None): +def _create_config_file(file): """ xxx fill me in """ - if not dir: - dir = version.getRepoDir() - if not file: - file = config_filename - return os.path.join(dir, file) - -def createConfigFile(config_file=None): - """ - xxx fill me in - """ - if not config_file: - config_file = getConfigFilename() - - if not os.path.isfile(config_file): - with open(config_file, 'w+') as conf: - conf.write(""" + with open(file, 'w+') as conf: + conf.write(""" # # mx.conf # ======= # Configurable options for the leap_mx encrypting mail exchange. # """) - conf.flush() + conf.flush() + try: + assert os.path.isfile(file), "Config file %s not created!" % file + except AssertionError, ae: + raise SystemExit(ae.message) else: - log.debug("Config file %s already present." % config_file) + return file -def loadConfigFile(config_file=None): +def _get_config_filename(filename=None, use_dot_config_directory=False): """ - xxx fill me in + Get the full path and filename of the config file. """ - if not config_file: - config_file = getConfigFilename() + platform = version.getClientPlatform()[0] + resource = version.name - if os.path.isfile(config_file): - with open(config_file, 'a+') as conf: + ## Oh hell, it could be said only to beguile: + ## That windoze users are capable of editing a .conf file. + ## Also, what maddened wingnut would be so fool + ## To run a mail exchange on a windoze nodule? + ## I'm ignoring these loons for now. And pardon if I seem jaded, + ## But srsly, this and that solaris sh*t should be deprecated. + if not platform.endswith('LINUX') and not platform.endswith('BSD'): + raise UnsupportedOS("Sorry, your operating system isn't supported.") + + ## If not given, default to the application's name + '.conf' + if not filename: + filename = resource + ".conf" + + where = None + if not use_dot_config_directory: + repo_dir = version.getRepoDir() + where = os.path.abspath(repo_dir) + ## Use ~/.config/ instead: + else: + dot_config_dirs = BaseDirectory.xdg_config_dirs + for dir in dot_config_dirs: + our_dir = os.path.join(dir, resource) + if os.path.isdir(our_dir): + if filename in os.listdir(our_dir): + where = os.path.abspath(our_dir) + if not where: + where = BaseDirectory.save_config_path(resource) + + conffile = os.path.join(where, filename) + try: + with open(conffile) as cf: pass + except IOError: + conffile = _create_config_file(conffile) + finally: + return conffile + +def loadConfig(filename=config_filename): + """ + Some of this is taken from OONI config code for now, and so this should be + refacotored, along with the leap_client config code, so that we have + similarly structured config files. It is perhaps desirable to also use + soledad as a backend for remote setup and maintainance, and thus this code + will need to hook into u1db (and potentially "pysqlcipher"). + + Excuse the yaml for now, I just wanted something that works. + + @param filename: (optional) If provided, use this filename. + """ + if not filename: + filename = _get_config_filename() + + if os.path.isfile(filename): + with open(filename, 'a+') as conf: config_contents = '\n'.join(conf.readlines()) configuration = yaml.safe_load(config_contents) + + ## These become objects with their keys loaded as attributes: + ## + ## from leap.util import config + ## config.basic.foo = bar + ## + basic = Storage() + try: + for k, v in configuration['basic'].items(): + basic[k] = v + except AttributeError: + pass + + advanced = Storage() + try: + for k, v in configuration['advanced'].items(): + advanced[k] = v + except AttributeError: + pass + + return basic, advanced else: - createConfigFile(config_file) + raise MissingConfig("Could not load config file.") + + +## This is the name of the config file to use: +## If not set, it defaults to 'leap_mx/leap_mx.conf' +if not config_filename: + config_filename = _get_config_filename() +else: + config_filename = _get_config_filename(filename=config_filename) - ## xxx finish load config - ## ask kali if we're using yaml or json or what? - ## xxx kali says json, so ixnay on the amlya bits -- cgit v1.2.3 From ff1ae8170f0e062a68a851183481662fe91511cd Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 01:54:19 +0000 Subject: Moved exceptions to their own file to keep the code cleaner. --- src/leap/util/exceptions.py | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 src/leap/util/exceptions.py diff --git a/src/leap/util/exceptions.py b/src/leap/util/exceptions.py new file mode 100644 index 0000000..63b946c --- /dev/null +++ b/src/leap/util/exceptions.py @@ -0,0 +1,23 @@ +#! -*- encoding: utf-8 -*- +""" +Custom exceptions for leap_mx. + +@authors: Isis Lovecruft, 0x2cdb8b35 +@version: 0.0.1 +@license: see included LICENSE file +""" + + +class MissingConfig(Exception): + """Raised when the config file cannot be found.""" + def __init__(self, message=None, config_file=None): + if message: + return + else: + self.message = "Cannot locate config file" + if config_file: + self.message += " %s" % config_file + self.message += "." + +class UnsupportedOS(Exception): + """Raised when we're not *nix or *BSD.""" -- cgit v1.2.3 From 2d13c3be08a6fddc76258e375952314b4107cae5 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 02:35:55 +0000 Subject: Paranoia led me to adopt AGPLv3 over my usual favourite, WTFPL. --- COPYLEFT | 13 ++ LICENSE | 620 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 633 insertions(+) create mode 100644 COPYLEFT create mode 100644 LICENSE diff --git a/COPYLEFT b/COPYLEFT new file mode 100644 index 0000000..d8e7331 --- /dev/null +++ b/COPYLEFT @@ -0,0 +1,13 @@ + + This file is part of leap_mx, an encrypting mail exchange program. + Copyright (C) 2013 Isis Lovecruft + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94702e6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,620 @@ + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS -- cgit v1.2.3 From 29427dbba0cde178e4440148df5dc7a10765825d Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 02:37:19 +0000 Subject: Add UUID creator to alias_resolver. --- src/leap/mx/alias_resolver.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 3d20ff7..da37314 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -12,6 +12,7 @@ Classes for resolving postfix aliases. ''' import os +import uuid try: from paisley import client @@ -30,6 +31,19 @@ except ImportError: from leap.mx import net, log ## xxx implement log +def createID(alias): + """ + Creates Universal Unique ID by taking the SHA-1 HASH of an email alias: + + >>> uuid.uuid5(uuid.NAMESPACE_URL, "isis@leap.se") + UUID('7194878e-4aea-563f-85a4-4f58519f3c4f') + + @param alias: An email address alias. + @returns: A :class:`uuid.UUID` containing attributes specifying the UUID. + """ + return uuid.uuid5(uuid.NAMESPACE_URL, str(alias)) + + class ConnectedCouchDB(client.CouchDB): """ Connect to a CouchDB instance. -- cgit v1.2.3 From 38fa3c8d164f4e2e2813f78cf08ecda587fd3508 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 02:59:49 +0000 Subject: Add default boilerplate config to the config file creator. --- src/leap/util/config.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/leap/util/config.py b/src/leap/util/config.py index a762853..5bc5231 100644 --- a/src/leap/util/config.py +++ b/src/leap/util/config.py @@ -50,6 +50,23 @@ def _create_config_file(file): # ======= # Configurable options for the leap_mx encrypting mail exchange. # +# This file follows YAML markup format: http://yaml.org/spec/1.2/spec.html +# Keep in mind that indentation matters. +# + +basic: + # Where is the spoolfile of messages to encrypt?: + spoolfile: /var/mail/encrypt_me +advanced: + # Which port on localhost should postfix send check_recipient queries to?: + check_recipient_access_port: 1347 + # Which port on localhost should postfix ask for UUIDs?: + virtual_alias_map_port: 1348 + # Enable debugging output in the logger: + debug: true + # Print enough things really fast to make you look super 1337: + noisy: false + """) conf.flush() try: -- cgit v1.2.3 From 0b8c4ac523d3934762517c2b149fcfa0920e78c5 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:25:15 +0000 Subject: Separated CouchDB code into mx/couchdb.py and added fake-SMTP status codes to alias_resolver. --- src/leap/mx/alias_resolver.py | 144 +++++++++++++----------------------------- src/leap/mx/couchdb.py | 118 ++++++++++++++++++++++++++++++++++ 2 files changed, 161 insertions(+), 101 deletions(-) create mode 100644 src/leap/mx/couchdb.py diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index da37314..7aeeedf 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -14,12 +14,6 @@ Classes for resolving postfix aliases. import os import uuid -try: - from paisley import client -except ImportError: - print "This software requires paisley. Please see the README file" - print "for instructions on getting required dependencies." - try: from twisted.internet import address, defer, reactor from twisted.mail import maildir, alias @@ -43,104 +37,52 @@ def createID(alias): """ return uuid.uuid5(uuid.NAMESPACE_URL, str(alias)) - -class ConnectedCouchDB(client.CouchDB): - """ - Connect to a CouchDB instance. - - ## xxx will we need to open CouchDB documents and views? - ## yes, these are in a _design document - ## - +class StatusCodes(object): """ - def __init__(self, host, port, dbName=None, - username=None, password=None, *args, **kwargs): - """ - Connect to a CouchDB instance. - - @param host: A hostname string for the CouchDB server. - @param port: The port of the CouchDB server, as an integer. - @param dbName: (optional) The default database to connect to. - @param username: (optional) The username for authorization. - @param password: (optional) The password for authorization. - @returns: A :class:`twisted.internet.defer.Deferred` representing the - the client connection to the CouchDB instance. - """ - super(client.CouchDB, self).__init__(host, port, - dbName=dbName, - username=username, - password=password, - *args, **kwargs) - if dbName: - self.bindToDB(dbName) - else: - databases = self.listDB() - log.msg("Available databases: %s" % databases) - - def queryByEmailOrAlias(self, alias, dbDoc="User", - view="by_email_or_alias"): - """ - Check to see if a particular email or alias exists. - - @param alias: A string representing the email or alias to check. - @param dbDoc: The CouchDB document to open. - @param view: The view of the CouchDB document to use. - """ - assert isinstance(alias, str), "Email or alias queries must be string" + The Postfix manual states: - ## Prepend a forward slash, in case we forgot it: - if not alias.startswith('/'): - alias = '/' + alias + The request completion status is one of OK, RETRY, NOKEY (lookup + failed because the key was not found), BAD (malformed request) or DENY + (the table is not approved for proxy read or update access). - d = self.openDoc(dbDoc) - d.addCallbacks(self.openView, log.err, (view)) - d.addCallbacks(self.get, log.err, (alias)) - d.addCallbacks(self.parseResult, log.err) - - @d.addCallback - def show_answer(result): - log.msg("Query: %s" % alias) - log.msg("Answer: %s" % alias) - - return d - - def query(self, uri): - """ - Query a CouchDB instance that we are connected to. - """ - try: - self.checkURI(uri) ## xxx write checkURI() - ## xxx we might be able to use self._parseURI() - except SchemeNotSupported, sns: ## xxx where in paisley is this? - log.exception(sns) ## xxx need log.exception() - - d = self.get(uri) - @d.addCallback - def parse_answer(answer): - return answer - - return answer - - @defer.inlineCallbacks - def listUsersAndEmails(self, limit=1000, reverse=False): - """ - List all users and email addresses, up to the given limit. - """ - query = "/users/_design/User/_view/by_email_or_alias/?reduce=false" - answer = yield self.query(query, limit=limit, reverse=reverse) - - if answer: - parsed = yield self.parseResult(answer) - if parsed: - log.msg("%s" % parsed) - else: - log.msg("No answer from database, perhaps there are no users.") - else: - log.msg("Problem querying CouchDB instance...") - log.debug("Host: %s" % host) - log.debug("Port: %d" % port) - -class PostfixAliasResolver(postfix.PostfixTCPMapServer): + Other SMTP codes: http://www.greenend.org.uk/rjk/tech/smtpreplies.html + """ + OK = "OK Others might say 'HELLA AWESOME'...but we're not convinced." + RETRY = "RETRY Server is busy plotting revolution; requests might take a while." + BAD = "BAD bad Leroy Brown, baddest man in the whole...er. Malformed request." + NOKEY = "NOKEY Couldn't find your keys, sorry. Did you check in the sofa?" + DEFER = "DEFER_IF_LOCAL xxx fill me in" + DENY = "DENY no gurlz aloud in teh tree house." + FAIL = "FAIL xxx fill me in" + + fakeSMTPCodes = { '250': OK, + '300': RETRY, + '500': BAD, + '550': NOKEY, + '552': DEFER, + '553': DENY, + '554': FAIL, } + + def __init__(self, status_code=None): + """xxx fill me in""" + if status_code: + self.get(status_code) + + def get(self, status_code=None) + """xxx fill me in""" + if status_code: + if isinstance(status_code, str): + return status_code, getattr(self, status_code.upper(), None) + elif isinstance(status_code, int): + for k, v in self.fake_smtp_codes.items(): + ## we want to return None if it's 550 + if k == str(status_code) and k != '550': + return status_code, v + log.debug("%s" % self.NOKEY) + return None, '' + + +class AliasResolver(postfix.PostfixTCPMapServer): """ Resolve postfix aliases, similarly to using "$ postmap -q ". diff --git a/src/leap/mx/couchdb.py b/src/leap/mx/couchdb.py new file mode 100644 index 0000000..b5d4127 --- /dev/null +++ b/src/leap/mx/couchdb.py @@ -0,0 +1,118 @@ +# -*- encoding: utf-8 -*- +''' +couchdb.py +========== +Classes for working with CouchDB or BigCouch instances which store email alias +maps, user UUIDs, and GPG keyIDs. + +@authors: Isis Agora Lovecruft +@version: 0.0.1-beta +@license: see included LICENSE file +''' + +try: + from paisley import client +except ImportError: + print "This software requires paisley. Please see the README file" + print "for instructions on getting required dependencies." + +try: + from twisted.internet import defer +except ImportError: + print "This software requires Twisted. Please see the README file" + print "for instructions on getting required dependencies." + +from leap.mx.util import log + + +class ConnectedCouchDB(client.CouchDB): + """ + Connect to a CouchDB instance. + + ## xxx will we need to open CouchDB documents and views? + ## yes, these are in a _design document + """ + def __init__(self, host, port, dbName=None, username=None, + password=None, *args, **kwargs): + """ + Connect to a CouchDB instance. + + @param host: A hostname string for the CouchDB server. + @param port: The port of the CouchDB server, as an integer. + @param dbName: (optional) The default database to connect to. + @param username: (optional) The username for authorization. + @param password: (optional) The password for authorization. + @returns: A :class:`twisted.internet.defer.Deferred` representing the + the client connection to the CouchDB instance. + """ + super(client.CouchDB, self).__init__(host, port, + dbName=dbName, + username=username, + password=password, + *args, **kwargs) + if dbName: + self.bindToDB(dbName) + else: + databases = self.listDB() + log.msg("Available databases: %s" % databases) + + def queryByEmailOrAlias(self, alias, dbDoc="User", + view="by_email_or_alias"): + """ + Check to see if a particular email or alias exists. + + @param alias: A string representing the email or alias to check. + @param dbDoc: The CouchDB document to open. + @param view: The view of the CouchDB document to use. + """ + assert isinstance(alias, str), "Email or alias queries must be string" + + ## Prepend a forward slash, in case we forgot it: + if not alias.startswith('/'): + alias = '/' + alias + + d = self.openDoc(dbDoc) + d.addCallbacks(self.openView, log.err, (view)) + d.addCallbacks(self.get, log.err, (alias)) + d.addCallbacks(self.parseResult, log.err) + + @d.addCallback + def show_answer(result): + log.msg("Query: %s" % alias) + log.msg("Answer: %s" % alias) + + return d + + def query(self, uri): + """ + Query a CouchDB instance that we are connected to. + """ + try: + self.checkURI(uri) ## xxx write checkURI() + ## xxx we might be able to use self._parseURI() + except SchemeNotSupported, sns: ## xxx where in paisley is this? + log.exception(sns) ## xxx need log.exception() + + d = self.get(uri) + @d.addCallback + def parse_answer(answer): + return answer + + return answer + + @defer.inlineCallbacks + def listUsersAndEmails(self, limit=1000, reverse=False): + """ + List all users and email addresses, up to the given limit. + """ + query = "/users/_design/User/_view/by_email_or_alias/?reduce=false" + answer = yield self.query(query, limit=limit, reverse=reverse) + + if answer: + parsed = yield self.parseResult(answer) + if parsed: + log.msg("%s" % parsed) + else: + log.msg("No answer from database, perhaps there are no users.") + else: + log.msg("Problem querying CouchDB instance...") -- cgit v1.2.3 From ecd01f1d83ddd9e4ada9fbace6c98c66819428cc Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:29:49 +0000 Subject: Fix typo. --- src/leap/mx/alias_resolver.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 7aeeedf..12b29fd 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -19,7 +19,7 @@ try: from twisted.mail import maildir, alias from twisted.protocols import postfix except ImportError: - print "This software requires paisley. Please see the README file" + print "This software requires Twisted. Please see the README file" print "for instructions on getting required dependencies." from leap.mx import net, log ## xxx implement log -- cgit v1.2.3 From 136cc7ffa4e15c922debe2ca1c9aef7c0847e292 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:31:45 +0000 Subject: Renamed alias_resolver.createID() to alias_resolver.aliasToUUID(), renamed AliasResolver classes, fixed docstrings and imports. --- src/leap/mx/alias_resolver.py | 113 ++++++++++++++++++++++++++++++++---------- 1 file changed, 88 insertions(+), 25 deletions(-) diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 12b29fd..4774d78 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -22,10 +22,10 @@ except ImportError: print "This software requires Twisted. Please see the README file" print "for instructions on getting required dependencies." -from leap.mx import net, log ## xxx implement log +from leap.mx.util import net, log, config, exceptions -def createID(alias): +def aliasToUUID(alias): """ Creates Universal Unique ID by taking the SHA-1 HASH of an email alias: @@ -91,50 +91,113 @@ class AliasResolver(postfix.PostfixTCPMapServer): query the local Postfix server. You can test it with: $ ./alias_resolver.py & - $ /usr/bin/postmap -q tcp:localhost:4242 + $ /usr/bin/postmap -q tcp:localhost:1347 + Resources: + http://www.postfix.org/proxymap.8.html + https://www.iana.org/assignments/smtp-enhanced-status-codes/smtp-enhanced-status-codes.txt """ def __init__(self, *args, **kwargs): + """Create a server which listens for Postfix aliases to resolve.""" + super(postfix.PostfixTCPMapServer, self).__init__(*args, **kwargs) + self.status_codes = StatusCodes() + + def sendCode(self, code, message=None): + """Send an SMTP-like code with a message.""" + if not message: + message = self.status_codes.get(code) + self.sendLine('%3.3d %s' % (code, message or '')) + + def do_get(self, key): + """Make a query to resolve an alias.""" + if key is None: + self.sendCode(500) + log.warn("Command 'get' takes one parameter.") + else: + d = defer.maybeDeferred(self.factory.get, key) + d.addCallbacks(self._cbGot, self._cbNot) + d.addErrback(log.err) + + def do_query(self, key): + """Make a query to resolve an alias.""" + self.do_get(self, key) + + @defer.inlineCallbacks + def do_put(self, keyAndValue): + """Add a key and value to the database, provided it does not exist.""" + if keyAndValue is None: + self.sendCode(500) + log.warn("Command 'put' takes two parameters.") + else: + try: + key, value = keyAndValue.split(None, 1) + except ValueError: + self.sendCode(500) + log.warn("Command 'put' takes two parameters.") + else: + alreadyThere = yield self.do_query(key) + if alreadyThere is None: + d = defer.maybeDeferred(self.factory.put, key, value) + d.addCallbacks(self._cbPut, self._cbPout) + d.addCallbacks(log.err) + else: + self.sendCode(553) + + @defer.inlineCallbacks + def do_delete(self, key): """ - Create a local LineReceiver server which listens for Postfix aliases - to resolve. + Delete an alias from the mapping database. + + xxx not sure if this is a good idea... """ - super(postfix.PostfixTCPMapServer, self).__init__(*args, **kwargs) + raise NotImplemented + + def _cbGot(self, value): + """Callback for self.get()""" + if value is None: + self.sendCode(550) + else: + self.sendCode(250, quote(value)) + def _cbNot(self, fail): + """Errback for self.get()""" + self.sendCode(554, fail.getErrorMessage()) -class PostfixAliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): + def _cbPut(self, value): + """xxx fill me in""" + pass + + def _cbPout(self, fail): + """xxx fill me in""" + pass + + +class AliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): """ - A Factory for creating PostfixAliasResolver servers, which handles inputs + A Factory for creating :class:`AliasResolver` servers, which handles inputs and outputs, and keeps an in-memory mapping of Postfix aliases in the form - of a dict. + of a dictionary. xxx fill me in - """ - protocol = PostfixAliasResolver + protocol = AliasResolver def __init__(self, addr='127.0.0.1', port=4242, timeout=120, data=None): """ - Create a Factory which returns :class:`PostfixAliasResolver` servers. + Create a Factory which returns :class:`AliasResolver` servers. - @param addr: - (optional) A string giving the IP address of the Postfix server. + @param addr: A string giving the IP address of this server. Default: '127.0.0.1' - @param port: - (optional) An integer that specifies the port number of the - Postfix server. Default: 4242 - @param timeout: - (optional) An integer specifying the number of seconds to wait + @param port: An integer that specifies the port number to listen + on. Default: 4242 + @param timeout: An integer specifying the number of seconds to wait until we should time out. Default: 120 - @param data: - (optional) A dict to use to initialise or update the alias - mapping. + @param data: A dict to use to initialise or update the alias mapping. """ - super(postfix.PostfixTCPMapDeferringDictServerFactory, + super(postfix.PostfixTCPMapDeferringDictServerFactory, self).__init__(data=data) self.timeout = timeout - ## xxx get config value, should be something like verbose = no - self.noisy = False + self.noisy = True if config.advanced.noisy else False try: assert isinstance(port, int), "Port number must be an integer" -- cgit v1.2.3 From fa684009c191227a6e5c05771099c956cd1985ad Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:34:11 +0000 Subject: Add TODO to alias_resolver. --- src/leap/mx/alias_resolver.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 4774d78..4867893 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -9,6 +9,19 @@ Classes for resolving postfix aliases. @version: 0.0.1-beta @license: see included LICENSE file @copyright: copyright 2013 Isis Agora Lovecruft + +TODO: + + o Look into using twisted.protocols.postfix.policies classes for + controlling concurrent connections and throttling resource consumption. + + o alias.ProcessAlias() + +## have uuid, need to get gpg keyid +## have key, make crypto + +alias.ProcessAlias('/path/to/mail_reciever', *args) + ''' import os -- cgit v1.2.3 From 2b6e5408048a458e2c7f447e44d3829cb552a737 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 07:36:06 +0000 Subject: Add callbacks to AliasResolverFactory, these need to be hooked to couchdb.ConnectedCouchDB(). --- src/leap/mx/alias_resolver.py | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 4867893..44cb44d 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -221,18 +221,35 @@ class AliasResolverFactory(postfix.PostfixTCPMapDeferringDictServerFactory): if net.checkIPaddress(addr): self.addr = address._IPAddress('TCP', addr, int(port)) else: - log.debug("Using default address for Postfix: 127.0.0.1:%s" % port) + log.msg("Using default address: 127.0.0.1:%s" % port) self.addr = address._IPAddress('TCP', '127.0.0.1', int(port)) + log.msg("To configure Postfix to query this alias_resolver,") + log.msg("you should do:") + log.msg(" $ postconf -e 'check_recipient_access = tcp:%s:%d" + % (addr, port)) + def buildProtocol(self): """ - Create an instance of the :class:`PostfixAliasResolver` server. + Create an instance of the :class:`AliasResolver` server. """ proto = self.protocol() proto.timeout = self.timeout proto.factory = self return proto + def get(self, *args, **kwargs): + """ + xxx connect me to the couchdb + """ + pass + + def put(self, *args, **kwargs): + """ + xxx connect me to the couchdb + """ + pass + if __name__ == "__main__": -- cgit v1.2.3 From cd8beb5798cdab1b3cd700be662e9659cbec8977 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 09:50:59 +0000 Subject: Finished check_recipient and virtual_alias_map in AliasResolver. --- src/leap/mx/alias_resolver.py | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py index 44cb44d..e079b80 100644 --- a/src/leap/mx/alias_resolver.py +++ b/src/leap/mx/alias_resolver.py @@ -17,8 +17,7 @@ TODO: o alias.ProcessAlias() -## have uuid, need to get gpg keyid -## have key, make crypto +## have uuid -> get gpg keyid alias.ProcessAlias('/path/to/mail_reciever', *args) @@ -38,7 +37,7 @@ except ImportError: from leap.mx.util import net, log, config, exceptions -def aliasToUUID(alias): +def createUUID(alias): """ Creates Universal Unique ID by taking the SHA-1 HASH of an email alias: @@ -108,7 +107,7 @@ class AliasResolver(postfix.PostfixTCPMapServer): Resources: http://www.postfix.org/proxymap.8.html - https://www.iana.org/assignments/smtp-enhanced-status-codes/smtp-enhanced-status-codes.txt + https://www.iana.org/assignments/smtp-enhanced-status-codes/ """ def __init__(self, *args, **kwargs): """Create a server which listens for Postfix aliases to resolve.""" @@ -131,10 +130,6 @@ class AliasResolver(postfix.PostfixTCPMapServer): d.addCallbacks(self._cbGot, self._cbNot) d.addErrback(log.err) - def do_query(self, key): - """Make a query to resolve an alias.""" - self.do_get(self, key) - @defer.inlineCallbacks def do_put(self, keyAndValue): """Add a key and value to the database, provided it does not exist.""" @@ -165,6 +160,30 @@ class AliasResolver(postfix.PostfixTCPMapServer): """ raise NotImplemented + def check_recipient_access(self, key): + """Make a query to resolve an alias.""" + self.do_get(self, key) + + def virtual_alias_map(self, key): + """ + Get the Universal Unique ID for the alias address. If + virtual_transport is True, then suffix the UUID with a domain. + + xxx I don't think we actually need couchdb for this, the UUID is an + identifier, not an authenticator. And the SHA1 should always be the + same, so unless it's considered to expensive to compute (less than + querying a database, I would presume), it seems silly to do this. + + Instead, we should query CouchDB with the UUID to get the GPG keyid. + """ + ## xxx need email address parser + client_id = createUUID(key) + + if self.virtual_transport: + return client.get_urn() + '@example.com' + else: + return client.get_urn() + def _cbGot(self, value): """Callback for self.get()""" if value is None: -- cgit v1.2.3 From 5e0c912371e73bd3b37b8f1b2d17056178c813b6 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 09:58:28 +0000 Subject: Update pip requirements file to include PyYAML. --- pkg/mx-requirements.pip | 1 + 1 file changed, 1 insertion(+) diff --git a/pkg/mx-requirements.pip b/pkg/mx-requirements.pip index 33b9b54..c809051 100644 --- a/pkg/mx-requirements.pip +++ b/pkg/mx-requirements.pip @@ -1,2 +1,3 @@ Twisted==12.2.0 paisley>=0.3.1 +PyYAML>=3.10 -- cgit v1.2.3 From 02e84d4ac48294bdfea49678d59ebd410010e2a9 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Thu, 31 Jan 2013 10:04:31 +0000 Subject: Update pip requirements for pyxdg. --- pkg/mx-requirements.pip | 1 + 1 file changed, 1 insertion(+) diff --git a/pkg/mx-requirements.pip b/pkg/mx-requirements.pip index c809051..12a6287 100644 --- a/pkg/mx-requirements.pip +++ b/pkg/mx-requirements.pip @@ -1,3 +1,4 @@ Twisted==12.2.0 paisley>=0.3.1 PyYAML>=3.10 +pyxdg>=0.19-5 -- cgit v1.2.3 From d486c13af17133e2e5a2bfe6e5a862bfea6736ff Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 15 Feb 2013 19:27:53 +0000 Subject: Module directory layout changes, with corresponding __init__.py changes. --- src/leap/__init__.py | 27 +++++-- src/leap/mx.py | 154 ------------------------------------ src/leap/mx/__init__.py | 4 +- src/leap/mx/util/__init__.py | 1 + src/leap/mx/util/config.py | 172 +++++++++++++++++++++++++++++++++++++++++ src/leap/mx/util/exceptions.py | 23 ++++++ src/leap/mx/util/log.py | 154 ++++++++++++++++++++++++++++++++++++ src/leap/mx/util/net.py | 126 ++++++++++++++++++++++++++++++ src/leap/mx/util/version.py | 101 ++++++++++++++++++++++++ src/leap/start_mx.py | 157 +++++++++++++++++++++++++++++++++++++ src/leap/util/__init__.py | 50 ------------ src/leap/util/config.py | 172 ----------------------------------------- src/leap/util/exceptions.py | 23 ------ src/leap/util/log.py | 154 ------------------------------------ src/leap/util/net.py | 126 ------------------------------ src/leap/util/version.py | 101 ------------------------ 16 files changed, 757 insertions(+), 788 deletions(-) delete mode 100755 src/leap/mx.py create mode 100644 src/leap/mx/util/__init__.py create mode 100644 src/leap/mx/util/config.py create mode 100644 src/leap/mx/util/exceptions.py create mode 100644 src/leap/mx/util/log.py create mode 100644 src/leap/mx/util/net.py create mode 100644 src/leap/mx/util/version.py create mode 100755 src/leap/start_mx.py delete mode 100644 src/leap/util/__init__.py delete mode 100644 src/leap/util/config.py delete mode 100644 src/leap/util/exceptions.py delete mode 100644 src/leap/util/log.py delete mode 100644 src/leap/util/net.py delete mode 100644 src/leap/util/version.py diff --git a/src/leap/__init__.py b/src/leap/__init__.py index 99a951f..8846fbc 100644 --- a/src/leap/__init__.py +++ b/src/leap/__init__.py @@ -1,12 +1,25 @@ # -*- encoding: utf-8 -*- +__all__ = ['mx'] +__author__ = version.authors +__version__ = version.getVersion() + from leap import mx -from leap import util -from leap.util import version as mxversion +from leap.mx import util +from leap.mx.util import version + -__all__ = ['mx', 'util'] -__author__ = mxversion.authors -__version__ = mxversion.getVersion() +def _print_authors_nicely(): + if hasattr(version, 'authors'): + assert isinstance(version.authors, list) + if len(version.authors) > 0: + first = version.authors.pop() + __author__ = (" ".join(first[:2])) + if len(version.authors) > 0: + for auth in version.authors: + joined = " ".join(auth[:2]) + __author__ += ("\n%s" % joined) + -print "Authors: %s" % __author__ -print "Version: %s" % __version__ +print "Version: %s" % version.getVersion() +print "Authors: %s" % _print_authors_nicely() diff --git a/src/leap/mx.py b/src/leap/mx.py deleted file mode 100755 index 60968bc..0000000 --- a/src/leap/mx.py +++ /dev/null @@ -1,154 +0,0 @@ -#!/usr/bin/env python -#-*- coding: utf-8 -*- -""" - ____ - | mx | - |____|_______________________ - | | - | An encrypting remailer. | - |_________________________| - -@author Isis Agora Lovecruft , 0x2cdb8b35 -@version 0.0.1 - -""" - -import os, sys - - -application_name = "leap_mx" - -def __get_repo_dir__(): - """Get the absolute path of the top-level repository directory.""" - here = os.getcwd() - base = here.rsplit(application_name, 1)[0] - repo = os.path.join(base, application_name) - return repo - -## Set the $PYTHONPATH: -src_dir = os.path.join(__get_repo_dir__(), 'src/') -sys.path[:] = map(os.path.abspath, sys.path) -sys.path.insert(0, src_dir) - -## Now we should be able to import ourselves without installation: -try: - from mx import runner - from util import log, version -except ImportError, ie: - print "%s\nExiting..." % ie.message - sys.exit(1) - - -class CheckRequirements(ImportError): - """ - Raised when we're missing something from requirements.pip. - """ - def __init__(self, message=None, missing=None, pipfile=None): - """ - Display an error message with instructions for obtaining missing - dependencies. - - @param message: A string describing the error. - @param missing: A string indicating which dependency is missing. - @param pipfile: The path and filename of the pip requirements file, - relative to the top-level repository directory. - """ - if message: - self.message = message - return self - - self.pipfile = pipfile - - if isinstance(missing, str): - missing = [missing] - else: - missing = [] - dependencies = self.__read_pip_requirements__() - for package, version in dependencies: - pkg = package.lower() if package == "Twisted" else package - try: - __import__(pkg) - except ImportError: - missing.append(package) - - self.message = application_name + " requires " - if len(missing) > 1: - for missed in missing[:-1]: - self.message += missed + ", " - self.message += "and " - if len(missing) == 1: - self.message += missing[0] + "." - self.message += "\nPlease see %s for ".format(pipfile) - self.message += "instruction on installing dependencies." - raise self - elif len(missing) <= 0: - return - - def __read_pip_requirements__(self, file=None): - """ - Check the pip requirements file to determine our dependencies. - - @param file: The name of the pip requirements.txt file. - @returns: A list of tuple(package_name, package_version). - """ - import re - - if not file: - file = self.pipfile - - filepath = os.path.join(__get_repo_dir__(), file) - requirement = re.compile('[^0-9=><]+') - dependencies = [] - - print filepath - assert os.path.isfile(filepath), \ - "Couldn't find requirements.pip file!" - - with open(filepath) as pipfile: - for line in pipfile.readlines(): - shortened = line.strip() - matched = requirement.match(shortened) - package_name = matched.group() - package_version = shortened.split(package_name, 1)[1] - dependencies.append((package_name, package_version)) - - return dependencies - -dependency_check = CheckRequirements(pipfile='pkg/mx-requirements.pip') - -try: - from twisted.python import usage, runtime - from twisted.internet import reactor -except: - print "the CheckRequirements class is broken!" - - -if __name__ == "__main__": - - log.start() - log.debug("Running %s, with Python %s" % (application_name, - runtime.shortPythonVersion())) - log.debug("Platform: %s" % runtime.platform.getType()) - log.debug("Thread support: %s" % str(runtime.platform.supportsThreads())) - - mx_options = MXOptions() - mx_options.parseOptions(sys.argv) - - if len(sys.argv) <= 0: - print mx_options.getUsage() - sys.exit(0) - else: - options = mx_options - - if options['verbose']: - config.basic.debug = True - - if options['test']: - from leap.mx import tests ## xxx this needs an __init__.py - tests.run() ## xxx need /leap/mx/tests.py - elif options['conf'] and os.path.isfile(options['conf']): - config.parse() ## xxx need /leap/mx/config.py - runner.run() ## xxx need /leap/mx/runner.py - else: - mx_options.getUsage() - sys.exit(1) diff --git a/src/leap/mx/__init__.py b/src/leap/mx/__init__.py index 10d8ee7..507efee 100644 --- a/src/leap/mx/__init__.py +++ b/src/leap/mx/__init__.py @@ -1 +1,3 @@ -__all__ = ['alias_resolver', 'runner', 'tests'] +#from . import util + +__all__ = ['alias_resolver', 'runner', 'tests', 'couchdb'] diff --git a/src/leap/mx/util/__init__.py b/src/leap/mx/util/__init__.py new file mode 100644 index 0000000..c8448b0 --- /dev/null +++ b/src/leap/mx/util/__init__.py @@ -0,0 +1 @@ +__all__ = ['config', 'exceptions', 'log', 'net', 'version, storage'] diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py new file mode 100644 index 0000000..5bc5231 --- /dev/null +++ b/src/leap/mx/util/config.py @@ -0,0 +1,172 @@ +#! -*- encoding: utf-8 -*- +""" +Config file utilities. + +This module has an :attr:`config_filename`, which can be used to set the +filename outside of function calls: + + >>> from leap.mx.util import config + >>> config.config_filename = "blahblah.yaml" + +If not set anywhere, it will default to using the top level repository +directory, i.e. "/.../leap_mx/leap_mx.conf", and will create that file with +the default settings if it does not exist. + +The config file can be loaded/created with :func:`config.loadConfig`: + + >>> config.loadConfig() + +Once the config file is loaded, this module presents a highly object-oriented +interface, so that sections taken from the config file become attribute of +this module, and the name of their respective settings become attributes of +the section names. Like this: + + >>> print config.basic.postfix_port + 465 + +@authors: Isis Lovecruft, 0x2cdb8b35 +@version: 0.0.1 +@license: see included LICENSE file +""" + +import os +import yaml + +## xxx only install/import this in *nix +from xdg import BaseDirectory + +from leap.util import log, version, Storage +from leap.util.exceptions import MissingConfig, UnsupportedOS + + +def _create_config_file(file): + """ + xxx fill me in + """ + with open(file, 'w+') as conf: + conf.write(""" +# +# mx.conf +# ======= +# Configurable options for the leap_mx encrypting mail exchange. +# +# This file follows YAML markup format: http://yaml.org/spec/1.2/spec.html +# Keep in mind that indentation matters. +# + +basic: + # Where is the spoolfile of messages to encrypt?: + spoolfile: /var/mail/encrypt_me +advanced: + # Which port on localhost should postfix send check_recipient queries to?: + check_recipient_access_port: 1347 + # Which port on localhost should postfix ask for UUIDs?: + virtual_alias_map_port: 1348 + # Enable debugging output in the logger: + debug: true + # Print enough things really fast to make you look super 1337: + noisy: false + +""") + conf.flush() + try: + assert os.path.isfile(file), "Config file %s not created!" % file + except AssertionError, ae: + raise SystemExit(ae.message) + else: + return file + +def _get_config_filename(filename=None, use_dot_config_directory=False): + """ + Get the full path and filename of the config file. + """ + platform = version.getClientPlatform()[0] + resource = version.name + + ## Oh hell, it could be said only to beguile: + ## That windoze users are capable of editing a .conf file. + ## Also, what maddened wingnut would be so fool + ## To run a mail exchange on a windoze nodule? + ## I'm ignoring these loons for now. And pardon if I seem jaded, + ## But srsly, this and that solaris sh*t should be deprecated. + if not platform.endswith('LINUX') and not platform.endswith('BSD'): + raise UnsupportedOS("Sorry, your operating system isn't supported.") + + ## If not given, default to the application's name + '.conf' + if not filename: + filename = resource + ".conf" + + where = None + if not use_dot_config_directory: + repo_dir = version.getRepoDir() + where = os.path.abspath(repo_dir) + ## Use ~/.config/ instead: + else: + dot_config_dirs = BaseDirectory.xdg_config_dirs + for dir in dot_config_dirs: + our_dir = os.path.join(dir, resource) + if os.path.isdir(our_dir): + if filename in os.listdir(our_dir): + where = os.path.abspath(our_dir) + if not where: + where = BaseDirectory.save_config_path(resource) + + conffile = os.path.join(where, filename) + try: + with open(conffile) as cf: pass + except IOError: + conffile = _create_config_file(conffile) + finally: + return conffile + +def loadConfig(filename=config_filename): + """ + Some of this is taken from OONI config code for now, and so this should be + refacotored, along with the leap_client config code, so that we have + similarly structured config files. It is perhaps desirable to also use + soledad as a backend for remote setup and maintainance, and thus this code + will need to hook into u1db (and potentially "pysqlcipher"). + + Excuse the yaml for now, I just wanted something that works. + + @param filename: (optional) If provided, use this filename. + """ + if not filename: + filename = _get_config_filename() + + if os.path.isfile(filename): + with open(filename, 'a+') as conf: + config_contents = '\n'.join(conf.readlines()) + configuration = yaml.safe_load(config_contents) + + ## These become objects with their keys loaded as attributes: + ## + ## from leap.util import config + ## config.basic.foo = bar + ## + basic = Storage() + try: + for k, v in configuration['basic'].items(): + basic[k] = v + except AttributeError: + pass + + advanced = Storage() + try: + for k, v in configuration['advanced'].items(): + advanced[k] = v + except AttributeError: + pass + + return basic, advanced + else: + raise MissingConfig("Could not load config file.") + + +## This is the name of the config file to use: +## If not set, it defaults to 'leap_mx/leap_mx.conf' +if not config_filename: + config_filename = _get_config_filename() +else: + config_filename = _get_config_filename(filename=config_filename) + diff --git a/src/leap/mx/util/exceptions.py b/src/leap/mx/util/exceptions.py new file mode 100644 index 0000000..63b946c --- /dev/null +++ b/src/leap/mx/util/exceptions.py @@ -0,0 +1,23 @@ +#! -*- encoding: utf-8 -*- +""" +Custom exceptions for leap_mx. + +@authors: Isis Lovecruft, 0x2cdb8b35 +@version: 0.0.1 +@license: see included LICENSE file +""" + + +class MissingConfig(Exception): + """Raised when the config file cannot be found.""" + def __init__(self, message=None, config_file=None): + if message: + return + else: + self.message = "Cannot locate config file" + if config_file: + self.message += " %s" % config_file + self.message += "." + +class UnsupportedOS(Exception): + """Raised when we're not *nix or *BSD.""" diff --git a/src/leap/mx/util/log.py b/src/leap/mx/util/log.py new file mode 100644 index 0000000..ef54605 --- /dev/null +++ b/src/leap/mx/util/log.py @@ -0,0 +1,154 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +log.py +------ +Logging for leap_mx. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@licence: see included LICENSE file +@copyright: 2013 Isis Agora Lovecruft +''' + +from datetime import datetime +from functools import wraps + +import logging +import os +import sys +import time +import traceback + +from twisted.python import log as txlog +from twisted.python import util as txutil +from twisted.python.logfile import DailyLogFile +from twisted.python.failure import Failure + +from leap.util import version, config + + +class InvalidTimestampFormat(Exception): + pass + +class UnprefixedLogfile(txlog.FileLogObserver): + """Logfile with plain messages, without timestamp prefixes.""" + def emit(self, eventDict): + text = txlog.textFromEventDict(eventDict) + if text is None: + return + + txutil.untilConcludes(self.write, "%s\n" % text) + txutil.untilConcludes(self.flush) + + +def utcDateNow(): + """The current date for UTC time.""" + return datetime.utcnow() + +def utcTimeNow(): + """Seconds since epoch in UTC time, as type float.""" + return time.mktime(time.gmtime()) + +def dateToTime(date): + """Convert datetime to seconds since epoch.""" + return time.mktime(date.timetuple()) + +def prettyDateNow(): + """Pretty string for the local time.""" + return datetime.now().ctime() + +def utcPrettyDateNow(): + """Pretty string for UTC.""" + return datetime.utcnow().ctime() + +def timeToPrettyDate(time_val): + """Convert seconds since epoch to date.""" + return time.ctime(time_val) + +def start(logfile=None, application_name=None): + """ + Start logging to stdout, and optionally to a logfile as well. + + @param logfile: The filename to store logs in, which is placed in + /leap_mx/logs/. + @param application_name: The name of the running application. + """ + if not application_name: + application_name = version.name + print "application name: %s" % application_name + + daily_logfile = None + + if not logfile: + logfile = config.basic.logfile + + repo_dir = version.getRepoDir() + logfile_dir = os.path.join(repo_dir, 'log') + logfile_name = logfile + + daily_logfile = DailyLogFile(logfile_name, logfile_dir) + + txlog.startLoggingWithObserver(UnprefixedLogfile(sys.stdout).emit) + txlog.addObserver(txlog.FileLogObserver(daily_logfile).emit) + txlog.msg("Starting %s on %s (%s UTC)" % (application_name, + prettyDateNow(), + utcPrettyDateNow())) + +def msg(msg, *arg, **kwarg): + """Log a message at the INFO level.""" + print "[*] %s" % msg + +def debug(msg, *arg, **kwarg): + """Log a message at the DEBUG level.""" + if config.basic.debug: + print "[d] %s" % msg + +def warn(msg, *arg, **kwarg): + """Log a message at the WARN level.""" + if config.basic.show_warnings: + txlog.logging.captureWarnings('true') + print "[#] %s" % msg + +def err(msg, *arg, **kwarg): + """Log a message at the ERROR level.""" + print "[!] %s" % msg + +def fail(*failure): + """Log a message at the CRITICAL level.""" + logging.critical(failure) + ## xxx should we take steps to exit here? + +def exception(error): + """ + Catch an exception and print only the error message, then continue normal + program execution. + + @param error: Can be error messages printed to stdout and to the + logfile, or can be a twisted.python.failure.Failure instance. + """ + if isinstance(error, Failure): + error.printTraceback() + else: + exc_type, exc_value, exc_traceback = sys.exc_info() + traceback.print_exception(exc_type, exc_value, exc_traceback) + +def catch(func): + """ + Quick wrapper to add around test methods for debugging purposes, + catches the given Exception. Use like so: + + >>> @log.catch + def foo(bar): + if bar == 'baz': + raise Exception("catch me no matter what I am") + >>> foo("baz") + [!] catch me no matter what I am + + """ + @wraps(func) + def _catch(*args, **kwargs): + try: + func(*args, **kwargs) + except Exception, exc: + exception(exc) + return _catch diff --git a/src/leap/mx/util/net.py b/src/leap/mx/util/net.py new file mode 100644 index 0000000..a4104d0 --- /dev/null +++ b/src/leap/mx/util/net.py @@ -0,0 +1,126 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +net.py +------- +Utilities for networking. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@license: see included LICENSE file +@copyright: 2013 Isis Agora Lovecruft +''' + +import ipaddr +import sys +import socket + +from random import randint + +from leap.mx.utils import log + + +PLATFORMS = {'LINUX': sys.platform.startswith("linux"), + 'OPENBSD': sys.platform.startswith("openbsd"), + 'FREEBSD': sys.platform.startswith("freebsd"), + 'NETBSD': sys.platform.startswith("netbsd"), + 'DARWIN': sys.platform.startswith("darwin"), + 'SOLARIS': sys.platform.startswith("sunos"), + 'WINDOWS': sys.platform.startswith("win32")} + + +class UnsupportedPlatform(Exception): + """Support for this platform is not currently available.""" + +class IfaceError(Exception): + """Could not find default network interface.""" + +class PermissionsError(SystemExit): + """This test requires admin or root privileges to run. Exiting...""" + + +def checkIPaddress(addr): + """ + Check that a given string is a valid IPv4 or IPv6 address. + + @param addr: Any string defining an IP address, i.e. '1.2.3.4' or '::1'. + @returns: True if :param:`addr` defines a valid IPAddress, else False. + """ + import ipaddr + + try: + check = ipaddr.IPAddress(addr) + except ValueError, ve: + log.warn(ve.message) + return False + else: + return True + +def getClientPlatform(platform_name=None): + for name, test in PLATFORMS.items(): + if not platform_name or platform_name.upper() == name: + if test: + return name, test + +def getPosixIfaces(): + from twisted.internet.test import _posixifaces + log.msg("Attempting to discover network interfaces...") + ifaces = _posixifaces._interfaces() + return ifaces + +def getWindowsIfaces(): + from twisted.internet.test import _win32ifaces + log.msg("Attempting to discover network interfaces...") + ifaces = _win32ifaces._interfaces() + return ifaces + +def getIfaces(platform_name=None): + client, test = getClientPlatform(platform_name) + if client: + if client == ('LINUX' or 'DARWIN') or client[-3:] == 'BSD': + return getPosixIfaces() + elif client == 'WINDOWS': + return getWindowsIfaces() + ## XXX fixme figure out how to get iface for Solaris + else: + raise UnsupportedPlatform + else: + raise UnsupportedPlatform + +def getRandomUnusedPort(addr=None): + free = False + while not free: + port = randint(1024, 65535) + s = socket.socket() + try: + s.bind((addr, port)) + free = True + except: + pass + s.close() + return port + +def getNonLoopbackIfaces(platform_name=None): + try: + ifaces = getIfaces(platform_name) + except UnsupportedPlatform, up: + log.err(up) + + if not ifaces: + log.msg("Unable to discover network interfaces...") + return None + else: + found = [{i[0]: i[2]} for i in ifaces if i[0] != 'lo'] + log.debug("Found non-loopback interfaces: %s" % found) + for iface in ifaces: + try: + interface = checkInterfaces(found) + except IfaceError, ie: + log.err(ie) + return None + else: + return interfaces + + +def getLocalAddress(): + default_iface = getDefaultIface() + return default_iface.ipaddr diff --git a/src/leap/mx/util/version.py b/src/leap/mx/util/version.py new file mode 100644 index 0000000..215876c --- /dev/null +++ b/src/leap/mx/util/version.py @@ -0,0 +1,101 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- +''' +version.py +---------- +Version information for leap_mx. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@licence: see included LICENSE file +@copyright: 2013 Isis Agora Lovecruft +''' + +import os +import sys + +from twisted.python import versions + +name = 'leap_mx' +version = versions.Version(name, 0, 0, 1, None) +authors = [('Isis Agora Lovecruft', '', '0x2cdb8b35'),] +git_url = 'https://github.com/isislovecruft/leap_mx/' +website = 'https://leap.se' + +PLATFORMS = {'LINUX': sys.platform.startswith("linux"), + 'OPENBSD': sys.platform.startswith("openbsd"), + 'FREEBSD': sys.platform.startswith("freebsd"), + 'NETBSD': sys.platform.startswith("netbsd"), + 'DARWIN': sys.platform.startswith("darwin"), + 'SOLARIS': sys.platform.startswith("sunos"), + 'WINDOWS': sys.platform.startswith("win32")} + +def getClientPlatform(platform_name=None): + """ + Determine the client's operating system platform. Optionally, if + :param:`platform_name` is given, check that this is indeed the platform + we're operating on. + + @param platform_name: A string, upper-, lower-, or mixed case, of one of + the keys in the :attr:`leap.util.version.PLATFORMS` dictionary. E.g. + 'Linux' or 'OPENBSD', etc. + @returns: A string specifying the platform name, and the boolean test used + to determine it. + """ + for name, test in PLATFORMS.items(): + if not platform_name or platform_name.upper() == name: + if test: + return name, test + +def getVersion(): + """ + Returns a version object, with attributes authors, git_url, and website. + """ + version.authors = authors + version.git_url = git_url + version.website = website + return version + +def getRepoDir(): + """ + Get the top-level repository directory. + """ + here = os.getcwd() + base = here.rsplit(name, 1)[0] + repo = os.path.join(base, name) + return repo + +def __make_text__(extra_text=None): + splitter = "-" * len(version.__str__()) + header = ["\n%s\n" % version.__str__(), "%s\n" % splitter] + footer = ["Website: \t%s\n" % website, "Github: \t%s\n" % git_url, "\n"] + contacts = ["\t%s, %s %s\n" % (a[0], a[1], a[2]) for a in authors] + contacts.insert(0, "Authors: ") + + with_contacts = header + contacts + + if extra_text is not None: + if isinstance(extra_text, iter): + with_contacts.extend((e for e in extra_text)) + elif isinstance(extra_text, str): + with_contacts.append(extra_text) + else: + print "Couldn't add extra text..." + + text = with_contacts + footer + return text + +def __update_version__(): + repo = getRepoDir() + version_file = os.path.join(repo, 'VERSION') + version_text = __make_text__() + + with open(version_file, 'w+') as fh: + fh.writelines((line for line in version_text)) + fh.flush() + fh.truncate() + + +if __name__ == "__main__": + print "Generating new VERSION file..." + __update_version__() + print "Done." diff --git a/src/leap/start_mx.py b/src/leap/start_mx.py new file mode 100755 index 0000000..59556f0 --- /dev/null +++ b/src/leap/start_mx.py @@ -0,0 +1,157 @@ +#!/usr/bin/env python +#-*- coding: utf-8 -*- +""" + ____ + | mx | + |____|_______________________ + | | + | An encrypting remailer. | + |_________________________| + +@author Isis Agora Lovecruft , 0x2cdb8b35 +@version 0.0.1 + +""" + +import os, sys + + +package_source = "/src" +application_name = "leap_mx" + +def __get_repo_dir__(): + """Get the absolute path of the top-level repository directory.""" + here = os.getcwd() + repo = here.rsplit(package_source, 1)[0] + leap = os.path.join(repo, package_source) + this = os.path.join(leap, application_name.replace('_', '/')) + return repo, leap, this + +## Set the $PYTHONPATH: +repo, leap, this = __get_repo_dir__() +srcdir = os.path.join(repo, 'src/') +sys.path[:] = map(os.path.abspath, sys.path) +sys.path.insert(0, leap) + +## Now we should be able to import ourselves without installation: +try: + from leap.mx import runner + from leap.mx.util import log, version +except ImportError, ie: + print "%s\nExiting..." % ie.message + sys.exit(1) + + +class CheckRequirements(ImportError): + """ + Raised when we're missing something from requirements.pip. + """ + def __init__(self, message=None, missing=None, pipfile=None): + """ + Display an error message with instructions for obtaining missing + dependencies. + + @param message: A string describing the error. + @param missing: A string indicating which dependency is missing. + @param pipfile: The path and filename of the pip requirements file, + relative to the top-level repository directory. + """ + if message: + self.message = message + return self + + self.pipfile = pipfile + + if isinstance(missing, str): + missing = [missing] + else: + missing = [] + dependencies = self.__read_pip_requirements__() + for package, version in dependencies: + pkg = package.lower() if package == "Twisted" else package + try: + __import__(pkg) + except ImportError: + missing.append(package) + + self.message = application_name + " requires " + if len(missing) > 1: + for missed in missing[:-1]: + self.message += missed + ", " + self.message += "and " + if len(missing) == 1: + self.message += missing[0] + "." + self.message += "\nPlease see %s for ".format(pipfile) + self.message += "instruction on installing dependencies." + raise self + elif len(missing) <= 0: + return + + def __read_pip_requirements__(self, file=None): + """ + Check the pip requirements file to determine our dependencies. + + @param file: The name of the pip requirements.txt file. + @returns: A list of tuple(package_name, package_version). + """ + import re + + if not file: + file = self.pipfile + + filepath = os.path.join(__get_repo_dir__(), file) + requirement = re.compile('[^0-9=><]+') + dependencies = [] + + print filepath + assert os.path.isfile(filepath), \ + "Couldn't find requirements.pip file!" + + with open(filepath) as pipfile: + for line in pipfile.readlines(): + shortened = line.strip() + matched = requirement.match(shortened) + package_name = matched.group() + package_version = shortened.split(package_name, 1)[1] + dependencies.append((package_name, package_version)) + + return dependencies + +dependency_check = CheckRequirements(pipfile='pkg/mx-requirements.pip') + +try: + from twisted.python import usage, runtime + from twisted.internet import reactor +except ImportError, ie: + print "CheckRequirements class is broken!:", ie.message + + +if __name__ == "__main__": + + log.start() + log.debug("Running %s, with Python %s" % (application_name, + runtime.shortPythonVersion())) + log.debug("Platform: %s" % runtime.platform.getType()) + log.debug("Thread support: %s" % str(runtime.platform.supportsThreads())) + + mx_options = MXOptions() + mx_options.parseOptions(sys.argv) + + if len(sys.argv) <= 0: + print mx_options.getUsage() + sys.exit(0) + else: + options = mx_options + + if options['verbose']: + config.basic.debug = True + + if options['test']: + from leap.mx import tests ## xxx this needs an __init__.py + tests.run() ## xxx need /leap/mx/tests.py + elif options['conf'] and os.path.isfile(options['conf']): + config.parse() ## xxx need /leap/mx/config.py + runner.run() ## xxx need /leap/mx/runner.py + else: + mx_options.getUsage() + sys.exit(1) diff --git a/src/leap/util/__init__.py b/src/leap/util/__init__.py deleted file mode 100644 index 35e1297..0000000 --- a/src/leap/util/__init__.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- encoding: utf-8 -*- -""" - mx/util/__init__.py - ------------------- - Initialization file for leap_mx utilities. Some miscellaneous things are - stored here also. -""" - - -class Storage(dict): - """ - A Storage object is like a dictionary except `obj.foo` can be used - in addition to `obj['foo']`. - - >>> o = Storage(a=1) - >>> o.a - 1 - >>> o['a'] - 1 - >>> o.a = 2 - >>> o['a'] - 2 - >>> del o.a - >>> o.a - None - """ - def __getattr__(self, key): - try: - return self[key] - except KeyError, k: - return None - - def __setattr__(self, key, value): - self[key] = value - - def __delattr__(self, key): - try: - del self[key] - except KeyError, k: - raise AttributeError, k - - def __repr__(self): - return '' - - def __getstate__(self): - return dict(self) - - def __setstate__(self, value): - for (k, v) in value.items(): - self[k] = v diff --git a/src/leap/util/config.py b/src/leap/util/config.py deleted file mode 100644 index 5bc5231..0000000 --- a/src/leap/util/config.py +++ /dev/null @@ -1,172 +0,0 @@ -#! -*- encoding: utf-8 -*- -""" -Config file utilities. - -This module has an :attr:`config_filename`, which can be used to set the -filename outside of function calls: - - >>> from leap.mx.util import config - >>> config.config_filename = "blahblah.yaml" - -If not set anywhere, it will default to using the top level repository -directory, i.e. "/.../leap_mx/leap_mx.conf", and will create that file with -the default settings if it does not exist. - -The config file can be loaded/created with :func:`config.loadConfig`: - - >>> config.loadConfig() - -Once the config file is loaded, this module presents a highly object-oriented -interface, so that sections taken from the config file become attribute of -this module, and the name of their respective settings become attributes of -the section names. Like this: - - >>> print config.basic.postfix_port - 465 - -@authors: Isis Lovecruft, 0x2cdb8b35 -@version: 0.0.1 -@license: see included LICENSE file -""" - -import os -import yaml - -## xxx only install/import this in *nix -from xdg import BaseDirectory - -from leap.util import log, version, Storage -from leap.util.exceptions import MissingConfig, UnsupportedOS - - -def _create_config_file(file): - """ - xxx fill me in - """ - with open(file, 'w+') as conf: - conf.write(""" -# -# mx.conf -# ======= -# Configurable options for the leap_mx encrypting mail exchange. -# -# This file follows YAML markup format: http://yaml.org/spec/1.2/spec.html -# Keep in mind that indentation matters. -# - -basic: - # Where is the spoolfile of messages to encrypt?: - spoolfile: /var/mail/encrypt_me -advanced: - # Which port on localhost should postfix send check_recipient queries to?: - check_recipient_access_port: 1347 - # Which port on localhost should postfix ask for UUIDs?: - virtual_alias_map_port: 1348 - # Enable debugging output in the logger: - debug: true - # Print enough things really fast to make you look super 1337: - noisy: false - -""") - conf.flush() - try: - assert os.path.isfile(file), "Config file %s not created!" % file - except AssertionError, ae: - raise SystemExit(ae.message) - else: - return file - -def _get_config_filename(filename=None, use_dot_config_directory=False): - """ - Get the full path and filename of the config file. - """ - platform = version.getClientPlatform()[0] - resource = version.name - - ## Oh hell, it could be said only to beguile: - ## That windoze users are capable of editing a .conf file. - ## Also, what maddened wingnut would be so fool - ## To run a mail exchange on a windoze nodule? - ## I'm ignoring these loons for now. And pardon if I seem jaded, - ## But srsly, this and that solaris sh*t should be deprecated. - if not platform.endswith('LINUX') and not platform.endswith('BSD'): - raise UnsupportedOS("Sorry, your operating system isn't supported.") - - ## If not given, default to the application's name + '.conf' - if not filename: - filename = resource + ".conf" - - where = None - if not use_dot_config_directory: - repo_dir = version.getRepoDir() - where = os.path.abspath(repo_dir) - ## Use ~/.config/ instead: - else: - dot_config_dirs = BaseDirectory.xdg_config_dirs - for dir in dot_config_dirs: - our_dir = os.path.join(dir, resource) - if os.path.isdir(our_dir): - if filename in os.listdir(our_dir): - where = os.path.abspath(our_dir) - if not where: - where = BaseDirectory.save_config_path(resource) - - conffile = os.path.join(where, filename) - try: - with open(conffile) as cf: pass - except IOError: - conffile = _create_config_file(conffile) - finally: - return conffile - -def loadConfig(filename=config_filename): - """ - Some of this is taken from OONI config code for now, and so this should be - refacotored, along with the leap_client config code, so that we have - similarly structured config files. It is perhaps desirable to also use - soledad as a backend for remote setup and maintainance, and thus this code - will need to hook into u1db (and potentially "pysqlcipher"). - - Excuse the yaml for now, I just wanted something that works. - - @param filename: (optional) If provided, use this filename. - """ - if not filename: - filename = _get_config_filename() - - if os.path.isfile(filename): - with open(filename, 'a+') as conf: - config_contents = '\n'.join(conf.readlines()) - configuration = yaml.safe_load(config_contents) - - ## These become objects with their keys loaded as attributes: - ## - ## from leap.util import config - ## config.basic.foo = bar - ## - basic = Storage() - try: - for k, v in configuration['basic'].items(): - basic[k] = v - except AttributeError: - pass - - advanced = Storage() - try: - for k, v in configuration['advanced'].items(): - advanced[k] = v - except AttributeError: - pass - - return basic, advanced - else: - raise MissingConfig("Could not load config file.") - - -## This is the name of the config file to use: -## If not set, it defaults to 'leap_mx/leap_mx.conf' -if not config_filename: - config_filename = _get_config_filename() -else: - config_filename = _get_config_filename(filename=config_filename) - diff --git a/src/leap/util/exceptions.py b/src/leap/util/exceptions.py deleted file mode 100644 index 63b946c..0000000 --- a/src/leap/util/exceptions.py +++ /dev/null @@ -1,23 +0,0 @@ -#! -*- encoding: utf-8 -*- -""" -Custom exceptions for leap_mx. - -@authors: Isis Lovecruft, 0x2cdb8b35 -@version: 0.0.1 -@license: see included LICENSE file -""" - - -class MissingConfig(Exception): - """Raised when the config file cannot be found.""" - def __init__(self, message=None, config_file=None): - if message: - return - else: - self.message = "Cannot locate config file" - if config_file: - self.message += " %s" % config_file - self.message += "." - -class UnsupportedOS(Exception): - """Raised when we're not *nix or *BSD.""" diff --git a/src/leap/util/log.py b/src/leap/util/log.py deleted file mode 100644 index ef54605..0000000 --- a/src/leap/util/log.py +++ /dev/null @@ -1,154 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- -''' -log.py ------- -Logging for leap_mx. - -@authors: Isis Agora Lovecruft, 0x2cdb8b35 -@licence: see included LICENSE file -@copyright: 2013 Isis Agora Lovecruft -''' - -from datetime import datetime -from functools import wraps - -import logging -import os -import sys -import time -import traceback - -from twisted.python import log as txlog -from twisted.python import util as txutil -from twisted.python.logfile import DailyLogFile -from twisted.python.failure import Failure - -from leap.util import version, config - - -class InvalidTimestampFormat(Exception): - pass - -class UnprefixedLogfile(txlog.FileLogObserver): - """Logfile with plain messages, without timestamp prefixes.""" - def emit(self, eventDict): - text = txlog.textFromEventDict(eventDict) - if text is None: - return - - txutil.untilConcludes(self.write, "%s\n" % text) - txutil.untilConcludes(self.flush) - - -def utcDateNow(): - """The current date for UTC time.""" - return datetime.utcnow() - -def utcTimeNow(): - """Seconds since epoch in UTC time, as type float.""" - return time.mktime(time.gmtime()) - -def dateToTime(date): - """Convert datetime to seconds since epoch.""" - return time.mktime(date.timetuple()) - -def prettyDateNow(): - """Pretty string for the local time.""" - return datetime.now().ctime() - -def utcPrettyDateNow(): - """Pretty string for UTC.""" - return datetime.utcnow().ctime() - -def timeToPrettyDate(time_val): - """Convert seconds since epoch to date.""" - return time.ctime(time_val) - -def start(logfile=None, application_name=None): - """ - Start logging to stdout, and optionally to a logfile as well. - - @param logfile: The filename to store logs in, which is placed in - /leap_mx/logs/. - @param application_name: The name of the running application. - """ - if not application_name: - application_name = version.name - print "application name: %s" % application_name - - daily_logfile = None - - if not logfile: - logfile = config.basic.logfile - - repo_dir = version.getRepoDir() - logfile_dir = os.path.join(repo_dir, 'log') - logfile_name = logfile - - daily_logfile = DailyLogFile(logfile_name, logfile_dir) - - txlog.startLoggingWithObserver(UnprefixedLogfile(sys.stdout).emit) - txlog.addObserver(txlog.FileLogObserver(daily_logfile).emit) - txlog.msg("Starting %s on %s (%s UTC)" % (application_name, - prettyDateNow(), - utcPrettyDateNow())) - -def msg(msg, *arg, **kwarg): - """Log a message at the INFO level.""" - print "[*] %s" % msg - -def debug(msg, *arg, **kwarg): - """Log a message at the DEBUG level.""" - if config.basic.debug: - print "[d] %s" % msg - -def warn(msg, *arg, **kwarg): - """Log a message at the WARN level.""" - if config.basic.show_warnings: - txlog.logging.captureWarnings('true') - print "[#] %s" % msg - -def err(msg, *arg, **kwarg): - """Log a message at the ERROR level.""" - print "[!] %s" % msg - -def fail(*failure): - """Log a message at the CRITICAL level.""" - logging.critical(failure) - ## xxx should we take steps to exit here? - -def exception(error): - """ - Catch an exception and print only the error message, then continue normal - program execution. - - @param error: Can be error messages printed to stdout and to the - logfile, or can be a twisted.python.failure.Failure instance. - """ - if isinstance(error, Failure): - error.printTraceback() - else: - exc_type, exc_value, exc_traceback = sys.exc_info() - traceback.print_exception(exc_type, exc_value, exc_traceback) - -def catch(func): - """ - Quick wrapper to add around test methods for debugging purposes, - catches the given Exception. Use like so: - - >>> @log.catch - def foo(bar): - if bar == 'baz': - raise Exception("catch me no matter what I am") - >>> foo("baz") - [!] catch me no matter what I am - - """ - @wraps(func) - def _catch(*args, **kwargs): - try: - func(*args, **kwargs) - except Exception, exc: - exception(exc) - return _catch diff --git a/src/leap/util/net.py b/src/leap/util/net.py deleted file mode 100644 index a4104d0..0000000 --- a/src/leap/util/net.py +++ /dev/null @@ -1,126 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- -''' -net.py -------- -Utilities for networking. - -@authors: Isis Agora Lovecruft, 0x2cdb8b35 -@license: see included LICENSE file -@copyright: 2013 Isis Agora Lovecruft -''' - -import ipaddr -import sys -import socket - -from random import randint - -from leap.mx.utils import log - - -PLATFORMS = {'LINUX': sys.platform.startswith("linux"), - 'OPENBSD': sys.platform.startswith("openbsd"), - 'FREEBSD': sys.platform.startswith("freebsd"), - 'NETBSD': sys.platform.startswith("netbsd"), - 'DARWIN': sys.platform.startswith("darwin"), - 'SOLARIS': sys.platform.startswith("sunos"), - 'WINDOWS': sys.platform.startswith("win32")} - - -class UnsupportedPlatform(Exception): - """Support for this platform is not currently available.""" - -class IfaceError(Exception): - """Could not find default network interface.""" - -class PermissionsError(SystemExit): - """This test requires admin or root privileges to run. Exiting...""" - - -def checkIPaddress(addr): - """ - Check that a given string is a valid IPv4 or IPv6 address. - - @param addr: Any string defining an IP address, i.e. '1.2.3.4' or '::1'. - @returns: True if :param:`addr` defines a valid IPAddress, else False. - """ - import ipaddr - - try: - check = ipaddr.IPAddress(addr) - except ValueError, ve: - log.warn(ve.message) - return False - else: - return True - -def getClientPlatform(platform_name=None): - for name, test in PLATFORMS.items(): - if not platform_name or platform_name.upper() == name: - if test: - return name, test - -def getPosixIfaces(): - from twisted.internet.test import _posixifaces - log.msg("Attempting to discover network interfaces...") - ifaces = _posixifaces._interfaces() - return ifaces - -def getWindowsIfaces(): - from twisted.internet.test import _win32ifaces - log.msg("Attempting to discover network interfaces...") - ifaces = _win32ifaces._interfaces() - return ifaces - -def getIfaces(platform_name=None): - client, test = getClientPlatform(platform_name) - if client: - if client == ('LINUX' or 'DARWIN') or client[-3:] == 'BSD': - return getPosixIfaces() - elif client == 'WINDOWS': - return getWindowsIfaces() - ## XXX fixme figure out how to get iface for Solaris - else: - raise UnsupportedPlatform - else: - raise UnsupportedPlatform - -def getRandomUnusedPort(addr=None): - free = False - while not free: - port = randint(1024, 65535) - s = socket.socket() - try: - s.bind((addr, port)) - free = True - except: - pass - s.close() - return port - -def getNonLoopbackIfaces(platform_name=None): - try: - ifaces = getIfaces(platform_name) - except UnsupportedPlatform, up: - log.err(up) - - if not ifaces: - log.msg("Unable to discover network interfaces...") - return None - else: - found = [{i[0]: i[2]} for i in ifaces if i[0] != 'lo'] - log.debug("Found non-loopback interfaces: %s" % found) - for iface in ifaces: - try: - interface = checkInterfaces(found) - except IfaceError, ie: - log.err(ie) - return None - else: - return interfaces - - -def getLocalAddress(): - default_iface = getDefaultIface() - return default_iface.ipaddr diff --git a/src/leap/util/version.py b/src/leap/util/version.py deleted file mode 100644 index 215876c..0000000 --- a/src/leap/util/version.py +++ /dev/null @@ -1,101 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- -''' -version.py ----------- -Version information for leap_mx. - -@authors: Isis Agora Lovecruft, 0x2cdb8b35 -@licence: see included LICENSE file -@copyright: 2013 Isis Agora Lovecruft -''' - -import os -import sys - -from twisted.python import versions - -name = 'leap_mx' -version = versions.Version(name, 0, 0, 1, None) -authors = [('Isis Agora Lovecruft', '', '0x2cdb8b35'),] -git_url = 'https://github.com/isislovecruft/leap_mx/' -website = 'https://leap.se' - -PLATFORMS = {'LINUX': sys.platform.startswith("linux"), - 'OPENBSD': sys.platform.startswith("openbsd"), - 'FREEBSD': sys.platform.startswith("freebsd"), - 'NETBSD': sys.platform.startswith("netbsd"), - 'DARWIN': sys.platform.startswith("darwin"), - 'SOLARIS': sys.platform.startswith("sunos"), - 'WINDOWS': sys.platform.startswith("win32")} - -def getClientPlatform(platform_name=None): - """ - Determine the client's operating system platform. Optionally, if - :param:`platform_name` is given, check that this is indeed the platform - we're operating on. - - @param platform_name: A string, upper-, lower-, or mixed case, of one of - the keys in the :attr:`leap.util.version.PLATFORMS` dictionary. E.g. - 'Linux' or 'OPENBSD', etc. - @returns: A string specifying the platform name, and the boolean test used - to determine it. - """ - for name, test in PLATFORMS.items(): - if not platform_name or platform_name.upper() == name: - if test: - return name, test - -def getVersion(): - """ - Returns a version object, with attributes authors, git_url, and website. - """ - version.authors = authors - version.git_url = git_url - version.website = website - return version - -def getRepoDir(): - """ - Get the top-level repository directory. - """ - here = os.getcwd() - base = here.rsplit(name, 1)[0] - repo = os.path.join(base, name) - return repo - -def __make_text__(extra_text=None): - splitter = "-" * len(version.__str__()) - header = ["\n%s\n" % version.__str__(), "%s\n" % splitter] - footer = ["Website: \t%s\n" % website, "Github: \t%s\n" % git_url, "\n"] - contacts = ["\t%s, %s %s\n" % (a[0], a[1], a[2]) for a in authors] - contacts.insert(0, "Authors: ") - - with_contacts = header + contacts - - if extra_text is not None: - if isinstance(extra_text, iter): - with_contacts.extend((e for e in extra_text)) - elif isinstance(extra_text, str): - with_contacts.append(extra_text) - else: - print "Couldn't add extra text..." - - text = with_contacts + footer - return text - -def __update_version__(): - repo = getRepoDir() - version_file = os.path.join(repo, 'VERSION') - version_text = __make_text__() - - with open(version_file, 'w+') as fh: - fh.writelines((line for line in version_text)) - fh.flush() - fh.truncate() - - -if __name__ == "__main__": - print "Generating new VERSION file..." - __update_version__() - print "Done." -- cgit v1.2.3 From 503af34d34233d771769499d2398378dd7a96df3 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 15 Feb 2013 19:28:33 +0000 Subject: Fixed (I think) the markdown on the subheader links in the README.md. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8864866..05422c2 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ leap_mx An asynchronous, transparently-encrypting remailer for the LEAP platform, using BigCouch/CouchDB and PGP/GnuPG, written in Twisted Python. -## [install](#install) ## {#install} +## [install](#install) {#install} ## ========================= **tl;dr:** To get started quickly do: @@ -15,7 +15,7 @@ An asynchronous, transparently-encrypting remailer for the LEAP platform, using Although, **it is advised** to install inside a python virtualenv. To install python, virtualenv, and get started, do: ~~~ -$ sudo apt-get install python2.7 python-pip virtualenv +$ sudo apt-get install python2.7 python-pip python-virtualenv python-dev $ pip install virtualenvwrapper $ cd $ git clone https://github.com/isislovecruft/leap_mx.git leap_mx @@ -25,7 +25,7 @@ $ mkvirtualenv -a $WORKON_LEAPMX -r ${WORKON_LEAPMX}/requirements.txt \ --no-site-packages --setuptools --unzip-setuptools leap_mx ~~~ -## [running](#running) ## {#running} +## [running](#running) {#running} ## ========================= Hold your horses, boy. This isn't ready yet -- check back later! -- cgit v1.2.3 From 280b713e4d9b35e3feae0902b7b8ff6d5542f68a Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 15 Feb 2013 19:32:32 +0000 Subject: Updated the pip requirements file with a note to add a requirement for whatever python-gnupg ends up being called after it's uploaded to pypi. --- pkg/mx-requirements.pip | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pkg/mx-requirements.pip b/pkg/mx-requirements.pip index 12a6287..aa8c63b 100644 --- a/pkg/mx-requirements.pip +++ b/pkg/mx-requirements.pip @@ -2,3 +2,5 @@ Twisted==12.2.0 paisley>=0.3.1 PyYAML>=3.10 pyxdg>=0.19-5 +## xxx change me to whatever you name the package in pypi +#python-gnupg>=0.3.0 -- cgit v1.2.3 From 2fc0d3ffaae3681177e023cd7a8a77b5ead8a403 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 15 Feb 2013 19:34:31 +0000 Subject: Add missing __init__.py file to src/. --- src/__init__.py | 1 + 1 file changed, 1 insertion(+) create mode 100644 src/__init__.py diff --git a/src/__init__.py b/src/__init__.py new file mode 100644 index 0000000..a4d511a --- /dev/null +++ b/src/__init__.py @@ -0,0 +1 @@ +__all__ = ['leap'] -- cgit v1.2.3 From b32d659b85901a8e04c6c921928483fda3b3e6e0 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 15 Feb 2013 19:36:43 +0000 Subject: Add the storage utility for parsing the config file structure in a more readable fashion. --- src/leap/mx/util/storage.py | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 src/leap/mx/util/storage.py diff --git a/src/leap/mx/util/storage.py b/src/leap/mx/util/storage.py new file mode 100644 index 0000000..c4c797a --- /dev/null +++ b/src/leap/mx/util/storage.py @@ -0,0 +1,42 @@ + +class Storage(dict): + """ + A Storage object is like a dictionary except `obj.foo` can be used + in addition to `obj['foo']`. + + >>> o = Storage(a=1) + >>> o.a + 1 + >>> o['a'] + 1 + >>> o.a = 2 + >>> o['a'] + 2 + >>> del o.a + >>> o.a + None + """ + def __getattr__(self, key): + try: + return self[key] + except KeyError, k: + return None + + def __setattr__(self, key, value): + self[key] = value + + def __delattr__(self, key): + try: + del self[key] + except KeyError, k: + raise AttributeError, k + + def __repr__(self): + return '' + + def __getstate__(self): + return dict(self) + + def __setstate__(self, value): + for (k, v) in value.items(): + self[k] = v -- cgit v1.2.3 From 73d33d4caac1cd5e0be63584f72de92742a2c91a Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 22:54:53 +0000 Subject: Cleaned up version tracking and printing. --- src/leap/__init__.py | 29 ++++++++--------------------- 1 file changed, 8 insertions(+), 21 deletions(-) diff --git a/src/leap/__init__.py b/src/leap/__init__.py index 8846fbc..8b30f3d 100644 --- a/src/leap/__init__.py +++ b/src/leap/__init__.py @@ -1,25 +1,12 @@ # -*- encoding: utf-8 -*- +""" +leap/__init__.py +---------------- +Module intialization file for leap. +""" -__all__ = ['mx'] -__author__ = version.authors -__version__ = version.getVersion() - -from leap import mx -from leap.mx import util from leap.mx.util import version - -def _print_authors_nicely(): - if hasattr(version, 'authors'): - assert isinstance(version.authors, list) - if len(version.authors) > 0: - first = version.authors.pop() - __author__ = (" ".join(first[:2])) - if len(version.authors) > 0: - for auth in version.authors: - joined = " ".join(auth[:2]) - __author__ += ("\n%s" % joined) - - -print "Version: %s" % version.getVersion() -print "Authors: %s" % _print_authors_nicely() +__all__ = ['mx'] +__author__ = version.getAuthors() +__version__ = version.getVersion() -- cgit v1.2.3 From 0ceaf9ac207e4d0716c0aa9c6bb4b5871d8d7292 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 22:57:08 +0000 Subject: Cleaned up versioning to have more easily parsable public methods. * Changed most of version.py to be in class Version, without importing any twisted code (so that runner.CheckRequirements can check for it first) and so that leap/mx/util/__init__.py can do: import version version = version.Version() to expost only the public methods. * Moved client detection platform code to leap/mx/util/config.py. --- src/leap/mx/util/__init__.py | 13 +++- src/leap/mx/util/version.py | 158 +++++++++++++++++++++---------------------- 2 files changed, 88 insertions(+), 83 deletions(-) diff --git a/src/leap/mx/util/__init__.py b/src/leap/mx/util/__init__.py index c8448b0..c4a93b8 100644 --- a/src/leap/mx/util/__init__.py +++ b/src/leap/mx/util/__init__.py @@ -1 +1,12 @@ -__all__ = ['config', 'exceptions', 'log', 'net', 'version, storage'] +#-*- encoding: utf-8 -*- +""" +leap/mx/util/__init__.py +------------------------ +Module intialization file for leap.mx.util. +""" + +import version +version = version.Version() + +__all__ = ['config', 'log', 'net', 'storage', 'version'] + diff --git a/src/leap/mx/util/version.py b/src/leap/mx/util/version.py index 215876c..c32166f 100644 --- a/src/leap/mx/util/version.py +++ b/src/leap/mx/util/version.py @@ -10,92 +10,86 @@ Version information for leap_mx. @copyright: 2013 Isis Agora Lovecruft ''' -import os +from os import getcwd +from os import path as ospath + import sys -from twisted.python import versions - -name = 'leap_mx' -version = versions.Version(name, 0, 0, 1, None) -authors = [('Isis Agora Lovecruft', '', '0x2cdb8b35'),] -git_url = 'https://github.com/isislovecruft/leap_mx/' -website = 'https://leap.se' - -PLATFORMS = {'LINUX': sys.platform.startswith("linux"), - 'OPENBSD': sys.platform.startswith("openbsd"), - 'FREEBSD': sys.platform.startswith("freebsd"), - 'NETBSD': sys.platform.startswith("netbsd"), - 'DARWIN': sys.platform.startswith("darwin"), - 'SOLARIS': sys.platform.startswith("sunos"), - 'WINDOWS': sys.platform.startswith("win32")} - -def getClientPlatform(platform_name=None): - """ - Determine the client's operating system platform. Optionally, if - :param:`platform_name` is given, check that this is indeed the platform - we're operating on. - - @param platform_name: A string, upper-, lower-, or mixed case, of one of - the keys in the :attr:`leap.util.version.PLATFORMS` dictionary. E.g. - 'Linux' or 'OPENBSD', etc. - @returns: A string specifying the platform name, and the boolean test used - to determine it. - """ - for name, test in PLATFORMS.items(): - if not platform_name or platform_name.upper() == name: - if test: - return name, test - -def getVersion(): - """ - Returns a version object, with attributes authors, git_url, and website. - """ - version.authors = authors - version.git_url = git_url - version.website = website - return version - -def getRepoDir(): - """ - Get the top-level repository directory. - """ - here = os.getcwd() - base = here.rsplit(name, 1)[0] - repo = os.path.join(base, name) - return repo - -def __make_text__(extra_text=None): - splitter = "-" * len(version.__str__()) - header = ["\n%s\n" % version.__str__(), "%s\n" % splitter] - footer = ["Website: \t%s\n" % website, "Github: \t%s\n" % git_url, "\n"] - contacts = ["\t%s, %s %s\n" % (a[0], a[1], a[2]) for a in authors] - contacts.insert(0, "Authors: ") - - with_contacts = header + contacts - - if extra_text is not None: - if isinstance(extra_text, iter): - with_contacts.extend((e for e in extra_text)) - elif isinstance(extra_text, str): - with_contacts.append(extra_text) - else: - print "Couldn't add extra text..." - - text = with_contacts + footer - return text - -def __update_version__(): - repo = getRepoDir() - version_file = os.path.join(repo, 'VERSION') - version_text = __make_text__() - - with open(version_file, 'w+') as fh: - fh.writelines((line for line in version_text)) - fh.flush() - fh.truncate() + +class Version(object): + def __init__(self): + self.name = 'leap_mx' + self.version = '0.0.2' + self.pipfile = ospath.join(self.getRepoDir(), + 'pkg/mx-requirements.pip') + self.authors = [ + ('Isis Agora Lovecruft', '', '0x2cdb8b35'), + ] + self.git_url = 'https://github.com/isislovecruft/leap_mx/' + self.website = 'https://leap.se' + + def getPackageName(self): + """Returns the application name.""" + return self.name + + def getPipfile(self): + """Returns the full path of the pip requirements.txt file.""" + return self.pipfile + + def getVersion(self): + """Returns a version the application name and version number.""" + return self.version + + def getAuthors(self): + credits = str() + for author in self.authors: + credits += " ".join(author) + return credits + + def getRepoDir(self): + """Get the top-level repository directory.""" + here = getcwd() + base = here.rsplit(self.name, 1)[0] + repo = ospath.join(base, self.name) + return repo + + def __make_text__(self, extra_text=None): + splitr = "-" * len(self.version.__str__()) + header = ["\n%s\n" % self.version.__str__(), + "%s\n" % splitr] + footer = ["Website: \t%s\n" % self.website, + "Github: \t%s\n" % self.git_url, + "\n"] + contacts = ["\t%s, %s %s\n" + % (a[0], a[1], a[2]) for a in self.authors] + contacts.insert(0, "Authors: ") + + with_contacts = header + contacts + + if extra_text is not None: + if isinstance(extra_text, iter): + with_contacts.extend((e for e in extra_text)) + elif isinstance(extra_text, str): + with_contacts.append(extra_text) + else: + print "Couldn't add extra text..." + + text = with_contacts + footer + return text + + def __update_version__(self): + repo = self.getRepoDir() + self.version_file = ospath.join(repo, 'VERSION') + version_text = self.__make_text__() + + with open(self.version_file, 'w+') as fh: + fh.writelines((line for line in version_text)) + fh.flush() + fh.truncate() if __name__ == "__main__": print "Generating new VERSION file..." - __update_version__() + vrsn = Version() + vrsn.__update_version__() print "Done." -- cgit v1.2.3 From 92ab44a213b88b510e9d86865a3630fa0b664313 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:02:26 +0000 Subject: Moved leap/mx/util/exceptions.py to leap/mx/exceptions.py. --- src/leap/mx/exceptions.py | 23 +++++++++++++++++++++++ src/leap/mx/util/exceptions.py | 23 ----------------------- 2 files changed, 23 insertions(+), 23 deletions(-) create mode 100644 src/leap/mx/exceptions.py delete mode 100644 src/leap/mx/util/exceptions.py diff --git a/src/leap/mx/exceptions.py b/src/leap/mx/exceptions.py new file mode 100644 index 0000000..63b946c --- /dev/null +++ b/src/leap/mx/exceptions.py @@ -0,0 +1,23 @@ +#! -*- encoding: utf-8 -*- +""" +Custom exceptions for leap_mx. + +@authors: Isis Lovecruft, 0x2cdb8b35 +@version: 0.0.1 +@license: see included LICENSE file +""" + + +class MissingConfig(Exception): + """Raised when the config file cannot be found.""" + def __init__(self, message=None, config_file=None): + if message: + return + else: + self.message = "Cannot locate config file" + if config_file: + self.message += " %s" % config_file + self.message += "." + +class UnsupportedOS(Exception): + """Raised when we're not *nix or *BSD.""" diff --git a/src/leap/mx/util/exceptions.py b/src/leap/mx/util/exceptions.py deleted file mode 100644 index 63b946c..0000000 --- a/src/leap/mx/util/exceptions.py +++ /dev/null @@ -1,23 +0,0 @@ -#! -*- encoding: utf-8 -*- -""" -Custom exceptions for leap_mx. - -@authors: Isis Lovecruft, 0x2cdb8b35 -@version: 0.0.1 -@license: see included LICENSE file -""" - - -class MissingConfig(Exception): - """Raised when the config file cannot be found.""" - def __init__(self, message=None, config_file=None): - if message: - return - else: - self.message = "Cannot locate config file" - if config_file: - self.message += " %s" % config_file - self.message += "." - -class UnsupportedOS(Exception): - """Raised when we're not *nix or *BSD.""" -- cgit v1.2.3 From d925c51439a85d552afaca58fc1f87a8745c3c16 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:03:46 +0000 Subject: Add exceptions and util to leap/mx/__init__.py. --- src/leap/mx/__init__.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/leap/mx/__init__.py b/src/leap/mx/__init__.py index 507efee..27fadca 100644 --- a/src/leap/mx/__init__.py +++ b/src/leap/mx/__init__.py @@ -1,3 +1,8 @@ -#from . import util +#-*- encoding: utf-8 -*- +""" +leap/mx/__init__.py +------------------- +Module intialization file for leap.mx . +""" -__all__ = ['alias_resolver', 'runner', 'tests', 'couchdb'] +__all__ = ['alias_resolver', 'couchdb', 'exceptions', 'runner', 'util'] -- cgit v1.2.3 From f995e157d65dbefea59b64366cb82c0ed30669f2 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:05:15 +0000 Subject: Remove unnecessary file src/__init__.py. --- src/__init__.py | 1 - 1 file changed, 1 deletion(-) delete mode 100644 src/__init__.py diff --git a/src/__init__.py b/src/__init__.py deleted file mode 100644 index a4d511a..0000000 --- a/src/__init__.py +++ /dev/null @@ -1 +0,0 @@ -__all__ = ['leap'] -- cgit v1.2.3 From 73ee880147dfd2dd5f6e553069028ea32ffc1a53 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:06:24 +0000 Subject: Fix typo in leap/mx/util/net.py. --- src/leap/mx/util/net.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/leap/mx/util/net.py b/src/leap/mx/util/net.py index a4104d0..64dbc90 100644 --- a/src/leap/mx/util/net.py +++ b/src/leap/mx/util/net.py @@ -16,7 +16,7 @@ import socket from random import randint -from leap.mx.utils import log +from leap.mx.util import log PLATFORMS = {'LINUX': sys.platform.startswith("linux"), -- cgit v1.2.3 From 91d70343acecb1b2225cf94024d738c053eff4c3 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:13:08 +0000 Subject: Fix imports in leap/mx/util/config.py to not import all of os. --- src/leap/mx/util/config.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index 5bc5231..5be66b1 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -29,7 +29,9 @@ the section names. Like this: @license: see included LICENSE file """ -import os +from os import path as ospath + +import sys import yaml ## xxx only install/import this in *nix -- cgit v1.2.3 From d3bc6e22b618771e02b2941f573759a8021e8752 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:15:31 +0000 Subject: Fix imports in leap/mx/util/config.py to reflect move of util/ directory, and setup default config storage.Storage() modified dictionary objects for YAML configs. --- src/leap/mx/util/config.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index 5be66b1..3eb4cdb 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -34,12 +34,13 @@ from os import path as ospath import sys import yaml -## xxx only install/import this in *nix -from xdg import BaseDirectory +from leap.mx.util import version, storage +from leap.mx.exceptions import MissingConfig, UnsupportedOS -from leap.util import log, version, Storage -from leap.util.exceptions import MissingConfig, UnsupportedOS +filename = None +basic = storage.Storage() +advanced = storage.Storage() def _create_config_file(file): """ -- cgit v1.2.3 From 2773a3d35a2c87100da520b7e947d1d77f52e134 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:18:57 +0000 Subject: Moved client platform detection code to leap/mx/util/config.py. * Remove extraneous storage.Storage() initializations. * Autosetup calls to config._get_config_location based on whether config.filename has been set elsewhere. --- src/leap/mx/util/config.py | 44 ++++++++++++++++++++++++++++++-------------- 1 file changed, 30 insertions(+), 14 deletions(-) diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index 3eb4cdb..9bf90e8 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -42,11 +42,36 @@ filename = None basic = storage.Storage() advanced = storage.Storage() -def _create_config_file(file): +PLATFORMS = {'LINUX': sys.platform.startswith("linux"), + 'OPENBSD': sys.platform.startswith("openbsd"), + 'FREEBSD': sys.platform.startswith("freebsd"), + 'NETBSD': sys.platform.startswith("netbsd"), + 'DARWIN': sys.platform.startswith("darwin"), + 'SOLARIS': sys.platform.startswith("sunos"), + 'WINDOWS': sys.platform.startswith("win32")} + +def getClientPlatform(platform_name=None): + """ + Determine the client's operating system platform. Optionally, if + :param:`platform_name` is given, check that this is indeed the platform + we're operating on. + + @param platform_name: A string, upper-, lower-, or mixed case, of one + of the keys in the :attr:`leap.util.version.PLATFORMS` + dictionary. E.g. 'Linux' or 'OPENBSD', etc. + @returns: A string specifying the platform name, and the boolean test + used to determine it. + """ + for name, test in PLATFORMS.items(): + if not platform_name or platform_name.upper() == name: + if test: + return name, test + +def _create_config_file(conffile): """ xxx fill me in """ - with open(file, 'w+') as conf: + with open(conffile, 'w+') as conf: conf.write(""" # # mx.conf @@ -72,12 +97,6 @@ advanced: """) conf.flush() - try: - assert os.path.isfile(file), "Config file %s not created!" % file - except AssertionError, ae: - raise SystemExit(ae.message) - else: - return file def _get_config_filename(filename=None, use_dot_config_directory=False): """ @@ -147,14 +166,12 @@ def loadConfig(filename=config_filename): ## from leap.util import config ## config.basic.foo = bar ## - basic = Storage() try: for k, v in configuration['basic'].items(): basic[k] = v except AttributeError: pass - advanced = Storage() try: for k, v in configuration['advanced'].items(): advanced[k] = v @@ -168,8 +185,7 @@ def loadConfig(filename=config_filename): ## This is the name of the config file to use: ## If not set, it defaults to 'leap_mx/leap_mx.conf' -if not config_filename: - config_filename = _get_config_filename() +if not filename: + filename = _get_config_location() else: - config_filename = _get_config_filename(filename=config_filename) - + filename = _get_config_location(config_filename=filename) -- cgit v1.2.3 From f02e6aa89d5a22182b5906ea7053eabc7d20ecb9 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:21:50 +0000 Subject: Add new parameters 'enable_logfile', 'logfile', 'debug', and 'noisy' to the default config creation template. --- src/leap/mx/util/config.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index 9bf90e8..cb548f6 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -83,6 +83,10 @@ def _create_config_file(conffile): # basic: + # Whether or not to log to file: + enable_logfile: True + # The name of the logfile: + logfile: mx.log # Where is the spoolfile of messages to encrypt?: spoolfile: /var/mail/encrypt_me advanced: @@ -91,9 +95,9 @@ advanced: # Which port on localhost should postfix ask for UUIDs?: virtual_alias_map_port: 1348 # Enable debugging output in the logger: - debug: true + debug: True # Print enough things really fast to make you look super 1337: - noisy: false + noisy: False """) conf.flush() -- cgit v1.2.3 From 031a0024c4350e5fb79ffd5ed3533c6a23600749 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:23:32 +0000 Subject: Fix discovery of xdg .config directory on *nix systems, and use that path for our config file if it exists. --- src/leap/mx/util/config.py | 59 +++++++++++++++++++++++++--------------------- 1 file changed, 32 insertions(+), 27 deletions(-) diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index cb548f6..e5db591 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -102,12 +102,21 @@ advanced: """) conf.flush() -def _get_config_filename(filename=None, use_dot_config_directory=False): + assert ospath.isfile(conffile), "Config file %s not created!" % conffile + +def _get_config_location(config_filename=None, + use_dot_config_directory=False): """ Get the full path and filename of the config file. """ - platform = version.getClientPlatform()[0] - resource = version.name + platform = getClientPlatform()[0] + + ## If not given, default to the application's name + '.conf' + if not config_filename: + if not filename: + config_filename = "mx.conf" + else: + config_filename = filename ## Oh hell, it could be said only to beguile: ## That windoze users are capable of editing a .conf file. @@ -118,34 +127,30 @@ def _get_config_filename(filename=None, use_dot_config_directory=False): if not platform.endswith('LINUX') and not platform.endswith('BSD'): raise UnsupportedOS("Sorry, your operating system isn't supported.") - ## If not given, default to the application's name + '.conf' - if not filename: - filename = resource + ".conf" - where = None - if not use_dot_config_directory: - repo_dir = version.getRepoDir() - where = os.path.abspath(repo_dir) - ## Use ~/.config/ instead: - else: + if use_dot_config_directory: + ## xxx only install/import this in *nix + from xdg import BaseDirectory + dot_config_dirs = BaseDirectory.xdg_config_dirs for dir in dot_config_dirs: - our_dir = os.path.join(dir, resource) - if os.path.isdir(our_dir): - if filename in os.listdir(our_dir): - where = os.path.abspath(our_dir) - if not where: - where = BaseDirectory.save_config_path(resource) - - conffile = os.path.join(where, filename) + our_dir = ospath.join(dir, package_name) + if ospath.isdir(our_dir): + if config_filename in os.listdir(our_dir): + where = ospath.abspath(our_dir) + ## Use repo dir instead: + if not where: + where = version.getRepoDir() + + conffile = ospath.join(where, config_filename) try: with open(conffile) as cf: pass except IOError: - conffile = _create_config_file(conffile) + _create_config_file(conffile) finally: return conffile -def loadConfig(filename=config_filename): +def loadConfig(file=None): """ Some of this is taken from OONI config code for now, and so this should be refacotored, along with the leap_client config code, so that we have @@ -155,13 +160,13 @@ def loadConfig(filename=config_filename): Excuse the yaml for now, I just wanted something that works. - @param filename: (optional) If provided, use this filename. + @param file: (optional) If provided, use this filename. """ - if not filename: - filename = _get_config_filename() + if not file: + file = _get_config_location() - if os.path.isfile(filename): - with open(filename, 'a+') as conf: + if ospath.isfile(file): + with open(file, 'a+') as conf: config_contents = '\n'.join(conf.readlines()) configuration = yaml.safe_load(config_contents) -- cgit v1.2.3 From 3cd39505708819a2d70dd5b91f8d1de81e89181e Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:27:18 +0000 Subject: Fix log.start() function in leap/mx/util/log.py to properly use the xdg directory if that was discovered in config setup. * Updated imports to reflect directory layout changes, again. --- src/leap/mx/util/log.py | 39 ++++++++++++++------------------------- 1 file changed, 14 insertions(+), 25 deletions(-) diff --git a/src/leap/mx/util/log.py b/src/leap/mx/util/log.py index ef54605..02ceddf 100644 --- a/src/leap/mx/util/log.py +++ b/src/leap/mx/util/log.py @@ -1,4 +1,3 @@ -#!/usr/bin/env python # -*- encoding: utf-8 -*- ''' log.py @@ -21,10 +20,10 @@ import traceback from twisted.python import log as txlog from twisted.python import util as txutil -from twisted.python.logfile import DailyLogFile +from twisted.python import logfile as txlogfile from twisted.python.failure import Failure -from leap.util import version, config +from leap.mx.util import version, config class InvalidTimestampFormat(Exception): @@ -65,34 +64,24 @@ def timeToPrettyDate(time_val): """Convert seconds since epoch to date.""" return time.ctime(time_val) -def start(logfile=None, application_name=None): +def start(logfilename=None, logfiledir=None): """ Start logging to stdout, and optionally to a logfile as well. - @param logfile: The filename to store logs in, which is placed in - /leap_mx/logs/. - @param application_name: The name of the running application. + @param logfile: The full path of the filename to store logs in. """ - if not application_name: - application_name = version.name - print "application name: %s" % application_name - - daily_logfile = None - - if not logfile: - logfile = config.basic.logfile - - repo_dir = version.getRepoDir() - logfile_dir = os.path.join(repo_dir, 'log') - logfile_name = logfile + txlog.startLoggingWithObserver(UnprefixedLogfile(sys.stdout).emit) - daily_logfile = DailyLogFile(logfile_name, logfile_dir) + if logfilename and logfiledir: + if not os.path.isdir(logfiledir): + os.makedirs(logfiledir) + daily_logfile = txlogfile.DailyLogFile(logfilename, logfiledir) + txlog.addObserver(txlog.FileLogObserver(daily_logfile).emit) - txlog.startLoggingWithObserver(UnprefixedLogfile(sys.stdout).emit) - txlog.addObserver(txlog.FileLogObserver(daily_logfile).emit) - txlog.msg("Starting %s on %s (%s UTC)" % (application_name, - prettyDateNow(), - utcPrettyDateNow())) + txlog.msg("Starting %s, version %s, on %s UTC" % (version.getPackageName(), + version.getVersion(), + utcPrettyDateNow())) + txlog.msg("Authors: %s" % version.getAuthors()) def msg(msg, *arg, **kwarg): """Log a message at the INFO level.""" -- cgit v1.2.3 From bd4b080b63493a180cb979f1cda952e7927a7c15 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:28:46 +0000 Subject: Fix a bug in log.debug() where it was checking for the config setting in the wrong section of the config. --- src/leap/mx/util/log.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/leap/mx/util/log.py b/src/leap/mx/util/log.py index 02ceddf..f31684d 100644 --- a/src/leap/mx/util/log.py +++ b/src/leap/mx/util/log.py @@ -89,7 +89,7 @@ def msg(msg, *arg, **kwarg): def debug(msg, *arg, **kwarg): """Log a message at the DEBUG level.""" - if config.basic.debug: + if config.advanced.debug: print "[d] %s" % msg def warn(msg, *arg, **kwarg): -- cgit v1.2.3 From ff7cf6677b6170afe30eb3ec332ee3767bea07ca Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:29:58 +0000 Subject: Remove old start script. --- src/leap/start_mx.py | 157 --------------------------------------------------- 1 file changed, 157 deletions(-) delete mode 100755 src/leap/start_mx.py diff --git a/src/leap/start_mx.py b/src/leap/start_mx.py deleted file mode 100755 index 59556f0..0000000 --- a/src/leap/start_mx.py +++ /dev/null @@ -1,157 +0,0 @@ -#!/usr/bin/env python -#-*- coding: utf-8 -*- -""" - ____ - | mx | - |____|_______________________ - | | - | An encrypting remailer. | - |_________________________| - -@author Isis Agora Lovecruft , 0x2cdb8b35 -@version 0.0.1 - -""" - -import os, sys - - -package_source = "/src" -application_name = "leap_mx" - -def __get_repo_dir__(): - """Get the absolute path of the top-level repository directory.""" - here = os.getcwd() - repo = here.rsplit(package_source, 1)[0] - leap = os.path.join(repo, package_source) - this = os.path.join(leap, application_name.replace('_', '/')) - return repo, leap, this - -## Set the $PYTHONPATH: -repo, leap, this = __get_repo_dir__() -srcdir = os.path.join(repo, 'src/') -sys.path[:] = map(os.path.abspath, sys.path) -sys.path.insert(0, leap) - -## Now we should be able to import ourselves without installation: -try: - from leap.mx import runner - from leap.mx.util import log, version -except ImportError, ie: - print "%s\nExiting..." % ie.message - sys.exit(1) - - -class CheckRequirements(ImportError): - """ - Raised when we're missing something from requirements.pip. - """ - def __init__(self, message=None, missing=None, pipfile=None): - """ - Display an error message with instructions for obtaining missing - dependencies. - - @param message: A string describing the error. - @param missing: A string indicating which dependency is missing. - @param pipfile: The path and filename of the pip requirements file, - relative to the top-level repository directory. - """ - if message: - self.message = message - return self - - self.pipfile = pipfile - - if isinstance(missing, str): - missing = [missing] - else: - missing = [] - dependencies = self.__read_pip_requirements__() - for package, version in dependencies: - pkg = package.lower() if package == "Twisted" else package - try: - __import__(pkg) - except ImportError: - missing.append(package) - - self.message = application_name + " requires " - if len(missing) > 1: - for missed in missing[:-1]: - self.message += missed + ", " - self.message += "and " - if len(missing) == 1: - self.message += missing[0] + "." - self.message += "\nPlease see %s for ".format(pipfile) - self.message += "instruction on installing dependencies." - raise self - elif len(missing) <= 0: - return - - def __read_pip_requirements__(self, file=None): - """ - Check the pip requirements file to determine our dependencies. - - @param file: The name of the pip requirements.txt file. - @returns: A list of tuple(package_name, package_version). - """ - import re - - if not file: - file = self.pipfile - - filepath = os.path.join(__get_repo_dir__(), file) - requirement = re.compile('[^0-9=><]+') - dependencies = [] - - print filepath - assert os.path.isfile(filepath), \ - "Couldn't find requirements.pip file!" - - with open(filepath) as pipfile: - for line in pipfile.readlines(): - shortened = line.strip() - matched = requirement.match(shortened) - package_name = matched.group() - package_version = shortened.split(package_name, 1)[1] - dependencies.append((package_name, package_version)) - - return dependencies - -dependency_check = CheckRequirements(pipfile='pkg/mx-requirements.pip') - -try: - from twisted.python import usage, runtime - from twisted.internet import reactor -except ImportError, ie: - print "CheckRequirements class is broken!:", ie.message - - -if __name__ == "__main__": - - log.start() - log.debug("Running %s, with Python %s" % (application_name, - runtime.shortPythonVersion())) - log.debug("Platform: %s" % runtime.platform.getType()) - log.debug("Thread support: %s" % str(runtime.platform.supportsThreads())) - - mx_options = MXOptions() - mx_options.parseOptions(sys.argv) - - if len(sys.argv) <= 0: - print mx_options.getUsage() - sys.exit(0) - else: - options = mx_options - - if options['verbose']: - config.basic.debug = True - - if options['test']: - from leap.mx import tests ## xxx this needs an __init__.py - tests.run() ## xxx need /leap/mx/tests.py - elif options['conf'] and os.path.isfile(options['conf']): - config.parse() ## xxx need /leap/mx/config.py - runner.run() ## xxx need /leap/mx/runner.py - else: - mx_options.getUsage() - sys.exit(1) -- cgit v1.2.3 From b6a4e1936f101c078ed6816eb73e148e1dab0f76 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:33:40 +0000 Subject: Update .gitignore file to exclude logs/ directory. --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 2f7e605..0cc9f85 100644 --- a/.gitignore +++ b/.gitignore @@ -40,3 +40,6 @@ nosetests.xml # Ignore emacs temporary files *~ \#*\# + +# Ignore client logfiles +*.log -- cgit v1.2.3 From b712b428c595686b187b1c188552b5c66ad684a7 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:35:38 +0000 Subject: Update .gitignore to exclude config files. --- .gitignore | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 0cc9f85..0519df8 100644 --- a/.gitignore +++ b/.gitignore @@ -41,5 +41,7 @@ nosetests.xml *~ \#*\# -# Ignore client logfiles +# Ignore client logfiles and configs *.log +*.conf +*.config -- cgit v1.2.3 From bc57191ce66b66b20fd21871a136ad84721b3a7b Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:36:07 +0000 Subject: Add new version of leap/mx/util/runner.py file. --- src/leap/mx/runner.py | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 src/leap/mx/runner.py diff --git a/src/leap/mx/runner.py b/src/leap/mx/runner.py new file mode 100644 index 0000000..daf956e --- /dev/null +++ b/src/leap/mx/runner.py @@ -0,0 +1,83 @@ +#-*- coding: utf-8 -*- +""" +runner +------ +A module containing application and daemon process utilities. + +@author Isis Agora Lovecruft , 0x2cdb8b35 +@version 0.0.1 + +""" + +from os import path as ospath + +import re + + +class CheckRequirements(ImportError): + """ + Raised when we're missing something from requirements.pip. + """ + def __init__(self, package_name, pipfile, message=None): + """ + Display an error message with instructions for obtaining missing + dependencies. + + @param message: A string describing the error. + @param missing: A string indicating which dependency is missing. + @param pipfile: The path and filename of the pip requirements file, + relative to the top-level repository directory. + """ + if message: + self.message = message + return self + + self.package_name = package_name + self.pipfile = pipfile + self.dependencies = self.__read_pip_requirements__() + self.missing = [] + + for package, version in self.dependencies: + pkg = package.lower() if package == "Twisted" else package + try: + __import__(pkg) + except ImportError: + self.missing.append(package) + + if len(self.missing) > 0: + self.message = self.package_name + " requires " + elif len(self.missing) <= 0: + return None + + if len(self.missing) >= 1: + for missed in self.missing[:-1]: + self.message += missed + ", " + self.message += "and " + + if len(self.missing) == 1: + self.message += self.missing[0] + "." + self.message += "\nPlease see %s for ".format(self.pipfile) + self.message += "instruction on installing dependencies." + raise self(self.message) + + def __read_pip_requirements__(self, file=None): + """ + Check the pip requirements file to determine our dependencies. + + @param file: The full path of the pip requirements.txt file. + @returns: A list of tuple(package_name, package_version). + """ + if not file: + file = self.pipfile + + requirement = re.compile('[^0-9=><]+') + dependencies = [] + + with open(file) as pipfile: + for line in pipfile.readlines(): + shortened = line.strip() + matched = requirement.match(shortened) + package_name = matched.group() + package_version = shortened.split(package_name, 1)[1] + dependencies.append((package_name, package_version)) + return dependencies -- cgit v1.2.3 From 1bf1763e5fed2e886d3f9cc26c0198f0b890dd50 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sat, 16 Feb 2013 23:36:59 +0000 Subject: Add new start script. * TODO: The new start script still need an usage.Options() class. --- start_mx.py | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100755 start_mx.py diff --git a/start_mx.py b/start_mx.py new file mode 100755 index 0000000..b4d7f9d --- /dev/null +++ b/start_mx.py @@ -0,0 +1,90 @@ +#!/usr/bin/env python +#-*- coding: utf-8 -*- +""" + ____ + | mx | + |____|_______________________ + | | + | An encrypting remailer. | + |_________________________| + +@author Isis Agora Lovecruft , 0x2cdb8b35 +@version 0.0.1 + +""" + +from os import getcwd +from os import path as ospath + +import sys + +application_name = "leap_mx" + +def __get_dirs__(): + """Get the absolute path of the top-level repository directory.""" + here = getcwd() + base = here.rsplit(application_name, 1)[0] + repo = ospath.join(base, application_name) + leap = ospath.join(repo, 'src') + ours = ospath.join(leap, application_name.replace('_', '/')) + return repo, leap, ours + + +if __name__ == "__main__": + ## Set the $PYTHONPATH: + repo, leap, ours = __get_dirs__() + sys.path[:] = map(ospath.abspath, sys.path) + sys.path.insert(0, leap) + + ## Now we should be able to import ourselves without installation: + try: + from leap.mx import runner + from leap.mx.util import config, log, version + except ImportError, ie: + print "%s\nExiting...\n" % ie.message + sys.exit(1) + + config.filename = 'mx.conf' + config.loadConfig() + + ## xxx fixme version requires twisted... + dependency_check = runner.CheckRequirements(version.getPackageName(), + version.getPipfile()) + + from twisted.python import usage, runtime + from twisted.internet import reactor + + if config.basic.enable_logfile: + logfilename = config.basic.logfile + logfilepath = ospath.join(repo, 'logs') + log.start(logfilename, logfilepath) + else: + log.start() + + log.msg("Testing logging functionality") + log.debug("Running %s, with Python %s" + % (application_name, runtime.shortPythonVersion())) + log.debug("Platform: %s" % runtime.platform.getType()) + log.debug("Thread support: %s" % str(runtime.platform.supportsThreads())) + + mx_options = MXOptions() + mx_options.parseOptions(sys.argv) + + if len(sys.argv) <= 0: + print mx_options.getUsage() + sys.exit(0) + else: + options = mx_options + + if options['verbose']: + config.basic.debug = True + + if options['test']: + from leap.mx import tests ## xxx this needs an __init__.py + tests.run() ## xxx need /leap/mx/tests.py + elif options['conf'] and os.path.isfile(options['conf']): + config.parse() + runner.run() + else: + mx_options.getUsage() + sys.exit(1) -- cgit v1.2.3 From 340392e50b04d2c795e6d84d632590b26188feee Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sun, 17 Feb 2013 00:03:58 +0000 Subject: Add update mechanism to config files to allow new default configs to be pushed to the git repo later without breaking past versions. --- src/leap/mx/util/config.py | 51 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 15 deletions(-) diff --git a/src/leap/mx/util/config.py b/src/leap/mx/util/config.py index e5db591..f655ca9 100644 --- a/src/leap/mx/util/config.py +++ b/src/leap/mx/util/config.py @@ -38,9 +38,11 @@ from leap.mx.util import version, storage from leap.mx.exceptions import MissingConfig, UnsupportedOS -filename = None -basic = storage.Storage() -advanced = storage.Storage() +filename = None +config_version = None +basic = storage.Storage() +couch = storage.Storage() +advanced = storage.Storage() PLATFORMS = {'LINUX': sys.platform.startswith("linux"), 'OPENBSD': sys.platform.startswith("openbsd"), @@ -69,7 +71,9 @@ def getClientPlatform(platform_name=None): def _create_config_file(conffile): """ - xxx fill me in + Create the config file if it doesn't exist. + + @param conffile: The full path to the config file to write to. """ with open(conffile, 'w+') as conf: conf.write(""" @@ -89,6 +93,15 @@ basic: logfile: mx.log # Where is the spoolfile of messages to encrypt?: spoolfile: /var/mail/encrypt_me +couch: + # The couch username for authentication to a CouchDB instance: + user: admin + # The couch username's password: + passwd: passwd + # The CouchDB hostname or IP address to connect to: + host: couchdb.example.com + # The CouchDB port to connect to: + port: 7001 advanced: # Which port on localhost should postfix send check_recipient queries to?: check_recipient_access_port: 1347 @@ -98,10 +111,10 @@ advanced: debug: True # Print enough things really fast to make you look super 1337: noisy: False +config_version: 0.0.2 """) conf.flush() - assert ospath.isfile(conffile), "Config file %s not created!" % conffile def _get_config_location(config_filename=None, @@ -168,26 +181,34 @@ def loadConfig(file=None): if ospath.isfile(file): with open(file, 'a+') as conf: config_contents = '\n'.join(conf.readlines()) - configuration = yaml.safe_load(config_contents) + cfg = yaml.safe_load(config_contents) ## These become objects with their keys loaded as attributes: ## ## from leap.util import config ## config.basic.foo = bar ## - try: - for k, v in configuration['basic'].items(): + try: + for k, v in cfg['basic'].items(): basic[k] = v - except AttributeError: - pass + except (AttributeError, KeyError): pass - try: - for k, v in configuration['advanced'].items(): + try: + for k, v in cfg['advanced'].items(): advanced[k] = v - except AttributeError: - pass + except (AttributeError, KeyError): pass + + try: + for k, v in cfg['couch'].items(): + couch[k] = v + except (AttributeError, KeyError): pass + + if 'config_version' in cfg: + config_version = cfg['config_version'] + else: + config_version = 'unknown' - return basic, advanced + return basic, couch, advanced, config_version else: raise MissingConfig("Could not load config file.") -- cgit v1.2.3 From de5e6ca37ff48b11f8215788974e2e9cee04fb3e Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sun, 17 Feb 2013 04:17:25 +0000 Subject: Cleaned up documentation and added option handling class for the start script. --- start_mx.py | 143 +++++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 99 insertions(+), 44 deletions(-) diff --git a/start_mx.py b/start_mx.py index b4d7f9d..79943d9 100755 --- a/start_mx.py +++ b/start_mx.py @@ -1,23 +1,29 @@ #!/usr/bin/env python #-*- coding: utf-8 -*- """ - ____ - | mx | - |____|_______________________ - | | - | An encrypting remailer. | - |_________________________| - -@author Isis Agora Lovecruft , 0x2cdb8b35 -@version 0.0.1 + ____ + | MX |_________________________ + ___|____| An encrypting remailer |________ + | |__________________________| | + | is designed for use on a mail exchange | + | with OpenPGP implementations and Postfix, | + | and is part of the Leap Encryption Access | + | Project platform. | + |___________________________________________| + + authors: Isis Agora Lovecruft, 0x2cdb8b35 + license: AGPLv3, see included LICENCE file. + copyright: copyright (c) 2013 Isis Agora Lovecruft """ -from os import getcwd -from os import path as ospath +from __future__ import print_function +from os import getcwd +from os import path as ospath import sys + application_name = "leap_mx" def __get_dirs__(): @@ -29,62 +35,111 @@ def __get_dirs__(): ours = ospath.join(leap, application_name.replace('_', '/')) return repo, leap, ours +## Set the $PYTHONPATH: +repo, leap, ours = __get_dirs__() +sys.path[:] = map(ospath.abspath, sys.path) +sys.path.insert(0, leap) + +## Now we should be able to import ourselves without installation: +try: + from leap.mx import runner + from leap.mx.util import config, log, version +except ImportError, ie: + print("%s \nExiting... \n" % ie.message) + sys.exit(1) + +try: + from twisted.python import usage, runtime + from twisted.python.util import spewer +except ImportError, ie: + print("This software requires Twisted>=12.0.2, please see the README for") + print("help on using virtualenv and pip to obtain requirements.") + + +class MXOptions(usage.Options): + """ + Command line options for leap_mx. + """ + #longdesc = str(" ") + optParameters = [ + ['config', 'c', 'mx.conf', 'Config file to use'],] + optFlags = [ + ['all-tests', 'a', 'Run all unittests'], + ['verbose', 'v', 'Increase logging verbosity'],] + + def opt_version(self): + """ + Print leap_mx version and exit + """ + print("Version: %s" % version.getVersion()) + sys.exit(0) -if __name__ == "__main__": - ## Set the $PYTHONPATH: - repo, leap, ours = __get_dirs__() - sys.path[:] = map(ospath.abspath, sys.path) - sys.path.insert(0, leap) + def opt_help(self): + """ + Print this cruft + """ + import __main__ + print("%s" % __main__.__doc__) + self.getUsage() - ## Now we should be able to import ourselves without installation: - try: - from leap.mx import runner - from leap.mx.util import config, log, version - except ImportError, ie: - print "%s\nExiting...\n" % ie.message - sys.exit(1) + def opt_spewer(self): + """ + Print *all of the things*. Useful for debugging. + """ + sys.settrace(spewer) + + def parseArgs(self): + """ + Called with the remaining commandline options which were unrecognised. + """ + log.warn("Couldn't recognise option: %s" % self) - config.filename = 'mx.conf' - config.loadConfig() - ## xxx fixme version requires twisted... +if __name__ == "__main__": dependency_check = runner.CheckRequirements(version.getPackageName(), version.getPipfile()) + mx_options = MXOptions() + if len(sys.argv) <= 1: + mx_options.opt_help() + sys.exit(0) - from twisted.python import usage, runtime - from twisted.internet import reactor + try: + mx_options.parseOptions() + except UsageError, ue: + print("%s" % ue.message) + sys.exit(1) + + options = mx_options.opts + + ## Get the config settings: + config.filename = options['config'] + config.loadConfig() if config.basic.enable_logfile: + ## Log to file: logfilename = config.basic.logfile logfilepath = ospath.join(repo, 'logs') log.start(logfilename, logfilepath) else: + ## Otherwise just log to stdout: log.start() log.msg("Testing logging functionality") - log.debug("Running %s, with Python %s" - % (application_name, runtime.shortPythonVersion())) - log.debug("Platform: %s" % runtime.platform.getType()) - log.debug("Thread support: %s" % str(runtime.platform.supportsThreads())) - - mx_options = MXOptions() - mx_options.parseOptions(sys.argv) - - if len(sys.argv) <= 0: - print mx_options.getUsage() - sys.exit(0) + if runtime.platform.supportsThreads(): + thread_support = "with thread support." else: - options = mx_options + thread_support = "without thread support." + log.debug("Running %s, with Python %s on %s platform %s" + % (application_name, runtime.shortPythonVersion(), + runtime.platform.getType(), thread_support)) + if options['verbose']: config.basic.debug = True if options['test']: from leap.mx import tests ## xxx this needs an __init__.py - tests.run() ## xxx need /leap/mx/tests.py - elif options['conf'] and os.path.isfile(options['conf']): - config.parse() - runner.run() + tests.run() else: mx_options.getUsage() sys.exit(1) -- cgit v1.2.3 From c9aa79c427c215ebc3abf2b9b9260739aef68b50 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sun, 17 Feb 2013 14:33:53 +0000 Subject: Move credit and license info out of __main__.__doc__ so that it's not crufting up the screen everytime we run start_mx.py. --- start_mx.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/start_mx.py b/start_mx.py index 79943d9..37ac5c0 100755 --- a/start_mx.py +++ b/start_mx.py @@ -10,12 +10,11 @@ | and is part of the Leap Encryption Access | | Project platform. | |___________________________________________| - - authors: Isis Agora Lovecruft, 0x2cdb8b35 - license: AGPLv3, see included LICENCE file. - copyright: copyright (c) 2013 Isis Agora Lovecruft - """ + # authors: Isis Agora Lovecruft, 0x2cdb8b35 + # license: AGPLv3, see included LICENCE file. + # copyright: copyright (c) 2013 Isis Agora Lovecruft + from __future__ import print_function from os import getcwd -- cgit v1.2.3 From f3bf0f6649fd6774e2e2a6abdd7f130f1f677401 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sun, 17 Feb 2013 14:35:04 +0000 Subject: Add a check for python3.0. --- start_mx.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/start_mx.py b/start_mx.py index 37ac5c0..7b8fc8a 100755 --- a/start_mx.py +++ b/start_mx.py @@ -34,6 +34,13 @@ def __get_dirs__(): ours = ospath.join(leap, application_name.replace('_', '/')) return repo, leap, ours +## py3k check, snagged from python-gnupg-0.3.2 by Vinay Sajip +try: + unicode + _py3k = False +except NameError: + _py3k = True + ## Set the $PYTHONPATH: repo, leap, ours = __get_dirs__() sys.path[:] = map(ospath.abspath, sys.path) -- cgit v1.2.3 From 49bf21c80939e8a5d83cd2d73323ab821de391dc Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sun, 17 Feb 2013 14:36:04 +0000 Subject: Set the traceback recursion when running in debug mode higher so that we can follow exceptions better. --- start_mx.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/start_mx.py b/start_mx.py index 7b8fc8a..fe0b23b 100755 --- a/start_mx.py +++ b/start_mx.py @@ -55,7 +55,7 @@ except ImportError, ie: sys.exit(1) try: - from twisted.python import usage, runtime + from twisted.python import usage, runtime, failure from twisted.python.util import spewer except ImportError, ie: print("This software requires Twisted>=12.0.2, please see the README for") @@ -139,9 +139,10 @@ if __name__ == "__main__": % (application_name, runtime.shortPythonVersion(), runtime.platform.getType(), thread_support)) - if options['verbose']: config.basic.debug = True + failure.traceupLength = 7 + failure.startDebugMode() if options['test']: from leap.mx import tests ## xxx this needs an __init__.py -- cgit v1.2.3 From d4e936461f996dbffafcc34b761ec1024055c906 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sun, 17 Feb 2013 14:37:38 +0000 Subject: Clean up the options parser and documentation. --- start_mx.py | 48 +++++++++++++++++++++--------------------------- 1 file changed, 21 insertions(+), 27 deletions(-) diff --git a/start_mx.py b/start_mx.py index fe0b23b..7837add 100755 --- a/start_mx.py +++ b/start_mx.py @@ -63,58 +63,52 @@ except ImportError, ie: class MXOptions(usage.Options): - """ - Command line options for leap_mx. - """ - #longdesc = str(" ") + """Command line options for leap_mx.""" + optParameters = [ - ['config', 'c', 'mx.conf', 'Config file to use'],] + ['config', 'c', 'mx.conf', 'Config file to use']] optFlags = [ ['all-tests', 'a', 'Run all unittests'], - ['verbose', 'v', 'Increase logging verbosity'],] + ['verbose', 'v', 'Increase logging verbosity']] def opt_version(self): - """ - Print leap_mx version and exit - """ - print("Version: %s" % version.getVersion()) + """Print leap_mx version and exit.""" + print("Authors: %s" % version.getAuthors()) + print("Licence: AGPLv3, see included LICENSE file") + print("Copyright: © 2013 Isis Lovecruft, see included COPYLEFT file") + print("Version: %s" % version.getVersion()) sys.exit(0) - def opt_help(self): - """ - Print this cruft - """ - import __main__ - print("%s" % __main__.__doc__) - self.getUsage() - def opt_spewer(self): - """ - Print *all of the things*. Useful for debugging. - """ + """Print *all of the things*. Useful for debugging.""" sys.settrace(spewer) def parseArgs(self): - """ - Called with the remaining commandline options which were unrecognised. - """ + """Called with the remaining unrecognised commandline options.""" log.warn("Couldn't recognise option: %s" % self) if __name__ == "__main__": dependency_check = runner.CheckRequirements(version.getPackageName(), version.getPipfile()) + ## the following trickery is for printing the module docstring + ## *before* the options help, and printing it only once: + import __main__ + print("%s" % __main__.__doc__) + __main__.__doc__ = (""" +Example Usage: + $ start_mx.py --config="./my-mx.conf" --spewer +""") + mx_options = MXOptions() if len(sys.argv) <= 1: mx_options.opt_help() sys.exit(0) - try: mx_options.parseOptions() - except UsageError, ue: + except usage.UsageError, ue: print("%s" % ue.message) sys.exit(1) - options = mx_options.opts ## Get the config settings: -- cgit v1.2.3 From 8d2fdc800de469420005f9c5deee4c342950ccc9 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Sun, 17 Feb 2013 14:38:14 +0000 Subject: Add an __init__.py to the leap/mx/tests module with a boilerplated tests.run() function so that the options parser doesn't choke on it. --- src/leap/mx/tests/__init__.py | 17 +++++++++++++++++ start_mx.py | 4 ++-- 2 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 src/leap/mx/tests/__init__.py diff --git a/src/leap/mx/tests/__init__.py b/src/leap/mx/tests/__init__.py new file mode 100644 index 0000000..0416769 --- /dev/null +++ b/src/leap/mx/tests/__init__.py @@ -0,0 +1,17 @@ +#-*- encoding: utf-8 -*- +""" +leap/mx/tests/__init__.py +------------------------- +Module intialization file for leap.mx.tests, a module containing unittesting +code, using twisted.trial, for testing leap_mx. + +@authors: Isis Agora Lovecruft, 0x2cdb8b35 +@license: AGPLv3, see included LICENSE file +@copyright: © 2013 Isis Lovecruft, see COPYLEFT file +""" + +__all__ = ['test_alias_resolver'] + +def run(): + """xxx fill me in""" + pass diff --git a/start_mx.py b/start_mx.py index 7837add..d45209c 100755 --- a/start_mx.py +++ b/start_mx.py @@ -138,8 +138,8 @@ Example Usage: failure.traceupLength = 7 failure.startDebugMode() - if options['test']: - from leap.mx import tests ## xxx this needs an __init__.py + if options['all-tests']: + from leap.mx import tests tests.run() else: mx_options.getUsage() -- cgit v1.2.3