diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a96c4f1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,682 @@ +happyDomain Licensing + +SOFTWARE LICENSING + +You may be licensed to use source code to create compiled versions not produced +by the happyDNS team in one of two ways: + +1. Under the AGPL v3, subject to the exceptions outlined in this policy; +2. Under a commercial license available from the happyDNS team by contacting + contact@happydns.org. + +happyDNS and happyDomain TRADEMARK GUIDELINES + +Your use of the mark happyDNS and happyDomain is subject to the happyDNS team's +prior written approval and our organization’s Trademark Standards of Use at +http://www.happydomain.org/trademark-standards-of-use/. For trademark approval +or any questions you have about using these trademarks, please email +contact@happydns.org + +------------------------------------------------------------------------------------------------------------------------------ + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md index 6cc3949..dbbed38 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,17 @@ make docker CHECKER_VERSION=1.2.3 Set the `endpoint` admin option for the ping checker to the URL of the running checker-ping server (e.g., `http://checker-ping:8080`). happyDomain will delegate observation collection to this endpoint. +### Deployment + +The `/collect` endpoint has no built-in authentication and will issue +ICMP probes to whatever hostnames or IP addresses the caller supplies, +including private (RFC 1918), loopback, link-local, and cloud metadata +addresses (e.g. `169.254.169.254`). It is meant to run on a trusted +network, reachable only by the happyDomain instance that drives it. +Restrict access via a reverse proxy with authentication, a network ACL, +or by binding the listener to a private interface; do not expose it +directly to the public internet. + ## Protocol ### POST /collect diff --git a/checker/collect.go b/checker/collect.go index f6bff1e..2b0fa74 100644 --- a/checker/collect.go +++ b/checker/collect.go @@ -26,7 +26,6 @@ import ( "encoding/json" "fmt" "net" - "strings" "time" probing "github.com/prometheus-community/pro-bing" @@ -45,12 +44,10 @@ func (p *pingProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (an return nil, err } + const minCount, maxCount = 1, 20 count := sdk.GetIntOption(opts, "count", 5) - if count < 1 { - count = 1 - } - if count > 20 { - count = 20 + if count < minCount || count > maxCount { + return nil, fmt.Errorf("count must be between %d and %d, got %d", minCount, maxCount, count) } data := &PingData{} @@ -76,8 +73,13 @@ func (p *pingProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (an } stats := pinger.Statistics() + var resolved string + if ip := pinger.IPAddr(); ip != nil { + resolved = ip.IP.String() + } data.Targets = append(data.Targets, PingTargetResult{ Address: addr, + ResolvedIP: resolved, RTTMin: float64(stats.MinRtt.Microseconds()) / 1000.0, RTTAvg: float64(stats.AvgRtt.Microseconds()) / 1000.0, RTTMax: float64(stats.MaxRtt.Microseconds()) / 1000.0, @@ -88,7 +90,7 @@ func (p *pingProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (an } if len(data.Targets) == 0 { - return nil, fmt.Errorf("all pings failed: %s", strings.Join(errs, "; ")) + return nil, fmt.Errorf("all %d ping(s) failed; first error: %s", len(errs), errs[0]) } return data, nil @@ -128,7 +130,10 @@ func resolveAddresses(opts sdk.CheckerOptions) ([]string, error) { if svc.Type != "abstract.Server" { return nil, fmt.Errorf("service is %s, expected abstract.Server", svc.Type) } - ips := ipsFromService(&svc) + ips, err := ipsFromService(&svc) + if err != nil { + return nil, fmt.Errorf("decode service payload: %w", err) + } if len(ips) > 0 { addrs := make([]string, len(ips)) for i, ip := range ips { @@ -142,10 +147,10 @@ func resolveAddresses(opts sdk.CheckerOptions) ([]string, error) { return nil, fmt.Errorf("no addresses provided: set 'addresses', 'address', or 'service' in options") } -func ipsFromService(svc *happydns.ServiceMessage) []net.IP { +func ipsFromService(svc *happydns.ServiceMessage) ([]net.IP, error) { var server abstract.Server if err := json.Unmarshal(svc.Service, &server); err != nil { - return nil + return nil, err } var ips []net.IP @@ -155,5 +160,5 @@ func ipsFromService(svc *happydns.ServiceMessage) []net.IP { if server.AAAA != nil && len(server.AAAA.AAAA) > 0 { ips = append(ips, server.AAAA.AAAA) } - return ips + return ips, nil } diff --git a/checker/collect_test.go b/checker/collect_test.go new file mode 100644 index 0000000..6a33bc5 --- /dev/null +++ b/checker/collect_test.go @@ -0,0 +1,121 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. +// +// This program is offered under a commercial and under the AGPL license. +// For commercial licensing, contact us at . +// +// For AGPL licensing: +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package checker + +import ( + "encoding/json" + "net" + "strings" + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" + happydns "git.happydns.org/happyDomain/model" + "git.happydns.org/happyDomain/services/abstract" + "github.com/miekg/dns" +) + +func TestResolveAddressesAddressesSlice(t *testing.T) { + cases := []sdk.CheckerOptions{ + {"addresses": []string{"1.1.1.1", "2.2.2.2"}}, + {"addresses": []any{"1.1.1.1", "2.2.2.2"}}, + {"addresses": []any{"1.1.1.1", "", "2.2.2.2"}}, // empties dropped + } + for i, opts := range cases { + got, err := resolveAddresses(opts) + if err != nil { + t.Fatalf("[%d] err: %v", i, err) + } + if len(got) != 2 || got[0] != "1.1.1.1" || got[1] != "2.2.2.2" { + t.Errorf("[%d] got %v", i, got) + } + } +} + +func TestResolveAddressesSingle(t *testing.T) { + got, err := resolveAddresses(sdk.CheckerOptions{"address": "8.8.8.8"}) + if err != nil { + t.Fatal(err) + } + if len(got) != 1 || got[0] != "8.8.8.8" { + t.Errorf("got %v", got) + } +} + +func TestResolveAddressesMissing(t *testing.T) { + if _, err := resolveAddresses(sdk.CheckerOptions{}); err == nil { + t.Error("expected error for missing addresses") + } +} + +func TestResolveAddressesEmptyStringIgnored(t *testing.T) { + if _, err := resolveAddresses(sdk.CheckerOptions{"address": ""}); err == nil { + t.Error("expected error when address is empty string") + } +} + +func TestResolveAddressesWrongServiceType(t *testing.T) { + svc := happydns.ServiceMessage{ + ServiceMeta: happydns.ServiceMeta{Type: "abstract.NotAServer"}, + Service: json.RawMessage(`{}`), + } + _, err := resolveAddresses(sdk.CheckerOptions{"service": svc}) + if err == nil || !strings.Contains(err.Error(), "expected abstract.Server") { + t.Errorf("got err=%v", err) + } +} + +func TestIpsFromService(t *testing.T) { + srv := abstract.Server{ + A: &dns.A{A: net.ParseIP("192.0.2.1").To4()}, + AAAA: &dns.AAAA{AAAA: net.ParseIP("2001:db8::1")}, + } + raw, err := json.Marshal(srv) + if err != nil { + t.Fatal(err) + } + msg := &happydns.ServiceMessage{Service: raw} + ips, err := ipsFromService(msg) + if err != nil { + t.Fatalf("err: %v", err) + } + if len(ips) != 2 { + t.Fatalf("got %d ips, want 2: %v", len(ips), ips) + } +} + +func TestIpsFromServiceMalformed(t *testing.T) { + msg := &happydns.ServiceMessage{Service: json.RawMessage(`{not json`)} + if _, err := ipsFromService(msg); err == nil { + t.Error("expected error on malformed payload") + } +} + +func TestIpsFromServiceEmpty(t *testing.T) { + msg := &happydns.ServiceMessage{Service: json.RawMessage(`{}`)} + ips, err := ipsFromService(msg) + if err != nil { + t.Fatalf("err: %v", err) + } + if len(ips) != 0 { + t.Errorf("expected 0 ips, got %v", ips) + } +} diff --git a/checker/provider.go b/checker/provider.go index 6488fe8..15c8bc3 100644 --- a/checker/provider.go +++ b/checker/provider.go @@ -23,6 +23,7 @@ package checker import ( "encoding/json" + "fmt" "time" happydns "git.happydns.org/checker-sdk-go/checker" @@ -51,7 +52,7 @@ func (p *pingProvider) Key() happydns.ObservationKey { func (p *pingProvider) ExtractMetrics(ctx happydns.ReportContext, collectedAt time.Time) ([]happydns.CheckMetric, error) { var data PingData if err := json.Unmarshal(ctx.Data(), &data); err != nil { - return nil, err + return nil, fmt.Errorf("decode ping data: %w", err) } metrics := Metrics(&data, collectedAt) diff --git a/checker/rule.go b/checker/rule.go index cc69219..70483af 100644 --- a/checker/rule.go +++ b/checker/rule.go @@ -42,11 +42,20 @@ func Rules() []sdk.CheckRule { } } -// Rule returns the primary rule (reachability) for backward compatibility -// with callers that expect a single rule; prefer Rules() which returns the -// full rule set. -func Rule() sdk.CheckRule { - return &reachabilityRule{} +// validateThresholdPair checks that warn and crit are within [min, max] and +// that crit is strictly greater than warn. The names are used in error +// messages so callers get diagnostics naming their actual options. +func validateThresholdPair(warnName, critName string, warn, crit, min, max float64) error { + if warn < min || warn > max { + return fmt.Errorf("%s must be between %v and %v", warnName, min, max) + } + if crit < min || crit > max { + return fmt.Errorf("%s must be between %v and %v", critName, min, max) + } + if crit <= warn { + return fmt.Errorf("%s (%v) must be greater than %s (%v)", critName, crit, warnName, warn) + } + return nil } // loadPingData fetches the ping observation. On error, returns a CheckState diff --git a/checker/rule_test.go b/checker/rule_test.go new file mode 100644 index 0000000..fbc77dd --- /dev/null +++ b/checker/rule_test.go @@ -0,0 +1,113 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. +// +// This program is offered under a commercial and under the AGPL license. +// For commercial licensing, contact us at . +// +// For AGPL licensing: +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package checker + +import ( + "context" + "encoding/json" + "errors" + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +// stubObs implements sdk.ObservationGetter for tests. If err is non-nil, Get +// returns it; otherwise it JSON-roundtrips data into dest so callers see the +// same shape they would get over HTTP. +type stubObs struct { + data any + err error +} + +func (s stubObs) Get(_ context.Context, _ sdk.ObservationKey, dest any) error { + if s.err != nil { + return s.err + } + raw, err := json.Marshal(s.data) + if err != nil { + return err + } + return json.Unmarshal(raw, dest) +} + +func (s stubObs) GetRelated(_ context.Context, _ sdk.ObservationKey) ([]sdk.RelatedObservation, error) { + return nil, nil +} + +func obsWith(targets ...PingTargetResult) stubObs { + return stubObs{data: PingData{Targets: targets}} +} + +func TestIsIPv6(t *testing.T) { + cases := []struct { + addr string + want bool + }{ + {"::1", true}, + {"2001:db8::1", true}, + {"127.0.0.1", false}, + {"::ffff:192.0.2.1", false}, // IPv4-mapped is treated as IPv4 + {"example.com", false}, + {"", false}, + {"not-an-ip", false}, + } + for _, c := range cases { + if got := isIPv6(c.addr); got != c.want { + t.Errorf("isIPv6(%q) = %v, want %v", c.addr, got, c.want) + } + } +} + +func TestLoadPingDataError(t *testing.T) { + _, st := loadPingData(context.Background(), stubObs{err: errors.New("boom")}) + if st == nil { + t.Fatal("expected error CheckState, got nil") + } + if st.Status != sdk.StatusError { + t.Errorf("status = %v, want StatusError", st.Status) + } + if st.Code != "ping.observation_error" { + t.Errorf("code = %q, want ping.observation_error", st.Code) + } +} + +func TestLoadPingDataOK(t *testing.T) { + d, st := loadPingData(context.Background(), obsWith(PingTargetResult{Address: "1.1.1.1"})) + if st != nil { + t.Fatalf("unexpected error state: %+v", st) + } + if len(d.Targets) != 1 || d.Targets[0].Address != "1.1.1.1" { + t.Errorf("unexpected data: %+v", d) + } +} + +func TestRulesContainsAll(t *testing.T) { + names := map[string]bool{} + for _, r := range Rules() { + names[r.Name()] = true + } + for _, want := range []string{"ping.reachable", "ping.packet_loss", "ping.rtt", "ping.ipv6_reachable"} { + if !names[want] { + t.Errorf("Rules() missing %q", want) + } + } +} diff --git a/checker/rules_ipv6.go b/checker/rules_ipv6.go index 9373d01..f458bf4 100644 --- a/checker/rules_ipv6.go +++ b/checker/rules_ipv6.go @@ -45,7 +45,11 @@ func (r *ipv6ReachabilityRule) Evaluate(ctx context.Context, obs sdk.Observation var ipv6Total, ipv6Reachable int for _, t := range data.Targets { - if !isIPv6(t.Address) { + probed := t.ResolvedIP + if probed == "" { + probed = t.Address + } + if !isIPv6(probed) { continue } ipv6Total++ diff --git a/checker/rules_ipv6_test.go b/checker/rules_ipv6_test.go new file mode 100644 index 0000000..927d3ea --- /dev/null +++ b/checker/rules_ipv6_test.go @@ -0,0 +1,80 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. +// +// This program is offered under a commercial and under the AGPL license. +// For commercial licensing, contact us at . +// +// For AGPL licensing: +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package checker + +import ( + "context" + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func TestIPv6ReachabilityEvaluate(t *testing.T) { + r := &ipv6ReachabilityRule{} + ctx := context.Background() + + cases := []struct { + name string + targets []PingTargetResult + wantStat sdk.Status + wantCode string + }{ + { + name: "no v6 targets", + targets: []PingTargetResult{{Address: "1.1.1.1", Sent: 5, Received: 5}}, + wantStat: sdk.StatusUnknown, + wantCode: "ping.ipv6_reachable.skipped", + }, + { + name: "v6 reachable", + targets: []PingTargetResult{ + {Address: "1.1.1.1", Sent: 5, Received: 5}, + {Address: "2001:db8::1", Sent: 5, Received: 5}, + }, + wantStat: sdk.StatusOK, + wantCode: "ping.ipv6_reachable.ok", + }, + { + name: "all v6 unreachable", + targets: []PingTargetResult{ + {Address: "2001:db8::1", Sent: 5, Received: 0}, + {Address: "2001:db8::2", Sent: 5, Received: 0}, + }, + wantStat: sdk.StatusWarn, + wantCode: "ping.ipv6_reachable.unreachable", + }, + } + for _, c := range cases { + t.Run(c.name, func(t *testing.T) { + states := r.Evaluate(ctx, obsWith(c.targets...), sdk.CheckerOptions{}) + if len(states) != 1 { + t.Fatalf("got %d states, want 1", len(states)) + } + if states[0].Status != c.wantStat { + t.Errorf("status = %v, want %v", states[0].Status, c.wantStat) + } + if states[0].Code != c.wantCode { + t.Errorf("code = %q, want %q", states[0].Code, c.wantCode) + } + }) + } +} diff --git a/checker/rules_loss.go b/checker/rules_loss.go index 869cd94..34134d1 100644 --- a/checker/rules_loss.go +++ b/checker/rules_loss.go @@ -40,16 +40,7 @@ func (r *packetLossRule) Description() string { func (r *packetLossRule) ValidateOptions(opts sdk.CheckerOptions) error { warn := sdk.GetFloatOption(opts, "warningPacketLoss", 10) crit := sdk.GetFloatOption(opts, "criticalPacketLoss", 50) - if warn < 0 || warn > 100 { - return fmt.Errorf("warningPacketLoss must be between 0 and 100") - } - if crit < 0 || crit > 100 { - return fmt.Errorf("criticalPacketLoss must be between 0 and 100") - } - if crit <= warn { - return fmt.Errorf("criticalPacketLoss (%v) must be greater than warningPacketLoss (%v)", crit, warn) - } - return nil + return validateThresholdPair("warningPacketLoss", "criticalPacketLoss", warn, crit, 0, 100) } func (r *packetLossRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, opts sdk.CheckerOptions) []sdk.CheckState { diff --git a/checker/rules_loss_test.go b/checker/rules_loss_test.go new file mode 100644 index 0000000..07256fe --- /dev/null +++ b/checker/rules_loss_test.go @@ -0,0 +1,83 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. +// +// This program is offered under a commercial and under the AGPL license. +// For commercial licensing, contact us at . +// +// For AGPL licensing: +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package checker + +import ( + "context" + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func TestPacketLossValidateOptions(t *testing.T) { + r := &packetLossRule{} + cases := []struct { + name string + opts sdk.CheckerOptions + wantErr bool + }{ + {"defaults", sdk.CheckerOptions{}, false}, + {"valid", sdk.CheckerOptions{"warningPacketLoss": 5.0, "criticalPacketLoss": 25.0}, false}, + {"warn negative", sdk.CheckerOptions{"warningPacketLoss": -1.0, "criticalPacketLoss": 50.0}, true}, + {"crit over 100", sdk.CheckerOptions{"warningPacketLoss": 10.0, "criticalPacketLoss": 150.0}, true}, + {"crit equal warn", sdk.CheckerOptions{"warningPacketLoss": 20.0, "criticalPacketLoss": 20.0}, true}, + {"crit below warn", sdk.CheckerOptions{"warningPacketLoss": 30.0, "criticalPacketLoss": 10.0}, true}, + } + for _, c := range cases { + t.Run(c.name, func(t *testing.T) { + err := r.ValidateOptions(c.opts) + if (err != nil) != c.wantErr { + t.Errorf("err=%v, wantErr=%v", err, c.wantErr) + } + }) + } +} + +func TestPacketLossEvaluate(t *testing.T) { + r := &packetLossRule{} + ctx := context.Background() + opts := sdk.CheckerOptions{"warningPacketLoss": 10.0, "criticalPacketLoss": 50.0} + + states := r.Evaluate(ctx, obsWith( + PingTargetResult{Address: "ok", PacketLoss: 0, Sent: 5, Received: 5}, + PingTargetResult{Address: "warn", PacketLoss: 20, Sent: 5, Received: 4}, + PingTargetResult{Address: "crit", PacketLoss: 80, Sent: 5, Received: 1}, + ), opts) + + if len(states) != 3 { + t.Fatalf("got %d states, want 3", len(states)) + } + want := []sdk.Status{sdk.StatusOK, sdk.StatusWarn, sdk.StatusCrit} + for i, s := range states { + if s.Status != want[i] { + t.Errorf("state[%d] status = %v, want %v", i, s.Status, want[i]) + } + } +} + +func TestPacketLossEvaluateNoTargets(t *testing.T) { + r := &packetLossRule{} + states := r.Evaluate(context.Background(), obsWith(), sdk.CheckerOptions{}) + if len(states) != 1 || states[0].Status != sdk.StatusUnknown { + t.Errorf("expected single Unknown state, got %+v", states) + } +} diff --git a/checker/rules_reachability_test.go b/checker/rules_reachability_test.go new file mode 100644 index 0000000..7690a96 --- /dev/null +++ b/checker/rules_reachability_test.go @@ -0,0 +1,55 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. +// +// This program is offered under a commercial and under the AGPL license. +// For commercial licensing, contact us at . +// +// For AGPL licensing: +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package checker + +import ( + "context" + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func TestReachabilityEvaluate(t *testing.T) { + r := &reachabilityRule{} + states := r.Evaluate(context.Background(), obsWith( + PingTargetResult{Address: "up", Sent: 5, Received: 5}, + PingTargetResult{Address: "down", Sent: 5, Received: 0}, + ), sdk.CheckerOptions{}) + + if len(states) != 2 { + t.Fatalf("got %d states, want 2", len(states)) + } + if states[0].Status != sdk.StatusOK || states[0].Code != "ping.reachable.ok" { + t.Errorf("up: %+v", states[0]) + } + if states[1].Status != sdk.StatusCrit || states[1].Code != "ping.reachable.unreachable" { + t.Errorf("down: %+v", states[1]) + } +} + +func TestReachabilityNoTargets(t *testing.T) { + r := &reachabilityRule{} + states := r.Evaluate(context.Background(), obsWith(), sdk.CheckerOptions{}) + if len(states) != 1 || states[0].Status != sdk.StatusUnknown { + t.Errorf("expected single Unknown state, got %+v", states) + } +} diff --git a/checker/rules_rtt.go b/checker/rules_rtt.go index 2b64110..a6be757 100644 --- a/checker/rules_rtt.go +++ b/checker/rules_rtt.go @@ -44,9 +44,6 @@ func (r *rttRule) ValidateOptions(opts sdk.CheckerOptions) error { if warn <= 0 { return fmt.Errorf("warningRTT must be positive") } - if crit <= 0 { - return fmt.Errorf("criticalRTT must be positive") - } if crit <= warn { return fmt.Errorf("criticalRTT (%v) must be greater than warningRTT (%v)", crit, warn) } diff --git a/checker/rules_rtt_test.go b/checker/rules_rtt_test.go new file mode 100644 index 0000000..62f4f95 --- /dev/null +++ b/checker/rules_rtt_test.go @@ -0,0 +1,79 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. +// +// This program is offered under a commercial and under the AGPL license. +// For commercial licensing, contact us at . +// +// For AGPL licensing: +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package checker + +import ( + "context" + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func TestRTTValidateOptions(t *testing.T) { + r := &rttRule{} + cases := []struct { + name string + opts sdk.CheckerOptions + wantErr bool + }{ + {"defaults", sdk.CheckerOptions{}, false}, + {"valid", sdk.CheckerOptions{"warningRTT": 50.0, "criticalRTT": 200.0}, false}, + {"warn zero", sdk.CheckerOptions{"warningRTT": 0.0, "criticalRTT": 100.0}, true}, + {"crit negative", sdk.CheckerOptions{"warningRTT": 50.0, "criticalRTT": -1.0}, true}, + {"crit equal warn", sdk.CheckerOptions{"warningRTT": 100.0, "criticalRTT": 100.0}, true}, + } + for _, c := range cases { + t.Run(c.name, func(t *testing.T) { + err := r.ValidateOptions(c.opts) + if (err != nil) != c.wantErr { + t.Errorf("err=%v, wantErr=%v", err, c.wantErr) + } + }) + } +} + +func TestRTTEvaluate(t *testing.T) { + r := &rttRule{} + ctx := context.Background() + opts := sdk.CheckerOptions{"warningRTT": 100.0, "criticalRTT": 500.0} + + states := r.Evaluate(ctx, obsWith( + PingTargetResult{Address: "ok", RTTAvg: 50, Sent: 5, Received: 5}, + PingTargetResult{Address: "warn", RTTAvg: 200, Sent: 5, Received: 5}, + PingTargetResult{Address: "crit", RTTAvg: 600, Sent: 5, Received: 5}, + PingTargetResult{Address: "dead", RTTAvg: 0, Sent: 5, Received: 0}, + ), opts) + + if len(states) != 4 { + t.Fatalf("got %d states, want 4", len(states)) + } + want := []sdk.Status{sdk.StatusOK, sdk.StatusWarn, sdk.StatusCrit, sdk.StatusUnknown} + wantCode := []string{"ping.rtt.ok", "ping.rtt.warning", "ping.rtt.critical", "ping.rtt.no_replies"} + for i, s := range states { + if s.Status != want[i] { + t.Errorf("state[%d] status = %v, want %v", i, s.Status, want[i]) + } + if s.Code != wantCode[i] { + t.Errorf("state[%d] code = %q, want %q", i, s.Code, wantCode[i]) + } + } +} diff --git a/checker/types.go b/checker/types.go index a641976..c389d7c 100644 --- a/checker/types.go +++ b/checker/types.go @@ -29,9 +29,15 @@ type PingData struct { Targets []PingTargetResult `json:"targets"` } -// PingTargetResult contains the ping statistics for a single IP address. +// PingTargetResult contains the ping statistics for a single target. +// +// Address is the user-supplied label (hostname or IP). ResolvedIP is the +// IP that was actually probed; rules that need to reason about address +// family (e.g. IPv6 reachability) must consult ResolvedIP because Address +// can be a hostname. type PingTargetResult struct { Address string `json:"address"` + ResolvedIP string `json:"resolved_ip,omitempty"` RTTMin float64 `json:"rtt_min"` RTTAvg float64 `json:"rtt_avg"` RTTMax float64 `json:"rtt_max"` diff --git a/go.mod b/go.mod index f7e14e2..650e3e3 100644 --- a/go.mod +++ b/go.mod @@ -5,6 +5,7 @@ go 1.25.0 require ( git.happydns.org/checker-sdk-go v1.3.0 git.happydns.org/happyDomain v0.7.0 + github.com/miekg/dns v1.1.72 github.com/prometheus-community/pro-bing v0.8.0 ) @@ -26,7 +27,6 @@ require ( github.com/klauspost/cpuid/v2 v2.3.0 // indirect github.com/leodido/go-urn v1.4.0 // indirect github.com/mattn/go-isatty v0.0.20 // indirect - github.com/miekg/dns v1.1.72 // indirect github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect github.com/modern-go/reflect2 v1.0.2 // indirect github.com/pelletier/go-toml/v2 v2.2.4 // indirect diff --git a/plugin/plugin.go b/plugin/plugin.go index 194a32c..fbd8519 100644 --- a/plugin/plugin.go +++ b/plugin/plugin.go @@ -1,3 +1,24 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. +// +// This program is offered under a commercial and under the AGPL license. +// For commercial licensing, contact us at . +// +// For AGPL licensing: +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + // Command plugin is the happyDomain plugin entrypoint for the ping checker. // // It is built as a Go plugin (`go build -buildmode=plugin`) and loaded at