diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..53d1f3d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ + 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..bbbfec6 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# LDAP User Directory Tool + +A Python tool for interacting with LDAP user and group directories, particularly useful for Active Directory management. + +## Features + +- List users and groups from LDAP directories +- Manage group memberships (add/remove users) +- Query user information by username or email +- Recursive group membership resolution +- Support for MS SFU (Services for Unix) attributes +- Paged results for large directories + +## Installation + +```bash +pip install ldapuserdir +``` + +## Usage + +```bash +# List groups matching a pattern +ldapuserdir-ctl 'svc-cluster_*' + +# Get group memberships for a user +ldapuserdir-ctl -g username + +# Add users to a group +ldapuserdir-ctl -a groupname user1 user2 user3 + +# Remove users from a group +ldapuserdir-ctl -d groupname user1 user2 + +# List users matching a pattern +ldapuserdir-ctl -u 'username*' + +# List users by email pattern +ldapuserdir-ctl -m '*@example.com' +``` + +## Configuration + +Create a configuration file at `~/.ldapuserdir-ctl.cfg` or `/etc/ldapuserdir-ctl.cfg`: + +```ini +[Ldap] +serverurl = ldaps://your-ldap-server:636 +user_ou = OU=Users,DC=example,DC=com +group_ou = OU=Groups,DC=example,DC=com +default_user_dn = CN=service-account,OU=Service Accounts,DC=example,DC=com +default_user_pw = service-account-password +default_group_filter = svc-* +``` + +## Requirements + +- Python 3.6+ +- python-ldap 3.0.0+ +- Access to an LDAP server (Active Directory or other LDAP-compatible directory) + +## License + +GPLv3+ diff --git a/bin/ldapuserdir-ctl b/bin/ldapuserdir-ctl index 38e7975..9bf5de3 100755 --- a/bin/ldapuserdir-ctl +++ b/bin/ldapuserdir-ctl @@ -1,4 +1,10 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 + +""" +Script to retrieve group and user information from an AD using LDAP. + +Author: Derek Feichtinger +""" import logging from ldapuserdir import LdapUserDir, __version__ as libversion, LdapUserDirError @@ -6,15 +12,18 @@ import ldap import sys import os import pwd -from optparse import OptionParser +import argparse import configparser import getpass -class MyOptParser(OptionParser): - """OptionParser derived class for enabling us to give out a +class MyArgParser(argparse.ArgumentParser): + """ArgumentParser derived class for enabling us to give out a nicer help text where text can follow the option section""" - def format_epilog(self, formatter): - return self.epilog.replace('%prog',os.path.basename(sys.argv[0])) + def format_help(self): + formatter = self._get_formatter() + formatter.add_text(self.description) + formatter.add_text(self.epilog.replace('%(prog)s', os.path.basename(sys.argv[0]))) + return formatter.format_help() def read_cfg(filename): cfg = configparser.ConfigParser() @@ -47,9 +56,9 @@ cfgfile_loc = [os.path.expanduser('~/.ldapuserdir-ctl.cfg'), '/etc/ldapuserdir-ctl.cfg'] config = { 'serverurl' : 'ldaps://xyzdir.example.com:636', - 'user_ou' : 'OU=Users,DC=example.com,DC=ch', - 'group_ou' : 'OU=Groups,DC=example.com,DC=ch', - 'default_user_dn' : 'CN=minpriv_user,OU=Services,DC=example.com,DC=ch', + 'user_ou' : 'OU=Users,DC=example.com,DC=org', + 'group_ou' : 'OU=Groups,DC=example.com,DC=org', + 'default_user_dn' : 'CN=minpriv_user,OU=Services,DC=example.com,DC=org', 'default_user_pw' : 'dummypwd', 'default_group_filter' : 'svc-cluster_merlin*' } @@ -71,7 +80,7 @@ mylogger.addHandler(ch) ################################################ # OPTION PARSING -usage = """%prog [options] groupname [usernames] +usage = """%(prog)s [options] groupname [usernames] Shows or changes members of a group in Active Directory. Also can be used to investigate users and their group memberships. @@ -94,150 +103,149 @@ usage += """ usage_epilog = """ Examples: List group members - %prog svc-cluster_merlin5 - %prog 'svc-cluster_*' + %(prog)s svc-cluster_merlin5 + %(prog)s 'svc-cluster_*' Get group memberships for user mueller (optionally with a group filter) - %prog -g mueller - %prog -g mueller 'svc-cluster_merlin5' - %prog -g mueller 'svc-cluster_*' + %(prog)s -g mueller + %(prog)s -g mueller 'svc-cluster_merlin5' + %(prog)s -g mueller 'svc-cluster_*' Add/delete users to/from a group (requires access rights defined in LDAP service!) - %prog -a svc-ra_x06sa user1 user2 user3 - %prog -d svc-ra_x06sa user1 user2 + %(prog)s -a svc-ra_x06sa user1 user2 user3 + %(prog)s -d svc-ra_x06sa user1 user2 List users matching a pattern - %prog -u 'mueller*' + %(prog)s -u 'mueller*' List users matching a mail address pattern - %prog -m '*mueller@psi*' + %(prog)s -m '*mueller@example*' - Author: 2013-19 D. Feichtinger """ examplecfg = """# Configuration file example: [Ldap] # URL for contacting the LDAP server -serverurl = ldaps://d.psi.ch:636 +serverurl = ldaps://d.example.org:636 # base ldap path under which all users are found -user_ou = OU=Users,OU=PSI,DC=d,DC=psi,DC=ch +user_ou = OU=Users,OU=ExampleOrg,DC=d,DC=example,DC=org # base ldap path under which groups are found -group_ou = ou=Groups,ou=PSI,dc=d,dc=psi,dc=ch +group_ou = ou=Groups,ou=ExampleOrg,dc=d,dc=example,dc=org # minimally privileged Ldap user and password for running normal # lookup queries -default_user_dn = CN=linux_ldap,OU=Services,OU=IT,DC=d,DC=psi,DC=ch +default_user_dn = CN=linux_ldap,OU=Services,OU=IT,DC=d,DC=example,DC=org default_user_pw = DEFaultPassword # Optional: # default filter to be used for group searches default_group_filter = svc-ra* """ -#parser = OptionParser(usage = usage, epilog = usage_epilog) -parser = MyOptParser(usage = usage, epilog = usage_epilog) -parser.add_option('-a', - action = 'store_true', - dest = 'flag_add', - help = 'add group members', -) -parser.add_option('-d', - action = 'store_true', - dest = 'flag_del', - help = 'delete group members', -) -parser.add_option('-g', - action = 'store', - dest = 'user_to_group', - help = 'get group memberships for this user', - default = '' -) -parser.add_option('-u', - action = 'store', - dest = 'userfilter', - help = 'list all ldap users matching the filter expression' -) -parser.add_option('-m', '--mail', - action = 'store', - dest = 'mailfilter', - help = 'list all ldap users based on the mail address filter expression' -) -parser.add_option('--dn', - action = 'store_true', - dest = 'flag_showdn', - help = 'show full DNs in the output', - default = False -) -parser.add_option('-c', - action = 'store', - dest = 'cfgfile', - help = 'path of a config file (else tries default locations)', - default = '' -) -parser.add_option('-D', - action = 'store', - dest = 'user_dn', - help = 'DN or CN of ldap user for binding to the AD server (%s)' % config['default_user_dn'], - default = None -) -parser.add_option('-f', - action = 'store', - dest = 'pwfile', - help = 'path to password file (without this pwd will be prompted for)', - default = '' -) -parser.add_option('-v', - action = 'count', - dest = 'verbosity', - help = 'use more verbose output (for group and user lists. Verbosity can be increased by multiple -v flags)', - default = False -) -parser.add_option('--user-ou', - action = 'store', - dest = 'user_ou', - help = 'default OU for users (%s)' % config['user_ou'], - default = None -) -parser.add_option('--group-ou', - action = 'store', - dest = 'group_ou', - help = 'default OU for groups (%s)' % config['group_ou'], - default = None -) -parser.add_option('-n', '--allow-no-mssfu', - action = 'store_false', - dest = 'flag_mssfu', - help = 'do not restrict to entries with unix (msSFU) mappings', - default = True -) -parser.add_option('--debug', - action = 'store_true', - dest = 'flag_debug', - help = 'debug mode: log messages at debug level', -) -parser.add_option('--showconf', - action = 'store_true', - dest = 'flag_examplecfg', - help = 'show an example configuration file', - default= False -) -parser.add_option('-V', - action = 'store_true', - dest = 'flag_version', - help = 'show version information', - default = False +# Create argument parser +parser = MyArgParser( + description=usage.strip(), + epilog=usage_epilog.strip(), + formatter_class=argparse.RawDescriptionHelpFormatter, + add_help=False ) -parser.add_option('-R', - action = 'store_false', - dest = 'recursive', - help = "Don't recursively resolve groups", - default = True -) +# Add arguments +parser.add_argument('-a', + action='store_true', + dest='flag_add', + help='add group members') +parser.add_argument('-d', + action='store_true', + dest='flag_del', + help='delete group members') +parser.add_argument('-g', + action='store', + dest='user_to_group', + help='get group memberships for this user', + default='') +parser.add_argument('-u', + action='store', + dest='userfilter', + help='list all ldap users matching the filter expression') +parser.add_argument('-m', '--mail', + action='store', + dest='mailfilter', + help='list all ldap users based on the mail address filter expression') +parser.add_argument('--dn', + action='store_true', + dest='flag_showdn', + help='show full DNs in the output', + default=False) +parser.add_argument('-c', + action='store', + dest='cfgfile', + help='path of a config file (else tries default locations)', + default='') +parser.add_argument('-D', + action='store', + dest='user_dn', + help='DN or CN of ldap user for binding to the AD server (%s)' % config['default_user_dn'], + default=None) +parser.add_argument('-f', + action='store', + dest='pwfile', + help='path to password file (without this pwd will be prompted for)', + default='') +parser.add_argument('-v', + action='count', + dest='verbosity', + help='use more verbose output (for group and user lists. Verbosity can be increased by multiple -v flags)', + default=False) +parser.add_argument('--user-ou', + action='store', + dest='user_ou', + help='default OU for users (%s)' % config['user_ou'], + default=None) +parser.add_argument('--group-ou', + action='store', + dest='group_ou', + help='default OU for groups (%s)' % config['group_ou'], + default=None) +parser.add_argument('-n', '--allow-no-mssfu', + action='store_false', + dest='flag_mssfu', + help='do not restrict to entries with unix (msSFU) mappings', + default=True) +parser.add_argument('--debug', + action='store_true', + dest='flag_debug', + help='debug mode: log messages at debug level') +parser.add_argument('--showconf', + action='store_true', + dest='flag_examplecfg', + help='show an example configuration file', + default=False) +parser.add_argument('-V', + action='store_true', + dest='flag_version', + help='show version information', + default=False) +parser.add_argument('-R', + action='store_false', + dest='recursive', + help="Don't recursively resolve groups", + default=True) +parser.add_argument('-h', '--help', + action='help', + help='show this help message and exit') -(options, args) = parser.parse_args() +# Add positional arguments for groupname and usernames +parser.add_argument('groupname', + nargs='?', + help='group name pattern') +parser.add_argument('usernames', + nargs='*', + help='user names to add/remove') + +options = parser.parse_args() if options.flag_debug: ch.setLevel(logging.DEBUG) @@ -349,8 +357,8 @@ try: if mode == 'grouplist': sfilter = config['default_group_filter'] - if args: - sfilter = args.pop(0) + if options.groupname: + sfilter = options.groupname ldapdir.list_groups(sfilter, mssfu=flag_mssfu, returndn=flag_showdn, verbose=verbosity, recursive=options.recursive) @@ -366,8 +374,8 @@ try: elif mode == 'user_to_group': sfilter = None - if args: - sfilter = args.pop(0) + if options.groupname: + sfilter = options.groupname try: sys.stdout.write("\n".join(ldapdir.get_groups_for_user(user_to_group, gfilter=sfilter, @@ -385,18 +393,18 @@ try: sys.exit(1) elif mode == 'add': - if len(args) < 2: + if not options.groupname or not options.usernames: sys.stderr.write("Error: Not enough arguments\n") sys.exit(1) - group = args.pop(0) - ldapdir.add_groupmembers(group, args) + group = options.groupname + ldapdir.add_groupmembers(group, options.usernames) elif mode == 'del': - if len(args) < 2: + if not options.groupname or not options.usernames: sys.stderr.write("Error: Not enough arguments\n") sys.exit(1) - group = args.pop(0) - ldapdir.del_groupmembers(group, args) + group = options.groupname + ldapdir.del_groupmembers(group, options.usernames) except ldap.INVALID_CREDENTIALS as e: sys.exit(1) diff --git a/conda-recipe/ldapuserdir/build.sh b/conda-recipe/ldapuserdir/build.sh deleted file mode 100644 index 8e25a14..0000000 --- a/conda-recipe/ldapuserdir/build.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash - -$PYTHON setup.py install diff --git a/conda-recipe/ldapuserdir/meta.yaml b/conda-recipe/ldapuserdir/meta.yaml deleted file mode 100644 index 0a6da6d..0000000 --- a/conda-recipe/ldapuserdir/meta.yaml +++ /dev/null @@ -1,30 +0,0 @@ -package: - name: ldapuserdir - version: "2.2.1" - -source: - path: ../../ - #fn: ldapuserdir-2.1.1.tar.gz - #md5: 14aca74738002d0943da253bc8f4642e - -requirements: - build: - - python - - setuptools - - python-ldap - run: - - python - - python-ldap - - configparser - -build: - preserve_egg_dir: True - -build: - has_prefix_files: - - bin/ldapuserdir-ctl - -about: - license: GPLv2 - summary: 'Client for interacting with a LDAP user/group directory service' - diff --git a/do_release.py b/do_release.py index 32734ef..3bbd45a 100644 --- a/do_release.py +++ b/do_release.py @@ -1,7 +1,6 @@ #/usr/bin/python # # A first simplistic try at a release helper script -# Derek Feichtinger import subprocess import sys @@ -89,8 +88,8 @@ prefix=/usr [bdist_rpm] Release=1.el6 Group=Applications/Internet -Vendor=PSI -Packager=Derek Feichtinger +Vendor=ExampleOrg +Packager=User Name #Provides Requires=python-ldap #Conflicts diff --git a/docs/conf.py b/docs/conf.py index 168e6b2..93bfe1b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,7 +44,7 @@ master_doc = 'index' # General information about the project. project = u'ldapuserdir' -copyright = u'2013, Derek Feichtinger' +copyright = u'2013, ' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -190,7 +190,7 @@ latex_elements = { # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'ldapuserdir.tex', u'ldapuserdir Documentation', - u'Derek Feichtinger', 'manual'), + u'User', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -220,7 +220,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'ldapuserdir', u'ldapuserdir Documentation', - [u'Derek Feichtinger'], 1) + [u'User'], 1) ] # If true, show URL addresses after external links. @@ -234,7 +234,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ ('index', 'ldapuserdir', u'ldapuserdir Documentation', - u'Derek Feichtinger', 'ldapuserdir', 'One line description of project.', + u'User', 'ldapuserdir', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/ldapuserdir-ctl.rst b/docs/ldapuserdir-ctl.rst index 13a2b02..425e5ce 100644 --- a/docs/ldapuserdir-ctl.rst +++ b/docs/ldapuserdir-ctl.rst @@ -21,13 +21,13 @@ Options:: mappings --debug debug mode: log messages at debug level -D USER_DN DN or CN of ldap user for binding to the AD server - (CN=minpriv_user,OU=Services,DC=example.com,DC=ch) + (CN=minpriv_user,OU=Services,DC=example.com,DC=org) -f PWFILE path to password file (without this pwd will be prompted for) -g USER_TO_GROUP get group memberships for this user -v use more verbose output (with user list only) - --user-ou=USER_OU default OU for users (OU=Users,DC=example.com,DC=ch) - --group-ou=GROUP_OU default OU for groups (OU=Groups,DC=example.com,DC=ch) + --user-ou=USER_OU default OU for users (OU=Users,DC=example.com,DC=org) + --group-ou=GROUP_OU default OU for groups (OU=Groups,DC=example.com,DC=org) -n, --allow-no-mssfu do not restrict to entries with unix (msSFU) mappings -V show version information diff --git a/etc/ldapuserdir-ctl.cfg b/etc/ldapuserdir-ctl.cfg index 8be4a30..855d679 100644 --- a/etc/ldapuserdir-ctl.cfg +++ b/etc/ldapuserdir-ctl.cfg @@ -18,4 +18,4 @@ default_user_pw = secret_pwd # Optional # default filter to be used for group searches -default_group_filter = svc-ra* +default_group_filter = svc-merlin* diff --git a/ldapuserdir/ldapuserdir.py b/ldapuserdir/ldapuserdir.py index f8fd7f0..a74bbed 100755 --- a/ldapuserdir/ldapuserdir.py +++ b/ldapuserdir/ldapuserdir.py @@ -1,13 +1,14 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 ###################################################################### # Tool for modifying group memberships in AD # -# Author: Derek Feichtinger -# ###################################################################### -""" This module provides the LdapUserDir class. It is used to interact -with an LDAP based user directory service +""" +This module provides the LdapUserDir class. It is used to interact +with an LDAP based user directory service. + +Author: Derek Feichtinger """ import ldap @@ -23,7 +24,7 @@ import itertools class LdapUserDirError(Exception): """Exception class for LdapUserDir error conditions""" def __init__(self, errmsg): - super(LdapUserDirError, self).__init__(errmsg) + super().__init__(errmsg) class LdapUserDir(object): @@ -112,7 +113,7 @@ class LdapUserDir(object): @staticmethod def ensure_utf8(bstr): try: - if type(bstr) == bytes: + if isinstance(bstr, bytes): return bstr.decode('utf-8') except UnicodeDecodeError: pass @@ -445,7 +446,7 @@ class LdapUserDir(object): # The following filter is necessary, because AD yielded # some (None,String) fields when searching with - # --group-ou='dc=d,dc=psi,dc=ch'. This led to errors. + # --group-ou='dc=d,dc=example,dc=org'. This led to errors. r = [el for el in r if el[0] is not None] return r @@ -598,7 +599,7 @@ class LdapUserDir(object): print("(%s)" % gid) if 'member' in entry: for member in (self.ensure_utf8(m) for m in entry['member']): - # Check if member is itself a group. This might be PSI-specific + # Check if member is itself a group. This might be ExampleOrg-specific is_group = self._is_group(member) if recursive and is_group: self.list_groups( @@ -686,9 +687,8 @@ class LdapUserDir(object): # self.logger.debug("_is_group: %s %s:" % (self.group_ou, dn)) - # Note that lower() is not a good casefold alternative - # but this is python 2 - return self.group_ou.lower() in dn.lower() + # Use casefold() for proper case-insensitive comparison in Python 3 + return self.group_ou.casefold() in dn.casefold() def _mod_groupmembers(self, ldapmode, dngroup, usernames): """modifies (adds/deletes) members of an LDAP group entry diff --git a/setup.cfg b/setup.cfg index 816be35..c608ccb 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,21 +1,34 @@ # setup.cfg for ldapuserdir +[metadata] +license_files = LICENSE + +[options] +zip_safe = False +include_package_data = True + +[options.packages.find] +exclude = + tests* + docs* + build* + dist* + *.egg-info* + [build] -#executable=/usr/bin/python +# No longer needed for modern setuptools [install] -#prefix=/usr -#install-data=/ +# No longer needed for modern setuptools [bdist_rpm] -Release=1.el6 +Release=1 Group=Applications/Internet -Vendor=PSI -Packager=Derek Feichtinger -#Provides -Requires=python-ldap -#Conflicts -#Obsoletes -#Distribution -#BuildRequires -#Icon +Vendor=ExampleOrg +Packager=User Name +Requires=python3-ldap + +[egg_info] +tag_build = +tag_date = 0 +tag_svn_revision = 0 diff --git a/setup.py b/setup.py index fd692df..d230972 100644 --- a/setup.py +++ b/setup.py @@ -1,30 +1,46 @@ -#from setuptools import setup, find_packages -#from distutils.core import setup +from setuptools import setup, find_packages -# we use the distribute framework that has a backward compatible invocation -# to the setuptools -from setuptools import setup - -# we get the package version from inside our package, since we then -# can use it also from within the package -#from ldapuserdir.version import __version__ -# py2.7 way: execfile('ldapuserdir/version.py') +# Read version from file exec(open("ldapuserdir/version.py").read()) +with open("README.md", "r", encoding="utf-8") as fh: + long_description = fh.read() + setup( name="ldapuserdir", version=__version__, description="Client for interacting with a LDAP user/group directory service", - long_description="Client for listing user and group information and" - + " for managing group memberships", - author="Derek Feichtinger", - author_email="derek.feichtinger@psi.ch", - license="GPL", - packages=['ldapuserdir'], + long_description=long_description, + long_description_content_type="text/markdown", + author="User Name", + author_email="user.name@example.org", + license="GPLv3+", + packages=find_packages(), scripts=['bin/ldapuserdir-ctl'], - - # following format is (targetdir,[list of files]) data_files=[('etc', ['etc/ldapuserdir-ctl.cfg'])], - - #install_requires=['python-ldap'] + install_requires=[ + 'python-ldap>=3.0.0', + ], + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Intended Audience :: System Administrators', + 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', + 'Natural Language :: English', + 'Operating System :: POSIX :: Linux', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.6', + '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 :: 3.12', + 'Topic :: System :: Systems Administration :: Authentication/Directory :: LDAP', + ], + keywords='ldap active-directory user group management', + project_urls={ + 'Source': 'https://github.com/example/ldapuserdir', + 'Tracker': 'https://github.com/example/ldapuserdir/issues', + }, )