diff --git b/LICENSE.txt a/LICENSE.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ a/LICENSE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git b/README.md a/README.md new file mode 100644 index 0000000..5c54b66 --- /dev/null +++ a/README.md @@ -0,0 +1,158 @@ +FreeIPA Scripts +=============== +This repository contains a small collection of scripts written to migrate my +existing LDAP/DNS setup (MacOS Server) to [FreeIPA](https://www.freeipa.org) +and manage my setup afterwards. These scripts provide functionality unavailable +in the FreeIPA command line tools. They use the FreeIPA API as much as possible +as I didn't like the provided alternatives for migration to directly update the +FreeIPA LDAP database. Most of these script / commands are meant to synchronize +between an existing situation and FreeIPA and are safe to run multiple times. +As side-effect, this also makes them suitable to support a gradual migration +over time (where a source system is still in production until final cut-over) + +The latest versions, documentation and a bug tracker are available on my +[GitLab instance](https://gitlab.lindenaar.net/scripts/freeipa) + +Copyright (c) 2018 Frederik Lindenaar. free for distribution under the GNU +General Public License, see [below](#license) + +Contents +======== +This repository contains the following scripts: + * [users2freeipa.py](#users2freeipa) + is a migration script to transfer/synchronize LDAP users to/with FreeIPA + * [freeipa-dns.py](#freeipadns) + is a script providing functionality not available in FreeIPA itself to + migrate/synchronize and maintain DNS zones in FreeIPA + + +<a name=users2freeipa>users2freeipa.py</a> +--------------------------------------------- +This script uses LDAP to obtain users from a MacOS Server (or other LDAP) +server and synchronizes the results with the users registered in FreeIPA. +Since it synchronizes data it is safe to run multiple times and users can be +imported also as stage users initially. + +The intent is to migrate user data and to not drag on a legacy setup. For +this reason, the script will create new user and group IDs and not copy homedir +and shell information by default. For the IDs, the legacy information can be +stored in an FreeIPA ID View so it remains available, other items can be copied +over using command line options. Passwords can be copied-over (if available in +a usable format), and the script also supports having FreeIPA generate random +passwords and store these in a file for further processing/sharing with users. + +Users can be copied from an existing (generic) LDAP database and a MacOS Server +OpenDirectory-flavor LDAP server. In this case, additional information (e.g. +Apple's generatedUID) will be copied over as well. Please note that this does +require customizing the FreeIPA LDAP schema, which the script will check for +and can install (option ```-U```). As the setup is modular it should be easy +to tweak or add other migrations. + +By default all users will be migrated/synchronized, but it is also possible to +limit this to specific user(s) or group(s) or specifically exclude specific +users or groups. An example to copy all users in the group ```workgroup``` +except ```admin``` from an Apple MacOS OpenDirectory server: +~~~ +./users2freeipa.py -v -O -U -c "Legacy LDAP" -g workgroup -x admin -G \ + -P -p passwords.txt ldap://ldap.mydomain.tld +~~~ +This will also install the OpenDirectory-specific schema customization, create +groups and copy group memberships, copy usuable passwords and ensure that all +users have a password (storing generated passwords to ```passwords.txt```) + +Before running a production user migration, it is important to have FreeIPA +setup and configured correctly so that the right defaults are used for new +users. Best is to start with a single user and add that as a stage user (please +note that this will not yet assign userIDs, group memberships and a password +as FreeIPA does not yet support that) and use an ID View to store legacy data. + +For all available command-line options, run ```users2freeipa.py -h``` + + +<a name=freeipadns>freeipa-dns.py</a> +---------------------------------------------------------------- +This script provides functionality not provided by FreeIPA to migrate and/or +synchronize / maintain DNS data in FreeIPA. Currently the following commands +are implemented: + * axfr - import/synchronize a DNS zone in FreeIPA using a zone-xfer. + for example, to migrate / synchronize fromain ```domain.tld``` from DNS + server ```192.168.1.53``` without checking DNS overlap, issue the command: + ~~~ + ./freeipa-dns.py -v axfr -T 172.1.2.53 -n -f none 192.168.1.53 domain.tld + ~~~ + in addition, this will ensure zone-xfers are allowed from ```172.1.2.53``` + and disable forwarding in FreeIPA. + * copy - copy a DNS record in FreeIPA within or between zones + for example, to copy ```A``` and ```AAAA``` from host ```wwww.domain.tld``` + to the domain ```domain.tld``` itself, issue the command: + ~~~ + ./freeipa-dns.py -v copy -l A AAAA wwww.domain.tld -T domain.tld + ~~~ + * move - move a DNS record in FreeIPA from one one to another + for example, to move ```host1.int``` in zone ```domain.tld``` to ```host``` + in zone ```int.domain.tld``` issue the command: + ~~~ + ./freeipa-dns.py -v move -z domain.tld host.int host.int.domain.tld + ~~~ + * serial - update (set) zone serial(s) in FreeIPA, supporting both RFC1912 + style serials (YYYYMMDD##) based on current date and setting the serial to + a specific value. To set the serial of a zone to revision 2 of today for + zones ```zone1.mydomain.tld``` and ```zone2.mydomain.tld```, run: + ~~~~ + ./freeipa-dns.py -v serial -t 2 zone1.mydomain.tld zone2.mydomain.tld + ~~~~ + by default this command will set the serial to a larger value (which can be + overridden with the ```-f```/```--force``` flag) + * generate - generate number-range DNS records/attributes in FreeIPA + This is meant to generate series of hosts or attributes, for example, to + generate hosts ```dhcp-01``` to ```dhcp-10``` in zone ```int.mydomain.tld``` + with ip addresses starting from ```192.168.2.100``` issue to command: + ~~~ + ./freeipa-dns.py -v generate int.mydomain.tld dhcp-%02d -4 192.168.2.100 \ + --auto-increment-a -n 5 + ~~~ + it can also be used to generate a farm of web servers in different subnets + with the command: + ~~~ + ./freeipa-dns.py -v generate int.mydomain.tld www -4 192.168.%d.80 -n 5 + ~~~ + * reverse-ptr - create/update reverse DNS (PTR) entries in FreeIPA + With this command reverse-zones can be automatically maintained. it scans + the zones in FreeIPA for ```A``` and ```AAAA``` records and creates the + corresponding records in the ```in-addr.arpa``` and ```ip6.arpa``` zones. + The reverse zones must exist, and can also be created with this command by: + ~~~ + ./freeipa-dns.py -v reverse-ptr -n -p -c 10. 10.100 192.168 2001:0db8:85a3 + ~~~ + which will create the reverse zones for prefixes 10.* 10.100.* 192.168.* + and ipv6 prefix 2001:0db8:85a3. Reverse (PTR) records will automatically be + created in the correct zone with the following command: + ~~~ + ./freeipa-dns.py -v reverse-ptr -a + ~~~ + by default, the command will not overwrite existing records, (which can be + overridden with the ```-o```/```--override``` flag). To force a PTR record + to point to a specific host, e.g. ```www.mydomain.tld``` run the command: + ~~~ + ./freeipa-dns.py -v reverse-ptr -o -z mydomain.tld -H www + ~~~ + +for available commands run ```freeipa-dns.py -h``` and to get an overview of +the available options for each commmand run ```freeipa-dns.py <command> -h``` + + +<a name="license">License</a> +----------------------------- +These scripts, documentation & configration examples are free software: you can +redistribute 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 script, documenatation and configuration examples are 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, download it from <http://www.gnu.org/licenses/>. + diff --git b/freeipa-dns.py a/freeipa-dns.py new file mode 100755 index 0000000..ed777a0 --- /dev/null +++ a/freeipa-dns.py @@ -0,0 +1,597 @@ +#! /usr/bin/env python3 +# +# freeipa-dns.py - python script to migrate and maintain DNS domains in FreeIPA +# +# Version 1.0, latest version, documentation and bugtracker available at: +# https://gitlab.lindenaar.net/scripts/freeipa +# +# Copyright (c) 2018 Frederik Lindenaar +# +# This script is free software,you can redistribute and/or modify it under the +# terms of version 3 of the GNU General Public License as published by the Free +# Software Foundation, or (at your option) any later version of the license. +# +# This script 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, visit <http://www.gnu.org/licenses/> to download it. + +""" +migrate/synchronize and maintain DNS domain(s) with FreeIPA. + +This script provides functionality not provided by FreeIPA to migrate and/or +synchronize / maintain DNS data in FreeIPA. Currently the following commands +are implemented: + axfr import/synchronize a DNS zone in FreeIPA using a zone-xfer + copy copy a DNS record in FreeIPA within or between zones + move move a DNS record in FreeIPA from one one to another + serial update (set) zone serial(s) in FreeIPA + generate generate number-range DNS records/attributes in FreeIPA + reverse-ptr create/update reverse DNS (PTR) entries in FreeIPA + +for available commands run 'freeipa-dns.py -h and to get an overview of +the available options for each commmand run 'freeipa-dns.py <command> -h' +""" + +import os, logging +from datetime import date +from argparse import ArgumentParser, FileType, \ + _StoreAction as StoreAction, _StoreConstAction as StoreConstAction + +import dns.query +import dns.zone +from dns.rdatatype import SOA, HINFO +from dns.exception import DNSException + +from ipalib import api +from ipalib.errors import PublicError, AuthenticationError, NotFound + + +VERSION="1.0" +PROG_NAME=os.path.splitext(os.path.basename(__file__))[0] +PROG_VERSION=PROG_NAME + ' ' + VERSION +LOG_FORMAT='%(levelname)s - %(message)s' +LOG_FORMAT_FILE='%(asctime)s - ' + LOG_FORMAT + +logger = logging.getLogger(PROG_NAME) + + +##################[ Action to immediately set the log level ]################## +class SetLogLevel(StoreConstAction): + """ArgumentParser action to set log level to provided const value""" + def __call__(self, parser, namespace, values, option_string=None): + logging.getLogger(PROG_NAME).setLevel(self.const) + +####################[ Action to immediately log to a file ]#################### +class SetLogFile(StoreAction): + """ArgumentParser action to log to file (sets up FileHandler accordingly)""" + def __call__(self, parser, namespace, values, option_string=None): + super(SetLogFile, self).__call__(parser,namespace,values,option_string) + formatter = logging.Formatter(LOG_FORMAT_FILE) + handler = logging.FileHandler(values) + handler.setFormatter(formatter) + logger = logging.getLogger(PROG_NAME) + logger.propagate = False + logger.addHandler(handler) + +def get_zone_opts(args): + return { + 'dnsttl': None if args.ttl is None else str(args.ttl), + 'dnsdefaultttl': None if args.default_ttl is None else str(args.default_ttl), + 'idnsforwardpolicy':args.forward_policy, + 'idnsforwarders': args.forwarder, + 'idnsallowquery': ';'.join(args.allow_query)+';' if args.allow_query else None, + 'idnsallowtransfer':';'.join(args.allow_transfer)+';' if args.allow_transfer else None, + 'idnsallowsyncptr': args.create_reverse_ptr, + }, { + 'skip_nameserver_check':args.no_ns_check, + 'skip_overlap_check': args.no_ns_check, + }, { + 'force': args.no_ns_check, + } + +############################[ AXFR implementation ]############################ +def process_zone(api, dnszone, args): + """Process a single DNS Zone and synchronize with FreeIPA using its API""" + domain = args.merge_zone if args.merge_zone else str(dnszone.origin) + logger.info('processing DNS domain %s to %s', str(dnszone.origin), domain) + soa_data = dnszone.get_rdataset(dnszone.origin, SOA)[0] + zone_opts, add_opts, mod_opts = get_zone_opts(args) + try: + ipa_data = api.Command.dnszone_show(domain, all=True)['result'] + updates = { key: str(soa_value) for key, ipa_value in ( + (k, v[0]) for k,v in ipa_data.items() if k.startswith('idnssoa') + ) for soa_value in ( getattr(soa_data, key[7:]), ) + if ( int(soa_value) > int(ipa_value) if key == 'idnssoaserial' + else str(soa_value) != str(ipa_value) ) + } + updates.update((key, value) for key,value in zone_opts.items() + if value is not None and not (key in ipa_data and + value in ipa_data[key] if isinstance(value, str) + else set(value).issubset(ipa_data.get(key)))) + if updates: + logger.info('updating existing domain %s in FreeIPA', domain) + logger.debug('updating domain %s with %s', domain, updates) + api.Command.dnszone_mod(domain, **mod_opts, **updates) + else: + logger.debug('no updates for existing domain %s in FreeIPA', domain) + except NotFound: + logger.info('creating new domain %s in FreeIPA', domain) + response = api.Command.dnszone_add(domain, **zone_opts, **add_opts, **{ + 'idnssoa'+key: str(getattr(soa_data, key)) for key in [ + 'mname','rname','serial','refresh','retry','expire','minimum']}) + print(response) + + api.Command.dnsrecord_del(domain, '@', + nsrecord=response['result']['nsrecord']) + + recordname = lambda x: dns.rdatatype.to_text(x.rdtype).lower()+'record' + optionchecks = tuple((key, datafield) for key, argopt, datafield in ( + ('force', 'no_ns_check', 'nsrecord'), + ('a_extra_create_reverse', 'create_reverse_ptr', 'arecord'), + ('aaaa_extra_create_reverse', 'create_reverse_ptr', 'aaaarecord') + ) if getattr(args, argopt) ) + options = lambda data: { k: True for k, f in optionchecks if f in data } + for rname, rdataset in dnszone.items(): + name = str(rname) + dns_data = { recordname(rdatas[0]): tuple(map(str, rdatas)) + for rdatas in rdataset.rdatasets + if rdatas[0].rdtype not in (SOA, HINFO) } + try: + ipa_data = api.Command.dnsrecord_show(domain, name)['result'] + dns_data={ key: value for key, value in dns_data.items() if not ( + key in ipa_data and set(value).issubset(ipa_data[key]))} + if dns_data: + logger.info('updating %s in domain %s in FreeIPA', name, domain) + except NotFound: + logger.info('adding %s to domain %s in FreeIPA', name, domain) + finally: + if dns_data: + dns_data.update(options(dns_data)) + logger.debug(dns_data) + api.Command.dnsrecord_add(domain, name, **dns_data) + else: + logger.debug('no updates for entry %s', name) + +def axfr(api, args): + for domain in args.dnszone: + logger.info('performing zone-xfer for domain %s', domain) + axfr_request = dns.query.xfr(args.dnsserver, domain, + source=args.source_address, relativize=args.relativize) + dnszone = dns.zone.from_xfr(axfr_request, relativize=args.relativize) + process_zone(api, dnszone, args) + + +############################[ COPY implementation ]############################ +def copy(api, args, remove=False): + """Copy a DNS Record in FreeIPA and optionally remove the source values""" + src_record, src_zone = ('@', args.source_record) if args.source_zone else \ + (args.source_record, args.source_zone_name) if args.source_zone_name else \ + args.source_record.split('.', 1) + dst_record, dst_zone = ('@', args.target_record) if args.target_zone else \ + (args.target_record, args.target_zone_name) if args.target_zone_name else \ + args.target_record.split('.', 1) + + logger.debug('%s %s in %s to %s in %s', 'Moving' if remove else 'Copying', + src_record, src_zone, dst_record, dst_zone) + + src_data = { key:value for key,value in + api.Command.dnsrecord_show(src_zone, src_record)['result'].items() + if key.endswith('record') and + (not args.limit_records or key[:-6].upper() in args.limit_records) } + logger.debug("obtained source data from %s in domain %s,%s", src_record, src_zone, src_data) + + try: + dst_data = api.Command.dnsrecord_show(dst_zone, dst_record)['result'] + if not args.merge: + logger.error("Destination record %s already exists in zone %s", dst_record, dst_zone) + exit(1) + updates = { key: value for key, value in src_data.items() + if not (key in dst_data and set(value).issubset(dst_data[key])) + } + if updates: + logger.info('updating %s in domain %s in FreeIPA', dst_record, dst_zone) + except NotFound: + logger.info('creating %s in domain %s in FreeIPA', dst_record, dst_zone) + updates = src_data + + if updates: + logger.debug(updates) + api.Command.dnsrecord_add(dst_zone, dst_record, **updates)['result'] + else: + logger.debug('no updates for entry %s in domain %s', dst_record, dst_zone) + + if remove and src_data: + if not args.limit_records: + logger.info('removing %s from domain %s in FreeIPA', src_record, src_zone) + api.Command.dnsrecord_delentry(src_zone, (src_record,)) + else: + logger.info('removing attributes %s from %s in domain %s in FreeIPA', + args.limit_records, src_record, src_zone) + api.Command.dnsrecord_del(src_zone, src_record, **src_data) + + +############################[ MOVE implementation ]############################ +def move(api, args): + """Move a DNS Record from one DNS zone in FreeIPA to another or rename it""" + copy(api, args, True) + + +###########################[ SERIAL implementation ]########################### +def serial(api, args, date=date.today()): + """Set the SOA serial number of a DNS zone to specified or RFC1912 value""" + serial = int(args.serial if args.serial else '%04d%02d%02d%02d'%(date.year, + 0 if args.year_revision is not False else date.month, + 0 if args.today_revision is False else date.day, + args.year_revision if args.year_revision else + args.month_revision if args.month_revision else + args.today_revision if args.today_revision else 0)) + for domain in args.dnszone: + ipa_serial = int( + api.Command.dnszone_show(domain)['result']['idnssoaserial'][0]) + if ipa_serial > serial and not (args.force or args.ignore_greater): + logger.error('current serial %s of %s is greater than target (%s)', + ipa_serial, domain, serial) + exit(1) + elif serial > ipa_serial or (args.force and serial != ipa_serial): + logger.info('updating serial of %s to %s', domain, serial) + api.Command.dnszone_mod(domain, idnssoaserial=serial) + + +##########################[ GENERATE implementation ]########################## +def generate(api, args): + """Generate DNS records / set DNS attributes based on a number range """ + records = { key: value for key in dir(args) if key.endswith('record') + for value in (getattr(args, key),) if value is not None } + dynamic = [k for k, v in records.items() if any(map(lambda x: '%' in x, v))] + autoincrement = { key: {'sep':':', 'maxvalue':65535, 'base':16, 'fmt':'%x'} + if key == 'aaaarecord' else {} for key in records.keys() + if getattr(args, 'auto_increment_'+key[:-6]) } + def increment(value, sep='.', maxvalue=255, base=10, fmt='%d'): + rest, _, value = value.rpartition(sep) + value = 1 if value == '' or value == 'None' else int(value, base) + 1 + return rest + sep + fmt % value if value < maxvalue else \ + increment(rest, sep, maxvalue, base, fmt) + sep + 1 + for number in range(args.start, args.end+1 if args.end else args.start+args.number): + name = args.template % number if '%' in args.template else args.template + if number > args.start: + for key, params in autoincrement.items(): + records[key] = list(map(lambda x: x if '%' in x else \ + increment(x, **params), records[key])) + dst_data = records.copy() + for key in dynamic: + dst_data[key] = list(map(lambda x: x%number if '%' in x else x, records[key])) + try: + ipa_data = api.Command.dnsrecord_show(args.dnszone, name)['result'] + updates = { key: value for key, value in dst_data.items() + if not (key in ipa_data and set(value).issubset(ipa_data[key]))} + if updates: + logger.info('updating %s in domain %s in FreeIPA', name, args.dnszone) + logger.debug(updates) + api.Command.dnsrecord_mod(args.dnszone, name, **updates) + else: + logger.debug('no updates for entry %s in domain %s', name, args.dnszone) + except NotFound: + logger.info('creating %s in domain %s in FreeIPA', name, args.dnszone) + logger.debug(updates) + api.Command.dnsrecord_add(args.dnszone, name, **dst_data) + + +#########################[ REVERSEPTR implementation ]######################### +def reverseptr(api, args): + rev_zones, ipv4_rev_zones, ipv6_rev_zones = {}, {}, {} + logger.info('Fetching existing reverse PTR domains') + for revzone in (zone for d in + api.Command.dnszone_find('.arpa.',pkey_only=True)['result'] + for zone in map(str, d['idnsname']) if zone.endswith('.arpa.')): + prefix, _, type = revzone[:-6].rpartition('.') + if type == 'ip6': + if not args.ipv6: + continue + reverse = lambda v: ''.join(reversed(v.replace('.',''))) + prefix = reverse(prefix) + ipv6_rev_zones[prefix] = revzone + else: + if not args.ipv4: + continue + reverse = lambda v: '.'.join(reversed(v.split('.'))) + prefix = reverse(prefix) + '.' + ipv4_rev_zones[prefix] = revzone + if args.dnszone or args.all_zones: + logger.debug('Loading reverse PTR domain %s for %s*',revzone,prefix) + rev_zones[prefix] = { prefix+reverse(str(ptr)): host + for d in api.Command.dnsrecord_find(revzone)['result'] + for ptr in d['idnsname'] for host in d.get('ptrrecord', ())} + else: + rev_zones[prefix] = {} + + for revprefix in args.create_revprefix: + try: + if ':' in revprefix and args.ipv6: + revtype = 'ipv6 ' + revprefix = revprefix.strip(': \t\r\n') + revprefix = ''.join([ '%04x' % int(w,16) + for w in revprefix.split(':',7) ]) + ipv6_rev_zones[revprefix] = revzone = \ + '.'.join(reversed(revprefix)) + '.ip6.arpa.' + elif '.' in revprefix and args.ipv4: + revtype = 'ipv4 ' + revprefix = revprefix.strip('. \t\r\n') + if revprefix.count('.') > 3 or any(map(lambda x: x<0 or x>255, + map(int, revprefix.split('.')))): + raise ValueError('not a valid IPv4 value') + revzone = '.'.join(reversed(revprefix.split('.'))) + '.in-addr.arpa.' + revprefix += '.' + ipv4_rev_zones[revprefix] = revzone + else: + revtype = '' + raise ValueError('unsupported reverse zone prefix') + except ValueError as e: + logger.critical('Error: %sreverse zone prefix %s is not valid: %s', + revtype, revprefix, e) + exit(1) + else: + if revprefix in rev_zones: + logger.debug('%sreverse zone %s exists', revtype, revprefix) + else: + logger.info('Creating %sreverse zone %s for %s*', + revtype, revzone, revprefix) + zone_opts, add_opts, _ = get_zone_opts(args) + api.Command.dnszone_add(revzone, **zone_opts, **add_opts) + rev_zones[revprefix] = {} + + revattrs = [ ('arecord', ipv4_rev_zones, sorted(ipv4_rev_zones), str, + lambda t,v: '.'.join(reversed(v[len(t):].split('.')))) ] if args.ipv4 else [] + if args.ipv6: + revattrs.append( ('aaaarecord', ipv6_rev_zones, sorted(ipv6_rev_zones), + lambda v: ''.join([ '0000' * (8-v.count(':')) if w == '' + else '%04x' % int(w, 16) for w in v.split(':') ]), + lambda t,v: '.'.join(reversed(v[len(t):]))) ) + excluded_zones = map(lambda x: x.strip(':.\t\r\n')+'.', args.exclude_zone) + for zone in (z for z in ((n for d in + api.Command.dnszone_find(pkey_only=True, idnszoneactive=True)['result'] + for n in map(str, d['idnsname'])) if args.all_zones + else map(lambda x: x.strip(':.\t\r\n')+'.', args.dnszone)) + if not (z.endswith('in-addr.arpa.') or z.endswith('ip6.arpa.') + or z in excluded_zones)): + logger.info('Processing DNS zone %s', zone) + for record in ( api.Command.dnsrecord_show(zone, host)['result'] + for host in args.host) if args.host \ + else api.Command.dnsrecord_find(zone)['result']: + recordname = str(record['idnsname'][0]) + recordname = zone if recordname=='@' else '%s.%s'%(recordname,zone) + for revattr,revzones,revzonelist,revconvert,revformat in revattrs: + for ipaddr in record.get(revattr, ()): + revaddr = revconvert(ipaddr) + try: + *oldrevs, revtarget = [ rz for rz in revzonelist + if revaddr.startswith(rz) ] + except ValueError: + logger.debug('Skipping %s (%s): no reverse DNS zone', + ipaddr, recordname) + else: + reventry = revformat(revtarget, revaddr) + revzone = revzones[revtarget] + currrev = rev_zones[revtarget].get(revaddr) + if currrev == recordname: + logger.debug('no update for %s (%s) in %s', + reventry, recordname, revzone) + elif currrev and not args.overwrite: + logger.warn('not updating %s (%s) in %s pointing to' + ' %s', reventry, recordname, revzone, currrev) + else: + action = 'modifying' if currrev else 'adding' + logger.info('%s %s (%s) to %s', action, reventry, + recordname, revzone) + getattr(api.Command, 'dnsrecord_%s' % action[:3])( + revzone, reventry, ptrrecord=recordname) + rev_zones[revtarget][revaddr] = recordname + for revzone, reventry, oldentry in ( (revzones[r], + revformat(r, revaddr), o) for r in oldrevs + for o in (rev_zones[r].get(revaddr),) if o): + logger.info('removing %s (%s) from %s', reventry, + oldentry, revzone) + api.Command.dnsrecord_delentry(revzone, reventry) + + +##########################[ Command-line processing ]########################## +def parse_args(): + """Parse command line and get parameters from environment if not set""" + + record_types = ( + ('A', '4', 'IPv4 address'), + ('AAAA', '6', 'IPv6 address'), + ('CNAME', 'c', 'canonical name (alias)'), + ('MX', 'm', 'Mail Exchange (priority + server)'), + ('NS', 'N', 'Nameserver name'), + ('PTR', 'p', 'Reverse address Pointer'), + ('SRV', 'V', 'Service record (priority+port+server)'), + ('TXT', 't', 'Text record'), + ('SSHFP', 'H', 'SSH Fingerprint (priority+type+fingerprint)'), + ) + parser = ArgumentParser( + description='Migrate or synchronize a DNS zone in FreeIPA with DNS', + ) + parser.add_argument('-V', '--version',action="version",version=PROG_VERSION) + + pgroup = parser.add_mutually_exclusive_group(required=False) + pgroup.add_argument('-q', '--quiet', action=SetLogLevel, const=logging.CRITICAL, + default=logging.CRITICAL, help='quiet (only fatal errors)') + pgroup.add_argument('-v', '--verbose', action=SetLogLevel, const=logging.INFO, + help='more verbose output') + pgroup.add_argument('-d', '--debug', action=SetLogLevel, const=logging.DEBUG, + help='debug output') + + parser.add_argument('-l', '--logfile', action=SetLogFile, + help='send logging output to logfile') + + zoneoptionsparser = ArgumentParser(add_help=False) + zoneoptionsparser.add_argument('-n', '--no-ns-check', action='store_true', + help='force zone/record creation in case NS not in DNS') + zoneoptionsparser.add_argument('-p', '--create-reverse-ptr', action='store_true', + help='Enable updating reverse records for created zone(s)') + zoneoptionsparser.add_argument('-f','--forward-policy',choices=('first','only','none'), + default='first', help='Set forward policy for created zone(s)') + zoneoptionsparser.add_argument('-F', '--forwarder', nargs="+", + help='Set IP addresses to forward queries for created zone(s)') + zoneoptionsparser.add_argument('-Q', '--allow-query', nargs="+", default=(), + help='Set IP addresses/ranges that can query created zone(s)') + zoneoptionsparser.add_argument('-T', '--allow-transfer', nargs="+", default=(), + help='Set IP addresses/ranges that can transfer created zone(s)') + zoneoptionsparser.add_argument('-t', '--ttl', type=int, + help='Set TTL for SOA record of created zone(s)') + zoneoptionsparser.add_argument('-D', '--default-ttl', type=int, + help='Set default TTL for records in created zone(s)') + + subparser = parser.add_subparsers(title='Available commands', dest='command') + subparser.required=True + cmdparser = subparser.add_parser('axfr', parents=[zoneoptionsparser], + help='import or synchronize an DNS zone in FreeIPA with the ' + 'result of a zone-xfer', + description='Migrate or synchronize a DNS zone in FreeIPA with ' + 'an external DNS server. Since it synchronizes data it is ' + 'safe to run multiple times for a domain.', + epilog='Please note that this uses a domain-xfer to fetch DNS ' + 'zone(s) so the DNS server must allow a Zone Transfer ' + 'for the domain from the host running the script for ' + 'this command to work') + cmdparser.set_defaults(func=axfr, cmdparser=cmdparser) + cmdparser.add_argument('-s', '--source-address', + help='perform the zone-xfr from specified address') + pgroup = cmdparser.add_mutually_exclusive_group(required=False) + pgroup.add_argument('-r', '--relativize', action='store_true', default=True, + help='store DNS records relative to zone origin') + pgroup.add_argument('-a','--absolute',action='store_false',dest='relativize', + help='store DNS records with absolute DNS domain') + + cmdparser.add_argument('-m', '--merge-zone', + help='merge DNSZONE(s) into MERGE_ZONE') + cmdparser.add_argument('dnsserver', help='DNS Server to request the zone from') + cmdparser.add_argument('dnszone', nargs='+', help='DNS Zone to synchronize') + + commonparser = ArgumentParser(add_help=False) + commonparser.add_argument('-m', '--merge', action='store_true', + help='merge SRC_RECORD into DST_RECORD (default is ' + 'to fail when DST_RECORD exists)') + commonparser.add_argument('-l', '--limit-records', nargs='+', + choices=list(map(lambda x:x[0], record_types)), + help='only move specified record types (default is to move all)') + pgroup = commonparser.add_mutually_exclusive_group(required=False) + pgroup.add_argument('-z', '--source-zone-name', + help='DNS zone to move SRC_RECORD from (will use SRC_RECORD if not provided)') + pgroup.add_argument('-Z', '--source-zone', action='store_true', + help='move attributes from DNS zone SRC_RECORD itself') + pgroup = commonparser.add_mutually_exclusive_group(required=False) + pgroup.add_argument('-t', '--target-zone-name', + help='new name for SRC_RECORD in DST_RECORD') + pgroup.add_argument('-T', '--target-zone', action='store_true', + help='move attributes from to DNS zone SRC_RECORD itself') + commonparser.add_argument('source_record', help='source record(s) to move') + commonparser.add_argument('target_record', help='DNS Zone to move records to') + + cmdparser = subparser.add_parser('copy',parents=[commonparser], + help='Copy a DNS record in FreeIPA within or between zones') + cmdparser.set_defaults(func=copy, cmdparser=cmdparser) + + cmdparser = subparser.add_parser('move',parents=[commonparser], + help='Move a DNS record in FreeIPA from one one to another') + cmdparser.set_defaults(func=move, cmdparser=cmdparser) + + cmdparser = subparser.add_parser('serial', + help='update (set) zone serial(s) in FreeIPA') + cmdparser.set_defaults(func=serial, cmdparser=cmdparser) + pgroup = cmdparser.add_mutually_exclusive_group(required=False) + pgroup.add_argument('-f', '--force', action='store_true', + help='force setting the SOA serial, even when smaller ' + '(default is to only update to larger value)') + pgroup.add_argument('-i', '--ignore-greater', action='store_true', + help='silently ignore exisging larger SOA serials ' + '(default is to abort if existing serial is larger)') + pgroup = cmdparser.add_mutually_exclusive_group(required=True) + generate_RFC1912 = 'generate RFC1912-format serial based on %s' + pgroup.add_argument('-y', '--current-year', type=int, + dest='year_revision', nargs='?', default=False, + help=generate_RFC1912 % 'current year (YYYY######)') + pgroup.add_argument('-m', '--current-month', type=int, + dest='month_revision', nargs='?', default=False, + help=generate_RFC1912 % 'current year & month (YYYYMM####)') + pgroup.add_argument('-t', '--today', type=int, + dest='today_revision', nargs='?', default=False, + help=generate_RFC1912 % 'current date (YYYYMMDD##)') + pgroup.add_argument('-s', '--serial', type=int, + help='serial value to use (must be a 32-bit integer)') + cmdparser.add_argument('dnszone', nargs='+', + help='DNS Zone to update serial for') + + cmdparser = subparser.add_parser('generate', + help='generate number-range DNS records/attributes in FreeIPA', + epilog='(*) %s/%d will be replaced with the sequence numnber, specify' + ' #leading zeros like with printf, i.e. %02d = 2 leading zeros') + cmdparser.set_defaults(func=generate, cmdparser=cmdparser) + cmdparser.add_argument('-s', '--start', type=int, default=1, + help='start (first) value of the numner range to generate, defaults to 1') + pgroup = cmdparser.add_mutually_exclusive_group(required=True) + pgroup.add_argument('-e', '--end', type=int, + help='end (last) value of the numner range to generate') + pgroup.add_argument('-n', '--number', type=int, + help='number of entries to generate') + for record, option, description in record_types: + cmdparser.add_argument('-'+option, '--'+record.lower()+'record', + nargs='+', help='set %s for record (*)' % description) + if option in ('4', '6'): + cmdparser.add_argument('--auto-increment-'+record.lower(), + action='store_true', help='Automatically increment %s values without a pattern' % description) + cmdparser.add_argument('dnszone', help='DNS Zone to generate records in') + cmdparser.add_argument('template', help='template for the name of the generated records (*)') + + cmdparser = subparser.add_parser('reverse-ptr', parents=[zoneoptionsparser], + help='create/update reverse DNS (PTR) entries in FreeIPA', + description='Generate IPv4/IPv6 reverse PTR zones and records.') + cmdparser.set_defaults(func=reverseptr, cmdparser=cmdparser) + pgroup = cmdparser.add_mutually_exclusive_group(required=False) + pgroup.add_argument('-4', '--ipv4', action='store_false', dest='ipv6', default=True, + help='process only ipv4 addresses') + pgroup.add_argument('-6', '--ipv6', action='store_false', dest='ipv4', default=True, + help='process only ipv6 addresses') + cmdparser.add_argument('-o', '--override', action='store_true', + help='overwrite existing reverse PTR records (default is to only add new mappings)') + cmdparser.add_argument('-c', '--create_revprefix', nargs='+', default=(), + help='create reverse zone for IPv4/IPv6 prefix ' + '(must contain either . or :, e.g. 10. 192.168 2001:0db8:85a3)') + pgroup = cmdparser.add_mutually_exclusive_group(required=False) + pgroup.add_argument('-a', '--all-zones', action='store_true', + help='process all enabled zones in FreeIPA') + pgroup.add_argument('-z', '--dnszone', nargs='+', default=(), + help='DNS zone(s) to generate reverse pointer records for') + cmdparser.add_argument('-H', '--host', nargs='+', + help='DNS host(s) to generate reverse pointer records for within each DNSZONE') + cmdparser.add_argument('-x', '--exclude-zone', nargs='+', default=(), + help='exclude specified zones') + + return parser.parse_args() + + +############################################################################### + +if __name__ == '__main__': + logging.basicConfig(format=LOG_FORMAT) + args = parse_args() + + try: + logger.debug('connecting to FreeIPA') + if api.isdone('finalize') is False: + api.bootstrap_with_global_options(context='api') + api.finalize() + api.Backend.rpcclient.connect() + args.func(api, args) + exit(0) + except DNSException as e: + logger.critical("Domain %s cannot be downloaded,%s", domain, e) + except AuthenticationError: + logger.critical("Unable to authenticate to FreeIPA, make sure you have a valid Kerberos ticket!") + except PublicError as e: + logger.critical("error while communicating with FreeIPA: %s", e) + exit(1) + diff --git b/users2freeipa.py a/users2freeipa.py new file mode 100755 index 0000000..86cfdc0 --- /dev/null +++ a/users2freeipa.py @@ -0,0 +1,632 @@ +#! /usr/bin/env python3 +# +# usersfreeipa.py - python script to migrate/synchronize LDAP users with FreeIPA +# +# Version 1.0, latest version, documentation and bugtracker available at: +# https://gitlab.lindenaar.net/scripts/freeipa +# +# Copyright (c) 2018 Frederik Lindenaar +# +# This script is free software: you can redistribute and/or modify it under the +# terms of version 3 of the GNU General Public License as published by the Free +# Software Foundation, or (at your option) any later version of the license. +# +# This script 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, visit <http://www.gnu.org/licenses/> to download it. + +""" +migrate/synchronize LDAP users with FreeIPA. + +This script uses LDAP to obtain users from a MacOS Server (or other LDAP) +server and synchronizes the results with the users registered in FreeIPA. +Since it synchronizes data it is safe to run multiple times. + +for available command-line options, run 'users2freeipa.py -h' +""" + +import os, logging +from argparse import ArgumentParser, FileType, \ + _StoreAction as StoreAction, _StoreConstAction as StoreConstAction +from base64 import b64encode +from getpass import getpass + +from ipalib import api +from ipalib.errors import PublicError, AuthenticationError, NotFound + +from ldap import LDAPError, SCOPE_SUBTREE, MOD_ADD, MOD_DELETE +from ldap.filter import escape_filter_chars +from ldap.ldapobject import LDAPObject +from ldap.resiter import ResultProcessor + + +VERSION="1.0" +PROG_NAME=os.path.splitext(os.path.basename(__file__))[0] +PROG_VERSION=PROG_NAME + ' ' + VERSION +LOG_FORMAT='%(levelname)s - %(message)s' +LOG_FORMAT_FILE='%(asctime)s - ' + LOG_FORMAT + +logger = logging.getLogger(PROG_NAME) + + +##################[ Action to immediately set the log level ]################## +class SetLogLevel(StoreConstAction): + """ArgumentParser action to set log level to provided const value""" + def __call__(self, parser, namespace, values, option_string=None): + logging.getLogger(PROG_NAME).setLevel(self.const) + +####################[ Action to immediately log to a file ]#################### +class SetLogFile(StoreAction): + """ArgumentParser action to log to file (sets up FileHandler accordingly)""" + def __call__(self, parser, namespace, values, option_string=None): + super(SetLogFile, self).__call__(parser,namespace,values,option_string) + formatter = logging.Formatter(LOG_FORMAT_FILE) + handler = logging.FileHandler(values) + handler.setFormatter(formatter) + logger = logging.getLogger(PROG_NAME) + logger.propagate = False + logger.addHandler(handler) + + +#################[ Generic LDAP Connection / ResultProcessor ]################# +class custom_attr(str): pass +class LDAPConnection(LDAPObject,ResultProcessor): + """LDAPConnection implements the LDAP-specifics to migrate LDAP to FreeIPA + + This class holds a generic implementation of the functionality needed to + migrate from a generic () LDAP server to FreeIPA. It is intended to be + subclassed to add the instance-specific parameters for implementation. + + Parameters and LDAP attributes steering the migration to FreeIPA are in + the below attributes (to be overrided by implementation subclasses): + + FreeIPA LDAP Schema customizations (used by check_schema) + SCHEMA_ATTRIBUTES: custom attribute mapping (oid:definiton) + SCHEMA_OBJECTCLASSES: custom objectclass mapping (oid:definiton) + + LDAP search parameters: + USER_SUBTREE: LDAP users subtree (relative to baseDN) + USER_OBJECTCLASS: objectclasses for searching users + USER_LOGINATTR: user login / (unique) key attribute + USER_MAPPING: mapping for LDAP attributes to FreeIPA + (LDAP attr: (FreeIPA attr, convert_func)) + GROUP_SUBTREE: LDAP groups subtree (relative to baseDN) + GROUP_OBJECTCLASS: objectclasses for searching group(member)s + GROUP_NAMEATTR: group name / (unique) key attribute + GROUP_DESCATTR: group description attribute + GROUP_GIDATTR: group gid attribute + GROUP_MEMBERATTR: group member attribute with member logins + """ + @staticmethod + def ldaplist2ipa(valuelist): return tuple(map(bytes.decode, valuelist)) + + @staticmethod + def ldapstr2ipa(valuelist, default=()): + return ' '.join(map(bytes.decode, valuelist if valuelist else default)) + + FREEIPA_SCHEMA_DN = 'cn=schema' + SCHEMA_ATTRIBUTES = { } + SCHEMA_OBJECTCLASSES = { } + + USER_OBJECTCLASS = ( 'posixAccount', 'shadowAccount' ) + + USER_SUBTREE = 'cn=users' + USER_LOGINATTR = 'uid' + USER_MAPPING = { # based on http://www.zytrax.com/books/ldap/ape/ + USER_LOGINATTR: (USER_LOGINATTR, ldaplist2ipa.__func__), + 'userPassword': ('userpassword', ldapstr2ipa.__func__), + 'uidNumber': ('uidnumber', ldapstr2ipa.__func__), + 'gidNumber': ('gidnumber', ldapstr2ipa.__func__), + 'gecos': ('gecos', ldapstr2ipa.__func__), + 'homeDirectory': ('homedirectory', ldapstr2ipa.__func__), + 'loginShell': ('loginshell', ldapstr2ipa.__func__), + 'givenName': ('givenname', ldapstr2ipa.__func__), + 'sn': ('sn', ldapstr2ipa.__func__), + 'cn': ('cn', ldapstr2ipa.__func__), + 'displayname': ('displayname', ldapstr2ipa.__func__), + 'initials': ('initials', ldapstr2ipa.__func__), + 'title': ('title', ldapstr2ipa.__func__), + 'mail': ('mail', ldaplist2ipa.__func__), + 'street': ('street', ldapstr2ipa.__func__), + 'l': ('l', ldapstr2ipa.__func__), + 'st': ('st', ldapstr2ipa.__func__), + 'postalCode': ('postalcode', ldapstr2ipa.__func__), + 'telephonenumber': ('telephonenumber', ldaplist2ipa.__func__), + 'mobile': ('mobile', ldaplist2ipa.__func__), + 'pager': ('pager', ldaplist2ipa.__func__), + 'facsimiletelephonenumber':('facsimiletelephonenumber',ldaplist2ipa.__func__), + 'carlicense': ('carlicense', ldaplist2ipa.__func__), + 'ou': ('ou', ldapstr2ipa.__func__), + 'departmentNumber': ('departmentnumber',ldaplist2ipa.__func__), + 'employeeNumber ': ('employeenumber', ldapstr2ipa.__func__), + 'employeeType': ('employeetype', ldapstr2ipa.__func__), + 'manager': ('manager', ldapstr2ipa.__func__), + 'userCertificate': ('usercertificate', ldaplist2ipa.__func__), + 'preferredLanguage':('preferredlanguage',ldapstr2ipa.__func__), + } + + GROUP_OBJECTCLASS = ( 'posixGroup', ) + GROUP_SUBTREE = 'cn=groups' + GROUP_NAMEATTR = 'cn' + GROUP_DESCATTR = GROUP_NAMEATTR + GROUP_GIDATTR = 'gidNumber' + GROUP_MEMBERATTR = 'memberUid' + + @staticmethod + def attrfilters(valuelist, attr, cmp='='): + """convert a value list into an LDAP-escaped attr=value filter list""" + return set(map(lambda x:attr + cmp + escape_filter_chars(x), valuelist)) + + @staticmethod + def filters2str(*filters, operator, default=''): + """convert a list of filters to a single filter(string) with operator""" + result = set('(%s)' % f if f[0]!='(' else f for f in filters if f) + return '(' + operator + ''.join(result) + ')' if len(result) > 1 else \ + result.pop() if result else default + + @staticmethod + def notfilter(fstr): + """Create a negative (NOT) LDAP filter based on a filter (string)""" + return '' if not fstr else ('(!%s)' if fstr[0]=='(' else '(!(%s))')%fstr + + def objectclassfilter(self, *objclasses, operator='|', cmp='=', default=''): + """Generates an LDAP filter to retrieve specific objectclass(es)""" + objclsfilter = self.attrfilters(objclasses, 'objectClass', cmp) + return self.filters2str(*objclsfilter,operator=operator,default=default) + + def usersfilter(self, *users, operator='|', cmp='=', default=''): + """Generates an LDAP filter to retrieve users based on login name(s)""" + userfilter = self.attrfilters(users,self.USER_LOGINATTR,cmp) + return self.filters2str(*userfilter, operator=operator, default=default) + + def groupsfilter(self, *groups, operator='|', cmp='=', default=''): + """Generates an LDAP filter to retrieve groups based on group name(s)""" + groupfilter = self.attrfilters(groups, self.GROUP_NAMEATTR, cmp) + return self.filters2str(*groupfilter, operator=operator, default=default) + + def groupmemberfilter(self, *members, operator='|', cmp='=', default=''): + """Generates an LDAP filter to retrieve groups based on their members""" + memberfilter = self.attrfilters(members, self.GROUP_MEMBERATTR, cmp) + return self.filters2str(*memberfilter,operator=operator,default=default) + + def __init__(self, server, basedn=None): + """Initialize connection to server, get server basedn unless provided""" + super(LDAPConnection, self).__init__(server) + self._basedn = basedn if basedn else self.get_naming_contexts()[0].decode() + logger.debug('Connected to %s, base_dn=%s', server, self._basedn) + + def check_schema(self, exists=True, update_schema=False): + """Check if schema customizations are present in the FreeIPA LDAP + server (or not, depending on 'exists') and apply the changes if + 'update_schema'. Returns whether the desired state is present. + """ + if not self.SCHEMA_ATTRIBUTES and not self.SCHEMA_OBJECTCLASSES: + return True + logger.debug('Checking LDAP schema customizations presence in FreeIPA') + operation = MOD_ADD if exists else MOD_DELETE + config = { 'attributeTypes': self.SCHEMA_ATTRIBUTES, + 'objectClasses': self.SCHEMA_OBJECTCLASSES } + ipa_ldap = LDAPObject('ldap:///') + ipa_schema = ipa_ldap.read_s(self.FREEIPA_SCHEMA_DN, attrlist=config.keys()) + updates = [ (operation, key, value) for key, cfg in config.items() + for cur in ({v.split(b' ')[1]: v for v in ipa_schema[key]},) + for value in ([ d for o,d in cfg.items() if o not in cur ] \ + if exists else [cur[o] for o in cfg if o in cur],) if value] + if updates and update_schema: + updates = sorted(updates, key=lambda x: x[1], reverse=not exists) + logger.info('%sing LDAP schema customizations in FreeIPA', + 'Add' if exists else 'Delet') + logger.debug('LDAP Schema changes: %s', updates) + ipa_ldap.bind_s('cn=directory manager', + getpass('FreeIPA diradmin password: ')) + ipa_ldap.modify_s(self.FREEIPA_SCHEMA_DN, updates) + elif updates: + logger.debug('Not %sing LDAP schema customizations in FreeIPA', + 'add' if exists else 'delet') + else: + logger.debug('LDAP schema customizations are %s in FreeIPA', + 'present' if exists else 'absent') + ipa_ldap.unbind() + return(not updates or update_schema) + + def search(self, base, *args, relativebase=True, **kwargs): + """Search using LDAPObject.search(), adding baseddn to base if needed""" + if relativebase and not base.endswith(self._basedn): + base += ',' + self._basedn + return super(LDAPConnection, self).search(base, *args, **kwargs) + + def get_group_members(self, *group): + """Returns set with users that are member of the provided group(s)""" + if not group: + return set() + filter=self.filters2str(self.objectclassfilter(*self.GROUP_OBJECTCLASS), + self.groupsfilter(*groups), operator='&') + logger.debug('Searching %s members with LDAP filter: %s',group,filter) + attrs = (self.GROUP_MEMBERATTR,) + msg_id = self.search(self.GROUP_SUBTREE, SCOPE_SUBTREE, filter, attrs) + return set(user.decode() for _,res_data,_,_ in ldap.allresults(msg_id) + for _, entry in res_data + for userlist in entry.values() + for user in userlist) + + def get_user_groups(self, user, groups=()): + """Returns list of groups that the specified user is member of. + checks the list of groups, if provided, or all groups + """ + filter=self.filters2str(self.objectclassfilter(*self.GROUP_OBJECTCLASS), + self.groupmemberfilter(user), + self.groupsfilter(*groups), operator='&') + logger.debug('Searching user\'s groups with LDAP filter: %s', filter) + attrs = (self.GROUP_NAMEATTR,self.GROUP_GIDATTR,self.GROUP_DESCATTR) + msg_id = self.search(self.GROUP_SUBTREE, SCOPE_SUBTREE, filter, attrs) + return [ (self.ldapstr2ipa(entry[self.GROUP_NAMEATTR]), + self.ldapstr2ipa(entry[self.GROUP_GIDATTR]), + self.ldapstr2ipa(entry.get(self.GROUP_DESCATTR, + entry[self.GROUP_NAMEATTR])) ) + for _,res_data,_,_ in ldap.allresults(msg_id) + for dn, entry in res_data ] + + def get_users(self, *users, excl_users=(), customfilter='', attrs=None): + """Returns an generator to iterate over LDAP users mapped to FreeIPA. + This function obtains the list of users (all if not specified) and + support exclusion list and custom filters for further control + """ + filter=self.filters2str(self.objectclassfilter(*self.USER_OBJECTCLASS), + customfilter, self.usersfilter(*users), + self.notfilter(self.usersfilter(*excl_users)), + operator='&', default='(%s=*)'%self.USER_LOGINATTR) + logger.debug('Searching users with LDAP filter: %s', filter) + msg_id = self.search(self.USER_SUBTREE, SCOPE_SUBTREE, filter, attrs) + for res_type,res_data,res_msgid,res_controls in self.allresults(msg_id): + for dn, entry in res_data: + if logger.getEffectiveLevel() <= logging.DEBUG: + notmigrated = ', '.join(key for key in entry if key not in + (*self.USER_MAPPING.keys(), 'objectClass')) + if notmigrated: + logger.debug('Ignoring attributes: %s', notmigrated) + yield (dn, { ipa_key: conv(v) for k, v in entry.items() + if k in self.USER_MAPPING + for ipa_key, conv in (self.USER_MAPPING[k],) }) + + + +##################[ MacOS LDAP Connection / ResultProcessor ]################## +class MacOSLDAPConnection(LDAPConnection): + """LDAPConnection subclass to migrate from Apple's OpenDirectory""" + + # @staticmethod + # def binary2ipa(valuelist): return b64encode(valuelist[0]).decode() + + SCHEMA_ATTRIBUTES = { + # Definition (and OID) taken from Apple MacOS Server OpenDirectory + b"1.3.6.1.4.1.63.1000.1.1.1.1.20": + b"( 1.3.6.1.4.1.63.1000.1.1.1.1.20 NAME ( 'apple-generateduid' )" + b" DESC 'generated unique ID' X-ORIGIN 'Apple Server OpenDirectoy'" + b" EQUALITY caseExactMatch SUBSTR caseExactSubstringsMatch" + b" SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 SINGLE-VALUE )", + } + SCHEMA_OBJECTCLASSES = { + # OID: iso.org.dod.internet.private.enterprise.lindenaar.2018.8.2.1.1 + # https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers + b"1.3.6.1.4.1.18143.2018.8.2.1.1": + b"( 1.3.6.1.4.1.18143.2018.8.2.1.1" + b" NAME 'openDirectoryPerson' SUP person STRUCTURAL" + b" MAY ( c $ apple-generateduid ) X-ORIGIN 'Extending FreeIPA' )" + } + + USER_OBJECTCLASS = ( *LDAPConnection.USER_OBJECTCLASS, 'apple-user' ) + USER_MAPPING = { **LDAPConnection.USER_MAPPING, + 'objectClass': (custom_attr('objectclass'), lambda x: 'openDirectoryPerson'), + 'c': (custom_attr('c'), LDAPConnection.ldapstr2ipa), + 'apple-generateduid': (custom_attr('apple-generateduid'),LDAPConnection.ldapstr2ipa), + 'apple-user-homeurl': LDAPConnection.USER_MAPPING['homeDirectory'], + # TODO: MacOS attribute: jpegPhoto + # 'jpegPhoto': (custom_attr('jpegphoto'), binary2ipa.__func__), + # TODO: migrate MacOS Passwords (not sure this is possible) + } + + GROUP_OBJECTCLASS = ( *LDAPConnection.GROUP_OBJECTCLASS, 'apple-group' ) + GROUP_DESCATTR = 'apple-group-realname' + + +###########[ Generic function to get/create/update FreeIPA entries ]########### +def ipa_update_create(api,entity,name,*keys,get_params={},add_params={},**data): + """ Generic function to create or update an entity and return it. + This will create or update the entity, with key *key so that it reflects + the values provided in the mapping **data. + Parameters: + api: FreeIPA API object to use + entity: name of the FreeIPA entity type to create/update + name: textual name of the entity for logging + keys: the FreeIPA key for this entity (1 or more values) + get_params: additional parameters when retrieving the entity + add_params: additional parameters/values when creating the entity + data: mapping containing the desired values for the entity + Returns the updated entity + """ + try: + ipa_data = getattr(api.Command, '%s_show' % entity)(*keys, **get_params)['result'] + if data: + updates = { k:v for k, v in data.items() if not (k in ipa_data and v in ipa_data[k]) } + if updates: + logger.info('updating existing %s %s in FreeIPA', name, keys[-1]) + return getattr(api.Command, '%s_mod' % entity)(*keys, **updates)['result'] + else: + logger.debug('no updates for existing %s %s in FreeIPA', name, keys[-1]) + else: + logger.debug('found existing %s %s in FreeIPA', name, keys[-1]) + return ipa_data + except NotFound: + logger.info('creating new %s %s in FreeIPA', name, keys[-1]) + return getattr(api.Command, '%s_add' % entity)(*keys, **data, **add_params)['result'] + + +##########################[ Command-line processing ]########################## +def parse_args(): + """Parse command line and get parameters from environment if not set""" + parser = ArgumentParser( + description='Migrate or synchronize LDAP users with FreeIPA', + epilog='(*) unless specified FreeIPA defaults are used. %s is replaced ' + 'by the userID' + ) + parser.add_argument('-V', '--version',action="version",version=PROG_VERSION) + + pgroup = parser.add_mutually_exclusive_group(required=False) + pgroup.add_argument('-O', '--apple-opendirectory', action='store_const', + dest='ldapconnection', const=MacOSLDAPConnection, + default=LDAPConnection, + help='migrate from Apple\'s MacOS Server OpenDirectory') + + parser.add_argument('ldapserver', help='LDAP Server to request users from') + parser.add_argument('-b', '--basedn', help='Base DN of source LDAP server, defaults to LDAP server') + parser.add_argument('-u', '--user', nargs='+', default=(), + help='user(s) to migrate/synchronize, defaults to all') + parser.add_argument('-g', '--member-of', nargs='+', dest='user_group', default=(), + help='migrate/synchronize members of group(s)') + parser.add_argument('-x', '--exclude-user', nargs='+', dest='x_user', default=(), + help='user(s) to exclude') + parser.add_argument('-X', '--exclude-group', nargs='+', dest='x_group', default=(), + help='exclude users in specified group(s)') + parser.add_argument('-f', '--filter', help='additional LDAP filter to apply') + parser.add_argument('-G', '--migrate-groups', nargs='*', dest='group', + help='migrate groups+membership for specified or all groups') + parser.add_argument('-H', '--migrate-homedir', nargs='?', dest='homedir', default="", + help='Migrate (if empty) or set homedir (*)') + parser.add_argument('-S', '--migrate-loginshell', nargs='?', dest='loginshell', default="", + help='Migrate (if empty) or set login shell (*)') + parser.add_argument('-P', '--migrate-password', action='store_true', + help='migrate passwords from LDAP (if present)') + parser.add_argument('-p', '--enforce-passwords', dest='password_logfile', + help='enforce users have passwords, file generated passwords') + parser.add_argument('-s', '--stage', action='store_true', + help='create new users as staged users') + parser.add_argument('-c', '--compatibility-view', dest='idview', + help='Maintain ID Compatibility view to preserve UID/GID/homedir/shell') + parser.add_argument('-U', '--update-schema', action='store_true', + help='Configure necessary LDAP schema customizations') + parser.add_argument('-C', '--cleanup-schema', action='store_true', + help='Remove applied LDAP schema customizations and exit') + + pgroup = parser.add_mutually_exclusive_group(required=False) + pgroup.add_argument('-q', '--quiet', action=SetLogLevel, const=logging.CRITICAL, + default=logging.CRITICAL, help='quiet (only fatal errors)') + pgroup.add_argument('-v', '--verbose', action=SetLogLevel, const=logging.INFO, + help='more verbose output') + pgroup.add_argument('-d', '--debug', action=SetLogLevel, const=logging.DEBUG, + help='debug output') + parser.add_argument('-l', '--logfile', action=SetLogFile, + help='send logging output to logfile') + + return parser.parse_args() + + +############################[ LDAPUser processing ]############################ +def process_user(api, userid, user_data, stage=False, enforce_password=False): + """Process a single LDAP user and synchronize with FreeIPA using its API""" + logger.info('processing LDAP user %s', userid) + + try: + ipa_data = api.Command.user_show(userid, all=True)['result'] + logger.debug('found active user %s', userid) + stage = False + except NotFound: + try: + ipa_data = api.Command.stageuser_show(userid, all=True)['result'] + if stage: + logger.debug('found existing stage entry for user %s', userid) + else: + logger.info('activating stage user %s', userid) + api.Command.stageuser_activate(userid) + except NotFound: + ipa_data = { } + + what = 'stageuser' if stage else 'user' + updates = user_data if not ipa_data else { key: value + for key, value in user_data.items() if not (key in ipa_data and + value in ipa_data[key] if isinstance(value, str) + else set(value).issubset(ipa_data[key])) } + + if ipa_data.get('has_password') and 'userpassword' in updates: + logger.debug('Not replacing existing password for %s %s', what, userid) + del updates['userpassword'] + elif enforce_password and not (stage or ipa_data.get('has_password')): + logger.info('Enforcing password for user %s in FreeIPA', userid) + updates['random'] = True + + if updates or not ipa_data: + action = 'Upd' if ipa_data else 'Cre' + logger.info('%sating %s %s in FreeIPA', action, what, userid) + logger.debug('%sating %s %s with %s', action, what, userid, updates) + cust=[k+'='+v for k,v in updates.items() if isinstance(k, custom_attr)] + if cust: + updates = { 'addattr': cust if ipa_data else None, **{ k:v + for k,v in updates.items() if not isinstance(k, custom_attr) }} + command = getattr(api.Command, what + ('_mod' if ipa_data else '_add')) + ipa_data = command(userid, **updates)['result'] + if cust and action == 'Cre': + getattr(api.Command, what + '_mod')(userid, addattr=cust) + else: + logger.debug('no updates for %s %s in FreeIPA', what, userid) + + return ipa_data.get('memberof_group', ()), stage, \ + ipa_data.get('randompassword') + + +#########################[ Get FreeIPA group members ]######################### +def get_group(api, group, gid, description, idview, group_cache={}): + try: + return group_cache[group] + except KeyError: + ipa_group = ipa_update_create(api, 'group', 'group', group, + add_params={'description': description}) + result = group_cache[group] = ipa_group.get('member_user', []) + + if idview: # Update or create idoverride for group? + ipa_update_create(api, 'idoverridegroup', 'GID override', idview, + group, gidnumber=gid, cn=group, add_params={ + 'description': "Added by %s while syncronizing %s with %s" \ + % (PROG_NAME, group, args.ldapserver) }) + return result + + +######################[ Update FreeIPA group membership ]###################### +def group_commit(command, desc, group, updates): + logger.info('Updating FreeIPA group %s, %s: %s', group, desc, updates) + getattr(api.Command, command)(group, user=list(updates)) + +def group_queue(command, desc, groups, users, commit, maxqueue=0, queue={}): + if groups and users: + for group in (groups,) if isinstance(groups, str) else groups: + try: + queued = queue[group] + queued.update((users,) if isinstance(users, str) else users) + if not commit and len(queued) > maxqueue: + group_commit(command, desc, group, queued) + del queue[group] + except KeyError: + queue[group] = set((users,) if isinstance(users,str) else users) + if commit and queue: + for group, updates in queue.items(): + group_commit(command, desc, group, updates) + queue.clear() + +def group_add(api, groups=None, users=None, commit=False, maxq=100, queue={}): + group_queue('group_add_member', 'adding', groups, users, commit, maxq,queue) + +def group_del(api, groups=None, users=None, commit=False, maxq=100, queue={}): + group_queue('group_remove_member','removing',groups,users,commit,maxq,queue) + + +############################################################################### +def attr_replace(data, attr, value, param=None): + """Remove/overwrite data[option] based on value, return inital data[option]. + parameters: + data - dict to update + option - attribute in data to update + value - if ''-->delete, if None-->no change, else overwrite with value + param - if value contains %s, it will be replaced by this value + """ + result = data.get(attr) + if value: + data[attr] = value % userid if '%s' in value else value + elif value == '' and result is not None: + del data[attr] + return result +def attr_remove(data, attr): return attr_replace(data, attr, '', None) + + +if __name__ == '__main__': + logging.basicConfig(format=LOG_FORMAT) + args = parse_args() + + try: + logger.debug('connecting to FreeIPA') + if api.isdone('finalize') is False: + api.bootstrap_with_global_options(context='api') + api.finalize() + api.Backend.rpcclient.connect() + + logger.info('Connecting to LDAP server %s', args.ldapserver) + ldap = args.ldapconnection(args.ldapserver, args.basedn) + + if not ldap.check_schema(exists=not args.cleanup_schema, + update_schema=args.update_schema or args.cleanup_schema): + logger.error("Required LDAP schema customizations not in FreeIPA") + exit(1) + elif args.cleanup_schema: + print("LDAP schema customizations are removed from FreeIPA") + exit(0) + + if args.idview: # Ensure IDView exists (if specified) + ipa_update_create(api, 'idview', 'Compatibility View', args.idview, + add_params={ 'description': 'Created by %s while syncronizing ' + 'with %s' % (PROG_NAME, args.ldapserver) }) + + logger.info('searching for users') + excl_users = ldap.get_group_members(*args.x_group) | set(args.x_user) + users = ldap.get_group_members(*args.user_group) | set(args.user) + for dn, user_data in ldap.get_users(*users, excl_users=excl_users, + customfilter=args.filter): + user, *aliases = attr_remove(user_data, 'uid') + if aliases: + logger.warn('ignoring additional userid\'s for user %s: %s', + user,', '.join(aliases)) + if not args.migrate_password: + attr_remove(user_data, 'userpassword') + uid=attr_remove(user_data, 'uidnumber') + gid=attr_remove(user_data, 'gidnumber') + homedir=attr_replace(user_data,'homedirectory',args.homedir,user) + loginshell=attr_replace(user_data,'loginshell',args.loginshell,user) + + in_groups, is_stage, password = process_user(api, user, user_data, + stage=args.stage, enforce_password=bool(args.password_logfile)) + + if password: + with open(args.password_logfile, 'a') as file: + print(user, password, user_data.get('givenname',''), + user_data.get('sn',''), user_data.get('cn',''), + ','.join(user_data.get('mail','')), sep='\t', file=file) + + if is_stage: + logger.debug('not processing group membership or ID overrides ' + 'for stage user %s', user) + continue + + if args.idview: # Update or create the idoverride for the user? + ipa_update_create(api, 'idoverrideuser', 'UID/GID override', + args.idview, user, uidnumber=uid, gidnumber=gid, + homedirectory=homedir, loginshell=loginshell, + add_params={ 'description': + "Added by %s while syncronizing %s with %s" + % (PROG_NAME, user, args.ldapserver)}) + + if args.group is not None: + remaining_groups = list(in_groups) if not args.group else \ + [ g for g in in_groups if g in args.group ] + for group, gid, desc in ldap.get_user_groups(user, args.group): + if user not in get_group(api,group,gid,desc,args.idview): + logger.debug('adding user %s to group %s', user, group) + group_add(api, group, user) + if group in remaining_groups: + remaining_groups.remove(group) + if remaining_groups: + logger.debug('removing user %s from group(s) %s', user, + ', '.join(remaining_groups)) + group_del(api, remaining_groups, user) + + group_add(api, commit=True) + group_del(api, commit=True) + except LDAPError as e: + logger.critical("Error with LDAP commmunication: %s", e) + except AuthenticationError: + logger.critical("Unable to authenticate to FreeIPA, " + "make sure you have a valid Kerberos ticket!") + except PublicError as e: + logger.critical("error while communicating with FreeIPA: %s", e) + else: + exit(0) + exit(1) +