summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIsis Lovecruft <isis@torproject.org>2013-02-17 15:23:54 +0000
committerIsis Lovecruft <isis@torproject.org>2013-02-17 15:23:54 +0000
commit66d60a58ef752f9c9692dd8bdb0f61a5c1dfdb17 (patch)
tree016980342b8e2610f0010efddcab489a8d30db0a
parent364200c25e28d4996024dcf2f0644f5f20cde9ae (diff)
parent8d2fdc800de469420005f9c5deee4c342950ccc9 (diff)
Merge branch 'feature/check-recipient' into develop
-rw-r--r--.gitignore9
-rw-r--r--COPYLEFT13
-rw-r--r--LICENSE620
-rw-r--r--NOTES.md11
-rw-r--r--README.md6
-rw-r--r--VERSION.md (renamed from VERSION)0
-rw-r--r--leap/__init__.py9
-rw-r--r--leap/mx/alias_resolver.py118
-rw-r--r--leap/util/version.py69
-rw-r--r--pkg/mx-requirements.pip6
-rw-r--r--requirements.txt2
-rw-r--r--src/leap/__init__.py12
-rw-r--r--src/leap/mx/__init__.py8
-rw-r--r--src/leap/mx/alias_resolver.py275
-rw-r--r--src/leap/mx/couchdb.py118
-rw-r--r--src/leap/mx/exceptions.py23
-rw-r--r--src/leap/mx/runner.py83
-rw-r--r--src/leap/mx/tests/__init__.py17
-rw-r--r--src/leap/mx/util/__init__.py12
-rw-r--r--src/leap/mx/util/config.py221
-rw-r--r--src/leap/mx/util/log.py143
-rw-r--r--src/leap/mx/util/net.py (renamed from leap/util/net.py)19
-rw-r--r--src/leap/mx/util/storage.py42
-rw-r--r--src/leap/mx/util/version.py95
-rwxr-xr-xstart_mx.py146
25 files changed, 1874 insertions, 203 deletions
diff --git a/.gitignore b/.gitignore
index 283f175..0519df8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -36,3 +36,12 @@ nosetests.xml
# Don't upload private things
*.private
+
+# Ignore emacs temporary files
+*~
+\#*\#
+
+# Ignore client logfiles and configs
+*.log
+*.conf
+*.config
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. <http://fsf.org/>
+ 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
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/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!
diff --git a/VERSION b/VERSION.md
index b756111..b756111 100644
--- a/VERSION
+++ b/VERSION.md
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 2263de5..0000000
--- a/leap/mx/alias_resolver.py
+++ /dev/null
@@ -1,118 +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: WTFPL see included LICENSE file
-@copyright: copyright 2013 Isis Agora Lovecruft
-'''
-
-import os
-
-from twisted.internet import address
-from twisted.mail import maildir
-from twisted.protocols import postfix
-
-from leap.mx import net, log
-
-
-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. '0.0.0.0', '::1', or '1.2.3.4'.
- @returns:
- True if :param:`addr` defines a valid IPAddress, False otherwise.
- """
- import ipaddr
-
- try:
- check = ipaddr.IPAddress(addr)
- except ValueError, ve:
- log.warn(ve.message)
- return False
- else:
- return True
-
-class PostfixAliasResolver(postfix.PostfixTCPMapServer):
- """
- Resolve postfix aliases, similarly to using "$ postmap -q <alias>".
-
- 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 <key> 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
- self.noisy = False ## xxx get config value
-
- 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 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/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, <isis@leap.se> 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', '<isis@leap.se>', '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/pkg/mx-requirements.pip b/pkg/mx-requirements.pip
new file mode 100644
index 0000000..aa8c63b
--- /dev/null
+++ b/pkg/mx-requirements.pip
@@ -0,0 +1,6 @@
+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
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
diff --git a/src/leap/__init__.py b/src/leap/__init__.py
new file mode 100644
index 0000000..8b30f3d
--- /dev/null
+++ b/src/leap/__init__.py
@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+"""
+leap/__init__.py
+----------------
+Module intialization file for leap.
+"""
+
+from leap.mx.util import version
+
+__all__ = ['mx']
+__author__ = version.getAuthors()
+__version__ = version.getVersion()
diff --git a/src/leap/mx/__init__.py b/src/leap/mx/__init__.py
new file mode 100644
index 0000000..27fadca
--- /dev/null
+++ b/src/leap/mx/__init__.py
@@ -0,0 +1,8 @@
+#-*- encoding: utf-8 -*-
+"""
+leap/mx/__init__.py
+-------------------
+Module intialization file for leap.mx .
+"""
+
+__all__ = ['alias_resolver', 'couchdb', 'exceptions', 'runner', 'util']
diff --git a/src/leap/mx/alias_resolver.py b/src/leap/mx/alias_resolver.py
new file mode 100644
index 0000000..e079b80
--- /dev/null
+++ b/src/leap/mx/alias_resolver.py
@@ -0,0 +1,275 @@
+#!/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
+
+TODO:
+
+ o Look into using twisted.protocols.postfix.policies classes for
+ controlling concurrent connections and throttling resource consumption.
+
+ o alias.ProcessAlias()
+
+## have uuid -> get gpg keyid
+
+alias.ProcessAlias('/path/to/mail_reciever', *args)
+
+'''
+
+import os
+import uuid
+
+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 Twisted. Please see the README file"
+ print "for instructions on getting required dependencies."
+
+from leap.mx.util import net, log, config, exceptions
+
+
+def createUUID(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 StatusCodes(object):
+ """
+ The Postfix manual states:
+
+ 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).
+
+ 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 <alias>".
+
+ 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 <key> tcp:localhost:1347
+
+ Resources:
+ http://www.postfix.org/proxymap.8.html
+ https://www.iana.org/assignments/smtp-enhanced-status-codes/
+ """
+ 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)
+
+ @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):
+ """
+ Delete an alias from the mapping database.
+
+ xxx not sure if this is a good idea...
+ """
+ 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:
+ self.sendCode(550)
+ else:
+ self.sendCode(250, quote(value))
+
+ def _cbNot(self, fail):
+ """Errback for self.get()"""
+ self.sendCode(554, fail.getErrorMessage())
+
+ 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 :class:`AliasResolver` servers, which handles inputs
+ and outputs, and keeps an in-memory mapping of Postfix aliases in the form
+ of a dictionary.
+
+ xxx fill me in
+ """
+ protocol = AliasResolver
+
+ def __init__(self, addr='127.0.0.1', port=4242, timeout=120, data=None):
+ """
+ Create a Factory which returns :class:`AliasResolver` servers.
+
+ @param addr: A string giving the IP address of this server.
+ Default: '127.0.0.1'
+ @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: A dict to use to initialise or update the alias mapping.
+ """
+ super(postfix.PostfixTCPMapDeferringDictServerFactory,
+ self).__init__(data=data)
+ self.timeout = timeout
+ self.noisy = True if config.advanced.noisy else 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.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:`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__":
+
+ print "To test alias_resolver.py, please use /test/test_alias_resolver.py"
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...")
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, <isis@leap.se> 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/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 <isis@leap.se>, 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
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, <isis@leap.se> 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/src/leap/mx/util/__init__.py b/src/leap/mx/util/__init__.py
new file mode 100644
index 0000000..c4a93b8
--- /dev/null
+++ b/src/leap/mx/util/__init__.py
@@ -0,0 +1,12 @@
+#-*- 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/config.py b/src/leap/mx/util/config.py
new file mode 100644
index 0000000..f655ca9
--- /dev/null
+++ b/src/leap/mx/util/config.py
@@ -0,0 +1,221 @@
+#! -*- 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, <isis@leap.se> 0x2cdb8b35
+@version: 0.0.1
+@license: see included LICENSE file
+"""
+
+from os import path as ospath
+
+import sys
+import yaml
+
+from leap.mx.util import version, storage
+from leap.mx.exceptions import MissingConfig, UnsupportedOS
+
+
+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"),
+ '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):
+ """
+ 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("""
+#
+# 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:
+ # 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
+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
+ # 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
+config_version: 0.0.2
+
+""")
+ conf.flush()
+ 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 = 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.
+ ## 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.")
+
+ where = None
+ 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 = 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:
+ _create_config_file(conffile)
+ finally:
+ return conffile
+
+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
+ 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 file: (optional) If provided, use this filename.
+ """
+ if not file:
+ file = _get_config_location()
+
+ if ospath.isfile(file):
+ with open(file, 'a+') as conf:
+ config_contents = '\n'.join(conf.readlines())
+ 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 cfg['basic'].items():
+ basic[k] = v
+ except (AttributeError, KeyError): pass
+
+ try:
+ for k, v in cfg['advanced'].items():
+ advanced[k] = v
+ 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, couch, advanced, config_version
+ 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 filename:
+ filename = _get_config_location()
+else:
+ filename = _get_config_location(config_filename=filename)
diff --git a/src/leap/mx/util/log.py b/src/leap/mx/util/log.py
new file mode 100644
index 0000000..f31684d
--- /dev/null
+++ b/src/leap/mx/util/log.py
@@ -0,0 +1,143 @@
+# -*- encoding: utf-8 -*-
+'''
+log.py
+------
+Logging for leap_mx.
+
+@authors: Isis Agora Lovecruft, <isis@leap.se> 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 import logfile as txlogfile
+from twisted.python.failure import Failure
+
+from leap.mx.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(logfilename=None, logfiledir=None):
+ """
+ Start logging to stdout, and optionally to a logfile as well.
+
+ @param logfile: The full path of the filename to store logs in.
+ """
+ txlog.startLoggingWithObserver(UnprefixedLogfile(sys.stdout).emit)
+
+ 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.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."""
+ print "[*] %s" % msg
+
+def debug(msg, *arg, **kwarg):
+ """Log a message at the DEBUG level."""
+ if config.advanced.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/leap/util/net.py b/src/leap/mx/util/net.py
index 10e72a4..64dbc90 100644
--- a/leap/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"),
@@ -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:
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 '<Storage ' + dict.__repr__(self) + '>'
+
+ def __getstate__(self):
+ return dict(self)
+
+ def __setstate__(self, value):
+ for (k, v) in value.items():
+ self[k] = v
diff --git a/src/leap/mx/util/version.py b/src/leap/mx/util/version.py
new file mode 100644
index 0000000..c32166f
--- /dev/null
+++ b/src/leap/mx/util/version.py
@@ -0,0 +1,95 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+'''
+version.py
+----------
+Version information for leap_mx.
+
+@authors: Isis Agora Lovecruft, <isis@leap.se> 0x2cdb8b35
+@licence: see included LICENSE file
+@copyright: 2013 Isis Agora Lovecruft
+'''
+
+from os import getcwd
+from os import path as ospath
+
+import sys
+
+
+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', '<isis@leap.se>', '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..."
+ vrsn = Version()
+ vrsn.__update_version__()
+ print "Done."
diff --git a/start_mx.py b/start_mx.py
new file mode 100755
index 0000000..d45209c
--- /dev/null
+++ b/start_mx.py
@@ -0,0 +1,146 @@
+#!/usr/bin/env python
+#-*- coding: utf-8 -*-
+"""
+ ____
+ | 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, <isis@leap.se> 0x2cdb8b35
+ # license: AGPLv3, see included LICENCE file.
+ # copyright: copyright (c) 2013 Isis Agora Lovecruft
+
+
+from __future__ import print_function
+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
+
+## 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)
+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, failure
+ 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."""
+
+ 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("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_spewer(self):
+ """Print *all of the things*. Useful for debugging."""
+ sys.settrace(spewer)
+
+ def parseArgs(self):
+ """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 usage.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")
+ if runtime.platform.supportsThreads():
+ thread_support = "with thread support."
+ else:
+ 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
+ failure.traceupLength = 7
+ failure.startDebugMode()
+
+ if options['all-tests']:
+ from leap.mx import tests
+ tests.run()
+ else:
+ mx_options.getUsage()
+ sys.exit(1)