[Pkg-privacy-commits] [onionbalance] 01/117: Inital commit, very buggy!
Donncha O'Cearbahill
donncha-guest at moszumanska.debian.org
Wed Dec 16 23:18:40 UTC 2015
This is an automated email from the git hooks/post-receive script.
donncha-guest pushed a commit to branch debian/sid
in repository onionbalance.
commit a8b970c7799a106440facd0ab9f0b19220a16e57
Author: Donncha O'Cearbhaill <donncha at donncha.is>
Date: Thu Apr 2 11:34:19 2015 +0100
Inital commit, very buggy!
---
.gitignore | 58 ++++
COPYING | 675 +++++++++++++++++++++++++++++++++++++++++
README.md | 83 +++++
config.yaml.example | 16 +
doc/torrc | 4 +
onion-balance/config.py | 16 +
onion-balance/descriptor.py | 192 ++++++++++++
onion-balance/eventhandler.py | 61 ++++
onion-balance/hiddenservice.py | 241 +++++++++++++++
onion-balance/log.py | 17 ++
onion-balance/manager.py | 156 ++++++++++
onion-balance/util.py | 111 +++++++
requirements.txt | 4 +
13 files changed, 1634 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..f58e4c3
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,58 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Config files and keys
+*.yaml
+*.key
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..10926e8
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,675 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 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 General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is 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. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ 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.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ 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 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. Use with the GNU Affero General Public License.
+
+ 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 Affero 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 special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU 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 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 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 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
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU 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 General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4eafe3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,83 @@
+# OnionBalance
+
+WARNING: THIS IS VERY EXPERIMENTAL, ROUGH CODE. THIS IS NOT READY TO BE USED
+FOR PRODUCTION. IT MAY CONTAIN CRITICAL SECURITY OR PERFORMANCE BUGS.
+
+## Overview
+
+The onion service load balancer allows an operator to distribute requests
+for their onion service to between 1 and 10 separate Tor instances. Each
+Tor instance can run completely independently with no knowledge of any other
+instances.
+
+The load balancer is the only system which needs to store the onion services's private key. As the load balancer handles no hidden service traffic it's
+risk of deanonymisation by traffic analysis attacks is reduced.
+
+## Installation
+
+### Load Balancing Instances
+
+Each load-balancing instance is an onion service configured with a unique
+private key. To minimize the disclosure of information about your onion
+service configuration it is advisable to configure some form of onion service
+authentication.
+
+The individual load balancing instances can use a standard Tor client.
+
+#### Management Server
+
+##### Generate a onion service key
+
+You can use your existing onion service `private_key` or generate a new
+one using OpenSSL.
+
+ $ openssl genrsa -out private_key 1024
+
+##### Encrypt an onion service private key
+
+Your master onion service private key can be protected by encrypting it
+while it is stored on disk. Due to limitation in the underlying pycrypto
+library, only DES-CBC, DES-EDE3-CBC, AES-128-CBC encrypted keys are supported.
+
+ $ openssl rsa -des3 -in private_key -out private_key.enc
+
+##### Configure Tor on the management server
+
+For this tool to work you need a version of Tor with the ability to fetch
+and upload HS descriptors. Until these features are merged into Tor, you can
+use my patched Tor branch.
+
+ $ git clone https://github.com/DonnchaC/tor.git
+ $ git checkout hs-fetch-and-post-cmds
+
+The `docs/torrc` contains a sample Tor config file which is suitable for the
+management server.
+
+##### Install the management server
+
+The code for the onion load balancer can be using git.
+
+ $ git clone https://github.com/DonnchaC/onion-balance.git
+ $ cd onion-balance
+
+The management server requires a number of Python dependencies. These can
+be install using pip.
+
+ $ pip install -r requirements.txt
+
+For onion service descriptor parsing you need a version of stem >= `1.3.0-dev`.
+
+## Configuration
+
+Each load balancing Tor instance is listed by it's unique onion address.
+An optional authentication cookie can also be provided if the back-end onion
+service is using some form of descriptor encryption.
+
+An example config file is provided in `config.yaml.example`.
+
+## Running
+
+Once your load balancing instances are running, you can run the onion load balancer by starting the management server:
+
+ $ python onion-balance/manage.py -f config.yaml
+
diff --git a/config.yaml.example b/config.yaml.example
new file mode 100644
index 0000000..b2ce5ec
--- /dev/null
+++ b/config.yaml.example
@@ -0,0 +1,16 @@
+# Onion Load Balancer Config File
+# ---
+# Each hidden service key line should be followed be followed by a list of 0
+# or more instances which contain the onion address of the load balancing
+# HS and any authentication data needed to access that HS.
+
+refresh: 600 # How often to poll for updated descriptors
+services:
+ - key: /path/to/private_key # 7s4hxwwifcslrus2.onion
+ instances:
+ - address: o6ff73vmigi4oxka # srv1
+ - address: nkz23ai6qesuwqhc # srv2
+ auth: dCmx3qIvArbil8A0KM4KgQ== # Hidden service authentication key
+ - key: /path/to/private_key.enc # dpkdeys3apjtqydk.onion
+ instances:
+ - address: htbzowpp5cn7wj2u # srv3
diff --git a/doc/torrc b/doc/torrc
new file mode 100644
index 0000000..d1a612b
--- /dev/null
+++ b/doc/torrc
@@ -0,0 +1,4 @@
+CookieAuthentication 1
+FetchDirInfoEarly 1
+FetchDirInfoExtraEarly 1
+FetchUselessDescriptors 1
diff --git a/onion-balance/config.py b/onion-balance/config.py
new file mode 100644
index 0000000..91140bc
--- /dev/null
+++ b/onion-balance/config.py
@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+class Config(object):
+ """
+ Config object to store the global state
+ """
+ def __init__(self):
+ # Configure some defaults
+ self.config = {
+ 'replicas': 2,
+ 'max_intro_points': 10,
+ 'refresh': 10 * 60
+ }
+ # In memory list of hidden services and balancing instances
+ self.hidden_services = []
+
+cfg = Config()
diff --git a/onion-balance/descriptor.py b/onion-balance/descriptor.py
new file mode 100644
index 0000000..1e9a152
--- /dev/null
+++ b/onion-balance/descriptor.py
@@ -0,0 +1,192 @@
+# -*- coding: utf-8 -*-
+import hashlib
+import base64
+import textwrap
+import datetime
+
+import Crypto.Util.number
+import stem
+
+import util
+import log
+
+logger = log.get_logger()
+
+
+def generate_hs_descriptor(permanent_key, introduction_point_list=None,
+ replica=0, timestamp=None):
+ """
+ High-level interface for generating a signed HS descriptor
+ TODO: Allow generation of descriptors for future timeperiod,
+ to help clients with a skewed clock
+ """
+
+ if not timestamp:
+ timestamp = datetime.datetime.utcnow()
+ unix_timestamp = int(timestamp.strftime("%s"))
+
+ permanent_key_block = make_public_key_block(permanent_key)
+ permanent_id = util.calc_permanent_id(permanent_key)
+
+ # Calculate the current secret-id-part for this hidden service
+ time_period = util.get_time_period(unix_timestamp, permanent_id)
+ secret_id_part = util.calc_secret_id_part(time_period, None, replica)
+ descriptor_id = util.calc_descriptor_id(permanent_id, secret_id_part)
+
+ intro_section = make_introduction_points_part(
+ introduction_point_list
+ )
+
+ unsigned_descriptor = generate_hs_descriptor_raw(
+ desc_id_base32=util.base32_encode_str(descriptor_id),
+ permanent_key_block=permanent_key_block,
+ secret_id_part_base32=util.base32_encode_str(secret_id_part),
+ publication_time=util.rounded_timestamp(timestamp),
+ introduction_points_part=intro_section
+ )
+
+ signed_descriptor = sign_descriptor(unsigned_descriptor, permanent_key)
+ return signed_descriptor
+
+
+def generate_hs_descriptor_raw(desc_id_base32, permanent_key_block,
+ secret_id_part_base32, publication_time,
+ introduction_points_part):
+ doc = []
+ doc.append("rendezvous-service-descriptor {}".format(desc_id_base32))
+ doc.append("version 2")
+ doc.append("permanent-key")
+ doc.append(permanent_key_block)
+ doc.append("secret-id-part {}".format(secret_id_part_base32))
+ doc.append("publication-time {}".format(publication_time))
+ doc.append("protocol-versions 2,3")
+ doc.append("introduction-points")
+ doc.append(introduction_points_part)
+ doc.append("signature\n")
+
+ unsigned_descriptor = '\n'.join(doc)
+ return unsigned_descriptor
+
+
+def make_introduction_points_part(introduction_point_list):
+ # If not intro points were specified, we should create and empty block
+ if not introduction_point_list:
+ introduction_point_list = []
+ intro = []
+ for intro_point in introduction_point_list:
+ intro.append("introduction-point {}".format(intro_point.identifier))
+ intro.append("ip-address {}".format(intro_point.address))
+ intro.append("onion-port {}".format(intro_point.port))
+ intro.append("onion-key")
+ intro.append(intro_point.onion_key)
+ intro.append("service-key")
+ intro.append(intro_point.service_key)
+
+ intro_section = '\n'.join(intro).encode('utf-8')
+ intro_section_base64 = base64.b64encode(intro_section).decode('utf-8')
+ intro_section_base64 = textwrap.fill(intro_section_base64, 64)
+
+ # Add the header and footer:
+ intro_points_with_headers = '\n'.join([
+ '-----BEGIN MESSAGE-----',
+ intro_section_base64,
+ '-----END MESSAGE-----'])
+ return intro_points_with_headers
+
+
+def make_public_key_block(key):
+ """
+ Get ASN.1 representation of public key, base64 and add headers
+ """
+ asn1_pub = util.get_asn1_sequence(key)
+ pub_base64 = base64.b64encode(asn1_pub).decode('utf-8')
+ pub_base64 = textwrap.fill(pub_base64, 64)
+
+ # Add the header and footer:
+ pub_with_headers = '\n'.join([
+ '-----BEGIN RSA PUBLIC KEY-----',
+ pub_base64,
+ '-----END RSA PUBLIC KEY-----'])
+ return pub_with_headers
+
+
+def sign_digest(digest, private_key):
+ """
+ Sign, base64 encode, wrap and add Tor signature headers
+
+ The message digest is PKCS1 padded without the optional algorithmIdentifier
+ section.
+ """
+
+ digest = util.add_pkcs1_padding(digest)
+ (signature_long, ) = private_key.sign(digest, None)
+ signature_bytes = Crypto.Util.number.long_to_bytes(signature_long, 128)
+ signature_base64 = base64.b64encode(signature_bytes).decode('utf-8')
+ signature_base64 = textwrap.fill(signature_base64, 64)
+
+ # Add the header and footer:
+ signature_with_headers = '\n'.join([
+ '-----BEGIN SIGNATURE-----',
+ signature_base64,
+ '-----END SIGNATURE-----'])
+ return signature_with_headers
+
+
+def sign_descriptor(descriptor, service_key):
+ """'Sign or resign a hidden service descriptor"""
+ TOKEN_HSDESCRIPTOR_SIGNATURE = '\nsignature\n'
+
+ # Remove signature block if it exists
+ if TOKEN_HSDESCRIPTOR_SIGNATURE in descriptor:
+ descriptor = descriptor[:descriptor.find(TOKEN_HSDESCRIPTOR_SIGNATURE)
+ + len(TOKEN_HSDESCRIPTOR_SIGNATURE)]
+ else:
+ descriptor = descriptor.strip() + TOKEN_HSDESCRIPTOR_SIGNATURE
+
+ descriptor_digest = hashlib.sha1(descriptor.encode('utf-8')).digest()
+ signature_with_headers = sign_digest(descriptor_digest, service_key)
+ return descriptor + signature_with_headers
+
+
+def fetch_descriptor(controller, onion_address, hsdir=None):
+ """
+ Try fetch a HS descriptor from any of the responsible HSDir's"
+ TODO: allow a hsdir to be specified
+ """
+ logger.info("Sending HS descriptor fetch for %s.onion" % onion_address)
+ response = controller.msg("HSFETCH %s" % (onion_address))
+ (response_code, divider, response_content) = response.content()[0]
+ if not response.is_ok():
+ if response_code == "552":
+ raise stem.InvalidRequest(response_code, response_content)
+ else:
+ raise stem.ProtocolError("HSFETCH returned unexpected "
+ "response code: %s" % response_code)
+ pass
+
+
+def upload_descriptor(controller, signed_descriptor, hsdirs=None):
+ """
+ Upload descriptor via the Tor control port
+
+ If no HSDir's are specified, Tor will upload to what it thinks are the
+ responsible directories
+ """
+ logger.debug("Sending HS descriptor upload")
+
+ # Provide server fingerprints to control command if HSDirs are specified.
+ if hsdirs:
+ server_args = ' '.join([("SERVER=%s" % hsdir) for hsdir in hsdirs])
+ else:
+ server_args = ""
+
+ response = controller.msg("HSPOST%s\r\n%s\r\n.\r\n" %
+ (server_args, signed_descriptor))
+
+ (response_code, divider, response_content) = response.content()[0]
+ if not response.is_ok():
+ if response_code == "552":
+ raise stem.InvalidRequest(response_code, response_content)
+ else:
+ raise stem.ProtocolError("+HSPOST returned unexpected response "
+ "code: %s" % response_code)
diff --git a/onion-balance/eventhandler.py b/onion-balance/eventhandler.py
new file mode 100644
index 0000000..c2f1e12
--- /dev/null
+++ b/onion-balance/eventhandler.py
@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+import stem
+
+import log
+import config
+
+logger = log.get_logger()
+
+
+class EventHandler(object):
+
+ """
+ Handles asynchronous Tor events.
+ """
+
+ def __init__(self, controller):
+
+ self.controller = controller
+
+ def new_desc(self, desc_event):
+ """
+ Parse HS_DESC response events
+ """
+ logger.debug("Received new HS_DESC event: %s" %
+ str(desc_event))
+
+ def new_desc_content(self, desc_content_event):
+ """
+ Parse HS_DESC_CONTENT response events for descriptor content
+
+ Update the HS instance object with the data from the new descriptor.
+ """
+ logger.debug("Received new HS_DESC_CONTENT event for %s" %
+ desc_content_event.address)
+
+ # Make sure the descriptor is not empty
+ descriptor_text = str(desc_content_event.descriptor).encode('utf-8')
+ if len(descriptor_text) < 5:
+ logger.debug("Empty descriptor received for %s" %
+ desc_content_event.address)
+ return
+
+ # Find the HS instance for this descriptor
+ for service in config.cfg.hidden_services:
+ for instance in service.instances:
+ if instance.onion_address == desc_content_event.address:
+ instance.update_descriptor(descriptor_text)
+ return
+
+ def new_event(self, event):
+ """
+ Dispatches new Tor controller events to the appropriate handlers.
+ """
+ if isinstance(event, stem.response.events.HSDescEvent):
+ self.new_desc(event)
+
+ elif isinstance(event, stem.response.events.HSDescContentEvent):
+ self.new_desc_content(event)
+
+ else:
+ logger.warning("Received unexpected event %s." % str(event))
diff --git a/onion-balance/hiddenservice.py b/onion-balance/hiddenservice.py
new file mode 100644
index 0000000..37f6b5c
--- /dev/null
+++ b/onion-balance/hiddenservice.py
@@ -0,0 +1,241 @@
+# -*- coding: utf-8 -*-
+import datetime
+import random
+import time
+
+import Crypto.PublicKey.RSA
+import stem.descriptor.hidden_service_descriptor
+
+import descriptor
+import util
+import log
+import config
+
+logger = log.get_logger()
+
+
+def fetch_all_descriptors(controller):
+ """
+ Try fetch fresh descriptors for all HS instances
+ """
+ logger.info("Running periodic descriptor fetch")
+
+ # Clear Tor descriptor cache before fetches by sending NEWNYM
+ controller.signal(stem.control.Signal.NEWNYM)
+ time.sleep(5)
+
+ for service in config.cfg.hidden_services:
+ for instance in service.instances:
+ instance.fetch_descriptor()
+
+
+def publish_all_descriptors():
+ """
+ Called periodically to upload new super-descriptors if needed
+ """
+ logger.info("Running periodic descriptor publish")
+ for service in config.cfg.hidden_services:
+ service.publish()
+
+
+class HiddenService(object):
+ """
+ HiddenService represents a front-facing hidden service which should
+ be load-balanced.
+ """
+
+ def __init__(self, controller, service_key=None, instances=None):
+ """
+ Initialise a HiddenService object.
+ """
+ self.controller = controller
+
+ # Service key must be a valid PyCrypto RSA key object
+ if not isinstance(service_key, Crypto.PublicKey.RSA._RSAobj):
+ raise ValueError("Service key is not a valid RSA object")
+ else:
+ self.service_key = service_key
+
+ # List of load balancing Instances for this hidden service
+ if not instances:
+ instances = []
+ self.instances = instances
+
+ self.onion_address = util.calc_onion_address(self.service_key)
+ self.last_uploaded = None
+
+ def _intro_points_modified(self):
+ """
+ Check if the introduction point set has changed since last
+ publish.
+ """
+ for instance in self.instances:
+ if instance.changed_since_published:
+ return True
+
+ # No introduction points have changed
+ return False
+
+ def _descriptor_expiring(self):
+ """
+ Check if the last uploaded super descriptor is expiring (> 1
+ hour old).
+ """
+ if not self.last_uploaded:
+ # No descriptor uploaded yet, we should publish.
+ return True
+
+ descriptor_age = (datetime.datetime.utcnow() - self.last_uploaded)
+ if (descriptor_age.total_seconds() > 60 * 60):
+ return True
+
+ return False
+
+ def _get_combined_introduction_points(self):
+ """
+ Choose set of introduction points from all fresh descriptors
+
+ TODO: There are probably better algorithms for choosing which
+ introduction points to include. If we have more than
+ `max_intro_points` introduction points, we will need to exclude
+ some. It probably sensible to prefer IPs which are new and
+ haven't been included in any previous descriptors. Clients with
+ an old descriptor will continue trying previously published IPs
+ if they still work.
+ """
+
+ combined_intro_points = []
+ for instance in self.instances:
+
+ if not instance.last_fetched:
+ logger.debug("No descriptor fetched for instance '%s' yet. "
+ "Skipping!" % instance.onion_address)
+ continue
+
+ # Check if the intro points are too old
+ intro_age = datetime.datetime.utcnow() - instance.last_fetched
+ if intro_age.total_seconds() > 60 * 60:
+ logger.info("Our introduction points for instance '%s' "
+ "are too old. Skipping!" % instance.onion_address)
+ continue
+
+ # Our IP's are recent enough, include them
+ instance.changed_since_published = False
+ combined_intro_points.extend(instance.introduction_points)
+
+ # Choose up to `max_intro_points` IPs from the combined set
+ max_introduction_points = min(
+ len(combined_intro_points),
+ config.cfg.config.get("max_intro_points")
+ )
+
+ choosen_intro_points = random.sample(combined_intro_points,
+ max_introduction_points)
+ # Shuffle IP's to try reveal less information about which
+ # instances are online and have introduction points included.
+ random.shuffle(choosen_intro_points)
+
+ logger.debug("Selected %d IPs (of %d) for service '%s'" %
+ (len(choosen_intro_points), len(combined_intro_points),
+ self.onion_address))
+
+ return choosen_intro_points
+
+ def _get_signed_descriptor(self, replica=0):
+ """
+ Generate a signed HS descriptor for this hidden service
+ """
+
+ # Select a set of introduction points from this HS's load
+ # balancing instances.
+ introduction_points = self._get_combined_introduction_points()
+
+ signed_descriptor = descriptor.generate_hs_descriptor(
+ self.service_key,
+ introduction_point_list=introduction_points,
+ replica=replica
+ )
+ return signed_descriptor
+
+ def _upload_descriptor(self):
+ """
+ Create, sign and upload a super-descriptors for this HS
+
+ TODO: If the descriptor ID is changing soon, upload to current
+ and upcoming set's of HSDirs.
+ """
+ for replica in range(0, config.cfg.config.get("replicas")):
+ signed_descriptor = self._get_signed_descriptor(replica=replica)
+ descriptor.upload_descriptor(self.controller, signed_descriptor)
+
+ self.last_uploaded = datetime.datetime.utcnow()
+
+ def publish(self, force=False):
+ """
+ Publish descriptor if have new IP's or if descriptor has expired
+ """
+
+ if ( self._intro_points_modified() or
+ self._descriptor_expiring() or
+ force):
+ logger.info("Publishing new descriptor for '%s'" %
+ self.onion_address)
+
+ self._upload_descriptor()
+
+
+class Instance(object):
+ """
+ Instance represents a back-end load balancing hidden service.
+ """
+
+ def __init__(self, controller, onion_address, authentication_cookie):
+ """
+ Initialise an Instance object.
+ """
+ self.controller = controller
+ self.onion_address = onion_address
+ self.authentication_cookie = authentication_cookie
+
+ self.introduction_points = []
+ self.last_fetched = None
+ self.changed_since_published = False
+
+ def fetch_descriptor(self):
+ """
+ Try fetch a fresh descriptor for this back-end HS instance.
+ """
+ logger.debug("Trying to fetch a descriptor of instance '%s'" %
+ self.onion_address)
+ return descriptor.fetch_descriptor(self.controller, self.onion_address)
+
+ def update_descriptor(self, descriptor_content):
+ """
+ Update introduction points when a new HS descriptor is received
+
+ Parse the descriptor content and update the set of introduction
+ points for this HS instance.
+ """
+
+ logger.info("Received a descriptor for %s" % self.onion_address)
+
+ self.last_fetched = datetime.datetime.utcnow()
+
+ # Parse and store this descriptors introduction points.
+ parsed_descriptor = stem.descriptor.hidden_service_descriptor.\
+ HiddenServiceDescriptor(descriptor_content)
+
+ # Parse the introduction point list, decrypting if necessary
+ introduction_points = parsed_descriptor.introduction_points(
+ authentication_cookie=self.authentication_cookie)
+
+ # If the new intro point set is different, flag this HS instance
+ # as modified.
+ if introduction_points != self.introduction_points:
+ logger.info("New IPs found for '%s'" % self.onion_address)
+ self.changed_since_publish = True
+ self.introduction_points = introduction_points
+
+ else:
+ logger.info("IPs for '%s' matched the cached set" %
+ self.onion_address)
diff --git a/onion-balance/log.py b/onion-balance/log.py
new file mode 100644
index 0000000..0106e9d
--- /dev/null
+++ b/onion-balance/log.py
@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+import logging
+
+handler = logging.StreamHandler()
+handler.setFormatter(logging.Formatter(fmt="%(asctime)s [%(levelname)s]: "
+ "%(message)s"))
+
+logger = logging.getLogger("onion-load-balancer")
+logger.addHandler(handler)
+logger.setLevel(logging.DEBUG)
+
+
+def get_logger():
+ """
+ Returns a logger.
+ """
+ return logger
diff --git a/onion-balance/manager.py b/onion-balance/manager.py
new file mode 100755
index 0000000..cb4f2f9
--- /dev/null
+++ b/onion-balance/manager.py
@@ -0,0 +1,156 @@
+# -*- coding: utf-8 -*-
+"""
+Load balance a hidden service across multiple (remote) Tor instances by
+create a hidden service descriptor containing introduction points from
+each instance.
+"""
+import sys
+import argparse
+import time
+import os
+import logging
+
+# import Crypto.PublicKeyl
+import stem
+from stem.control import Controller, EventType
+import yaml
+import schedule
+
+import log
+import util
+import config
+import hiddenservice
+import eventhandler
+
+
+logger = log.get_logger()
+
+
+def parse_cmd_args():
+ """
+ Parses and returns command line arguments.
+ """
+
+ parser = argparse.ArgumentParser(
+ description="%s distributes the requests for a Tor hidden services "
+ "across multiple (remote) Tor instances." % sys.argv[0])
+
+ parser.add_argument("-i", "--ip", type=str, default="127.0.0.1",
+ help="Tor controller IP address")
+
+ parser.add_argument("-p", "--port", type=int, default=9051,
+ help="Tor controller port")
+
+ parser.add_argument("-c", "--config", type=str,
+ default="config.yaml", help="Config file")
+
+ parser.add_argument("-v", "--verbosity", type=str, default="info",
+ help="Minimum verbosity level for logging. Available "
+ "in ascending order: debug, info, warning, "
+ "error, critical). The default is info.")
+
+ return parser.parse_args()
+
+
+def parse_config_file(config_file):
+ """
+ Parse config file contain load balancing node configuration
+ """
+ if os.path.exists(config_file):
+ with open(config_file, 'r') as handle:
+ config_data = yaml.load(handle.read())
+ logger.info("Loaded the config file '%s'" % config_file)
+ else:
+ logger.error("The specified config file does not exist (%s)" %
+ config_file)
+ sys.exit(1)
+
+ return config_data
+
+
+def main():
+ """
+ Entry point when invoked over the command line.
+ """
+ args = parse_cmd_args()
+ config.cfg.config.update(parse_config_file(args.config))
+
+ logger.setLevel(logging.__dict__[args.verbosity.upper()])
+
+ # Create a connection to the Tor control port
+ controller = Controller.from_port(address=args.ip, port=args.port)
+ try:
+ controller.authenticate()
+ except stem.connection.AuthenticationFailure as exc:
+ logger.error("Unable to authenticate to Tor control port: %s"
+ % exc)
+ sys.exit(1)
+ else:
+ logger.debug("Successfully connected to the Tor control port")
+
+ # Load the keys and configuration for each hidden service
+ for service in config.cfg.config.get("services"):
+ service_key = util.key_decrypt_prompt(service.get("key"))
+ if not service_key:
+ logger.error("Private key could not be imported (%s)" %
+ args.key)
+ sys.exit(0)
+ else:
+ # Successfully import the private key
+ onion_address = util.calc_onion_address(service_key)
+ logger.debug("Loaded private key for service '%s'" %
+ onion_address)
+
+ # Parse the load balancing instances for this hidden service
+ instance_config = service.get("instances", [])
+ if not instance_config:
+ logger.error("No load balancing hidden service "
+ "specified for %s" % onion_address)
+ sys.exit(1)
+ else:
+ instances = []
+ for instance in instance_config:
+ instances.append(hiddenservice.Instance(
+ controller=controller,
+ onion_address=instance.get("address"),
+ authentication_cookie=instance.get("auth")
+ ))
+
+ logger.info("Loaded {} balancing services for {}".format(
+ len(instances), onion_address))
+
+ config.cfg.hidden_services.append(hiddenservice.HiddenService(
+ controller=controller,
+ service_key=service_key,
+ instances=instances
+ ))
+ # Finished parsing all the config file.
+
+ handler = eventhandler.EventHandler(controller)
+ controller.add_event_listener(handler.new_event,
+ EventType.HS_DESC,
+ EventType.HS_DESC_CONTENT)
+
+ # Run initial fetch of HS instance descriptors
+ hiddenservice.fetch_all_descriptors(controller)
+ time.sleep(15)
+ hiddenservice.publish_all_descriptors()
+
+ # Schedule descriptor fetch and upload events
+ schedule.every(config.cfg.config.get('refresh')).seconds.do(
+ hiddenservice.fetch_all_descriptors, controller)
+ schedule.every(config.cfg.config.get('refresh')).seconds.do(
+ hiddenservice.publish_all_descriptors)
+
+ # Begin main loop to poll for HS descriptors
+ try:
+ while True:
+ schedule.run_pending()
+ time.sleep(1)
+ except KeyboardInterrupt:
+ logger.info("Stopping descriptor uploads")
+
+ return 0
+
+if __name__ == "__main__":
+ exit(main())
diff --git a/onion-balance/util.py b/onion-balance/util.py
new file mode 100644
index 0000000..e755c6d
--- /dev/null
+++ b/onion-balance/util.py
@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+import hashlib
+import struct
+import datetime
+import getpass
+import base64
+import binascii
+
+# import Crypto.Util
+import Crypto.PublicKey
+
+
+def add_pkcs1_padding(message):
+ """Add PKCS#1 padding to **message**."""
+ padding = b''
+ typeinfo = b'\x00\x01'
+ separator = b'\x00'
+ for x in range(125 - len(message)):
+ padding += b'\xFF'
+ PKCS1paddedMessage = typeinfo + padding + separator + message
+ assert len(PKCS1paddedMessage) == 128
+ return PKCS1paddedMessage
+
+
+def get_asn1_sequence(rsa_key):
+ seq = Crypto.Util.asn1.DerSequence()
+ seq.append(rsa_key.n)
+ seq.append(rsa_key.e)
+ asn1_seq = seq.encode()
+ return asn1_seq
+
+
+def calc_key_digest(rsa_key):
+ """Calculate the SHA1 digest of an RSA key"""
+ return hashlib.sha1(get_asn1_sequence(rsa_key)).digest()
+
+
+def calc_permanent_id(rsa_key):
+ return calc_key_digest(rsa_key)[:10]
+
+
+def calc_onion_address(rsa_key):
+ return base64.b32encode(calc_permanent_id(rsa_key)).decode().lower()
+
+
+def calc_descriptor_id(permanent_id, secret_id_part):
+ return hashlib.sha1(permanent_id + secret_id_part).digest()
+
+
+def get_time_period(time, permanent_id):
+ """
+ time-period = (current-time + permanent-id-byte * 86400 / 256) / 86400
+ """
+ permanent_id_byte = int(struct.unpack('B', permanent_id[0:1])[0])
+ return int((time + permanent_id_byte * 86400 / 256) / 86400)
+
+
+def calc_secret_id_part(time_period, descriptor_cookie, replica):
+ """
+ secret-id-part = H(time-period | descriptor-cookie | replica)
+ """
+ secret_id_part = hashlib.sha1()
+ secret_id_part.update(struct.pack('>I', time_period)[:4])
+ if descriptor_cookie:
+ secret_id_part.update(descriptor_cookie)
+ secret_id_part.update(binascii.unhexlify('{0:02X}'.format(replica)))
+ return secret_id_part.digest()
+
+
+def rounded_timestamp(timestamp=None):
+ """
+ Create timestamp rounded down to the nearest hour
+ """
+ if not timestamp:
+ timestamp = datetime.datetime.utcnow()
+ timestamp = timestamp.replace(minute=0, second=0, microsecond=0)
+ return timestamp.strftime('%Y-%m-%d %H:%M:%S')
+
+
+def base32_encode_str(bytes):
+ """
+ Encode bytes as lowercase base32 string
+ """
+ return base64.b32encode(bytes).lower().decode('utf-8')
+
+
+def key_decrypt_prompt(key_file, retries=3):
+ """
+ Try open an PEM encrypted private key, propmpting the user for a
+ passphrase if required.
+ """
+
+ for retries in range(0, retries):
+ key_passphrase = None
+ with open(key_file, 'r') as handle:
+ pem_key = handle.read()
+
+ if "Proc-Type: 4,ENCRYPTED" in pem_key: # Key looks encrypted
+ key_passphrase = getpass.getpass(
+ "Enter the password for the private key (%s): " % key_file)
+ try:
+ permanent_key = Crypto.PublicKey.RSA.importKey(
+ pem_key, passphrase=key_passphrase)
+ except ValueError:
+ # Key not decrypted correctly, prompt for passphrase again
+ continue
+ else:
+ return permanent_key
+
+ # No private key was imported
+ raise ValueError("Could not import RSA key")
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..5ec1cac
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,4 @@
+PyYAML==3.11
+pycrypto==2.6.1
+schedule==0.3.1
+stem==1.3.0-dev
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/onionbalance.git
More information about the Pkg-privacy-commits
mailing list