From 05875879ea91d29cc14357098bf71fb19423620b Mon Sep 17 00:00:00 2001 From: Troy Siedsma Date: Thu, 11 Jul 2019 11:57:07 -0500 Subject: [PATCH 01/14] WIP --- .gitignore | 2 + Api.php | 77 ++++++ CHANGELOG.md | 6 + ISSUES.md | 20 ++ LICENSE | 695 ++------------------------------------------------ Module.php | 587 ++++++++++++++++++++++++++++++++++++++++++ README.md | 50 ++++ Validator.php | 39 +++ 8 files changed, 802 insertions(+), 674 deletions(-) create mode 100644 .gitignore create mode 100644 Api.php create mode 100644 CHANGELOG.md create mode 100644 ISSUES.md create mode 100644 Module.php create mode 100644 README.md create mode 100644 Validator.php diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..142a508 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/vendor/ +.idea/ diff --git a/Api.php b/Api.php new file mode 100644 index 0000000..64f2723 --- /dev/null +++ b/Api.php @@ -0,0 +1,77 @@ +key = AUTH_PDNS_KEY; + $this->endpoint = AUTH_PDNS_URI; + $this->client = new \GuzzleHttp\Client([ + 'base_uri' => $this->endpoint, + ]); + } + + public function do(string $method, string $endpoint, array $params = null): array + { + $method = strtoupper($method); + if (! \in_array($method, ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'])) + { + error("Unknown method `%s'", $method); + + return []; + } + if ($endpoint[0] === '/') + { + warn("Stripping `/' from endpoint `%s'", $endpoint); + $endpoint = ltrim($endpoint, '/'); + } + if (strpos($endpoint, 'server') === false) + { + $endpoint = 'servers/localhost/' . $endpoint; + } + $this->lastResponse = $this->client->request($method, $endpoint, [ + 'headers' => [ + 'User-Agent' => PANEL_BRAND . " " . APNSCP_VERSION, + 'Accept' => 'application/json', + 'X-API-Key' => $this->key, + ], + 'json' => $params, + ]); + + return \json_decode($this->lastResponse->getBody()->getContents(), true) ?? []; + } + + public function getResponse(): Response + { + return $this->lastResponse; + } +} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e450c29 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + diff --git a/ISSUES.md b/ISSUES.md new file mode 100644 index 0000000..e750bde --- /dev/null +++ b/ISSUES.md @@ -0,0 +1,20 @@ +##Issues List: ## +1) Deleting a Site deletes the zone and then tries to delete records but they were already deleted with the zone +2) Creating MX records just doesn't work +3) Deleting records seems to fail at $id = $this->getRecordId($record); + + + +### Issue 1 ### +ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 +I know that's generated in the zoneAxfr method, but not sure why it happens during delete. + +DEBUG : 0.68447: Dns_Module -> _delete +DEBUG : 0.04320: Mysql_Module -> _delete +DEBUG : 0.00006: Ipinfo_Module -> _delete +DEBUG : Service config `billing' disabled for site - disabling calling hook `_delete' on `Billing_Module' +DEBUG : Service config `pgsql' disabled for site - disabling calling hook `_delete' on `Pgsql_Module' +DEBUG : 0.00054: Site_Module -> _delete +ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 + +Seems to be trying to delete records after deleting the zone which deletes the records... \ No newline at end of file diff --git a/LICENSE b/LICENSE index f288702..6f9c778 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. +MIT License + +Copyright (c) 2018 Apis Networks + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Module.php b/Module.php new file mode 100644 index 0000000..21730a0 --- /dev/null +++ b/Module.php @@ -0,0 +1,587 @@ +key = AUTH_PDNS_KEY; + $this->ns = AUTH_PDNS; + } + + /** + * Add a DNS record + * + * @param string $zone + * @param string $subdomain + * @param string $rr + * @param string $param + * @param int $ttl + * + * @return bool + */ + public function add_record(string $zone, string $subdomain, string $rr, string $param, int $ttl = self::DNS_TTL): bool + { + if (! $this->canonicalizeRecord($zone, $subdomain, $rr, $param, $ttl)) + { + return false; + } + + $record = new Record($zone, [ + 'name' => $subdomain, + 'rr' => $rr, + 'parameter' => $param, + 'ttl' => $ttl, + ]); + + if ($record['name'] === '@') + { + $record['name'] = ''; + } + + try + { + $api = $this->makeApi(); + $rrsets = $this->formatRecord($record); + $ret = $api->do('PATCH', 'zones/' . $this->canonical($zone), ['rrsets' => $rrsets]); // returns empty or zero??? + $this->addCache($record); + } + catch (ClientException $e) + { + info(json_encode(['rec' => $record->toArray(), 'ret' => $ret, 'rrsets' => $rrsets], JSON_PRETTY_PRINT)); + info($e->getMessage()); + + return error("Failed to create record '%s': %s", (string) $record, $this->renderMessage($e)); + } + + return true; // this sucks... + } + + /** + * Create a PowerDNS API client + * + * @return Api + */ + private function makeApi(): Api + { + return new Api(); + } + + /** + * Format a PowerDNS record prior to sending + * + * @param Record $r + * + * @return array + */ + protected function formatRecord(Record $r): ?array + { + $type = strtoupper($r['rr']); + $ttl = $r['ttl'] ?? static::DNS_TTL; + + $content = ''; + $priority = null; + $name = null; + + switch ($type) + { + case 'A': + case 'AAAA': + case 'CNAME': + case 'TXT': + case 'NS': + case 'PTR': + $content = $r['parameter']; + break; + case 'MX': + $priority = (int) $r->getMeta('priority'); + $content = sprintf( + '%d%s', + $r->getMeta('priority'), + $this->canonical($r->getMeta('data')) + ); + break; + case 'SRV': + $content = sprintf( + // protocol | service | target | priority | weight | port + '%s %s %s %d %d %d', + $r->getMeta('protocol'), + $r->getMeta('service'), + $r->getMeta('data'), + (int) $r->getMeta('priority'), + (int) $r->getMeta('weight'), + (int) $r->getMeta('port') + ); + break; + case 'CAA': + $content = sprintf( + // tag | target + '%s %s', + $r->getMeta('tag'), + $r->getMeta('data') + ); + break; + default: + fatal("Unsupported DNS RR type '%s'", $type); + } + + $rrsets[] = [ + 'records' => [0 => [ + 'content' => $content, + 'disabled' => false, + ]], + 'name' => $name ?? $this->canonical(implode('.', [$r['name'], $r['zone']])), + 'ttl' => $ttl, + 'type' => $type, + 'prio' => $priority ?? 0, + 'changetype' => 'REPLACE', + ]; + + return $rrsets; + } + + /** + * returns canonical domain (e.g. always returns root dot) + * + * @param string $name + * + * @return string + */ + private function canonical($name) + { + if (empty($name)) // Sometimes the name is empty and ltrim throws a fit about it + { + return $name; + } + $name = ltrim($name, '.'); + if (substr($name, -1) !== '.') + { + return $name . '.'; + } + + return $name; + } + + /** + * Extract JSON message if present + * + * @param ClientException $e + * + * @return string + */ + private function renderMessage(ClientException $e): string + { + + $body = \Error_Reporter::silence(function () use ($e) { + return \json_decode($e->getResponse()->getBody()->getContents(), true); + }); + if (! $body || ! ($reason = array_get($body, 'errors.0.reason'))) + { + return $e->getMessage(); + } + + return $reason; + } + + /** + * Remove a DNS record + * + * @param string $zone + * @param string $subdomain + * @param string $rr + * @param string|null $param + * + * @return bool + */ + public function remove_record(string $zone, string $subdomain, string $rr, string $param = null): bool + { + $zone = trim($zone, '.'); + if (! $this->canonicalizeRecord($zone, $subdomain, $rr, $param)) + { + return false; + } + + $record = new Record($zone, [ + 'name' => $subdomain, + 'rr' => $rr, + 'parameter' => $param, + 'ttl' => self::DNS_TTL, + ]); + + if ($record['name'] === '@') + { + $record['name'] = ''; + } + + $api = $this->makeApi(); + + $id = $this->getRecordId($record); + if (! $id) + { + $fqdn = implode('.', [$subdomain, $zone]); + + return error("Record '%s' (rr: '%s', param: '%s') does not exist", $fqdn, $rr, $param); + } + + $rrsets[] = [ + 'records' => '', + 'name' => $record['name'], + 'changetype' => 'DELETE', + 'type' => $record['rr'], + ]; + + try + { + $ret = $api->do('PATCH', "zones/${zone}", ['rrsets' => $rrsets]); + } + catch (ClientException $e) + { + $fqdn = implode('.', [$subdomain, $zone]); + + return error("Failed to delete record '%s' type %s", $fqdn, $rr); + } + array_forget($this->zoneCache[ $record->getZone() ], $this->getCacheKey($record)); + + return $api->getResponse()->getStatusCode() === 200; + } + + /** + * Add DNS zone to service + * + * @param string $domain + * @param string $ip + * + * @return bool + */ + public function add_zone_backend(string $domain, string $ip): bool + { + $domain = trim($domain, '.'); + /** + * @var Zones $api + */ + $api = $this->makeApi(); + try + { + $resp = $api->do('POST', 'servers/localhost/zones', [ + 'account' => null, + 'kind' => 'native', + 'soa_edit_api' => 'INCEPTION-INCREMENT', + 'masters' => [], + 'name' => $this->canonical($domain), + 'nameservers' => [], + // 'rrsets' => array_merge($this->createSOA($domain, $this->ns[0], 'hostmaster@' . $domain), $this->createNS($domain, $this->ns), $this->createDefaultRecords($domain, $ip)), + 'rrsets' => array_merge($this->createSOA($domain, $this->ns[0], 'hostmaster@' . $domain), $this->createNS($domain, $this->ns)), + ]); + } + catch (ClientException $e) + { + return error("Failed to add zone '%s', error: %s", $domain, $this->renderMessage($e)); + } + + return true; + } + + protected function createSOA($name, $primary, $soa_contact) + { + $rrsets = [ + 'records' => [ + [ + 'content' => sprintf( + // primary | contact | serial | refresh | retry | expire | ttl + '%s %s %s 3600 1800 604800 600', + $this->canonical($primary), + $this->canonical($soa_contact), + date('Ymd') . sprintf('%02d', rand(0, 99)) + ), + 'disabled' => false, + ], + ], + 'name' => $this->canonical($name), + 'ttl' => 86400, + 'type' => 'SOA', + ]; + + return [$rrsets]; + } + + protected function createNS($name, array $nameservers): array + { + $rrsets = $records = []; + + foreach ($nameservers as $nameserver) + { + $records[] = [ + 'content' => $this->canonical($nameserver), + 'disabled' => false, + ]; + } + + $rrsets[] = [ + 'records' => $records, + 'name' => $this->canonical($name), + 'ttl' => 86400, + 'type' => 'NS', + ]; + + return $rrsets; + } + + /** + * Remove DNS zone from nameserver + * + * @param string $domain + * + * @return bool + */ + public function remove_zone_backend(string $domain): bool + { + $api = $this->makeApi(); + try + { + $api->do('DELETE', 'servers/localhost/zones' . sprintf('/%s', $domain)); + } + catch (ClientException $e) + { + return error("Failed to remove zone '%s', error: %s", $domain, $this->renderMessage($e)); + } + + return true; + } + + protected function createDefaultRecords($name, $ip = null): array + { + $rrsets = []; + $cnames = $this->defaultCnames; + + if (! is_null($ip)) + { + $records[] = [ + 'content' => $ip, + 'disabled' => false, + ]; + + $rrsets[] = [ + 'records' => $records, + 'name' => $this->canonical($name), + 'ttl' => 14400, + 'type' => 'A', + ]; + } + + foreach ($cnames as $cname) + { + $records = [0 => [ + 'content' => $this->canonical($name), + 'disabled' => false, + ]]; + + $rrsets[] = [ + 'records' => $records, + 'name' => $this->canonical(implode('.', [$cname, $name])), + 'ttl' => 14400, + 'type' => 'CNAME', + ]; + } + + return $rrsets; + } + + /** + * Get raw zone data + * + * @param string $domain + * + * @return null|string + */ + protected function zoneAxfr($domain): ?string + { + // @todo hold records in cache and synthesize AXFR + $client = $this->makeApi(); + + try + { + $records = $client->do('GET', "zones/${domain}"); + + if (empty($records['rrsets'])) + { + // No Records Exist + return null; + } + $soa = array_get($this->get_records_external('', 'soa', $domain, $this->get_hosting_nameservers($domain)), 0, []); + + $ttldef = (int) array_get(preg_split('/\s+/', $soa['parameter'] ?? ''), 6, static::DNS_TTL); + $preamble = []; + if ($soa) + { + $preamble = [ + "${domain}.\t${ttldef}\tIN\tSOA\t${soa['parameter']}", + ]; + } + foreach ($this->get_hosting_nameservers($domain) as $ns) + { + $preamble[] = "${domain}.\t${ttldef}\tIN\tNS\t${ns}."; + } + } + catch (ClientException $e) + { + if ($e->getResponse()->getStatusCode() === 422) + { + // zone doesn't exist + return null; + } + error("Failed to transfer DNS records from PowerDNS - try again later. Response code: %d", $e->getResponse()->getStatusCode()); + + return null; + } + $this->zoneCache[ $domain ] = []; + foreach ($records['rrsets'] as $r) + { + foreach ($r['records'] as $record) + { + switch ($r['type']) + { + case 'CAA': + // @XXX flags always defaults to "0" + $parameter = '0 ' . ' ' . $record['content']; + break; + case 'SRV': + $parameter = $record['content']; + break; + case 'MX': + $parameter = $record['content']; + break; + default: + $parameter = $record['content']; + } + $hostname = $this->canonical($r['name']); + $preamble[] = $hostname . "\t" . $r['ttl'] . "\tIN\t" . $r['type'] . "\t" . $parameter; + + $this->addCache(new Record($domain, + [ + 'name' => $hostname, + 'rr' => $r['type'], + 'ttl' => $r['ttl'] ?? static::DNS_TTL, + 'parameter' => $parameter, + ] + )); + } + } + $axfrrec = implode("\n", $preamble); + + return $axfrrec; + } + + /** + * Get hosting nameservers + * + * @param string|null $domain + * + * @return array + */ + public function get_hosting_nameservers(string $domain = null): array + { + return $this->ns; + } + + /** + * Modify a DNS record + * + * @param string $zone + * @param Record $old + * @param Record $new + * + * @return bool + */ + protected function atomicUpdate(string $zone, Record $old, Record $new): bool + { + if (! $this->canonicalizeRecord($zone, $old['name'], $old['rr'], $old['parameter'], $old['ttl'])) + { + return false; + } + if (! $this->getRecordId($old)) + { + return error("failed to find record ID in PowerDNS zone '%s' - does '%s' (rr: '%s', parameter: '%s') exist?", + $zone, $old['name'], $old['rr'], $old['parameter']); + } + if (! $this->canonicalizeRecord($zone, $new['name'], $new['rr'], $new['parameter'], $new['ttl'])) + { + return false; + } + + $api = $this->makeApi(); + try + { + $merged = clone $old; + $new = $merged->merge($new); + $id = $this->getRecordId($old); + + $ret = $api->do('PATCH', "zones/" . sprintf('%s', $this->canonical($zone)), ['rrsets' => $this->formatRecord($old)]); + } + catch (ClientException $e) + { + return error("Failed to update record '%s' on zone '%s' (old - rr: '%s', param: '%s'; new - rr: '%s', param: '%s'): %s", + $old['name'], + $zone, + $old['rr'], + $old['parameter'], $new['name'] ?? $old['name'], $new['parameter'] ?? $old['parameter'], + $this->renderMessage($e) + ); + } + array_forget($this->zoneCache[ $old->getZone() ], $this->getCacheKey($old)); + $this->addCache($new); + + return true; + } + + /** + * CNAME cannot be present in root + * + * @return bool + */ + protected function hasCnameApexRestriction(): bool + { + return true; + } +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..1259962 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# PowerDNS DNS Provider + +This is a drop-in provider for [apnscp](https://apnscp.com) to enable DNS support globally using PowerDNS. This provider is built into apnscp. + +## Configuring + +Update your `/usr/local/apnscp/config/auth.yaml` file and add the following to the bottom: +```yaml +pdns: + uri: http://dns1.yourdomain.com:8081/api/v1/ # This url may be different if using nginx as a reverse proxy with SSL + key: your_api_key_here + ns: + - ns1.yourdomain.com + - ns2.yourdomain.com + ## Optional additional nameservers +``` +The "host" value is the hostname of your master PowerDNS server running the HTTP API webserver (with a trailing slash). The "key" value is the API key you defined in the pdns.conf on the Master server. The "nameservers" value is a comma delimited list of nameservers. There is not currently a limit for the number of nameservers you may use, 2-5 is typical. + +### Setting as default + +PowerDNS may be configured as the default provider for all sites using the `dns.default-provider` [Scope](https://gitlab.com/apisnetworks/apnscp/blob/master/docs/admin/Scopes.md). When adding a site in Nexus or [AddDomain](https://hq.apnscp.com/working-with-cli-helpers/#adddomain) the key will be replaced with "DEFAULT". This is substituted automatically on account creation. + +```bash +cpcmd config_set dns.default-provider powerdns +``` + +> Note that it is not safe to set this value as a server-wide default in untrusted multiuser environments. A user with panel access can retrieve your key `common_get_service_value dns key` or even using Javascript in the panel, `apnscp.cmd('common_get_service_value',['dns','key'], {async: false})`. + +## Components + +- Module- overrides [Dns_Module](https://github.com/apisnetworks/apnscp-modules/blob/master/modules/dns.php) behavior +- Validator- service validator, checks input with AddDomain/EditDomain helpers + +### Minimal module methods + +All module methods can be overwritten. The following are the bare minimum that are overwritten for this DNS provider to work: + +- `atomicUpdate()` attempts a record modification, which must retain the original record if it fails +- `zoneAxfr()` returns all DNS records +- `add_record()` add a DNS record +- `remove_record()` removes a DNS record +- `get_hosting_nameservers()` returns nameservers for the DNS provider +- `add_zone_backend()` creates DNS zone +- `remove_zone_backend()` removes a DNS zone + +See also: [Creating a provider](https://hq.apnscp.com/apnscp-pre-alpha-technical-release/#creatingaprovider) (hq.apnscp.com) + +## Contributing + +Submit a PR and have fun! diff --git a/Validator.php b/Validator.php new file mode 100644 index 0000000..b0ac5d9 --- /dev/null +++ b/Validator.php @@ -0,0 +1,39 @@ +do('GET', '/servers'); + } + catch (RequestException $e) + { + $response = \json_decode($e->getResponse()->getBody()->getContents(), true); + $reason = array_get($response, 'errors.0.reason', "Invalid key"); + + return error("PowerDNS key failed: %s", $reason); + } + + return true; + } +} From 7aa36c4350c47b6046355c1adc275529750ea9dd Mon Sep 17 00:00:00 2001 From: Troy Siedsma Date: Thu, 11 Jul 2019 12:03:48 -0500 Subject: [PATCH 02/14] Update License I am providing this free and want it to always be free. You're welcome to fork and improve and submit PRs, but I want this module to always be free for those with a valid apnscp license! --- LICENSE | 695 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 674 insertions(+), 21 deletions(-) diff --git a/LICENSE b/LICENSE index 6f9c778..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License - -Copyright (c) 2018 Apis Networks - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From 2092b06abc1feae91d41e1338e60e2cde14b3e0b Mon Sep 17 00:00:00 2001 From: Matt Saladna Date: Thu, 11 Jul 2019 03:22:36 -0400 Subject: [PATCH 03/14] Initial plays Signed-off-by: Matt Saladna --- .../defaults/main.yml | 43 +++++++++ .../files/mysql-4.0.sql | 90 ++++++++++++++++++ .../files/mysql-4.1.sql | 89 +++++++++++++++++ .../files/mysql-4.2.sql | 88 +++++++++++++++++ .../files/pgsql-4.0.sql | 95 +++++++++++++++++++ .../files/pgsql-4.1.sql | 95 +++++++++++++++++++ .../files/pgsql-4.2.sql | 94 ++++++++++++++++++ .../tasks/main.yml | 36 +++++++ .../tasks/setup-mysql.yml | 34 +++++++ .../tasks/setup-pgsql.yml | 45 +++++++++ .../tasks/setup-powerdns.yml | 33 +++++++ 11 files changed, 742 insertions(+) create mode 100644 plays/powerdns-authoritative-setup/defaults/main.yml create mode 100644 plays/powerdns-authoritative-setup/files/mysql-4.0.sql create mode 100644 plays/powerdns-authoritative-setup/files/mysql-4.1.sql create mode 100644 plays/powerdns-authoritative-setup/files/mysql-4.2.sql create mode 100644 plays/powerdns-authoritative-setup/files/pgsql-4.0.sql create mode 100644 plays/powerdns-authoritative-setup/files/pgsql-4.1.sql create mode 100644 plays/powerdns-authoritative-setup/files/pgsql-4.2.sql create mode 100644 plays/powerdns-authoritative-setup/tasks/main.yml create mode 100644 plays/powerdns-authoritative-setup/tasks/setup-mysql.yml create mode 100644 plays/powerdns-authoritative-setup/tasks/setup-pgsql.yml create mode 100644 plays/powerdns-authoritative-setup/tasks/setup-powerdns.yml diff --git a/plays/powerdns-authoritative-setup/defaults/main.yml b/plays/powerdns-authoritative-setup/defaults/main.yml new file mode 100644 index 0000000..ef5ea10 --- /dev/null +++ b/plays/powerdns-authoritative-setup/defaults/main.yml @@ -0,0 +1,43 @@ +--- +powerdns_enabled: true +powerdns_version: 4.2 +powerdns_repo_uri: "https://repo.powerdns.com/repo-files/centos-rec-{{ powerdns_version | regex_replace('\\.','') }}.repo" +powerdns_repo_config: /etc/yum.repos.d/powerdns.repo +powerdns_packages: + - pdns + - "pdns-backend-{{ (powerdns_driver == 'pgsql') | ternary('postgresql', powerdns_driver) }}" + +powerdns_local_dir: "/etc/pdns/local.d" +powerdns_config_file: /etc/pdns/pdns.conf +powerdns_driver: mysql +powerdns_api_port: 8081 + +powerdns_db_password: >- + {{ lookup('pipe', 'grep -e "^\s*g' + powerdns_driver + '-password\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default(lookup('password', '/dev/null chars=ascii_letters length=24'), true) | trim }} +powerdns_db_user: >- + {{ lookup('pipe', 'grep -e "^\s*g' + powerdns_driver + '-user\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default('powerdns', true) | trim }} +powerdns_db_name: >- + {{ lookup('pipe', 'grep -e "^\s*g' + powerdns_driver + '-dbname\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default('powerdns', true) | trim }} +powerdns_db_host: >- + {{ lookup('pipe', 'grep -e "^\s*g' + powerdns_driver + '-host\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default('localhost', true) | trim }} +powerdns_api_key: >- + {{ lookup('pipe', 'grep -e "^\s*api-key\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default(lookup('password', '/dev/null chars=ascii_letters length=24'), true) | trim }} +powerdns_config: + api: yes + "api-key": "{{ powerdns_api_key }}" + "include-dir": "{{ powerdns_local_dir }}" + webserver: "{{ powerdns_webserver_enable | default((powerdns_version is version('4.1', '>=')) | ternary('no', 'yes')) }}" + "webserver-address": "{{ powerdns_api_listen | default('0.0.0.0') }}" + "webserver-allow-from": "{{ powerdns_api_whitelist | default('0.0.0.0') }}" + "webserver-port": "{{ powerdns_api_port }}" + launch: "g{{ powerdns_driver }}" + "g{{powerdns_driver}}-password": "{{ powerdns_db_password }}" + "g{{powerdns_driver}}-user": "{{ powerdns_db_user }}" + "g{{powerdns_driver}}-dbname": "{{ powerdns_db_name }}" + "g{{powerdns_driver}}-host": "{{ powerdns_db_host }}" + version-string: anonymous + +# Inject overrides via powerdns_custom_config +# powerdns_custom_config: +# "allow-axfr-ips": 1.2.3.4 +# "also-notify": 2.3.4.5 diff --git a/plays/powerdns-authoritative-setup/files/mysql-4.0.sql b/plays/powerdns-authoritative-setup/files/mysql-4.0.sql new file mode 100644 index 0000000..002fe92 --- /dev/null +++ b/plays/powerdns-authoritative-setup/files/mysql-4.0.sql @@ -0,0 +1,90 @@ +CREATE TABLE domains ( + id INT AUTO_INCREMENT, + name VARCHAR(255) NOT NULL, + master VARCHAR(128) DEFAULT NULL, + last_check INT DEFAULT NULL, + type VARCHAR(6) NOT NULL, + notified_serial INT DEFAULT NULL, + account VARCHAR(40) DEFAULT NULL, + PRIMARY KEY (id) +) Engine=InnoDB; + +CREATE UNIQUE INDEX name_index ON domains(name); + + +CREATE TABLE records ( + id INT AUTO_INCREMENT, + domain_id INT DEFAULT NULL, + name VARCHAR(255) DEFAULT NULL, + type VARCHAR(10) DEFAULT NULL, + content VARCHAR(64000) DEFAULT NULL, + ttl INT DEFAULT NULL, + prio INT DEFAULT NULL, + change_date INT DEFAULT NULL, + disabled TINYINT(1) DEFAULT 0, + ordername VARCHAR(255) BINARY DEFAULT NULL, + auth TINYINT(1) DEFAULT 1, + PRIMARY KEY (id) +) Engine=InnoDB; + +CREATE INDEX nametype_index ON records(name,type); +CREATE INDEX domain_id ON records(domain_id); +CREATE INDEX recordorder ON records (domain_id, ordername); + + +CREATE TABLE supermasters ( + ip VARCHAR(64) NOT NULL, + nameserver VARCHAR(255) NOT NULL, + account VARCHAR(40) NOT NULL, + PRIMARY KEY (ip, nameserver) +) Engine=InnoDB; + + +CREATE TABLE comments ( + id INT AUTO_INCREMENT, + domain_id INT NOT NULL, + name VARCHAR(255) NOT NULL, + type VARCHAR(10) NOT NULL, + modified_at INT NOT NULL, + account VARCHAR(40) NOT NULL, + comment VARCHAR(64000) NOT NULL, + PRIMARY KEY (id) +) Engine=InnoDB; + +CREATE INDEX comments_domain_id_idx ON comments (domain_id); +CREATE INDEX comments_name_type_idx ON comments (name, type); +CREATE INDEX comments_order_idx ON comments (domain_id, modified_at); + + +CREATE TABLE domainmetadata ( + id INT AUTO_INCREMENT, + domain_id INT NOT NULL, + kind VARCHAR(32), + content TEXT, + PRIMARY KEY (id) +) Engine=InnoDB; + +CREATE INDEX domainmetadata_idx ON domainmetadata (domain_id, kind); + + +CREATE TABLE cryptokeys ( + id INT AUTO_INCREMENT, + domain_id INT NOT NULL, + flags INT NOT NULL, + active BOOL, + content TEXT, + PRIMARY KEY(id) +) Engine=InnoDB; + +CREATE INDEX domainidindex ON cryptokeys(domain_id); + + +CREATE TABLE tsigkeys ( + id INT AUTO_INCREMENT, + name VARCHAR(255), + algorithm VARCHAR(50), + secret VARCHAR(255), + PRIMARY KEY (id) +) Engine=InnoDB; + +CREATE UNIQUE INDEX namealgoindex ON tsigkeys(name, algorithm); diff --git a/plays/powerdns-authoritative-setup/files/mysql-4.1.sql b/plays/powerdns-authoritative-setup/files/mysql-4.1.sql new file mode 100644 index 0000000..bf15329 --- /dev/null +++ b/plays/powerdns-authoritative-setup/files/mysql-4.1.sql @@ -0,0 +1,89 @@ +CREATE TABLE domains ( + id INT AUTO_INCREMENT, + name VARCHAR(255) NOT NULL, + master VARCHAR(128) DEFAULT NULL, + last_check INT DEFAULT NULL, + type VARCHAR(6) NOT NULL, + notified_serial INT DEFAULT NULL, + account VARCHAR(40) CHARACTER SET 'utf8' DEFAULT NULL, + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE UNIQUE INDEX name_index ON domains(name); + + +CREATE TABLE records ( + id BIGINT AUTO_INCREMENT, + domain_id INT DEFAULT NULL, + name VARCHAR(255) DEFAULT NULL, + type VARCHAR(10) DEFAULT NULL, + content VARCHAR(64000) DEFAULT NULL, + ttl INT DEFAULT NULL, + prio INT DEFAULT NULL, + change_date INT DEFAULT NULL, + disabled TINYINT(1) DEFAULT 0, + ordername VARCHAR(255) BINARY DEFAULT NULL, + auth TINYINT(1) DEFAULT 1, + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE INDEX nametype_index ON records(name,type); +CREATE INDEX domain_id ON records(domain_id); +CREATE INDEX ordername ON records (ordername); + + +CREATE TABLE supermasters ( + ip VARCHAR(64) NOT NULL, + nameserver VARCHAR(255) NOT NULL, + account VARCHAR(40) CHARACTER SET 'utf8' NOT NULL, + PRIMARY KEY (ip, nameserver) +) Engine=InnoDB CHARACTER SET 'latin1'; + + +CREATE TABLE comments ( + id INT AUTO_INCREMENT, + domain_id INT NOT NULL, + name VARCHAR(255) NOT NULL, + type VARCHAR(10) NOT NULL, + modified_at INT NOT NULL, + account VARCHAR(40) CHARACTER SET 'utf8' DEFAULT NULL, + comment TEXT CHARACTER SET 'utf8' NOT NULL, + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE INDEX comments_name_type_idx ON comments (name, type); +CREATE INDEX comments_order_idx ON comments (domain_id, modified_at); + + +CREATE TABLE domainmetadata ( + id INT AUTO_INCREMENT, + domain_id INT NOT NULL, + kind VARCHAR(32), + content TEXT, + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE INDEX domainmetadata_idx ON domainmetadata (domain_id, kind); + + +CREATE TABLE cryptokeys ( + id INT AUTO_INCREMENT, + domain_id INT NOT NULL, + flags INT NOT NULL, + active BOOL, + content TEXT, + PRIMARY KEY(id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE INDEX domainidindex ON cryptokeys(domain_id); + + +CREATE TABLE tsigkeys ( + id INT AUTO_INCREMENT, + name VARCHAR(255), + algorithm VARCHAR(50), + secret VARCHAR(255), + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE UNIQUE INDEX namealgoindex ON tsigkeys(name, algorithm); diff --git a/plays/powerdns-authoritative-setup/files/mysql-4.2.sql b/plays/powerdns-authoritative-setup/files/mysql-4.2.sql new file mode 100644 index 0000000..2dea1c2 --- /dev/null +++ b/plays/powerdns-authoritative-setup/files/mysql-4.2.sql @@ -0,0 +1,88 @@ +CREATE TABLE domains ( + id INT AUTO_INCREMENT, + name VARCHAR(255) NOT NULL, + master VARCHAR(128) DEFAULT NULL, + last_check INT DEFAULT NULL, + type VARCHAR(6) NOT NULL, + notified_serial INT UNSIGNED DEFAULT NULL, + account VARCHAR(40) CHARACTER SET 'utf8' DEFAULT NULL, + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE UNIQUE INDEX name_index ON domains(name); + + +CREATE TABLE records ( + id BIGINT AUTO_INCREMENT, + domain_id INT DEFAULT NULL, + name VARCHAR(255) DEFAULT NULL, + type VARCHAR(10) DEFAULT NULL, + content VARCHAR(64000) DEFAULT NULL, + ttl INT DEFAULT NULL, + prio INT DEFAULT NULL, + disabled TINYINT(1) DEFAULT 0, + ordername VARCHAR(255) BINARY DEFAULT NULL, + auth TINYINT(1) DEFAULT 1, + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE INDEX nametype_index ON records(name,type); +CREATE INDEX domain_id ON records(domain_id); +CREATE INDEX ordername ON records (ordername); + + +CREATE TABLE supermasters ( + ip VARCHAR(64) NOT NULL, + nameserver VARCHAR(255) NOT NULL, + account VARCHAR(40) CHARACTER SET 'utf8' NOT NULL, + PRIMARY KEY (ip, nameserver) +) Engine=InnoDB CHARACTER SET 'latin1'; + + +CREATE TABLE comments ( + id INT AUTO_INCREMENT, + domain_id INT NOT NULL, + name VARCHAR(255) NOT NULL, + type VARCHAR(10) NOT NULL, + modified_at INT NOT NULL, + account VARCHAR(40) CHARACTER SET 'utf8' DEFAULT NULL, + comment TEXT CHARACTER SET 'utf8' NOT NULL, + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE INDEX comments_name_type_idx ON comments (name, type); +CREATE INDEX comments_order_idx ON comments (domain_id, modified_at); + + +CREATE TABLE domainmetadata ( + id INT AUTO_INCREMENT, + domain_id INT NOT NULL, + kind VARCHAR(32), + content TEXT, + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE INDEX domainmetadata_idx ON domainmetadata (domain_id, kind); + + +CREATE TABLE cryptokeys ( + id INT AUTO_INCREMENT, + domain_id INT NOT NULL, + flags INT NOT NULL, + active BOOL, + content TEXT, + PRIMARY KEY(id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE INDEX domainidindex ON cryptokeys(domain_id); + + +CREATE TABLE tsigkeys ( + id INT AUTO_INCREMENT, + name VARCHAR(255), + algorithm VARCHAR(50), + secret VARCHAR(255), + PRIMARY KEY (id) +) Engine=InnoDB CHARACTER SET 'latin1'; + +CREATE UNIQUE INDEX namealgoindex ON tsigkeys(name, algorithm); diff --git a/plays/powerdns-authoritative-setup/files/pgsql-4.0.sql b/plays/powerdns-authoritative-setup/files/pgsql-4.0.sql new file mode 100644 index 0000000..e14395b --- /dev/null +++ b/plays/powerdns-authoritative-setup/files/pgsql-4.0.sql @@ -0,0 +1,95 @@ +CREATE TABLE domains ( + id SERIAL PRIMARY KEY, + name VARCHAR(255) NOT NULL, + master VARCHAR(128) DEFAULT NULL, + last_check INT DEFAULT NULL, + type VARCHAR(6) NOT NULL, + notified_serial INT DEFAULT NULL, + account VARCHAR(40) DEFAULT NULL, + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE UNIQUE INDEX name_index ON domains(name); + + +CREATE TABLE records ( + id SERIAL PRIMARY KEY, + domain_id INT DEFAULT NULL, + name VARCHAR(255) DEFAULT NULL, + type VARCHAR(10) DEFAULT NULL, + content VARCHAR(65535) DEFAULT NULL, + ttl INT DEFAULT NULL, + prio INT DEFAULT NULL, + change_date INT DEFAULT NULL, + disabled BOOL DEFAULT 'f', + ordername VARCHAR(255), + auth BOOL DEFAULT 't', + CONSTRAINT domain_exists + FOREIGN KEY(domain_id) REFERENCES domains(id) + ON DELETE CASCADE, + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE INDEX rec_name_index ON records(name); +CREATE INDEX nametype_index ON records(name,type); +CREATE INDEX domain_id ON records(domain_id); +CREATE INDEX recordorder ON records (domain_id, ordername text_pattern_ops); + + +CREATE TABLE supermasters ( + ip INET NOT NULL, + nameserver VARCHAR(255) NOT NULL, + account VARCHAR(40) NOT NULL, + PRIMARY KEY(ip, nameserver) +); + + +CREATE TABLE comments ( + id SERIAL PRIMARY KEY, + domain_id INT NOT NULL, + name VARCHAR(255) NOT NULL, + type VARCHAR(10) NOT NULL, + modified_at INT NOT NULL, + account VARCHAR(40) DEFAULT NULL, + comment VARCHAR(65535) NOT NULL, + CONSTRAINT domain_exists + FOREIGN KEY(domain_id) REFERENCES domains(id) + ON DELETE CASCADE, + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE INDEX comments_domain_id_idx ON comments (domain_id); +CREATE INDEX comments_name_type_idx ON comments (name, type); +CREATE INDEX comments_order_idx ON comments (domain_id, modified_at); + + +CREATE TABLE domainmetadata ( + id SERIAL PRIMARY KEY, + domain_id INT REFERENCES domains(id) ON DELETE CASCADE, + kind VARCHAR(32), + content TEXT +); + +CREATE INDEX domainidmetaindex ON domainmetadata(domain_id); + + +CREATE TABLE cryptokeys ( + id SERIAL PRIMARY KEY, + domain_id INT REFERENCES domains(id) ON DELETE CASCADE, + flags INT NOT NULL, + active BOOL, + content TEXT +); + +CREATE INDEX domainidindex ON cryptokeys(domain_id); + + +CREATE TABLE tsigkeys ( + id SERIAL PRIMARY KEY, + name VARCHAR(255), + algorithm VARCHAR(50), + secret VARCHAR(255), + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE UNIQUE INDEX namealgoindex ON tsigkeys(name, algorithm); diff --git a/plays/powerdns-authoritative-setup/files/pgsql-4.1.sql b/plays/powerdns-authoritative-setup/files/pgsql-4.1.sql new file mode 100644 index 0000000..b105d87 --- /dev/null +++ b/plays/powerdns-authoritative-setup/files/pgsql-4.1.sql @@ -0,0 +1,95 @@ +CREATE TABLE domains ( + id SERIAL PRIMARY KEY, + name VARCHAR(255) NOT NULL, + master VARCHAR(128) DEFAULT NULL, + last_check INT DEFAULT NULL, + type VARCHAR(6) NOT NULL, + notified_serial INT DEFAULT NULL, + account VARCHAR(40) DEFAULT NULL, + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE UNIQUE INDEX name_index ON domains(name); + + +CREATE TABLE records ( + id BIGSERIAL PRIMARY KEY, + domain_id INT DEFAULT NULL, + name VARCHAR(255) DEFAULT NULL, + type VARCHAR(10) DEFAULT NULL, + content VARCHAR(65535) DEFAULT NULL, + ttl INT DEFAULT NULL, + prio INT DEFAULT NULL, + change_date INT DEFAULT NULL, + disabled BOOL DEFAULT 'f', + ordername VARCHAR(255), + auth BOOL DEFAULT 't', + CONSTRAINT domain_exists + FOREIGN KEY(domain_id) REFERENCES domains(id) + ON DELETE CASCADE, + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE INDEX rec_name_index ON records(name); +CREATE INDEX nametype_index ON records(name,type); +CREATE INDEX domain_id ON records(domain_id); +CREATE INDEX recordorder ON records (domain_id, ordername text_pattern_ops); + + +CREATE TABLE supermasters ( + ip INET NOT NULL, + nameserver VARCHAR(255) NOT NULL, + account VARCHAR(40) NOT NULL, + PRIMARY KEY(ip, nameserver) +); + + +CREATE TABLE comments ( + id SERIAL PRIMARY KEY, + domain_id INT NOT NULL, + name VARCHAR(255) NOT NULL, + type VARCHAR(10) NOT NULL, + modified_at INT NOT NULL, + account VARCHAR(40) DEFAULT NULL, + comment VARCHAR(65535) NOT NULL, + CONSTRAINT domain_exists + FOREIGN KEY(domain_id) REFERENCES domains(id) + ON DELETE CASCADE, + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE INDEX comments_domain_id_idx ON comments (domain_id); +CREATE INDEX comments_name_type_idx ON comments (name, type); +CREATE INDEX comments_order_idx ON comments (domain_id, modified_at); + + +CREATE TABLE domainmetadata ( + id SERIAL PRIMARY KEY, + domain_id INT REFERENCES domains(id) ON DELETE CASCADE, + kind VARCHAR(32), + content TEXT +); + +CREATE INDEX domainidmetaindex ON domainmetadata(domain_id); + + +CREATE TABLE cryptokeys ( + id SERIAL PRIMARY KEY, + domain_id INT REFERENCES domains(id) ON DELETE CASCADE, + flags INT NOT NULL, + active BOOL, + content TEXT +); + +CREATE INDEX domainidindex ON cryptokeys(domain_id); + + +CREATE TABLE tsigkeys ( + id SERIAL PRIMARY KEY, + name VARCHAR(255), + algorithm VARCHAR(50), + secret VARCHAR(255), + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE UNIQUE INDEX namealgoindex ON tsigkeys(name, algorithm); diff --git a/plays/powerdns-authoritative-setup/files/pgsql-4.2.sql b/plays/powerdns-authoritative-setup/files/pgsql-4.2.sql new file mode 100644 index 0000000..e6c6b7c --- /dev/null +++ b/plays/powerdns-authoritative-setup/files/pgsql-4.2.sql @@ -0,0 +1,94 @@ +CREATE TABLE domains ( + id SERIAL PRIMARY KEY, + name VARCHAR(255) NOT NULL, + master VARCHAR(128) DEFAULT NULL, + last_check INT DEFAULT NULL, + type VARCHAR(6) NOT NULL, + notified_serial INT DEFAULT NULL, + account VARCHAR(40) DEFAULT NULL, + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE UNIQUE INDEX name_index ON domains(name); + + +CREATE TABLE records ( + id BIGSERIAL PRIMARY KEY, + domain_id INT DEFAULT NULL, + name VARCHAR(255) DEFAULT NULL, + type VARCHAR(10) DEFAULT NULL, + content VARCHAR(65535) DEFAULT NULL, + ttl INT DEFAULT NULL, + prio INT DEFAULT NULL, + disabled BOOL DEFAULT 'f', + ordername VARCHAR(255), + auth BOOL DEFAULT 't', + CONSTRAINT domain_exists + FOREIGN KEY(domain_id) REFERENCES domains(id) + ON DELETE CASCADE, + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE INDEX rec_name_index ON records(name); +CREATE INDEX nametype_index ON records(name,type); +CREATE INDEX domain_id ON records(domain_id); +CREATE INDEX recordorder ON records (domain_id, ordername text_pattern_ops); + + +CREATE TABLE supermasters ( + ip INET NOT NULL, + nameserver VARCHAR(255) NOT NULL, + account VARCHAR(40) NOT NULL, + PRIMARY KEY(ip, nameserver) +); + + +CREATE TABLE comments ( + id SERIAL PRIMARY KEY, + domain_id INT NOT NULL, + name VARCHAR(255) NOT NULL, + type VARCHAR(10) NOT NULL, + modified_at INT NOT NULL, + account VARCHAR(40) DEFAULT NULL, + comment VARCHAR(65535) NOT NULL, + CONSTRAINT domain_exists + FOREIGN KEY(domain_id) REFERENCES domains(id) + ON DELETE CASCADE, + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE INDEX comments_domain_id_idx ON comments (domain_id); +CREATE INDEX comments_name_type_idx ON comments (name, type); +CREATE INDEX comments_order_idx ON comments (domain_id, modified_at); + + +CREATE TABLE domainmetadata ( + id SERIAL PRIMARY KEY, + domain_id INT REFERENCES domains(id) ON DELETE CASCADE, + kind VARCHAR(32), + content TEXT +); + +CREATE INDEX domainidmetaindex ON domainmetadata(domain_id); + + +CREATE TABLE cryptokeys ( + id SERIAL PRIMARY KEY, + domain_id INT REFERENCES domains(id) ON DELETE CASCADE, + flags INT NOT NULL, + active BOOL, + content TEXT +); + +CREATE INDEX domainidindex ON cryptokeys(domain_id); + + +CREATE TABLE tsigkeys ( + id SERIAL PRIMARY KEY, + name VARCHAR(255), + algorithm VARCHAR(50), + secret VARCHAR(255), + CONSTRAINT c_lowercase_name CHECK (((name)::TEXT = LOWER((name)::TEXT))) +); + +CREATE UNIQUE INDEX namealgoindex ON tsigkeys(name, algorithm); diff --git a/plays/powerdns-authoritative-setup/tasks/main.yml b/plays/powerdns-authoritative-setup/tasks/main.yml new file mode 100644 index 0000000..71a2deb --- /dev/null +++ b/plays/powerdns-authoritative-setup/tasks/main.yml @@ -0,0 +1,36 @@ +# Addin play +# vim:et ts=2 sw=2 sts=2 syntax=yaml filetype=yaml +# Configure PowerDNS +--- +- assert: + that: powerdns_driver in ['mysql','pgsql'] + fail_msg: "Unknown driver {{ powerdns_driver }}" + +- set_fact: + __powerdns_db_password: "{{ powerdns_db_password }}" + +- name: Create RPM repo configuration + template: + src: templates/powerdns.repo.j2 + dest: "{{ powerdns_repo_config }}" + +- name: Install PowerDNS RPMs + yum: + name: "{{ powerdns_packages }}" + state: "{{ powerdns_enabled | ternary('present', 'absent') }}" + +- name: Setup PowerDNS + include_tasks: setup-powerdns.yml + when: powerdns_enabled | bool + +- name: "{{ powerdns_enabled | ternary('Enable', 'Disable') }} firewall ports" + include_role: name=network/setup-firewall tasks_from=add-firewall.yml + vars: + immediate: yes + service: "{{ item.service | default(None) }}" + port: "{{ item.port | default(None) }}" + state: "{{ powerdns_enabled | ternary('enabled', 'disabled') }}" + permanent: yes + with_items: + - service: dns + - port: "{{ powerdns_api_port | int }}/tcp" diff --git a/plays/powerdns-authoritative-setup/tasks/setup-mysql.yml b/plays/powerdns-authoritative-setup/tasks/setup-mysql.yml new file mode 100644 index 0000000..419cdb7 --- /dev/null +++ b/plays/powerdns-authoritative-setup/tasks/setup-mysql.yml @@ -0,0 +1,34 @@ +--- +- name: Verify {{ powerdns_db_name }} database exists + mysql_db: + name: "{{ powerdns_db_name }}" + state: present + register: exists + +- name: Create {{ powerdns_db_name }} database + mysql_db: + name: "{{ powerdns_db_name }}" + state: import + config_file: /root/.my.cnf + target: "{{ role_path }}/files/mysql-{{powerdns_version }}.sql" + when: exists.changed + +# MySQL-python is dumb and can't detect authentication_string usage +- name: Verify {{ powerdns_db_user }} user exists + command: mysql -u {{ powerdns_db_user | quote }} -p{{ __powerdns_db_password | quote}} + register: need_update + failed_when: false + changed_when: need_update.rc != 0 + +- name: Create {{ powerdns_db_user }} user + mysql_user: + name: "{{ powerdns_db_user }}" + password: "{{__powerdns_db_password}}" + priv: "{{powerdns_db_name}}.*:ALL" + host: localhost + state: present + login_user: root + update_password: "{{ (need_update.rc != 0) | ternary('always', 'on_create') }}" + check_implicit_admin: yes + register: user_exists + notify: Restart PowerDNS diff --git a/plays/powerdns-authoritative-setup/tasks/setup-pgsql.yml b/plays/powerdns-authoritative-setup/tasks/setup-pgsql.yml new file mode 100644 index 0000000..86a2b7f --- /dev/null +++ b/plays/powerdns-authoritative-setup/tasks/setup-pgsql.yml @@ -0,0 +1,45 @@ +--- +- name: Verify {{ appliance_user }} user exists + postgresql_user: + role_attr_flags: SUPERUSER + name: "{{ powerdns_db_user }}" + encrypted: yes + password: "{{ __powerdns_db_password}}" + state: present + register: user_exists + notify: Restart PowerDNS + become_user: postgres + become: yes + +- name: Verify {{ powerdns_db_name }} database exists + postgresql_db: + name: "{{ powerdns_db_name}}" + owner: "{{ powerdns_db_user }}" + template: template1 + state: present + register: db_exists + become_user: postgres + become: yes + +- name: Create {{ powerdns_db_name }} database + postgresql_db: + name: "{{ powerdns_db_name}}" + state: restore + target: "{{ role_path }}/files/pgsql-{{ powerdns_version }}.sql" + owner: "{{ powerdns_db_user }}" + login_password: "{{ __powerdns_db_password }}" + login_user: "{{powerdns_db_user}}" + login_host: 127.0.0.1 + when: db_exists.changed + notify: Restart PowerDNS + +- name: Verify {{powerdns_db_user}} grants + postgresql_privs: + db: template1 + privs: ALL + obj: "{{ powerdns_db_name }}" + role: "{{ powerdns_db_user }}" + type: database + state: present + become_user: postgres + become: yes diff --git a/plays/powerdns-authoritative-setup/tasks/setup-powerdns.yml b/plays/powerdns-authoritative-setup/tasks/setup-powerdns.yml new file mode 100644 index 0000000..73d7708 --- /dev/null +++ b/plays/powerdns-authoritative-setup/tasks/setup-powerdns.yml @@ -0,0 +1,33 @@ +--- +- name: Merge custom config + include_role: name=common tasks_from="implicitly-import-overrides.yml" + vars: + base: "{{ powerdns_config }}" + varname: __config + prefix: '' + name: powerdns + +- name: Update {{ powerdns_config_file }} + lineinfile: + path: "{{ powerdns_config_file }}" + regexp: '^\s*{{ item.key |quote }}\s*=' + line: '{{ item.key }}={{ item.value }}' + with_dict: "{{ __config }}" + notify: Restart PowerDNS + +- name: Create PowerDNS configuration directory + file: + path: "{{ powerdns_local_dir }}" + state: "{{ powerdns_enabled | ternary('directory', 'absent') }}" + owner: "root" + group: "root" + mode: 0700 + +- name: Setup database + include_tasks: "setup-{{ powerdns_driver }}.yml" + +- name: Enable PowerDNS + systemd: + name: pdns + state: started + enabled: yes From 2df954f4e3008445b8710bb3d4e3f645c704114e Mon Sep 17 00:00:00 2001 From: Matt Saladna Date: Thu, 11 Jul 2019 14:21:14 -0400 Subject: [PATCH 04/14] addin task completed Signed-off-by: Matt Saladna --- .../defaults/main.yml | 15 +++++++++++++-- .../handlers/main.yml | 6 ++++++ .../powerdns-authoritative-setup/tasks/main.yml | 10 +++++++++- .../templates/powerdns.repo.j2 | 17 +++++++++++++++++ setup.yml | 3 +++ 5 files changed, 48 insertions(+), 3 deletions(-) create mode 100644 plays/powerdns-authoritative-setup/handlers/main.yml create mode 100644 plays/powerdns-authoritative-setup/templates/powerdns.repo.j2 create mode 100644 setup.yml diff --git a/plays/powerdns-authoritative-setup/defaults/main.yml b/plays/powerdns-authoritative-setup/defaults/main.yml index ef5ea10..dd9e259 100644 --- a/plays/powerdns-authoritative-setup/defaults/main.yml +++ b/plays/powerdns-authoritative-setup/defaults/main.yml @@ -1,4 +1,9 @@ --- +# PowerDNS API listens for local requests only +# This can be put behind an Apache proxy or other means +# See documentation for examples +powerdns_localonly: true +# Toggle installation of PowerDNS powerdns_enabled: true powerdns_version: 4.2 powerdns_repo_uri: "https://repo.powerdns.com/repo-files/centos-rec-{{ powerdns_version | regex_replace('\\.','') }}.repo" @@ -12,6 +17,10 @@ powerdns_config_file: /etc/pdns/pdns.conf powerdns_driver: mysql powerdns_api_port: 8081 +# Code installation +addin_provider_name: Powerdns +addin_integration_type: "{{ (apnscp_debug | bool) | ternary('link', 'copy') }}" + powerdns_db_password: >- {{ lookup('pipe', 'grep -e "^\s*g' + powerdns_driver + '-password\s*=" ' + (powerdns_config_file | quote) + ' | cut -d= -f2') | default(lookup('password', '/dev/null chars=ascii_letters length=24'), true) | trim }} powerdns_db_user: >- @@ -27,8 +36,10 @@ powerdns_config: "api-key": "{{ powerdns_api_key }}" "include-dir": "{{ powerdns_local_dir }}" webserver: "{{ powerdns_webserver_enable | default((powerdns_version is version('4.1', '>=')) | ternary('no', 'yes')) }}" - "webserver-address": "{{ powerdns_api_listen | default('0.0.0.0') }}" - "webserver-allow-from": "{{ powerdns_api_whitelist | default('0.0.0.0') }}" + "webserver-address": >- + {{ powerdns_api_listen | default(powerdns_localonly | ternary('127.0.0.1', '0.0.0.0')) }} + "webserver-allow-from": >- + {{ powerdns_api_whitelist | default(powerdns_localonly | ternary('127.0.0.1,::1', '0.0.0.0,::/0')) }} "webserver-port": "{{ powerdns_api_port }}" launch: "g{{ powerdns_driver }}" "g{{powerdns_driver}}-password": "{{ powerdns_db_password }}" diff --git a/plays/powerdns-authoritative-setup/handlers/main.yml b/plays/powerdns-authoritative-setup/handlers/main.yml new file mode 100644 index 0000000..132f9d0 --- /dev/null +++ b/plays/powerdns-authoritative-setup/handlers/main.yml @@ -0,0 +1,6 @@ +--- +- name: Restart PowerDNS + systemd: + name: pdns + state: restarted + enabled: yes diff --git a/plays/powerdns-authoritative-setup/tasks/main.yml b/plays/powerdns-authoritative-setup/tasks/main.yml index 71a2deb..0472442 100644 --- a/plays/powerdns-authoritative-setup/tasks/main.yml +++ b/plays/powerdns-authoritative-setup/tasks/main.yml @@ -33,4 +33,12 @@ permanent: yes with_items: - service: dns - - port: "{{ powerdns_api_port | int }}/tcp" + +- name: Install provider module + include_role: name=common/addin tasks_from="{{ powerdns_enabled | ternary('install', 'remove') }}-library.yml" + vars: + name: "{{ addin_provider_name }}" + type: "dns" + method: "{{ addin_integration_type }}" + hook: Restart apnscp + module_path: "src/" diff --git a/plays/powerdns-authoritative-setup/templates/powerdns.repo.j2 b/plays/powerdns-authoritative-setup/templates/powerdns.repo.j2 new file mode 100644 index 0000000..0167bff --- /dev/null +++ b/plays/powerdns-authoritative-setup/templates/powerdns.repo.j2 @@ -0,0 +1,17 @@ +[powerdns-rec-{{ powerdns_version | regex_replace('\.', '')}}] +name=PowerDNS repository for PowerDNS Recursor - version {{ powerdns_version }}.X +baseurl=http://repo.powerdns.com/centos/$basearch/$releasever/rec-{{ powerdns_version | regex_replace('\.', '')}} +gpgkey=https://repo.powerdns.com/FD380FBB-pub.asc +gpgcheck=1 +enabled=1 +priority=90 +includepkg=pdns* + +[powerdns-rec-{{powerdns_version | regex_replace('\.', '')}}-debuginfo] +name=PowerDNS repository for PowerDNS Recursor - version {{ powerdns_version }}.X debug symbols +baseurl=http://repo.powerdns.com/centos/$basearch/$releasever/rec-{{ powerdns_version | regex_replace('\.', '')}}/debug +gpgkey=https://repo.powerdns.com/FD380FBB-pub.asc +gpgcheck=1 +enabled=0 +priority=90 +includepkg=pdns* diff --git a/setup.yml b/setup.yml new file mode 100644 index 0000000..8528d00 --- /dev/null +++ b/setup.yml @@ -0,0 +1,3 @@ +# Task to kickoff installation +--- +- include_role: name=addins/{{addin}}/plays/powerdns-authoritative-setup From 0b2fb298ea8c57b4550a52ecac039c98dbc002b6 Mon Sep 17 00:00:00 2001 From: Matt Saladna Date: Thu, 11 Jul 2019 15:00:46 -0400 Subject: [PATCH 05/14] Relocate module, cleanup gitignore EOL Signed-off-by: Matt Saladna --- .gitignore | 4 ++-- Api.php => src/Api.php | 0 Module.php => src/Module.php | 0 Validator.php => src/Validator.php | 0 4 files changed, 2 insertions(+), 2 deletions(-) rename Api.php => src/Api.php (100%) rename Module.php => src/Module.php (100%) rename Validator.php => src/Validator.php (100%) diff --git a/.gitignore b/.gitignore index 142a508..491f666 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ -/vendor/ -.idea/ +/vendor/ +.idea/ diff --git a/Api.php b/src/Api.php similarity index 100% rename from Api.php rename to src/Api.php diff --git a/Module.php b/src/Module.php similarity index 100% rename from Module.php rename to src/Module.php diff --git a/Validator.php b/src/Validator.php similarity index 100% rename from Validator.php rename to src/Validator.php From 4e4d8f1935469abc3cb45b0b7f295b737f987246 Mon Sep 17 00:00:00 2001 From: Matt Saladna Date: Thu, 11 Jul 2019 15:31:32 -0400 Subject: [PATCH 06/14] g-password generated twice on first run Signed-off-by: Matt Saladna --- plays/powerdns-authoritative-setup/defaults/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plays/powerdns-authoritative-setup/defaults/main.yml b/plays/powerdns-authoritative-setup/defaults/main.yml index dd9e259..34c88f4 100644 --- a/plays/powerdns-authoritative-setup/defaults/main.yml +++ b/plays/powerdns-authoritative-setup/defaults/main.yml @@ -42,7 +42,7 @@ powerdns_config: {{ powerdns_api_whitelist | default(powerdns_localonly | ternary('127.0.0.1,::1', '0.0.0.0,::/0')) }} "webserver-port": "{{ powerdns_api_port }}" launch: "g{{ powerdns_driver }}" - "g{{powerdns_driver}}-password": "{{ powerdns_db_password }}" + "g{{powerdns_driver}}-password": "{{ __powerdns_db_password }}" "g{{powerdns_driver}}-user": "{{ powerdns_db_user }}" "g{{powerdns_driver}}-dbname": "{{ powerdns_db_name }}" "g{{powerdns_driver}}-host": "{{ powerdns_db_host }}" From 7abce628efdd95ee47855238f4e5495d26c05079 Mon Sep 17 00:00:00 2001 From: Troy Siedsma Date: Thu, 11 Jul 2019 15:37:21 -0500 Subject: [PATCH 07/14] Update Issues --- ISSUES.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ISSUES.md b/ISSUES.md index e750bde..2c067cd 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -1,4 +1,4 @@ -##Issues List: ## +## Issues List: ## 1) Deleting a Site deletes the zone and then tries to delete records but they were already deleted with the zone 2) Creating MX records just doesn't work 3) Deleting records seems to fail at $id = $this->getRecordId($record); @@ -17,4 +17,4 @@ DEBUG : Service config `pgsql' disabled for site - disabling calling hook `_de DEBUG : 0.00054: Site_Module -> _delete ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 -Seems to be trying to delete records after deleting the zone which deletes the records... \ No newline at end of file +Seems to be trying to delete records after deleting the zone which deletes the records... From 83233fd9920a2c80aa701b3803c1722cfbe5a6f1 Mon Sep 17 00:00:00 2001 From: Troy Siedsma Date: Thu, 11 Jul 2019 15:38:26 -0500 Subject: [PATCH 08/14] Update Issues.md again --- ISSUES.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/ISSUES.md b/ISSUES.md index 2c067cd..1fffe87 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -6,15 +6,14 @@ ### Issue 1 ### -ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 -I know that's generated in the zoneAxfr method, but not sure why it happens during delete. - +I know the "ERROR" is generated in the zoneAxfr method, but not sure why it happens during delete. +```ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 DEBUG : 0.68447: Dns_Module -> _delete DEBUG : 0.04320: Mysql_Module -> _delete DEBUG : 0.00006: Ipinfo_Module -> _delete DEBUG : Service config `billing' disabled for site - disabling calling hook `_delete' on `Billing_Module' DEBUG : Service config `pgsql' disabled for site - disabling calling hook `_delete' on `Pgsql_Module' DEBUG : 0.00054: Site_Module -> _delete -ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 +ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404``` Seems to be trying to delete records after deleting the zone which deletes the records... From 31d7f92ce1335274e807bcdf3ad3de1f8278bbbb Mon Sep 17 00:00:00 2001 From: Matt Saladna Date: Fri, 12 Jul 2019 02:23:36 -0400 Subject: [PATCH 09/14] README updates Signed-off-by: Matt Saladna --- README.md | 108 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 102 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1259962..756d187 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,116 @@ # PowerDNS DNS Provider -This is a drop-in provider for [apnscp](https://apnscp.com) to enable DNS support globally using PowerDNS. This provider is built into apnscp. +This is a drop-in provider for [apnscp](https://apnscp.com) to enable DNS support using PowerDNS. This module may use PostgreSQL or MySQL as a backend driver. -## Configuring +## Nameserver installation + +Clone the repository into the Bootstrapper addin path. Note this requires either apnscp v3.1 or apnscp v3.0.47 minimum to work. + +```bash +upcp +cd /usr/local/apnscp/resources/playbooks +git clone -b develop https://github.com/LithiumHosting/apnscp-powerdns.git addins/apnscp-powerdns +ansible-playbook addin.yml --extra-vars=addin=apnscp-powerdns --extra-vars=powerdns_driver=mysql +``` + +*PostgreSQL can be used by specifying powerdns_driver=pgsql* + +PowerDNS is now setup to accept requests on port 8081. Requests require an authorization key that can be found in `/etc/pdns/pdns.conf` + +``` +# Install jq if not already installed +yum install -y jq +grep api= /etc/pdns/pdns.conf | cut -d= -f2 +# This is your API key +curl -v -H 'X-API-Key: APIKEYABOVE' http://127.0.0.1:8081/api/v1/servers/localhost | jq . +``` + +apnscp provides a DNS-only license class that allows apnscp to run on a server without the capability to host sites. These licenses are free and may be requested via [my.apnscp.com](https://my.apnscp.com). Contact license@apnscp.com if these licenses are not available at time of writing for manual issuance. + +### Idempotently changing configuration + +PowerDNS may be configured via files in `/etc/pdns/local.d`. In addition to this location, Bootstrapper supports injecting settings via `powerdns_custom_config`. For example, + +```bash +cpcmd config:set apnscp.bootstrapper 'powerdns_custom_config' '["allow-axfr-ips":1.2.3.4,"also-notify":1.2.3.4]' +cd /usr/local/apnscp/resources/playbooks +ansible-playbook addin.yml --extra-vars=addin=apnscp-powerdns +``` + +allow-axfr-ips and also-notify directives will be set whenever the addin plays are run. + +### Restricting submission access + +In the above example, only local requests may submit DNS modifications to the server. None of the below examples affect querying; DNS queries occur over 53/UDP typically (or 53/TCP if packet size exceeds UDP limits). Depending upon infrastructure, there are a few options to securely accept record submission, *all of which require an API key for submission*. + +#### SSL + Apache + +Apache's `ProxyPass` directive send requests to the backend. Brute-force attempts are protected by [mod_evasive](https://github.com/apisnetworks/mod_evasive ) bundled with apnscp. Requests over this medium are protected by SSL, without HTTP/2 to ameliorate handshake overhead. In all but the very high volume API request environments, this will be acceptable. + +In this situation, the endpoint is https://myserver.apnscp.com/dns. Changes are made to `/etc/httpd/conf/httpd-custom.conf` within the `` bracket (with `SSLEngine On`!). After adding the below changes, `systemctl restart httpd`. + +``` + + ProxyPass http://127.0.0.1:8081 + ProxyPassReverse http://127.0.0.1:8081 + +``` + +**Downsides**: minor SSL overhead. Dependent upon Apache. +**Upsides**: easy to setup. Protected by threat deterrence. PowerDNS accessible remotely via an easily controlled URI. + +In the above example, API requests can be made via https://myserver.apnscp.com/dns, e.g. + +```bash +curl -q -H 'X-API-Key: SOMEKEY' https://myserver.apnscp.com/dns/api/v1/servers/localhost +``` + +#### Standalone server + +PowerDNS can also run by itself on a different port. In this situation, the network is configured to block all external requests to port 8081 except those whitelisted. For example, if the entire 32.12.1.1-32.12.1.255 network can be trusted and under your control, then whitelist the IP range: + +```bash +cpcmd rampart:whitelist 32.12.1.1/24 +``` + +Additionally, PowerDNS' whitelist must be updated as well. This can be quickly accomplished using the *apnscp.bootstrapper* Scope: + +``` +cpcmd config:set apnscp.bootstrapper powerdns_localonly false +cd /usr/local/apnscp/resources/playbooks +ansible-playbook addin.yml --extra-vars=addin=apnscp-powerdns +``` + +**Downsides**: requires whitelisting IP addresses for access to API server. Must run on port different than Apache. + +**Upsides**: operates independently from Apache. + +The server may be accessed once the source IP has been whitelisted, + +```bash +curl -q -H 'X-API-Key: SOMEKEY' http://myserver.apnscp.com/api/v1/servers/localhost +``` + + +## apnscp DNS provider setup + +Every server that runs apnscp may delegate DNS authority to PowerDNS. This is ideal in distributed infrastructures in which coordination allows for seamless [server-to-server migrations]( ). + +Taking the **API key** from above, configure `/usr/local/apnscp/config/auth.yaml`. Configuration within this file is secret and is not exposed via apnscp's API. -Update your `/usr/local/apnscp/config/auth.yaml` file and add the following to the bottom: ```yaml pdns: - uri: http://dns1.yourdomain.com:8081/api/v1/ # This url may be different if using nginx as a reverse proxy with SSL + # This url may be different if using running PowerDNS in standalone + uri: https://myserver.apnscp.com/dns/api/v1/ key: your_api_key_here ns: - ns1.yourdomain.com - ns2.yourdomain.com ## Optional additional nameservers ``` -The "host" value is the hostname of your master PowerDNS server running the HTTP API webserver (with a trailing slash). The "key" value is the API key you defined in the pdns.conf on the Master server. The "nameservers" value is a comma delimited list of nameservers. There is not currently a limit for the number of nameservers you may use, 2-5 is typical. +* `uri` value is the hostname of your master PowerDNS server running the HTTP API webserver (with a trailing slash) +* `key` value is the **API Key** in `pdns.conf` on the master nameserver. +* `nameservers` value is a comma delimited list of nameservers. There is not currently a limit for the number of nameservers you may use, 2-5 is typical and should be geographically distributed per RFC 2182. ### Setting as default @@ -24,7 +120,7 @@ PowerDNS may be configured as the default provider for all sites using the `dns. cpcmd config_set dns.default-provider powerdns ``` -> Note that it is not safe to set this value as a server-wide default in untrusted multiuser environments. A user with panel access can retrieve your key `common_get_service_value dns key` or even using Javascript in the panel, `apnscp.cmd('common_get_service_value',['dns','key'], {async: false})`. +> Do not set dns.default-provider-key. API key is configured via `config/auth.yaml`. ## Components From 5dffd615e59453134d811b774d204963120aa2d7 Mon Sep 17 00:00:00 2001 From: Matt Saladna Date: Fri, 12 Jul 2019 02:25:09 -0400 Subject: [PATCH 10/14] Preserve line break Signed-off-by: Matt Saladna --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 756d187..72377d6 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,8 @@ In this situation, the endpoint is https://myserver.apnscp.com/dns. Changes are ``` -**Downsides**: minor SSL overhead. Dependent upon Apache. -**Upsides**: easy to setup. Protected by threat deterrence. PowerDNS accessible remotely via an easily controlled URI. +**Downsides**: minor SSL overhead. Dependent upon Apache. +**Upsides**: easy to setup. Protected by threat deterrence. PowerDNS accessible remotely via an easily controlled URI. In the above example, API requests can be made via https://myserver.apnscp.com/dns, e.g. @@ -81,9 +81,8 @@ cd /usr/local/apnscp/resources/playbooks ansible-playbook addin.yml --extra-vars=addin=apnscp-powerdns ``` -**Downsides**: requires whitelisting IP addresses for access to API server. Must run on port different than Apache. - -**Upsides**: operates independently from Apache. +**Downsides**: requires whitelisting IP addresses for access to API server. Must run on port different than Apache. +**Upsides**: operates independently from Apache. The server may be accessed once the source IP has been whitelisted, From 684090ecd4d70f45ddd1225f50787937a3f30d52 Mon Sep 17 00:00:00 2001 From: Matt Saladna Date: Fri, 12 Jul 2019 12:33:23 -0400 Subject: [PATCH 11/14] Brute-force workarounds Signed-off-by: Matt Saladna --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 72377d6..e55c3cb 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,22 @@ In the above example, API requests can be made via https://myserver.apnscp.com/d curl -q -H 'X-API-Key: SOMEKEY' https://myserver.apnscp.com/dns/api/v1/servers/localhost ``` +##### Disabling brute-force throttling + +As hinted above, placing PowerDNS behind Apache confers brute-force protection by mod_evasive. By default, 10 of the same requests in 2 seconds can trigger a brute-force block. Two solutions exist, either raise the same-page request threshold or disable mod_evasive. + +Working off the example above * ... * +``` + + # Raise threshold to 30 same-page requests in 2 seconds + DOSPageCount 30 + DOSPageInterval 2 + + # Or disable entirely + DOSEnabled off + +``` + #### Standalone server PowerDNS can also run by itself on a different port. In this situation, the network is configured to block all external requests to port 8081 except those whitelisted. For example, if the entire 32.12.1.1-32.12.1.255 network can be trusted and under your control, then whitelist the IP range: From 1c1e6127a35eb005d28acf3384f2222a221e78d1 Mon Sep 17 00:00:00 2001 From: Troy Siedsma Date: Mon, 15 Jul 2019 13:21:50 -0500 Subject: [PATCH 12/14] Chg: Issues List Fix: Adding / Removing Records --- ISSUES.md | 12 ++++-------- src/Module.php | 25 ++++++++++++++----------- 2 files changed, 18 insertions(+), 19 deletions(-) diff --git a/ISSUES.md b/ISSUES.md index 1fffe87..7686259 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -1,19 +1,15 @@ ## Issues List: ## 1) Deleting a Site deletes the zone and then tries to delete records but they were already deleted with the zone -2) Creating MX records just doesn't work -3) Deleting records seems to fail at $id = $this->getRecordId($record); +ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 +I know that's generated in the zoneAxfr method, but not sure why it happens during delete. - -### Issue 1 ### -I know the "ERROR" is generated in the zoneAxfr method, but not sure why it happens during delete. -```ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 DEBUG : 0.68447: Dns_Module -> _delete DEBUG : 0.04320: Mysql_Module -> _delete DEBUG : 0.00006: Ipinfo_Module -> _delete DEBUG : Service config `billing' disabled for site - disabling calling hook `_delete' on `Billing_Module' DEBUG : Service config `pgsql' disabled for site - disabling calling hook `_delete' on `Pgsql_Module' DEBUG : 0.00054: Site_Module -> _delete -ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404``` +ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 -Seems to be trying to delete records after deleting the zone which deletes the records... +Seems to be trying to delete records after deleting the zone which deletes the records... \ No newline at end of file diff --git a/src/Module.php b/src/Module.php index 21730a0..741078a 100644 --- a/src/Module.php +++ b/src/Module.php @@ -138,7 +138,7 @@ protected function formatRecord(Record $r): ?array case 'MX': $priority = (int) $r->getMeta('priority'); $content = sprintf( - '%d%s', + '%d %s', $r->getMeta('priority'), $this->canonical($r->getMeta('data')) ); @@ -238,7 +238,7 @@ private function renderMessage(ClientException $e): string public function remove_record(string $zone, string $subdomain, string $rr, string $param = null): bool { $zone = trim($zone, '.'); - if (! $this->canonicalizeRecord($zone, $subdomain, $rr, $param)) + if (! $canonicalZone = $this->canonicalizeRecord($zone, $subdomain, $rr, $param)) { return false; } @@ -247,23 +247,26 @@ public function remove_record(string $zone, string $subdomain, string $rr, strin 'name' => $subdomain, 'rr' => $rr, 'parameter' => $param, - 'ttl' => self::DNS_TTL, ]); + // Not sure how this is used +// $id = $this->getRecordId($record); + if ($record['name'] === '@') { - $record['name'] = ''; + $record['name'] = $this->canonical($zone); + } else { + $record['name'] = $this->canonical(implode('.', [$subdomain, $zone])); } $api = $this->makeApi(); - $id = $this->getRecordId($record); - if (! $id) - { - $fqdn = implode('.', [$subdomain, $zone]); - - return error("Record '%s' (rr: '%s', param: '%s') does not exist", $fqdn, $rr, $param); - } +// if (! $id) +// { +// $fqdn = implode('.', [$subdomain, $zone]); +// +// return error("Record '%s' (rr: '%s', param: '%s') does not exist", $fqdn, $rr, $param); +// } $rrsets[] = [ 'records' => '', From cbff707c69deb4fb0a363b6109969878286c0d7b Mon Sep 17 00:00:00 2001 From: Troy Siedsma Date: Mon, 15 Jul 2019 14:02:55 -0500 Subject: [PATCH 13/14] Update Issues DeleteDomain fails with an error --- ISSUES.md | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 102 insertions(+), 4 deletions(-) diff --git a/ISSUES.md b/ISSUES.md index 7686259..43359ec 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -1,9 +1,7 @@ ## Issues List: ## 1) Deleting a Site deletes the zone and then tries to delete records but they were already deleted with the zone -ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 -I know that's generated in the zoneAxfr method, but not sure why it happens during delete. - +```ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 DEBUG : 0.68447: Dns_Module -> _delete DEBUG : 0.04320: Mysql_Module -> _delete DEBUG : 0.00006: Ipinfo_Module -> _delete @@ -11,5 +9,105 @@ DEBUG : Service config `billing' disabled for site - disabling calling hook `_ DEBUG : Service config `pgsql' disabled for site - disabling calling hook `_delete' on `Pgsql_Module' DEBUG : 0.00054: Site_Module -> _delete ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 +``` + +Full Backtrace: +``` +DEBUG : Running hooks for `testdomain.com' (user: `testuser') +DEBUG : 0.00007: Sql_Module -> _delete +DEBUG : 0.00285: Php_Module -> _delete +DEBUG : 0.00042: Letsencrypt_Module -> _delete +DEBUG : 0.00004: Dav_Module -> _delete +DEBUG : 0.01276: Majordomo_Module -> _delete +DEBUG : 0.00329: Crontab_Module -> _delete +DEBUG : 0.00012: Spamfilter_Module -> _delete +DEBUG : 0.00008: Email_Module -> _delete +DEBUG : 0.00009: Ssh_Module -> _delete +DEBUG : 0.00004: Ftp_Module -> _delete +ERROR : Auth_Module::_getAPIQueryFragment: cannot get billing invoice for API key + 0. Error_Reporter::add_error("Auth_Module::_getAPIQueryFragment: cannot get billing invoice for API key", ) + [/usr/local/apnscp/lib/log_wrapper.php:63] + 1. error("cannot get billing invoice for API key") + [/usr/local/apnscp/lib/modules/auth.php:322] + 2. Auth_Module->_getAPIQueryFragment() + [/usr/local/apnscp/lib/modules/auth.php:950] + 3. Auth_Module->_get_api_keys_real("testuser") + [/usr/local/apnscp/lib/modules/auth.php:1082] + 4. Auth_Module->get_api_keys() + [/usr/local/apnscp/lib/modules/auth.php:1057] + 5. Auth_Module->_delete() + [/usr/local/apnscp/lib/Util/Account/Hooks.php:142] + 6. Util_Account_Hooks::_process("delete", ) + [/usr/local/apnscp/lib/Util/Account/Hooks.php:49] + 7. Util_Account_Hooks::run("delete") + [/usr/local/apnscp/bin/DeleteDomain:35] + +DEBUG : 0.00313: Auth_Module -> _delete +DEBUG : 0.00060: Aliases_Module -> _delete +DEBUG : 0.00004: Diskquota_Module -> _delete +DEBUG : Service config `tomcat' disabled for site - disabling calling hook `_delete' on `Tomcat_Module' +DEBUG : 0.00736: User_Module -> _delete +DEBUG : 0.00011: Bandwidth_Module -> _delete +DEBUG : 0.00006: Ssl_Module -> _delete +DEBUG : 0.00166: Cgroup_Module -> _delete +DEBUG : 0.03925: Web_Module -> _delete +DEBUG : 0.63373: Dns_Module -> _delete +DEBUG : 0.02480: Mysql_Module -> _delete +DEBUG : 0.00006: Ipinfo_Module -> _delete +DEBUG : Service config `billing' disabled for site - disabling calling hook `_delete' on `Billing_Module' +DEBUG : Service config `pgsql' disabled for site - disabling calling hook `_delete' on `Pgsql_Module' +DEBUG : 0.00035: Site_Module -> _delete +ERROR : Opcenter\Dns\Providers\Powerdns\Module::zoneAxfr: Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 + 0. Error_Reporter::add_error("Opcenter\Dns\Providers\Powerdns\Module::zoneAxfr: Failed to transfer DNS records from PowerDNS - try again later. Response code: %d", [404]) + [/usr/local/apnscp/lib/log_wrapper.php:63] + 1. error("Failed to transfer DNS records from PowerDNS - try again later. Response code: %d", 404) + [/usr/local/apnscp/resources/playbooks/addins/apnscp-powerdns/src/Module.php:477] + 2. Opcenter\Dns\Providers\Powerdns\Module->zoneAxfr("testdomain.com") + [/usr/local/apnscp/lib/modules/dns.php:295] + 3. Dns_Module->zone_exists("testdomain.com") + [/usr/local/apnscp/lib/Module/Skeleton/Standard.php:144] + 4. Module\Skeleton\Standard->_invoke("zone_exists", ["testdomain.com"]) + [/usr/local/apnscp/lib/Module/Skeleton/Webhooks.php:35] + 5. Module\Skeleton\Webhooks->_invoke("zone_exists", ["testdomain.com"]) + [/usr/local/apnscp/lib/apnscpfunction.php:734] + 6. apnscpFunctionInterceptor->call("dns_zone_exists", ["testdomain.com"]) + [/usr/local/apnscp/lib/apnscpFunctionInterceptorTrait.php:34] + 7. Module\Skeleton\Standard->__call("dns_zone_exists", ["testdomain.com"]) + [/usr/local/apnscp/lib/modules/email.php:959] + 8. Email_Module->remove_virtual_transport("testdomain.com") + [/usr/local/apnscp/lib/Module/Skeleton/Standard.php:144] + 9. Module\Skeleton\Standard->_invoke("remove_virtual_transport", ["testdomain.com"]) + [/usr/local/apnscp/lib/Module/Skeleton/Webhooks.php:35] +10. Module\Skeleton\Webhooks->_invoke("remove_virtual_transport", ["testdomain.com"]) + [/usr/local/apnscp/lib/apnscpfunction.php:734] +11. apnscpFunctionInterceptor->call("email_remove_virtual_transport", ["testdomain.com"]) + [/usr/local/apnscp/lib/apnscpfunction.php:685] +12. apnscpFunctionInterceptor->__call("email_remove_virtual_transport", ["testdomain.com"]) + [/usr/local/apnscp/lib/Opcenter/Service/Validators/Mail/Enabled.php:57] +13. Opcenter\Service\Validators\Mail\Enabled->depopulate(Opcenter\SiteConfiguration) + [/usr/local/apnscp/lib/Opcenter/Account/Delete.php:110] +14. Opcenter\Account\Delete->exec() + [/usr/local/apnscp/bin/DeleteDomain:43] + +INFO : Removing port `1' assigned to `site1' + 0. Error_Reporter::add_info("Removing port `%d' assigned to `%s'", [1, "site1"]) + [/usr/local/apnscp/lib/log_wrapper.php:87] + 1. info("Removing port `%d' assigned to `%s'", 1, "site1") + [/usr/local/apnscp/lib/Opcenter/Service/Validators/Ssh/PortIndex.php:97] + 2. Opcenter\Service\Validators\Ssh\PortIndex->depopulate(Opcenter\SiteConfiguration) + [/usr/local/apnscp/lib/Opcenter/Account/Delete.php:110] + 3. Opcenter\Account\Delete->exec() + [/usr/local/apnscp/bin/DeleteDomain:43] + +WARNING : Opcenter\Service\Validators\Pgsql\Enabled::depopulate(): unable to lookup postgresql user for `site1' + 0. Error_Reporter::add_warning("Opcenter\Service\Validators\Pgsql\Enabled::depopulate(): unable to lookup postgresql user for `%s'", ["site1"]) + [/usr/local/apnscp/lib/log_wrapper.php:75] + 1. warn("unable to lookup postgresql user for `%s'", "site1") + [/usr/local/apnscp/lib/Opcenter/Service/Validators/Pgsql/Enabled.php:90] + 2. Opcenter\Service\Validators\Pgsql\Enabled->depopulate(Opcenter\SiteConfiguration) + [/usr/local/apnscp/lib/Opcenter/Account/Delete.php:110] + 3. Opcenter\Account\Delete->exec() + [/usr/local/apnscp/bin/DeleteDomain:43] +``` -Seems to be trying to delete records after deleting the zone which deletes the records... \ No newline at end of file +Seems to be trying to delete records after deleting the zone which deletes the records... The 404 is a result of the zone not existing in PowerDNS anymore. From 26cba21e5dc9eee10fd4fc3a8577de716d567e9f Mon Sep 17 00:00:00 2001 From: Troy Siedsma Date: Wed, 17 Jul 2019 13:45:43 -0500 Subject: [PATCH 14/14] Fixed issues, updated license and ready for release --- ISSUES.md | 113 ---------- LICENSE | 2 +- README.md | 4 +- src/Module.php | 572 ++++++++++++++++++++++++++----------------------- 4 files changed, 310 insertions(+), 381 deletions(-) delete mode 100644 ISSUES.md diff --git a/ISSUES.md b/ISSUES.md deleted file mode 100644 index 43359ec..0000000 --- a/ISSUES.md +++ /dev/null @@ -1,113 +0,0 @@ -## Issues List: ## -1) Deleting a Site deletes the zone and then tries to delete records but they were already deleted with the zone - -```ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 -DEBUG : 0.68447: Dns_Module -> _delete -DEBUG : 0.04320: Mysql_Module -> _delete -DEBUG : 0.00006: Ipinfo_Module -> _delete -DEBUG : Service config `billing' disabled for site - disabling calling hook `_delete' on `Billing_Module' -DEBUG : Service config `pgsql' disabled for site - disabling calling hook `_delete' on `Pgsql_Module' -DEBUG : 0.00054: Site_Module -> _delete -ERROR : Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 -``` - -Full Backtrace: -``` -DEBUG : Running hooks for `testdomain.com' (user: `testuser') -DEBUG : 0.00007: Sql_Module -> _delete -DEBUG : 0.00285: Php_Module -> _delete -DEBUG : 0.00042: Letsencrypt_Module -> _delete -DEBUG : 0.00004: Dav_Module -> _delete -DEBUG : 0.01276: Majordomo_Module -> _delete -DEBUG : 0.00329: Crontab_Module -> _delete -DEBUG : 0.00012: Spamfilter_Module -> _delete -DEBUG : 0.00008: Email_Module -> _delete -DEBUG : 0.00009: Ssh_Module -> _delete -DEBUG : 0.00004: Ftp_Module -> _delete -ERROR : Auth_Module::_getAPIQueryFragment: cannot get billing invoice for API key - 0. Error_Reporter::add_error("Auth_Module::_getAPIQueryFragment: cannot get billing invoice for API key", ) - [/usr/local/apnscp/lib/log_wrapper.php:63] - 1. error("cannot get billing invoice for API key") - [/usr/local/apnscp/lib/modules/auth.php:322] - 2. Auth_Module->_getAPIQueryFragment() - [/usr/local/apnscp/lib/modules/auth.php:950] - 3. Auth_Module->_get_api_keys_real("testuser") - [/usr/local/apnscp/lib/modules/auth.php:1082] - 4. Auth_Module->get_api_keys() - [/usr/local/apnscp/lib/modules/auth.php:1057] - 5. Auth_Module->_delete() - [/usr/local/apnscp/lib/Util/Account/Hooks.php:142] - 6. Util_Account_Hooks::_process("delete", ) - [/usr/local/apnscp/lib/Util/Account/Hooks.php:49] - 7. Util_Account_Hooks::run("delete") - [/usr/local/apnscp/bin/DeleteDomain:35] - -DEBUG : 0.00313: Auth_Module -> _delete -DEBUG : 0.00060: Aliases_Module -> _delete -DEBUG : 0.00004: Diskquota_Module -> _delete -DEBUG : Service config `tomcat' disabled for site - disabling calling hook `_delete' on `Tomcat_Module' -DEBUG : 0.00736: User_Module -> _delete -DEBUG : 0.00011: Bandwidth_Module -> _delete -DEBUG : 0.00006: Ssl_Module -> _delete -DEBUG : 0.00166: Cgroup_Module -> _delete -DEBUG : 0.03925: Web_Module -> _delete -DEBUG : 0.63373: Dns_Module -> _delete -DEBUG : 0.02480: Mysql_Module -> _delete -DEBUG : 0.00006: Ipinfo_Module -> _delete -DEBUG : Service config `billing' disabled for site - disabling calling hook `_delete' on `Billing_Module' -DEBUG : Service config `pgsql' disabled for site - disabling calling hook `_delete' on `Pgsql_Module' -DEBUG : 0.00035: Site_Module -> _delete -ERROR : Opcenter\Dns\Providers\Powerdns\Module::zoneAxfr: Failed to transfer DNS records from PowerDNS - try again later. Response code: 404 - 0. Error_Reporter::add_error("Opcenter\Dns\Providers\Powerdns\Module::zoneAxfr: Failed to transfer DNS records from PowerDNS - try again later. Response code: %d", [404]) - [/usr/local/apnscp/lib/log_wrapper.php:63] - 1. error("Failed to transfer DNS records from PowerDNS - try again later. Response code: %d", 404) - [/usr/local/apnscp/resources/playbooks/addins/apnscp-powerdns/src/Module.php:477] - 2. Opcenter\Dns\Providers\Powerdns\Module->zoneAxfr("testdomain.com") - [/usr/local/apnscp/lib/modules/dns.php:295] - 3. Dns_Module->zone_exists("testdomain.com") - [/usr/local/apnscp/lib/Module/Skeleton/Standard.php:144] - 4. Module\Skeleton\Standard->_invoke("zone_exists", ["testdomain.com"]) - [/usr/local/apnscp/lib/Module/Skeleton/Webhooks.php:35] - 5. Module\Skeleton\Webhooks->_invoke("zone_exists", ["testdomain.com"]) - [/usr/local/apnscp/lib/apnscpfunction.php:734] - 6. apnscpFunctionInterceptor->call("dns_zone_exists", ["testdomain.com"]) - [/usr/local/apnscp/lib/apnscpFunctionInterceptorTrait.php:34] - 7. Module\Skeleton\Standard->__call("dns_zone_exists", ["testdomain.com"]) - [/usr/local/apnscp/lib/modules/email.php:959] - 8. Email_Module->remove_virtual_transport("testdomain.com") - [/usr/local/apnscp/lib/Module/Skeleton/Standard.php:144] - 9. Module\Skeleton\Standard->_invoke("remove_virtual_transport", ["testdomain.com"]) - [/usr/local/apnscp/lib/Module/Skeleton/Webhooks.php:35] -10. Module\Skeleton\Webhooks->_invoke("remove_virtual_transport", ["testdomain.com"]) - [/usr/local/apnscp/lib/apnscpfunction.php:734] -11. apnscpFunctionInterceptor->call("email_remove_virtual_transport", ["testdomain.com"]) - [/usr/local/apnscp/lib/apnscpfunction.php:685] -12. apnscpFunctionInterceptor->__call("email_remove_virtual_transport", ["testdomain.com"]) - [/usr/local/apnscp/lib/Opcenter/Service/Validators/Mail/Enabled.php:57] -13. Opcenter\Service\Validators\Mail\Enabled->depopulate(Opcenter\SiteConfiguration) - [/usr/local/apnscp/lib/Opcenter/Account/Delete.php:110] -14. Opcenter\Account\Delete->exec() - [/usr/local/apnscp/bin/DeleteDomain:43] - -INFO : Removing port `1' assigned to `site1' - 0. Error_Reporter::add_info("Removing port `%d' assigned to `%s'", [1, "site1"]) - [/usr/local/apnscp/lib/log_wrapper.php:87] - 1. info("Removing port `%d' assigned to `%s'", 1, "site1") - [/usr/local/apnscp/lib/Opcenter/Service/Validators/Ssh/PortIndex.php:97] - 2. Opcenter\Service\Validators\Ssh\PortIndex->depopulate(Opcenter\SiteConfiguration) - [/usr/local/apnscp/lib/Opcenter/Account/Delete.php:110] - 3. Opcenter\Account\Delete->exec() - [/usr/local/apnscp/bin/DeleteDomain:43] - -WARNING : Opcenter\Service\Validators\Pgsql\Enabled::depopulate(): unable to lookup postgresql user for `site1' - 0. Error_Reporter::add_warning("Opcenter\Service\Validators\Pgsql\Enabled::depopulate(): unable to lookup postgresql user for `%s'", ["site1"]) - [/usr/local/apnscp/lib/log_wrapper.php:75] - 1. warn("unable to lookup postgresql user for `%s'", "site1") - [/usr/local/apnscp/lib/Opcenter/Service/Validators/Pgsql/Enabled.php:90] - 2. Opcenter\Service\Validators\Pgsql\Enabled->depopulate(Opcenter\SiteConfiguration) - [/usr/local/apnscp/lib/Opcenter/Account/Delete.php:110] - 3. Opcenter\Account\Delete->exec() - [/usr/local/apnscp/bin/DeleteDomain:43] -``` - -Seems to be trying to delete records after deleting the zone which deletes the records... The 404 is a result of the zone not existing in PowerDNS anymore. diff --git a/LICENSE b/LICENSE index f288702..e72bfdd 100644 --- a/LICENSE +++ b/LICENSE @@ -671,4 +671,4 @@ 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 -. +. \ No newline at end of file diff --git a/README.md b/README.md index e55c3cb..e2fe1e0 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ pdns: ``` * `uri` value is the hostname of your master PowerDNS server running the HTTP API webserver (with a trailing slash) * `key` value is the **API Key** in `pdns.conf` on the master nameserver. -* `nameservers` value is a comma delimited list of nameservers. There is not currently a limit for the number of nameservers you may use, 2-5 is typical and should be geographically distributed per RFC 2182. +* `ns` value is a list of nameservers as in the example above. Put nameservers on their own lines prefixed with a hyphen and indented accordingly. There is not currently a limit for the number of nameservers you may use, 2-5 is typical and should be geographically distributed per RFC 2182. ### Setting as default @@ -158,4 +158,4 @@ See also: [Creating a provider](https://hq.apnscp.com/apnscp-pre-alpha-technical ## Contributing -Submit a PR and have fun! +Submit a PR and have fun! \ No newline at end of file diff --git a/src/Module.php b/src/Module.php index 741078a..64df744 100644 --- a/src/Module.php +++ b/src/Module.php @@ -14,13 +14,6 @@ use Module\Provider\Contracts\ProviderInterface; use Opcenter\Dns\Record; -/** @TODO - * Fix Deleting Records / The PowerDNS API logic is weird. I feel like deleting a record could delete other records with the same name... - * Fix Adding Records not showing on page until reload - * Test Changing Records - * Test addon domains - * Fix MX creation - Default account creation MX records fail - */ class Module extends \Dns_Module implements ProviderInterface { use \NamespaceUtilitiesTrait; @@ -52,51 +45,38 @@ public function __construct() } /** - * Add a DNS record + * Add DNS zone to service * - * @param string $zone - * @param string $subdomain - * @param string $rr - * @param string $param - * @param int $ttl + * @param string $domain + * @param string $ip * * @return bool */ - public function add_record(string $zone, string $subdomain, string $rr, string $param, int $ttl = self::DNS_TTL): bool + public function add_zone_backend(string $domain, string $ip): bool { - if (! $this->canonicalizeRecord($zone, $subdomain, $rr, $param, $ttl)) - { - return false; - } - - $record = new Record($zone, [ - 'name' => $subdomain, - 'rr' => $rr, - 'parameter' => $param, - 'ttl' => $ttl, - ]); - - if ($record['name'] === '@') - { - $record['name'] = ''; - } - + $domain = rtrim($domain, '\.'); + /** + * @var Zones $api + */ + $api = $this->makeApi(); try { - $api = $this->makeApi(); - $rrsets = $this->formatRecord($record); - $ret = $api->do('PATCH', 'zones/' . $this->canonical($zone), ['rrsets' => $rrsets]); // returns empty or zero??? - $this->addCache($record); + $resp = $api->do('POST', 'servers/localhost/zones', [ + 'account' => null, + 'kind' => 'native', + 'soa_edit_api' => 'INCEPTION-INCREMENT', + 'masters' => [], + 'name' => $this->makeCanonical($domain), + 'nameservers' => [], + 'rrsets' => array_merge($this->createSOA($domain, $this->ns[0], 'hostmaster@' . $domain), $this->createNS($domain, $this->ns)), + ]); } catch (ClientException $e) { - info(json_encode(['rec' => $record->toArray(), 'ret' => $ret, 'rrsets' => $rrsets], JSON_PRETTY_PRINT)); - info($e->getMessage()); - - return error("Failed to create record '%s': %s", (string) $record, $this->renderMessage($e)); + return error("Failed to add zone '%s', error: %s", $domain, $this->renderMessage($e)); } - return true; // this sucks... + return true; } /** @@ -109,79 +89,6 @@ private function makeApi(): Api return new Api(); } - /** - * Format a PowerDNS record prior to sending - * - * @param Record $r - * - * @return array - */ - protected function formatRecord(Record $r): ?array - { - $type = strtoupper($r['rr']); - $ttl = $r['ttl'] ?? static::DNS_TTL; - - $content = ''; - $priority = null; - $name = null; - - switch ($type) - { - case 'A': - case 'AAAA': - case 'CNAME': - case 'TXT': - case 'NS': - case 'PTR': - $content = $r['parameter']; - break; - case 'MX': - $priority = (int) $r->getMeta('priority'); - $content = sprintf( - '%d %s', - $r->getMeta('priority'), - $this->canonical($r->getMeta('data')) - ); - break; - case 'SRV': - $content = sprintf( - // protocol | service | target | priority | weight | port - '%s %s %s %d %d %d', - $r->getMeta('protocol'), - $r->getMeta('service'), - $r->getMeta('data'), - (int) $r->getMeta('priority'), - (int) $r->getMeta('weight'), - (int) $r->getMeta('port') - ); - break; - case 'CAA': - $content = sprintf( - // tag | target - '%s %s', - $r->getMeta('tag'), - $r->getMeta('data') - ); - break; - default: - fatal("Unsupported DNS RR type '%s'", $type); - } - - $rrsets[] = [ - 'records' => [0 => [ - 'content' => $content, - 'disabled' => false, - ]], - 'name' => $name ?? $this->canonical(implode('.', [$r['name'], $r['zone']])), - 'ttl' => $ttl, - 'type' => $type, - 'prio' => $priority ?? 0, - 'changetype' => 'REPLACE', - ]; - - return $rrsets; - } - /** * returns canonical domain (e.g. always returns root dot) * @@ -189,13 +96,13 @@ protected function formatRecord(Record $r): ?array * * @return string */ - private function canonical($name) + private function makeCanonical($name) { if (empty($name)) // Sometimes the name is empty and ltrim throws a fit about it { return $name; } - $name = ltrim($name, '.'); + $name = trim($name, '.'); if (substr($name, -1) !== '.') { return $name . '.'; @@ -205,127 +112,14 @@ private function canonical($name) } /** - * Extract JSON message if present - * - * @param ClientException $e - * - * @return string - */ - private function renderMessage(ClientException $e): string - { - - $body = \Error_Reporter::silence(function () use ($e) { - return \json_decode($e->getResponse()->getBody()->getContents(), true); - }); - if (! $body || ! ($reason = array_get($body, 'errors.0.reason'))) - { - return $e->getMessage(); - } - - return $reason; - } - - /** - * Remove a DNS record - * - * @param string $zone - * @param string $subdomain - * @param string $rr - * @param string|null $param - * - * @return bool - */ - public function remove_record(string $zone, string $subdomain, string $rr, string $param = null): bool - { - $zone = trim($zone, '.'); - if (! $canonicalZone = $this->canonicalizeRecord($zone, $subdomain, $rr, $param)) - { - return false; - } - - $record = new Record($zone, [ - 'name' => $subdomain, - 'rr' => $rr, - 'parameter' => $param, - ]); - - // Not sure how this is used -// $id = $this->getRecordId($record); - - if ($record['name'] === '@') - { - $record['name'] = $this->canonical($zone); - } else { - $record['name'] = $this->canonical(implode('.', [$subdomain, $zone])); - } - - $api = $this->makeApi(); - -// if (! $id) -// { -// $fqdn = implode('.', [$subdomain, $zone]); -// -// return error("Record '%s' (rr: '%s', param: '%s') does not exist", $fqdn, $rr, $param); -// } - - $rrsets[] = [ - 'records' => '', - 'name' => $record['name'], - 'changetype' => 'DELETE', - 'type' => $record['rr'], - ]; - - try - { - $ret = $api->do('PATCH', "zones/${zone}", ['rrsets' => $rrsets]); - } - catch (ClientException $e) - { - $fqdn = implode('.', [$subdomain, $zone]); - - return error("Failed to delete record '%s' type %s", $fqdn, $rr); - } - array_forget($this->zoneCache[ $record->getZone() ], $this->getCacheKey($record)); - - return $api->getResponse()->getStatusCode() === 200; - } - - /** - * Add DNS zone to service + * Create SOA record for specified domain/zone * - * @param string $domain - * @param string $ip + * @param $name + * @param $primary + * @param $soa_contact * - * @return bool + * @return array */ - public function add_zone_backend(string $domain, string $ip): bool - { - $domain = trim($domain, '.'); - /** - * @var Zones $api - */ - $api = $this->makeApi(); - try - { - $resp = $api->do('POST', 'servers/localhost/zones', [ - 'account' => null, - 'kind' => 'native', - 'soa_edit_api' => 'INCEPTION-INCREMENT', - 'masters' => [], - 'name' => $this->canonical($domain), - 'nameservers' => [], - // 'rrsets' => array_merge($this->createSOA($domain, $this->ns[0], 'hostmaster@' . $domain), $this->createNS($domain, $this->ns), $this->createDefaultRecords($domain, $ip)), - 'rrsets' => array_merge($this->createSOA($domain, $this->ns[0], 'hostmaster@' . $domain), $this->createNS($domain, $this->ns)), - ]); - } - catch (ClientException $e) - { - return error("Failed to add zone '%s', error: %s", $domain, $this->renderMessage($e)); - } - - return true; - } - protected function createSOA($name, $primary, $soa_contact) { $rrsets = [ @@ -334,14 +128,14 @@ protected function createSOA($name, $primary, $soa_contact) 'content' => sprintf( // primary | contact | serial | refresh | retry | expire | ttl '%s %s %s 3600 1800 604800 600', - $this->canonical($primary), - $this->canonical($soa_contact), + $this->makeCanonical($primary), + $this->makeCanonical($soa_contact), date('Ymd') . sprintf('%02d', rand(0, 99)) ), 'disabled' => false, ], ], - 'name' => $this->canonical($name), + 'name' => $this->makeCanonical($name), 'ttl' => 86400, 'type' => 'SOA', ]; @@ -349,6 +143,14 @@ protected function createSOA($name, $primary, $soa_contact) return [$rrsets]; } + /** + * Create NS records for the specified domain/zone + * + * @param $name + * @param array $nameservers + * + * @return array + */ protected function createNS($name, array $nameservers): array { $rrsets = $records = []; @@ -356,14 +158,14 @@ protected function createNS($name, array $nameservers): array foreach ($nameservers as $nameserver) { $records[] = [ - 'content' => $this->canonical($nameserver), + 'content' => $this->makeCanonical($nameserver), 'disabled' => false, ]; } $rrsets[] = [ 'records' => $records, - 'name' => $this->canonical($name), + 'name' => $this->makeCanonical($name), 'ttl' => 86400, 'type' => 'NS', ]; @@ -371,6 +173,27 @@ protected function createNS($name, array $nameservers): array return $rrsets; } + /** + * Extract JSON message if present + * + * @param ClientException $e + * + * @return string + */ + private function renderMessage(ClientException $e): string + { + + $body = \Error_Reporter::silence(function () use ($e) { + return \json_decode($e->getResponse()->getBody()->getContents(), true); + }); + if (! $body || ! ($reason = array_get($body, 'errors.0.reason'))) + { + return $e->getMessage(); + } + + return $reason; + } + /** * Remove DNS zone from nameserver * @@ -393,6 +216,14 @@ public function remove_zone_backend(string $domain): bool return true; } + /** + * Creates Record with Zone Creation (not currently implemented) + * + * @param $name + * @param null $ip + * + * @return array + */ protected function createDefaultRecords($name, $ip = null): array { $rrsets = []; @@ -407,7 +238,7 @@ protected function createDefaultRecords($name, $ip = null): array $rrsets[] = [ 'records' => $records, - 'name' => $this->canonical($name), + 'name' => $this->makeCanonical($name), 'ttl' => 14400, 'type' => 'A', ]; @@ -416,13 +247,13 @@ protected function createDefaultRecords($name, $ip = null): array foreach ($cnames as $cname) { $records = [0 => [ - 'content' => $this->canonical($name), + 'content' => $this->makeCanonical($name), 'disabled' => false, ]]; $rrsets[] = [ 'records' => $records, - 'name' => $this->canonical(implode('.', [$cname, $name])), + 'name' => $this->makeFqdn($name, $cname, true), 'ttl' => 14400, 'type' => 'CNAME', ]; @@ -431,6 +262,32 @@ protected function createDefaultRecords($name, $ip = null): array return $rrsets; } + /** + * Return a complete domain name with the subdomain and zone. + * Optionally returns the canonical domain with trailing period + * + * @param $zone + * @param $subdomain + * + * @param bool $makeCanonical + * + * @return string + */ + private function makeFqdn($zone, $subdomain, $makeCanonical = false): string + { + if (strpos($subdomain, $zone) === false) + { + $subdomain = implode('.', [$subdomain, $zone]); + } + + if ($makeCanonical) + { + return $this->makeCanonical($subdomain); + } + + return $subdomain; + } + /** * Get raw zone data * @@ -440,6 +297,7 @@ protected function createDefaultRecords($name, $ip = null): array */ protected function zoneAxfr($domain): ?string { + $domain = rtrim($domain, '\.'); // @todo hold records in cache and synthesize AXFR $client = $this->makeApi(); @@ -471,14 +329,17 @@ protected function zoneAxfr($domain): ?string { if ($e->getResponse()->getStatusCode() === 422) { - // zone doesn't exist - return null; + return null; // This really shouldn't happen } + if ($e->getResponse()->getStatusCode() === 404) + { + return null; // No zone here! + } + error("Failed to transfer DNS records from PowerDNS - try again later. Response code: %d", $e->getResponse()->getStatusCode()); return null; } - $this->zoneCache[ $domain ] = []; foreach ($records['rrsets'] as $r) { foreach ($r['records'] as $record) @@ -498,17 +359,7 @@ protected function zoneAxfr($domain): ?string default: $parameter = $record['content']; } - $hostname = $this->canonical($r['name']); - $preamble[] = $hostname . "\t" . $r['ttl'] . "\tIN\t" . $r['type'] . "\t" . $parameter; - - $this->addCache(new Record($domain, - [ - 'name' => $hostname, - 'rr' => $r['type'], - 'ttl' => $r['ttl'] ?? static::DNS_TTL, - 'parameter' => $parameter, - ] - )); + $preamble[] = $r['name'] . "\t" . $r['ttl'] . "\tIN\t" . $r['type'] . "\t" . $parameter; } } $axfrrec = implode("\n", $preamble); @@ -543,24 +394,21 @@ protected function atomicUpdate(string $zone, Record $old, Record $new): bool { return false; } - if (! $this->getRecordId($old)) - { - return error("failed to find record ID in PowerDNS zone '%s' - does '%s' (rr: '%s', parameter: '%s') exist?", - $zone, $old['name'], $old['rr'], $old['parameter']); - } + + $old['ttl'] = null; + if (! $this->canonicalizeRecord($zone, $new['name'], $new['rr'], $new['parameter'], $new['ttl'])) { return false; } - $api = $this->makeApi(); try { $merged = clone $old; $new = $merged->merge($new); - $id = $this->getRecordId($old); - $ret = $api->do('PATCH', "zones/" . sprintf('%s', $this->canonical($zone)), ['rrsets' => $this->formatRecord($old)]); + $this->add_record($zone, $new['name'], $new['rr'], $new['parameter'], $new['ttl']); + $this->remove_record($zone, $old['name'], $new['rr'], $new['parameter']); } catch (ClientException $e) { @@ -572,12 +420,185 @@ protected function atomicUpdate(string $zone, Record $old, Record $new): bool $this->renderMessage($e) ); } - array_forget($this->zoneCache[ $old->getZone() ], $this->getCacheKey($old)); - $this->addCache($new); return true; } + /** + * Add a DNS record + * + * @param string $zone + * @param string $subdomain + * @param string $rr + * @param string $param + * @param int $ttl + * + * @return bool + */ + public function add_record(string $zone, string $subdomain, string $rr, string $param, int $ttl = self::DNS_TTL): bool + { + if (! $this->canonicalizeRecord($zone, $subdomain, $rr, $param, $ttl)) + { + return false; + } + + $record = new Record($zone, [ + 'name' => $subdomain, + 'rr' => $rr, + 'parameter' => $param, + 'ttl' => $ttl, + ]); + + try + { + $api = $this->makeApi(); + $rrsets = $this->formatRecord($record); + $ret = $api->do('PATCH', 'zones/' . $this->makeCanonical($zone), ['rrsets' => $rrsets]); // returns empty or zero??? + } + catch (ClientException $e) + { +// info(json_encode(['rec' => $record->toArray(), 'rrsets' => $rrsets], JSON_PRETTY_PRINT)); +// info($e->getMessage()); + + return error("Failed to create record '%s': %s", (string) $record, $this->renderMessage($e)); + } + + return true; // this sucks... + } + + /** + * Format a PowerDNS record prior to sending + * + * @param Record $r + * + * @return array + */ + protected function formatRecord(Record $r): ?array + { + $type = strtoupper($r['rr']); + $ttl = $r['ttl'] ?? static::DNS_TTL; + + $content = ''; + $priority = null; + $name = null; + + switch ($type) + { + case 'A': + case 'AAAA': + case 'CNAME': + case 'TXT': + case 'NS': + case 'PTR': + $content = $r['parameter']; + break; + case 'MX': + $priority = (int) $r->getMeta('priority'); + $content = sprintf( + '%d %s', + $r->getMeta('priority'), + $this->makeCanonical($r->getMeta('data')) + ); + break; + case 'SRV': + $content = sprintf( + // protocol | service | target | priority | weight | port + '%s %s %s %d %d %d', + $r->getMeta('protocol'), + $r->getMeta('service'), + $r->getMeta('data'), + (int) $r->getMeta('priority'), + (int) $r->getMeta('weight'), + (int) $r->getMeta('port') + ); + break; + case 'CAA': + $content = sprintf( + // tag | target + '%s %s', + $r->getMeta('tag'), + $r->getMeta('data') + ); + break; + default: + fatal("Unsupported DNS RR type '%s'", $type); + } + + if ($r['name'] === '@') + { + $r['name'] = ''; + } + + $rrsets[] = [ + 'records' => [0 => [ + 'content' => $content, + 'disabled' => false, + ]], + 'name' => $name ?? $this->makeFqdn($r['zone'], $r['name'], true), + 'ttl' => $ttl, + 'type' => $type, + 'prio' => $priority ?? 0, + 'changetype' => 'REPLACE', + ]; + + return $rrsets; + } + + /** + * Remove a DNS record + * + * @param string $zone + * @param string $subdomain + * @param string $rr + * @param string|null $param + * + * @return bool + */ + public function remove_record(string $zone, string $subdomain, string $rr, string $param = null): bool + { + $zone = rtrim($zone, '\.'); + if (! $canonicalZone = $this->canonicalizeRecord($zone, $subdomain, $rr, $param)) + { + return false; + } + + $record = new Record($zone, [ + 'name' => $subdomain, + 'rr' => $rr, + 'parameter' => $param, + ]); + + if ($record['name'] === '@') + { + $name = $this->makeCanonical($zone); + } + else + { + $name = $this->makeFqdn($zone, $subdomain, true); + } + + $rrsets[] = [ + 'records' => '', + 'name' => $name, + 'changetype' => 'DELETE', + 'type' => $record['rr'], + ]; + + try + { + $api = $this->makeApi(); + $ret = $api->do('PATCH', "zones/${zone}", ['rrsets' => $rrsets]); + } + catch (ClientException $e) + { + $fqdn = $this->makeFqdn($zone, $subdomain); + + return error("Failed to delete record '%s' type %s", $fqdn, $rr); + } + + return $api->getResponse()->getStatusCode() === 200; + } + /** * CNAME cannot be present in root * @@ -587,4 +608,25 @@ protected function hasCnameApexRestriction(): bool { return true; } + + /** + * Strip the zone and trailing . from a subdomain/name entry + * + * @param $zone + * @param $subdomain + * + * @return string + */ + private function stripName($zone, $subdomain): string + { + $zone = rtrim($zone, '\.'); + $subdomain = rtrim($subdomain, '\.'); + + if (strpos($subdomain, $zone) !== false) + { + $subdomain = str_replace($zone, '', $subdomain); + } + + return rtrim($subdomain, '\.'); + } }