From 4914b0c74ed669d6631897950ff1660ce91ef918 Mon Sep 17 00:00:00 2001
From: Simeon Simeonov
Date: Thu, 23 Dec 2021 14:41:14 +0100
Subject: Initial commit and release for Christmas with love
---
.gitignore | 1 +
COPYING | 674 +++++++++++++++++++++++++++++++
LICENSE | 674 +++++++++++++++++++++++++++++++
README.md | 289 +++++++++++++
etoolkit/__init__.py | 34 ++
etoolkit/__main__.py | 276 +++++++++++++
etoolkit/etoolkit.py | 406 +++++++++++++++++++
etoolkit_sample.json | 21 +
setup.py | 56 +++
tests/conftest.py | 59 +++
tests/test_cli.py | 40 ++
tests/test_envtoolkit_instance.py | 64 +++
tests/test_envtoolkit_instance_static.py | 102 +++++
13 files changed, 2696 insertions(+)
create mode 100644 .gitignore
create mode 100644 COPYING
create mode 100644 LICENSE
create mode 100644 README.md
create mode 100644 etoolkit/__init__.py
create mode 100644 etoolkit/__main__.py
create mode 100755 etoolkit/etoolkit.py
create mode 100644 etoolkit_sample.json
create mode 100644 setup.py
create mode 100644 tests/conftest.py
create mode 100644 tests/test_cli.py
create mode 100644 tests/test_envtoolkit_instance.py
create mode 100644 tests/test_envtoolkit_instance_static.py
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..c18dd8d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+__pycache__/
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..94a9ed0
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU 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.
+
+
+ Copyright (C)
+
+ 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 .
+
+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:
+
+ Copyright (C)
+ 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
+.
+
+ 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
+.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..94a9ed0
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU 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.
+
+
+ Copyright (C)
+
+ 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 .
+
+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:
+
+ Copyright (C)
+ 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
+.
+
+ 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
+.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5c543f4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,289 @@
+# etoolkit
+
+*etoolkit* is a simple toolkit for defining and setting environment variables
+in a flexible and secure way.
+
+
+## General
+
+*etoolkit* started as a simple idea while I was working at the University
+of Oslo. Later I felt the need for even more flexible solution. The following
+goals were set:
+
+- the ability to define env. var. "instances" with support for inheritance
+
+- encrypting values using a master password
+
+- the ability to spawn a child process with the defined variables
+
+- support for macros
+
+
+## Requirements
+
+Apart from Python >= 3.7, the only requirement is
+[cryptography](https://pypi.org/project/cryptography/)
+
+
+## Overview
+
+In a typical UNIX environment, env. variables are usually set in one
+or more of the initialization / startup files like f.i. */etc/profile*,
+*~/.bash_profile*, *~/.bashrc*, *~/.tcshrc*, *~/.cshrc* ... depending
+on the OS, shell, distribution... etc.
+Env. variables represent key-value pairs (env. variable name and its value).
+
+A potential problem when dealing with env. variables containing sensitive
+values like passwords, tokens, connection strings... is that they are inherited
+by all child processes spawned from the login / interactive shell.
+
+A malicious / exploited process (like f.i. web browser) will then be able to
+fetch those values by using *getenv*. Such process may in addition be able to
+simply read *~/.bashrc* or any similar file readable by the process owner and
+get the values from there if necessary.
+
+*etoolkit* attempts to solve both of these problems.
+
+When started, it reads env. variables from its own configuration file.
+Sensitive data may be encrypted using a master password. Hence reading
+etoolkit's configuration file will not reveal the real value of the data.
+
+When *etoolkit* has processed (decryption, macro replacement, etc) its data,
+it may define new env. variables corresponding to that data and may start a new
+interactive shell. The processed environment variables will not be available
+for processes that were not spawned by that same *etoolkit* session.
+
+
+## Installation
+
+### pip (pypi)
+
+ ```bash
+ pip install etoolkit
+ ```
+
+
+### Gentoo
+
+ ```bash
+ layman -a sgs
+ emerge dev-python/etoolkit
+ ```
+
+
+## Setup and examples
+
+Most users (including me) will simply use the command line interface (CLI).
+
+
+### CLI
+
+*etoolkit* comes with a simple CLI:
+
+ ```bash
+ python -m etoolkit -h
+ ```
+
+... or even (if *etoolkit* was installed using the methods described above)
+
+ ```bash
+ etoolkit -h
+ ```
+
+
+The *etoolkit* CLI loads the configuration located by default in
+*~/.etoolkit.json*. That file is based on
+[etoolkit_sample.json](https://github.com/blackm0re/etoolkit/blob/master/etoolkit_sample.json).
+
+The *"instances"* part of the configuration defines unique instances, each of
+which represents its own environment with its own defined env. variables.
+Each instance consists of key-value pairs corresponding to env. name and value.
+All pairs will result in corresponding env. variables being defined, with the
+exception of the following *etoolkit* internal keys:
+
+- **ETOOLKIT_PARENT** - string - reference to another instance
+
+- **ETOOLKIT_SENSITIVE** - list - env. variables containing sensitive data
+
+All pairs defined in *"general"* (currently only **MASTER_PASSWORD_HASH**) are
+*etoolkit* internal as well.
+
+An instance may inherit (and if desired overwrite) key value pairs from its
+parent.
+
+Variables containing sensitive data can be encrypted / decrypted using a master
+password. Currently *etoolkit* requires that all values in a configuration
+file are encrypted with the same master password. Setting a master password
+hash is a recommended but not mandatory.
+
+ ```bash
+ etoolkit -p
+ ```
+
+That command will prompt for master password and output a hash that can then
+be stored
+in ["general"]["MASTER_PASSWORD_HASH"].
+The hash is only used for verifying that a correct master password has been
+provided at a later time. Issuing:
+
+ ```bash
+ etoolkit -e
+ ```
+
+will prompt for the master password, then for the value to be encrypted and
+finally display the encrypted string of the value. Unless invoked with the
+*-E* / *--echo* parameter *etoolkit* will not display the value that is about
+to be encrypted.
+
+More than one value can be encrypted / decrypted with a single master password
+prompt if *-m* / *--multiple-values* parameter is provided. Manual decryption
+of single value(s):
+
+ ```bash
+ etoolkit -d -m
+ ```
+
+Listing all available instances defined in the configuration file and then
+loading a specific instance can be achieved by:
+
+ ```bash
+ etoolkit -l
+ etoolkit
+ ```
+
+*etoolkit* will prompt for the master password the first time it encounters
+and encrypted value. Once provided the master password will be used to decrypt
+the rest of the encrypted values.
+
+When all values are fetched from a given instance (and its parents) and then
+decrypted, they are further processed by replacing macros with their
+corresponding values. Currently the following macros are supported:
+
+- **%h** - the home directory of the user running *etoolkit* (~/)
+
+- **%i** - the names of the instance that is about to be loaded
+
+- **%u** - the username of the user running *etoolkit* (*getpass.getuser()*)
+
+In addition, value starting with *":"* is appended to the existing value
+(if any) of the env. variable about to be set
+(like *MYVAR=$MYVAR\)*).
+The opposite is true for value ending with *":"* (*MYVAR=\$MYVAR*).
+
+When the variables are finally processed, *etoolkit* sets / changes them as env.
+variables (using *setenv* / *os.environ.update*) and spawns an interactive
+child process (by invoking *system($SHELL)*).
+
+One can also spawn a different process than an interactive shell by using the
+*-s* / *--spawn* parameter.
+
+ ```bash
+ etoolkit -s /bin/othershell
+ ```
+
+Contact the author for questions and suggestions! :)
+
+
+### Using the *EtoolkitInstance* class
+
+*etoolkit* comes with its own *etoolkit* package that contains the
+*EtoolkitInstance* class.
+
+The class encapsulates the function of creating and processing instances
+from a given structure (dict).
+
+It may be useful if one should prefer for example making her own CLI interface.
+or the *instances* structure being loaded from a diferent configuration file
+(f.i. .yml).
+
+ ```python
+ import os
+
+ import etoolkit
+
+
+ # using some static methods in order to create encrypted values
+ etoolkit.EtoolkitInstance.encrypt('the very secret passwd', 'secret1')
+ # Out: 'enc-val$1$Y/TBb1F3siHTw6qZg9ERzZfA8PLPf2CwGSQLpu9jYWw=$FT5tS9o+ABvsxogIXpJim16Gz5SVtV8='
+
+ etoolkit.EtoolkitInstance.encrypt('the very secret passwd', 'secret2')
+ # Out: 'enc-val$1$vIBcoCNiYrsDLtF41uLuSEnppBjhliD0B8jwcBJcj/c=$KwOGe/y1dlxktDaCnJPIVNuaQ4Q7yNo='
+
+
+ # The encrypted values will be used in our configuration structure
+ # The following structure defines the 3 instances: default, dev and secret
+ instances = {
+ "general": {
+ },
+ "instances": {
+ "default": {
+ "ETOOLKIT_PROMPT": "(%i)"
+ },
+ "dev": {
+ "ETOOLKIT_PARENT": "default",
+ "PYTHONPATH": ":/home/user/.pythonpath",
+ "DB_CONNECTION": "enc-val$1$Y/TBb1F3siHTw6qZg9ERzZfA8PLPf2CwGSQLpu9jYWw=$FT5tS9o+ABvsxogIXpJim16Gz5SVtV8="
+ },
+ "secret": {
+ "ETOOLKIT_PARENT": "default",
+ "ETOOLKIT_SENSITIVE": ["PASSWORD"],
+ "GNUPGHOME": "%h/private/.gnupg",
+ "PASSWORD": "enc-val$1$vIBcoCNiYrsDLtF41uLuSEnppBjhliD0B8jwcBJcj/c=$KwOGe/y1dlxktDaCnJPIVNuaQ4Q7yNo="
+ }
+ }
+ }
+
+
+ dev_instance = etoolkit.EtoolkitInstance('dev', instances)
+
+ # fetch the variables before the processing stage (calling get_environ())
+ # since raw_env_variables is a dict, it can be modified (f.i. .update())
+ dev_instance.raw_env_variables
+
+ dev_instance.master_password = 'the very secret passwd' # or perhaps using getpass
+ env_vars = dev_instance.get_env()
+ print(env_vars['PASSWORD']) # outputs: 'secret2'
+
+ inst.dump_env(env_vars) # prints all values, with the exception of 'PASSWORD'
+
+ # set the env. variables.
+ os.environ.update(env_vars)
+ ```
+
+
+### Tips
+
+When starting a new interactive process (f.i. bash), the process will
+in turn invoke its startup script (f.i. *~/.bashrc*).
+Avoid redefining the env. variables that have just been set by *etoolkit*!
+
+If you want your shell prompt to display the name of the loaded instance, you
+can set a new env. variable (f.i. "ETOOLKIT_PROMPT" as shown in the sample
+configuration above) and then add the following at the bottom of your startup
+file (f.i. ~/.bashrc):
+
+ ```bash
+ if [ -n "$ETOOLKIT_PROMPT" ]; then
+ export PS1="$ETOOLKIT_PROMPT$PS1"
+ fi
+ ```
+
+
+## Support and contributing
+
+*etoolkit* is hosted on GitHub: https://github.com/blackm0re/etoolkit
+
+
+## Author
+
+Simeon Simeonov - sgs @ LiberaChat
+
+
+## [License](https://github.com/blackm0re/etoolkit/blob/master/LICENSE)
+
+Copyright (c) 2021, Simeon Simeonov
+All rights reserved.
+
+[Licensed](https://github.com/blackm0re/etoolkit/blob/master/LICENSE) under the
+GNU General Public License v3.0 or later.
+SPDX-License-Identifier: GPL-3.0-or-later
diff --git a/etoolkit/__init__.py b/etoolkit/__init__.py
new file mode 100644
index 0000000..9a6d9aa
--- /dev/null
+++ b/etoolkit/__init__.py
@@ -0,0 +1,34 @@
+# etoolkit
+# Copyright (C) 2021 Simeon Simeonov
+
+# 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 .
+"""A simple toolkit for setting environment variables in a flexible way"""
+from .etoolkit import EtoolkitInstance, EtoolkitInstanceError
+
+__author__ = 'Simeon Simeonov'
+__version__ = '1.0.0'
+__license__ = 'GPL3'
+
+
+def int_or_str(value):
+ """Returns int value of value when possible"""
+ try:
+ return int(value)
+ except ValueError:
+ return value
+
+
+VERSION = tuple(map(int_or_str, __version__.split('.')))
+
+__all__ = ['EtoolkitInstance', 'EtoolkitInstanceError']
diff --git a/etoolkit/__main__.py b/etoolkit/__main__.py
new file mode 100644
index 0000000..8c4245d
--- /dev/null
+++ b/etoolkit/__main__.py
@@ -0,0 +1,276 @@
+# etoolkit
+# Copyright (C) 2021 Simeon Simeonov
+
+# 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 .
+"""
+CLI entry point for the etoolkit package
+
+Examples:
+python -m etoolkit -h
+
+python -m etoolkit -p
+"""
+import argparse
+import errno
+import getpass
+import json
+import logging
+import os
+import sys
+
+import etoolkit
+
+DEFAULT_LOG_FORMAT = "%(levelname)s: %(message)s"
+DEFAULT_LOG_LEVEL = logging.WARNING
+
+logger = logging.getLogger(__name__)
+
+
+def decrypt_value(args: argparse.Namespace, config: dict):
+ """
+ Interactive function for decrypting value(s)
+
+ Prompts for master key password and then prompts for a value to decrypt
+
+ The decrypted value is printed to stdout
+
+ :param args: The arguments sent by the caller
+ :type args: arparse.Namespace
+
+ :param config: The config dict sent by the caller
+ :type config: dict
+ """
+ password_hash = None
+ if 'general' in config:
+ password_hash = config['general'].get('MASTER_PASSWORD_HASH')
+ password = etoolkit.EtoolkitInstance.confirm_password_prompt(
+ password_hash, False
+ )
+ while True:
+ try:
+ value = input('Value: ')
+ print(
+ 'Decrypted value: '
+ f'{etoolkit.EtoolkitInstance.decrypt(password, value)}'
+ )
+ if not args.multiple_values:
+ break
+ except KeyboardInterrupt:
+ print(os.linesep)
+ break
+
+
+def encrypt_value(args: argparse.Namespace, config: dict):
+ """
+ Interactive function for encrypting value(s)
+
+ Prompts for master key password and then prompts for a value to encrypt
+
+ The encrypted value is printed to stdout
+
+ :param args: The arguments sent by the caller
+ :type args: arparse.Namespace
+
+ :param config: The config dict sent by the caller
+ :type config: dict
+ """
+ password_hash = None
+ if 'general' in config:
+ password_hash = config['general'].get('MASTER_PASSWORD_HASH')
+ password = etoolkit.EtoolkitInstance.confirm_password_prompt(password_hash)
+ while True:
+ try:
+ if args.echo:
+ value = input('Value: ')
+ else:
+ value = getpass.getpass('Value: ')
+ print(
+ 'Encrypted value: '
+ f'{etoolkit.EtoolkitInstance.encrypt(password, value)}'
+ )
+ if not args.multiple_values:
+ break
+ except KeyboardInterrupt:
+ print(os.linesep)
+ break
+
+
+def main(inargs=None):
+ """main entry point"""
+ parser = argparse.ArgumentParser(
+ prog=__package__,
+ epilog=(
+ f'%(prog)s {etoolkit.__version__} by Simeon Simeonov '
+ '(sgs @ LiberaChat)'
+ ),
+ description='The following options are available',
+ )
+ group = parser.add_mutually_exclusive_group(required=True)
+ group.add_argument(
+ 'instance',
+ metavar='',
+ nargs='?',
+ type=str,
+ help='The instance to be loaded',
+ )
+ group.add_argument(
+ '-d',
+ '--decrypt-value',
+ dest='decrypt_value',
+ action='store_true',
+ required=False,
+ help=(
+ 'Prompt for master password & value to decrypt, '
+ 'display the decrypted value and exit'
+ ),
+ )
+ group.add_argument(
+ '-e',
+ '--encrypt-value',
+ dest='encrypt_value',
+ action='store_true',
+ required=False,
+ help=(
+ 'Prompt for master password & value to encrypt, '
+ 'display the encrypted value and exit'
+ ),
+ )
+ group.add_argument(
+ '-l',
+ '--list',
+ dest='list',
+ action='store_true',
+ required=False,
+ help='List all defined instances',
+ )
+ group.add_argument(
+ '-p',
+ '--generate-master-password-hash',
+ dest='password_hash',
+ action='store_true',
+ required=False,
+ help='Prompt for master password, display the generated hash and exit',
+ )
+ parser.add_argument(
+ '-c',
+ '--config-file',
+ metavar='',
+ type=str,
+ default=os.path.expanduser(
+ os.environ.get('ETOOLKIT_CONFIG', '~/.etoolkit.json')
+ ),
+ dest='config_file',
+ help='JSON config file (default: ~/.etoolkit.json)',
+ )
+ parser.add_argument(
+ '-E',
+ '--echo',
+ dest='echo',
+ action='store_true',
+ help='Display the value to be encrypted (used together with -e)',
+ )
+ parser.add_argument(
+ '-m',
+ '--multiple-values',
+ dest='multiple_values',
+ action='store_true',
+ help=(
+ 'Prompt for more than one value when '
+ 'encrypting / decrypting until terminated '
+ '(Ctrl+C) (used together with -d / -e)'
+ ),
+ )
+ parser.add_argument(
+ '-q',
+ '--no-output',
+ dest='dump_output',
+ action='store_false',
+ default=True,
+ help='Do not print environment variables to stdout',
+ )
+ parser.add_argument(
+ '-s',
+ '--spawn',
+ metavar='',
+ type=str,
+ default='',
+ dest='spawn',
+ help='Spawn another process than $SHELL',
+ )
+ parser.add_argument(
+ '-v',
+ '--version',
+ action='version',
+ version=f'%(prog)s {etoolkit.__version__}',
+ help='Display program-version and exit',
+ )
+ args = parser.parse_args(inargs)
+ try:
+ with open(args.config_file, 'r', encoding='utf-8') as fp:
+ config_dict = json.load(fp)
+ except Exception as e:
+ logger.error("Unable to parse %r: %s", args.config_file, e)
+ raise SystemExit(errno.EIO) from e
+
+ try:
+ if args.decrypt_value:
+ decrypt_value(args, config_dict)
+ sys.exit(0)
+ if args.encrypt_value:
+ encrypt_value(args, config_dict)
+ sys.exit(0)
+ if args.password_hash:
+ master_password = (
+ etoolkit.EtoolkitInstance.confirm_password_prompt()
+ )
+ phash = etoolkit.EtoolkitInstance.get_new_password_hash(
+ master_password
+ )
+ print(f'Master password hash: {phash}')
+ sys.exit(0)
+ if args.list:
+ for instance_name in sorted(
+ config_dict.get('instances', {}).keys()
+ ):
+ print(instance_name)
+ sys.exit(0)
+
+ inst = etoolkit.EtoolkitInstance(args.instance, config_dict)
+ inst.prompt_func = etoolkit.EtoolkitInstance.confirm_password_prompt
+ env = inst.get_environ()
+
+ if args.dump_output:
+ inst.dump_env(env)
+
+ os.environ.update(env)
+
+ if args.spawn:
+ os.system(args.spawn)
+ else:
+ os.system(os.getenv('SHELL', 'bash'))
+ except KeyboardInterrupt:
+ logger.debug('KeyboardInterrupt')
+ print(os.linesep)
+ sys.exit(0)
+ except etoolkit.EtoolkitInstanceError as e:
+ logger.error('EtoolkitInstanceError: %s', e)
+ sys.exit(1)
+ except Exception as e:
+ logger.error('Unexpected exception: %s', e)
+ sys.exit(1)
+
+
+if __name__ == '__main__':
+ logging.basicConfig(level=DEFAULT_LOG_LEVEL, format=DEFAULT_LOG_FORMAT)
+ main()
diff --git a/etoolkit/etoolkit.py b/etoolkit/etoolkit.py
new file mode 100755
index 0000000..837d13a
--- /dev/null
+++ b/etoolkit/etoolkit.py
@@ -0,0 +1,406 @@
+# etoolkit
+# Copyright (C) 2021 Simeon Simeonov
+
+# 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 .
+"""The main module of the etoolkit package"""
+import base64
+import getpass
+import hashlib
+import os
+
+from cryptography.exceptions import InvalidTag
+from cryptography.hazmat.primitives.ciphers.aead import AESGCM
+
+
+class EtoolkitInstanceError(Exception):
+ """EtoolkitInstanceError - Generic exceptions related to instances"""
+
+
+class EtoolkitInstance:
+ """A basic class representing a single instance"""
+
+ def __init__(self, name: str, data: dict):
+ """
+ :param name: Instance name
+ :type name: str
+
+ :param data: .etoolkit.json alike dict
+ :type data: dict
+ """
+ self._name = name
+ self._parent = None
+ self._raw_env_variables = {}
+ self._sensitive_env_variables = []
+ self._master_password = None
+ self._master_password_hash = None
+ self._prompt_func = None # function to use when prompting for input
+ try:
+ inst_data = data['instances'][name]
+ except KeyError as e:
+ raise EtoolkitInstanceError(f'Unknown instance "{name}"') from e
+ if inst_data.get('ETOOLKIT_PARENT'):
+ self._parent = EtoolkitInstance(inst_data['ETOOLKIT_PARENT'], data)
+ self._raw_env_variables.update(self._parent.raw_env_variables)
+ self._sensitive_env_variables.extend(
+ self._parent.sensitive_env_variables
+ )
+ if inst_data.get('ETOOLKIT_SENSITIVE'):
+ if not isinstance(inst_data['ETOOLKIT_SENSITIVE'], list):
+ raise EtoolkitInstanceError(
+ '"ETOOLKIT_SENSITIVE" must be a list'
+ )
+ self._sensitive_env_variables.extend(
+ inst_data['ETOOLKIT_SENSITIVE']
+ )
+ self._raw_env_variables.update(inst_data)
+ # remove non env. variable data
+ self._raw_env_variables.pop('ETOOLKIT_PARENT', None)
+ self._raw_env_variables.pop('ETOOLKIT_SENSITIVE', None)
+ if 'general' in data and 'MASTER_PASSWORD_HASH' in data['general']:
+ self._master_password_hash = data['general'][
+ 'MASTER_PASSWORD_HASH'
+ ]
+
+ @property
+ def master_password(self) -> str:
+ """master_password-property"""
+ return self._master_password
+
+ @master_password.setter
+ def master_password(self, value):
+ """master_password-property setter"""
+ self._master_password = value
+
+ @property
+ def master_password_hash(self) -> str:
+ """master_password_hash-property"""
+ return self._master_password_hash
+
+ @master_password_hash.setter
+ def master_password_hash(self, value):
+ """master_password_hash-property setter"""
+ self._master_password_hash = value
+
+ @property
+ def name(self) -> str:
+ """name-property"""
+ return self._name
+
+ @property
+ def prompt_func(self):
+ """prompt_func-property"""
+ return self._prompt_func
+
+ @prompt_func.setter
+ def prompt_func(self, value):
+ """prompt_func-property setter"""
+ self._prompt_func = value
+
+ @property
+ def raw_env_variables(self) -> dict:
+ """raw_env_variables-property"""
+ return self._raw_env_variables
+
+ @property
+ def sensitive_env_variables(self) -> list:
+ """sensitive_env_variables-property"""
+ return self._sensitive_env_variables
+
+ @staticmethod
+ def confirm_password_prompt(
+ password_hash: str = None, confirm: bool = True
+ ) -> str:
+ """
+ Prompts for master password and then for confirmation if `confirm` True
+
+ :param password_hash: Hash to compare with instead of confirm
+ :type password_hash: str
+
+ :param confirm: Confirm the password (and see if there is a match)
+ :type confirm: bool
+
+ :return: Password provided by the user
+ :rtype: str
+ """
+ try:
+ while True:
+ pass1 = getpass.getpass('Type master password: ')
+ if password_hash:
+ if EtoolkitInstance.password_matches(pass1, password_hash):
+ return pass1
+ print('Wrong password')
+ continue
+ if confirm:
+ pass2 = getpass.getpass('Confirm master password: ')
+ if not pass1 or pass1 != pass2:
+ print('The passwords are either empty or do not match')
+ continue
+ return pass1.strip()
+ except Exception as e:
+ raise EtoolkitInstanceError('Prompt error') from e
+
+ @staticmethod
+ def decrypt(password: str, edata: str) -> str:
+ """
+ Decrypts `edata` using `password`.
+
+ `edata` is in the following format:
+ enc-val$`version-num`$`bas64-salt`$`base64-encrypted_data`
+
+ :param password: The password to generate the key with
+ :type password: str
+
+ :param edata: The data to be decrypted
+ :type edata: str
+
+ :return: The output string / decrypted data
+ :rtype: str
+ """
+ # check for supported versions
+ if not edata.startswith('enc-val$1$'):
+ raise EtoolkitInstanceError(
+ f'Unsupported encryption format: {edata}'
+ )
+ try:
+ salt, data = [base64.b64decode(t) for t in edata[10:].split('$')]
+ nonce = salt[:12]
+ aesgcm = AESGCM(
+ hashlib.scrypt(
+ password.encode('utf-8'),
+ salt=salt,
+ n=2 ** 14,
+ r=8,
+ p=1,
+ dklen=32,
+ )
+ )
+ return aesgcm.decrypt(nonce, data, salt).decode()
+ except InvalidTag as e:
+ raise EtoolkitInstanceError(
+ f'Invalid tag when decrypting: {edata}'
+ ) from e
+ except Exception as e:
+ raise EtoolkitInstanceError(
+ f'Error when decrypting: {edata}'
+ ) from e
+
+ @staticmethod
+ def encrypt(password: str, data: str) -> str:
+ """
+ Encrypts `data` using `password`.
+
+ The output string is in the following format:
+ enc-val$`version-num`$`bas64-salt`$`base64-encrypted_data`
+
+ :param password: The password to generate the key with
+ :type password: str
+
+ :param data: The data to be encrypted
+ :type data: str
+
+ :return: The output string
+ :rtype: str
+ """
+ salt = os.urandom(32)
+ aesgcm = AESGCM(
+ hashlib.scrypt(
+ password.encode('utf-8'),
+ salt=salt,
+ n=2 ** 14,
+ r=8,
+ p=1,
+ dklen=32,
+ )
+ )
+ nonce = salt[:12]
+ edata = aesgcm.encrypt(nonce, data.encode('utf-8'), salt)
+ return (
+ f'enc-val$1${base64.b64encode(salt).decode()}$'
+ f'{base64.b64encode(edata).decode()}'
+ )
+
+ @staticmethod
+ def get_new_password_hash(password: str) -> str:
+ """
+ Returns a complete password hash based on `password`
+
+ This password hash is *not* used as a key when encrypting / decrypting
+ but only for optional check if a correct master password is provided.
+
+ :param password: The plaintext password
+ :type password: str
+
+ :return: The hashed version of `password`
+ :rtype: str
+ """
+ hash_algo = 'sha256'
+ iterations = 100000
+ salt = os.urandom(32)
+ key = hashlib.pbkdf2_hmac(
+ hash_algo, password.encode('utf-8'), salt, iterations
+ )
+ return (
+ f'pbkdf2_{hash_algo}${iterations}$'
+ f'{base64.b64encode(salt).decode()}$'
+ f'{base64.b64encode(key).decode()}'
+ )
+
+ @staticmethod
+ def parse_value(value, macros: dict):
+ """
+ Returns the value with all macros replaced by their values
+
+ If `value` is not of type 'str' simply return `value`
+
+ :param value: A simple value
+ :type value: object
+
+ :param macros: Macros mapping
+ :type macros: dict
+
+ :return: New value with all macros replaced by their values
+ :rtype: object
+ """
+ if not isinstance(value, str):
+ return value
+ for key, val in macros.items():
+ value = value.replace(key, val)
+ return value
+
+ @staticmethod
+ def password_matches(password: str, password_hash: str) -> bool:
+ """
+ Checks `password` agains s stored password hash
+
+ Hash format: pbkdf2_hashalgo$ietarations$salt-base64$key-base64
+
+ :param password: password
+ :type password: str
+
+ :param password_hash: The pbkdf2_hmac password hash
+ :type password_hash: str
+
+ :return: True if the password matches or password_hash is None,
+ :rtype: bool
+ """
+ if password_hash is None:
+ return True
+ # format: pbkdf2_hashalgo$ietarations$salt-base64$key-base64
+ try:
+ tokens = password_hash.split('$')
+ key = hashlib.pbkdf2_hmac(
+ tokens[0].split('_')[1],
+ password.encode('utf-8'),
+ base64.b64decode(tokens[2]),
+ int(tokens[1]),
+ )
+ return key == base64.b64decode(tokens[3])
+ except Exception:
+ return False
+
+ def dump_env(self, env: dict):
+ """
+ Prints an environment dict to stdout.
+
+ :param env: The environment dict
+ :type env: dict
+ """
+ for key, value in env.items():
+ if key in self._sensitive_env_variables:
+ print(f'{key}: ***')
+ continue
+ print(f'{key}: {value}')
+
+ def get_environ(self) -> dict:
+ """
+ Generates a new environ dict
+
+ :return: New environment dict with all macros replaced by their values
+ :rtype: dict
+ """
+ macros = {
+ '%h': os.path.expanduser('~'),
+ '%i': self.name,
+ # '%f': self.get_full_name(),
+ '%u': getpass.getuser(),
+ }
+ new_env = {}
+ for key, value in sorted(
+ self._raw_env_variables.items(), key=lambda x: x[0]
+ ):
+ if not value:
+ # perhaps unset instead of skipping?
+ continue
+ if isinstance(value, str) and value.startswith('enc-val$1$'):
+ value = self._decrypt_value(value)
+ if isinstance(value, str) and value.endswith(':'):
+ # if 'value' ends with ':', append the existing value of
+ # os.environ[key] after the value of 'value'
+ new_env[key] = self.parse_value(
+ value, macros
+ ) + os.environ.get(key, '')
+ elif isinstance(value, str) and value.startswith(':'):
+ # if 'value' starts with ':', append after the existing value
+ # of os.environ[key]
+ new_env[key] = os.environ.get(key, '') + self.parse_value(
+ value, macros
+ )
+ else:
+ # completely overwrite the existing value of os.environ[key]
+ new_env[key] = self.parse_value(value, macros)
+ return new_env
+
+ def get_full_name(self, delimiter: str = '') -> str:
+ """
+ Returns the entire instance inheritence path separated by `delimiter`
+
+ The format is:
+ `grandparent-name``parent-name``instance-name`
+
+ :param delimiter: Delimiter to separate parent instance names by
+ :type delimiter: str
+
+ :return: Path in case this instance has parent, instance.name otherwise
+ :rtype: str
+ """
+ if self._parent is None:
+ return self.name
+ return self._parent.get_full_name(delimiter) + delimiter + self.name
+
+ def _decrypt_value(self, evalue: str) -> str:
+ """
+ Decrypts an encrypted value using the master password
+
+ The method prompts for the master password when it encounters its
+ first encrypted value since the creation of its EtoolkitInstance
+ object
+
+ `evalue` is in the following format:
+ enc-val$`version-num`$`bas64-salt`$`base64-encrypted_data`
+
+ :param evalue: Encrypted value to be decrypted
+ :type evalue: str
+
+ :return: Decrypted value
+ :rtype: str
+ """
+ if self._master_password is None:
+ if self._prompt_func is None:
+ raise EtoolkitInstanceError(
+ 'Neither password or prompt function set'
+ )
+ self._master_password = self._prompt_func(
+ self._master_password_hash, confirm=False
+ )
+ return EtoolkitInstance.decrypt(self._master_password, evalue)
diff --git a/etoolkit_sample.json b/etoolkit_sample.json
new file mode 100644
index 0000000..66c9d17
--- /dev/null
+++ b/etoolkit_sample.json
@@ -0,0 +1,21 @@
+{
+ "general": {
+ "MASTER_PASSWORD_HASH": "pbkdf2_sha256$100000$kFOQkAPtStZ/Ny/O4501ygHGQnqh5Y+ySxF9qVHriv8=$3BujuWzn3CfDnw4yiD9m3F+GjeW1MHHW40R/ThHNcn0="
+ },
+ "instances": {
+ "default": {
+ "ETOOLKIT_PROMPT": "(%i)"
+ },
+ "dev": {
+ "ETOOLKIT_PARENT": "default",
+ "PYTHONPATH": ":/home/user/.pythonpath",
+ "DB_CONNECTION": "enc-val$1$Y/TBb1F3siHTw6qZg9ERzZfA8PLPf2CwGSQLpu9jYWw=$FT5tS9o+ABvsxogIXpJim16Gz5SVtV8="
+ },
+ "secret": {
+ "ETOOLKIT_PARENT": "default",
+ "ETOOLKIT_SENSITIVE": ["PASSWORD"],
+ "GNUPGHOME": "%h/private/.gnupg",
+ "PASSWORD": "enc-val$1$vIBcoCNiYrsDLtF41uLuSEnppBjhliD0B8jwcBJcj/c=$KwOGe/y1dlxktDaCnJPIVNuaQ4Q7yNo="
+ }
+ }
+}
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..b4681c3
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+
+import setuptools
+
+import etoolkit
+
+with open('README.md', 'r', encoding='utf-8') as fh:
+ long_description = fh.read()
+
+
+setuptools.setup(
+ name='etoolkit',
+ version=etoolkit.__version__,
+ author=etoolkit.__author__,
+ author_email='sgs@pichove.org',
+ description=(
+ 'A simple toolkit for setting environment variables in a flexible way'
+ ),
+ license=etoolkit.__license__,
+ long_description=long_description,
+ long_description_content_type='text/markdown',
+ url='https://github.com/blackm0re/etoolkit',
+ packages=setuptools.find_packages(),
+ exclude_package_data={'': ['.gitignore']},
+ entry_points={
+ 'console_scripts': [
+ 'etoolkit=etoolkit.__main__:main',
+ ],
+ },
+ classifiers=[
+ 'Development Status :: 5 - Production/Stable',
+ 'Environment :: Console',
+ 'Intended Audience :: Developers',
+ 'Intended Audience :: System Administrators',
+ (
+ 'License :: OSI Approved :: GNU General Public License v3 or later'
+ ' (GPLv3+)'
+ ),
+ 'Programming Language :: Python :: 3 :: Only',
+ 'Programming Language :: Python :: 3.7',
+ 'Programming Language :: Python :: 3.8',
+ 'Programming Language :: Python :: 3.9',
+ 'Programming Language :: Python :: 3.10',
+ 'Programming Language :: Python :: 3.11',
+ 'Programming Language :: Python :: Implementation',
+ 'Operating System :: POSIX',
+ 'Topic :: Security :: Cryptography',
+ ],
+ keywords='unix environment security cryptography',
+ project_urls={
+ 'Bug Reports': 'https://github.com/blackm0re/etoolkit/issues',
+ 'Source': 'https://github.com/blackm0re/etoolkit',
+ },
+ install_requires=["cryptography>=3.2"],
+ python_requires='>=3.7',
+)
diff --git a/tests/conftest.py b/tests/conftest.py
new file mode 100644
index 0000000..1f70259
--- /dev/null
+++ b/tests/conftest.py
@@ -0,0 +1,59 @@
+# etoolkit
+# Copyright (C) 2021 Simeon Simeonov
+
+# 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 .
+"""Common fixtures"""
+import pytest
+
+
+@pytest.fixture
+def config_data():
+ """config_data for testing"""
+ return {
+ 'general': {
+ 'MASTER_PASSWORD_HASH': (
+ 'pbkdf2_sha256$100000$kFOQkAPtStZ/Ny/O4501ygHGQnqh5Y+ySxF9qVHr'
+ 'iv8=$3BujuWzn3CfDnw4yiD9m3F+GjeW1MHHW40R/ThHNcn0='
+ )
+ },
+ 'instances': {
+ 'default': {'ETOOLKIT_PROMPT': '(%i)'},
+ 'dev': {
+ 'ETOOLKIT_PARENT': 'default',
+ 'PYTHONPATH': ':/home/user/.pythonpath',
+ 'DB_CONNECTION': (
+ 'enc-val$1$Y/TBb1F3siHTw6qZg9ERzZfA8PLPf2CwGSQLpu9jYWw=$FT'
+ '5tS9o+ABvsxogIXpJim16Gz5SVtV8='
+ ),
+ },
+ 'secret': {
+ 'ETOOLKIT_PARENT': 'default',
+ 'ETOOLKIT_SENSITIVE': ['PASSWORD'],
+ 'GNUPGHOME': '%h/private/.gnupg',
+ 'PASSWORD': (
+ 'enc-val$1$vIBcoCNiYrsDLtF41uLuSEnppBjhliD0B8jwcBJcj/c=$Kw'
+ 'OGe/y1dlxktDaCnJPIVNuaQ4Q7yNo='
+ ),
+ },
+ },
+ }
+
+
+@pytest.fixture
+def password_hash():
+ """password hash for testing, corresponding to 'the very secret passwd'"""
+ return (
+ 'pbkdf2_sha256$100000$kFOQkAPtStZ/Ny/O4501ygHGQnqh5Y+ySxF9qVHr'
+ 'iv8=$3BujuWzn3CfDnw4yiD9m3F+GjeW1MHHW40R/ThHNcn0='
+ )
diff --git a/tests/test_cli.py b/tests/test_cli.py
new file mode 100644
index 0000000..1bd9be1
--- /dev/null
+++ b/tests/test_cli.py
@@ -0,0 +1,40 @@
+# etoolkit
+# Copyright (C) 2021 Simeon Simeonov
+
+# 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 .
+"""Tests for the CLI (etoolkit.__main__"""
+import pytest
+
+import etoolkit
+from etoolkit.__main__ import main
+
+
+def test_help(capsys):
+ """Dummy test checking if the CLI is available at all"""
+ with pytest.raises(SystemExit) as exit_info:
+ main(['-h'])
+ assert exit_info.type == SystemExit
+ assert exit_info.value.code == 0
+ assert capsys.readouterr().out.startswith('usage: etoolkit')
+
+
+def test_version(capsys):
+ """Dummy test checking if the CLI is available at all"""
+ with pytest.raises(SystemExit) as exit_info:
+ main(['-v'])
+ assert exit_info.type == SystemExit
+ assert exit_info.value.code == 0
+ assert capsys.readouterr().out.startswith(
+ f'etoolkit {etoolkit.__version__}'
+ )
diff --git a/tests/test_envtoolkit_instance.py b/tests/test_envtoolkit_instance.py
new file mode 100644
index 0000000..2ffacd2
--- /dev/null
+++ b/tests/test_envtoolkit_instance.py
@@ -0,0 +1,64 @@
+# etoolkit
+# Copyright (C) 2021 Simeon Simeonov
+
+# 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 .
+"""Tests for etoolkit.EtoolkitInstance"""
+import pytest
+
+import etoolkit
+
+
+def test_instantiation(config_data, password_hash):
+ """Tests for object instatiation"""
+ with pytest.raises(etoolkit.EtoolkitInstanceError) as exc_info:
+ instance = etoolkit.EtoolkitInstance('devv', config_data)
+ assert exc_info.type is etoolkit.EtoolkitInstanceError
+ assert exc_info.value.args[0] == 'Unknown instance "devv"'
+
+ instance = etoolkit.EtoolkitInstance('secret', config_data)
+ assert 'ETOOLKIT_PARENT' not in instance.raw_env_variables
+ assert 'ETOOLKIT_SENSITIVE' not in instance.raw_env_variables
+ assert 'DB_CONNECTION' not in instance.sensitive_env_variables
+ assert 'PASSWORD' in instance.sensitive_env_variables
+ assert instance.name == 'secret'
+ assert instance.master_password_hash == password_hash
+ assert instance.master_password is None
+
+
+def test_get_environ(config_data):
+ """Tests the EtoolkitInstance.get_environ method"""
+ instance = etoolkit.EtoolkitInstance('secret', config_data)
+ with pytest.raises(etoolkit.EtoolkitInstanceError) as exc_info:
+ env = instance.get_environ()
+ assert exc_info.type is etoolkit.EtoolkitInstanceError
+ assert exc_info.value.args[0] == 'Neither password or prompt function set'
+
+ instance.master_password = 'The very secret passwd' # wrong passwd
+ with pytest.raises(etoolkit.EtoolkitInstanceError) as exc_info:
+ env = instance.get_environ()
+ assert exc_info.type is etoolkit.EtoolkitInstanceError
+ assert exc_info.value.args[0].startswith(
+ 'Invalid tag when decrypting: enc-val$'
+ )
+
+ instance.master_password = 'the very secret passwd' # correct passwd
+ env = instance.get_environ()
+ assert isinstance(env, dict)
+ assert env['PASSWORD'] == 'secret2'
+
+
+def test_get_full_name(config_data):
+ """Tests the EtoolkitInstance.get_full_name method"""
+ instance = etoolkit.EtoolkitInstance('secret', config_data)
+ assert instance.get_full_name('->') == 'default->secret'
diff --git a/tests/test_envtoolkit_instance_static.py b/tests/test_envtoolkit_instance_static.py
new file mode 100644
index 0000000..d7ac857
--- /dev/null
+++ b/tests/test_envtoolkit_instance_static.py
@@ -0,0 +1,102 @@
+# etoolkit
+# Copyright (C) 2021 Simeon Simeonov
+
+# 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 .
+"""Tests for etoolkit.EtoolkitInstance static methods"""
+import unittest.mock
+
+import pytest
+
+import etoolkit
+
+
+@unittest.mock.patch('getpass.getpass')
+def test_confirm_password_prompt(getpass, password_hash):
+ """Tests the static EtoolkitInstance.confirm_password_prompt method"""
+ getpass.return_value = 'the very secret passwd'
+ assert (
+ etoolkit.EtoolkitInstance.confirm_password_prompt(password_hash)
+ == 'the very secret passwd'
+ )
+ assert (
+ etoolkit.EtoolkitInstance.confirm_password_prompt(password_hash, False)
+ == 'the very secret passwd'
+ )
+
+
+def test_decrypt():
+ """Tests the static EtoolkitInstance.decrypt method"""
+ assert (
+ etoolkit.EtoolkitInstance.decrypt(
+ 'the very secret passwd',
+ (
+ 'enc-val$1$Y/TBb1F3siHTw6qZg9ERzZfA8PLPf2CwGSQLpu9jYWw=$FT5tS9'
+ 'o+ABvsxogIXpJim16Gz5SVtV8='
+ ),
+ )
+ == 'secret1'
+ )
+
+ # now test with modified edata
+ with pytest.raises(etoolkit.EtoolkitInstanceError) as exc_info:
+ edata = (
+ 'enc-val$1$Y/TBb1F3siHTw6qZg9ERzZfA8PLPf2CwGSQLpu9jYWw=$FT5tS9'
+ 'o+ABvsxogIXpJim17Gz5SVtV8='
+ )
+ etoolkit.EtoolkitInstance.decrypt(
+ 'the very secret passwd', edata
+ ) == 'secret1'
+ assert exc_info.type is etoolkit.EtoolkitInstanceError
+ assert exc_info.value.args[0] == f'Invalid tag when decrypting: {edata}'
+
+
+def test_encrypt():
+ """Tests the static EtoolkitInstance.encrypt method"""
+ edata = etoolkit.EtoolkitInstance.encrypt('foo', 'bar')
+ assert edata.startswith('enc-val$')
+ assert len(edata) == 83
+ # the edata should always be different because of random salting
+ assert edata != etoolkit.EtoolkitInstance.encrypt('foo', 'bar')
+
+
+def test_get_new_password_hash():
+ """Tests the static EtoolkitInstance.get_new_password_hash method"""
+ new_hash = etoolkit.EtoolkitInstance.get_new_password_hash(
+ 'the very secret passwd'
+ )
+ # all pbkdf2 params are the same / hardcoded for the time being
+ assert new_hash.startswith('pbkdf2_sha256$100000$')
+ assert len(new_hash) == 110
+ # the hash should always be different because of random salting
+ assert new_hash != etoolkit.EtoolkitInstance.get_new_password_hash(
+ 'the very secret passwd'
+ )
+
+
+def test_parse_value():
+ """Tests the static EtoolkitInstance.parse_value method"""
+ assert (
+ etoolkit.EtoolkitInstance.parse_value('t%bs%t', {'%b': 'e', '%t': 't'})
+ == 'test'
+ )
+
+
+def test_password_matches(password_hash):
+ """Tests the static EtoolkitInstance.password_matches method"""
+ assert etoolkit.EtoolkitInstance.password_matches(
+ 'the very secret passwd', password_hash
+ )
+ assert not etoolkit.EtoolkitInstance.password_matches(
+ 'the very secret passwdo', password_hash
+ )
--
cgit v1.3