commit 542ebdea3488a7445dec12cc4c9ebb523de73f46 Author: Pierre-Olivier Mercier Date: Mon Apr 27 01:31:20 2026 +0700 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..720da2a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +checker-http +checker-http.so diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..01e1543 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,17 @@ +FROM golang:1.25-alpine AS builder + +ARG CHECKER_VERSION=custom-build + +WORKDIR /src +COPY go.mod go.sum ./ +RUN go mod download +COPY . . +RUN CGO_ENABLED=0 go build -tags standalone -ldflags "-X main.Version=${CHECKER_VERSION}" -o /checker-http . + +FROM scratch +COPY --from=builder /checker-http /checker-http +USER 65534:65534 +EXPOSE 8080 +HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \ + CMD ["/checker-http", "-healthcheck"] +ENTRYPOINT ["/checker-http"] 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/Makefile b/Makefile new file mode 100644 index 0000000..d5b361e --- /dev/null +++ b/Makefile @@ -0,0 +1,28 @@ +CHECKER_NAME := checker-http +CHECKER_IMAGE := happydomain/$(CHECKER_NAME) +CHECKER_VERSION ?= custom-build + +CHECKER_SOURCES := main.go $(wildcard checker/*.go) + +GO_LDFLAGS := -X main.Version=$(CHECKER_VERSION) + +.PHONY: all plugin docker test clean + +all: $(CHECKER_NAME) + +$(CHECKER_NAME): $(CHECKER_SOURCES) + go build -tags standalone -ldflags "$(GO_LDFLAGS)" -o $@ . + +plugin: $(CHECKER_NAME).so + +$(CHECKER_NAME).so: $(CHECKER_SOURCES) $(wildcard plugin/*.go) + go build -buildmode=plugin -ldflags "$(GO_LDFLAGS)" -o $@ ./plugin/ + +docker: + docker build --build-arg CHECKER_VERSION=$(CHECKER_VERSION) -t $(CHECKER_IMAGE) . + +test: + go test -tags standalone ./... + +clean: + rm -f $(CHECKER_NAME) $(CHECKER_NAME).so diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..555e852 --- /dev/null +++ b/NOTICE @@ -0,0 +1,24 @@ +checker-http +Copyright (c) 2020-2026 happyDomain +Authors: Pierre-Olivier Mercier, et al. + +This product is currently licensed under the GNU Affero General Public +License v3.0 (see LICENSE), because it imports types from the happyDomain +server module which is itself licensed under AGPL-3.0. + +A relicensing to the MIT License is planned once that dependency has been +removed. See README.md for the licensing roadmap. + +------------------------------------------------------------------------------- +Third-party notices +------------------------------------------------------------------------------- + +This product includes software developed as part of the checker-sdk-go +project (https://git.happydns.org/happyDomain/checker-sdk-go), licensed +under the Apache License, Version 2.0: + + checker-sdk-go + Copyright 2020-2026 The happyDomain Authors + +You may obtain a copy of the Apache License 2.0 at: + http://www.apache.org/licenses/LICENSE-2.0 diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc5736a --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +# checker-http + +HTTP/HTTPS server checker plugin for [happyDomain](https://happydomain.org). + +Probes the `abstract.Server` it is attached to over HTTP (port 80) and HTTPS +(port 443) and evaluates a battery of independent rules on the response. + +Deep TLS / certificate analysis is intentionally **delegated to +[checker-tls](https://git.happydns.org/checker-tls)** - this checker only +relies on TLS for transport. + +## What it checks + +| Rule | What it verifies | +| --------------------------------- | --------------------------------------------------------------------------------- | +| `http.tcp_reachable` | Port 80 accepts connections on every A/AAAA address. | +| `https.tcp_reachable` | Port 443 accepts connections on every A/AAAA address. | +| `http.https_redirect` | Plain HTTP redirects to HTTPS (warning if not). | +| `http.hsts` | `Strict-Transport-Security` is present with a sufficient `max-age`. | +| `http.csp` | `Content-Security-Policy` is set; flags `'unsafe-inline'` / `'unsafe-eval'`. | +| `http.x_frame_options` | `X-Frame-Options` or CSP `frame-ancestors` provides clickjacking protection. | +| `http.x_content_type_options` | `X-Content-Type-Options: nosniff` is set. | +| `http.x_xss_protection` | Reports the legacy `X-XSS-Protection` header (recommendation: disable). | +| `http.cookie_flags` | Every Set-Cookie has `Secure`, `HttpOnly`, and a `SameSite` attribute. | +| `http.sri` | Cross-origin ` + + + +` + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { + w.Header().Set("Content-Type", "text/html; charset=utf-8") + _, _ = io.WriteString(w, html) + })) + defer srv.Close() + + ip, port := splitHostPort(t, srv.URL) + probe := runProbe(context.Background(), ip, ip, "http", port, 5*time.Second, 0, "ua", true) + if probe.Error != "" { + t.Fatalf("error: %q", probe.Error) + } + if len(probe.Resources) != 3 { + // Expect: cdn script, local script, cdn stylesheet. The icon link is ignored (rel=icon). + t.Fatalf("got %d resources, want 3: %+v", len(probe.Resources), probe.Resources) + } + var cdnScript, localScript, stylesheet bool + for _, r := range probe.Resources { + switch r.URL { + case "https://cdn.example/lib.js": + cdnScript = true + if !r.CrossOrigin || r.Integrity != "sha384-abc" { + t.Errorf("cdn script: %+v", r) + } + case "/local.js": + localScript = true + if r.CrossOrigin { + t.Errorf("local script flagged as cross-origin") + } + case "https://cdn.example/style.css": + stylesheet = true + if !r.CrossOrigin || r.Integrity != "" { + t.Errorf("stylesheet: %+v", r) + } + } + } + if !cdnScript || !localScript || !stylesheet { + t.Errorf("missing expected resources: cdnScript=%v local=%v stylesheet=%v", cdnScript, localScript, stylesheet) + } +} + +func TestRunProbe_NonHTMLContentTypeSkipsExtraction(t *testing.T) { + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { + w.Header().Set("Content-Type", "application/json") + _, _ = io.WriteString(w, ``) + })) + defer srv.Close() + + ip, port := splitHostPort(t, srv.URL) + probe := runProbe(context.Background(), ip, ip, "http", port, 5*time.Second, 0, "ua", true) + if len(probe.Resources) != 0 { + t.Errorf("non-HTML content-type should skip parsing, got %+v", probe.Resources) + } +} + +func TestRunProbe_ContextCancelled(t *testing.T) { + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + <-r.Context().Done() + })) + defer srv.Close() + + ip, port := splitHostPort(t, srv.URL) + ctx, cancel := context.WithCancel(context.Background()) + cancel() + probe := runProbe(ctx, ip, ip, "http", port, 5*time.Second, 0, "ua", false) + if probe.Error == "" { + t.Errorf("expected error when context is already cancelled, got probe=%+v", probe) + } +} + +func TestIsHTMLContent(t *testing.T) { + yes := []string{"text/html", "TEXT/HTML; charset=utf-8", "application/xhtml+xml"} + no := []string{"", "application/json", "text/plain", "image/png"} + for _, ct := range yes { + if !isHTMLContent(ct) { + t.Errorf("isHTMLContent(%q) = false, want true", ct) + } + } + for _, ct := range no { + if isHTMLContent(ct) { + t.Errorf("isHTMLContent(%q) = true, want false", ct) + } + } +} + +func TestRelIsAsset(t *testing.T) { + yes := []string{"stylesheet", "preload", "modulepreload", "STYLESHEET", "preload stylesheet"} + no := []string{"", "icon", "alternate", "canonical"} + for _, r := range yes { + if !relIsAsset(r) { + t.Errorf("relIsAsset(%q) = false, want true", r) + } + } + for _, r := range no { + if relIsAsset(r) { + t.Errorf("relIsAsset(%q) = true, want false", r) + } + } +} + +func TestExtractResources_EmptyAndMalformed(t *testing.T) { + // The HTML parser is forgiving: even garbage produces no resources rather than panicking. + if got := extractResources([]byte(""), "h"); got != nil { + t.Errorf("empty body: got %+v, want nil", got) + } + if got := extractResources([]byte("<<>>"), "h"); got != nil { + t.Errorf("garbage: got %+v, want nil", got) + } +} + +func TestExtractResources_SkipsScriptWithoutSrc(t *testing.T) { + body := `` + if got := extractResources([]byte(body), "h"); len(got) != 0 { + t.Errorf("inline/empty-src scripts should not produce resources: %+v", got) + } +} + +func TestAttrCaseInsensitive(t *testing.T) { + doc, err := html.Parse(strings.NewReader(``)) + if err != nil { + t.Fatal(err) + } + var found *html.Node + var walk func(*html.Node) + walk = func(n *html.Node) { + if n.Type == html.ElementNode && n.Data == "a" { + found = n + return + } + for c := n.FirstChild; c != nil; c = c.NextSibling { + walk(c) + } + } + walk(doc) + if found == nil { + t.Fatal("anchor not found") + } + if v, ok := attr(found, "href"); !ok || v != "x" { + t.Errorf("href: got (%q,%v)", v, ok) + } + if v, ok := attr(found, "INTEGRITY"); !ok || v != "i" { + t.Errorf("INTEGRITY: got (%q,%v)", v, ok) + } + if _, ok := attr(found, "missing"); ok { + t.Errorf("missing attr should return ok=false") + } +} diff --git a/checker/collector.go b/checker/collector.go new file mode 100644 index 0000000..a10cf20 --- /dev/null +++ b/checker/collector.go @@ -0,0 +1,36 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "time" +) + +// Target captures everything a Collector needs to probe one logical host. +// It is built once by the orchestrator from CheckerOptions and passed to +// every Collector, so individual collectors don't have to re-parse options +// or re-resolve IPs. +type Target struct { + Host string + IPs []string + Timeout time.Duration + MaxRedirects int + UserAgent string +} + +// Collector contributes a typed observation about a Target. Each collector +// owns one slice of the work (root probe, well-known endpoints, CORS +// preflight, etc.) and writes its result under Key() in the final +// payload's Extensions map. +// +// The current orchestrator wires only the root collector and writes its +// result directly under ObservationKeyHTTP for backward compatibility. +// Additional collectors are introduced in step 4; they will populate +// HTTPData.Extensions[Key()] without disturbing existing rules. +type Collector interface { + Key() string + Collect(ctx context.Context, t Target) (any, error) +} diff --git a/checker/collector_root.go b/checker/collector_root.go new file mode 100644 index 0000000..17d0222 --- /dev/null +++ b/checker/collector_root.go @@ -0,0 +1,73 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "log" + "sync" + "time" +) + +// rootCollector probes the target host on HTTP/80 and HTTPS/443 for every +// known IP, captures headers/cookies/redirects on each, and parses the +// HTML body of the first successful HTTPS probe (so SRI-style rules have +// something to evaluate). This is the original behaviour of Collect() +// before the Collector interface was introduced. +type rootCollector struct{} + +func (rootCollector) Key() string { return ObservationKeyHTTP } + +func (rootCollector) Collect(ctx context.Context, t Target) (any, error) { + data := &HTTPData{ + Domain: t.Host, + CollectedAt: time.Now(), + } + + type job struct { + scheme string + port uint16 + ip string + // parseHTML controls whether the HTML body is parsed and its + // references kept on the probe. Only the first HTTPS probe gets + // it, to keep payload size bounded. + parseHTML bool + } + + var jobs []job + htmlPicked := false + for _, ip := range t.IPs { + jobs = append(jobs, job{scheme: "http", port: DefaultHTTPPort, ip: ip}) + j := job{scheme: "https", port: DefaultHTTPSPort, ip: ip} + if !htmlPicked { + j.parseHTML = true + htmlPicked = true + } + jobs = append(jobs, j) + } + + var mu sync.Mutex + var wg sync.WaitGroup + sem := make(chan struct{}, MaxConcurrentProbes) + for _, j := range jobs { + wg.Add(1) + sem <- struct{}{} + go func(j job) { + defer wg.Done() + defer func() { <-sem }() + probe := runProbe(ctx, t.Host, j.ip, j.scheme, j.port, t.Timeout, t.MaxRedirects, t.UserAgent, j.parseHTML) + if verboseLogging { + log.Printf("checker-http: %s ip=%s status=%d redirects=%d err=%q", + j.scheme, j.ip, probe.StatusCode, len(probe.RedirectChain), probe.Error) + } + mu.Lock() + data.Probes = append(data.Probes, probe) + mu.Unlock() + }(j) + } + wg.Wait() + + return data, nil +} diff --git a/checker/collector_wellknown.go b/checker/collector_wellknown.go new file mode 100644 index 0000000..4ac5349 --- /dev/null +++ b/checker/collector_wellknown.go @@ -0,0 +1,99 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "crypto/tls" + "fmt" + "io" + "net" + "net/http" + "net/url" +) + +// ObservationKeyWellKnown is the Extensions[] key under which +// wellknownCollector publishes its observation. +const ObservationKeyWellKnown = "wellknown" + +// WellKnownData captures whether each well-known URI returned a usable +// document. It is intentionally narrow: per-URI presence and HTTP status +// are enough for the current rule set; deeper parsing (e.g. PGP-signed +// security.txt fields) is left to dedicated collectors when the need +// arises. +type WellKnownData struct { + URIs map[string]WellKnownProbe `json:"uris"` +} + +// WellKnownProbe is a single (URI → outcome) entry. +type WellKnownProbe struct { + URL string `json:"url"` + StatusCode int `json:"status_code,omitempty"` + Bytes int `json:"bytes,omitempty"` + Error string `json:"error,omitempty"` +} + +// wellknownCollector probes a small, fixed set of standardised URIs +// served at the apex of the host. Today it covers: +// +// - /.well-known/security.txt (RFC 9116) — security disclosure contact +// - /robots.txt (RFC 9309) — crawler directives +// +// It uses the first IP only because these documents are expected to be +// host-uniform: there is nothing to learn from probing every backend. +type wellknownCollector struct{} + +func (wellknownCollector) Key() string { return ObservationKeyWellKnown } + +func (wellknownCollector) Collect(ctx context.Context, t Target) (any, error) { + if len(t.IPs) == 0 { + return nil, fmt.Errorf("no IPs to probe") + } + addr := net.JoinHostPort(t.IPs[0], "443") + dialer := &net.Dialer{Timeout: t.Timeout} + transport := &http.Transport{ + DialContext: func(ctx context.Context, network, _ string) (net.Conn, error) { + return dialer.DialContext(ctx, network, addr) + }, + TLSClientConfig: &tls.Config{ServerName: t.Host}, + TLSHandshakeTimeout: t.Timeout, + ResponseHeaderTimeout: t.Timeout, + DisableKeepAlives: true, + } + defer transport.CloseIdleConnections() + client := &http.Client{Transport: transport} + + uris := []string{"/.well-known/security.txt", "/robots.txt"} + out := WellKnownData{URIs: make(map[string]WellKnownProbe, len(uris))} + for _, path := range uris { + out.URIs[path] = fetchOne(ctx, client, t.Host, path, t.UserAgent) + } + return &out, nil +} + +func fetchOne(ctx context.Context, client *http.Client, host, path, ua string) WellKnownProbe { + u := (&url.URL{Scheme: "https", Host: host, Path: path}).String() + probe := WellKnownProbe{URL: u} + req, err := http.NewRequestWithContext(ctx, http.MethodGet, u, nil) + if err != nil { + probe.Error = err.Error() + return probe + } + req.Header.Set("User-Agent", ua) + resp, err := client.Do(req) + if err != nil { + probe.Error = err.Error() + return probe + } + defer resp.Body.Close() + probe.StatusCode = resp.StatusCode + // Cap the read so a misconfigured server can't pull megabytes for a + // "did this exist?" probe. + body, _ := io.ReadAll(io.LimitReader(resp.Body, 64<<10)) + probe.Bytes = len(body) + return probe +} + +func init() { RegisterCollector(wellknownCollector{}) } diff --git a/checker/definition.go b/checker/definition.go new file mode 100644 index 0000000..74b1a3f --- /dev/null +++ b/checker/definition.go @@ -0,0 +1,94 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "time" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +// Version is overridden at link time via -ldflags. +var Version = "built-in" + +func (p *httpProvider) Definition() *sdk.CheckerDefinition { + return &sdk.CheckerDefinition{ + ID: "http", + Name: "HTTP / HTTPS", + Version: Version, + Availability: sdk.CheckerAvailability{ + ApplyToService: true, + LimitToServices: []string{"abstract.Server"}, + }, + ObservationKeys: []sdk.ObservationKey{ObservationKeyHTTP}, + Options: sdk.CheckerOptionsDocumentation{ + UserOpts: []sdk.CheckerOptionDocumentation{ + { + Id: OptionProbeTimeoutMs, + Type: "number", + Label: "Per-request timeout (ms)", + Description: "Maximum time allowed for a single HTTP/HTTPS request.", + Default: float64(DefaultProbeTimeoutMs), + }, + { + Id: OptionMaxRedirects, + Type: "number", + Label: "Max redirects to follow", + Description: "Stop following redirects after this many hops.", + Default: float64(DefaultMaxRedirects), + }, + { + Id: OptionUserAgent, + Type: "string", + Label: "User-Agent", + Description: "User-Agent header sent with every request.", + Default: DefaultUserAgent, + }, + { + Id: OptionRequireHTTPS, + Type: "bool", + Label: "Require HTTPS", + Description: "Plain HTTP must redirect to HTTPS.", + Default: true, + }, + { + Id: OptionRequireHSTS, + Type: "bool", + Label: "Require HSTS", + Description: "HTTPS responses must include a Strict-Transport-Security header.", + Default: true, + }, + { + Id: OptionMinHSTSMaxAgeDays, + Type: "number", + Label: "Min HSTS max-age (days)", + Description: "Minimum acceptable max-age value (in days) for HSTS.", + Default: float64(DefaultMinHSTSMaxAge), + }, + { + Id: OptionRequireCSP, + Type: "bool", + Label: "Require Content-Security-Policy", + Description: "HTTPS responses must include a Content-Security-Policy header.", + Default: false, + }, + }, + ServiceOpts: []sdk.CheckerOptionDocumentation{ + { + Id: OptionService, + Label: "Service", + AutoFill: sdk.AutoFillService, + Hide: true, + }, + }, + }, + Rules: Rules(), + Interval: &sdk.CheckIntervalSpec{ + Min: 15 * time.Minute, + Max: 7 * 24 * time.Hour, + Default: 6 * time.Hour, + }, + } +} diff --git a/checker/header_rule.go b/checker/header_rule.go new file mode 100644 index 0000000..b57f5a7 --- /dev/null +++ b/checker/header_rule.go @@ -0,0 +1,111 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "strings" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +// HeaderRuleSpec declares a "presence + value validation" rule for one +// HTTP response header. It covers the most common shape of security +// header rule (one of Referrer-Policy, Permissions-Policy, COOP, COEP, +// CORP, X-Content-Type-Options, …) without forcing the author to write +// the load/iterate/build-state scaffolding. +// +// The DSL emits three CheckState codes derived from Code: +// - Code+".missing" when the header is absent +// - Code+".invalid" when Validate returns a non-OK status +// - Code+".ok" when Validate accepts the value +// +// Rules with richer semantics (HSTS quality thresholds, CSP directive +// inspection, cookie flag aggregation, legacy headers with reversed +// "absent is fine" semantics) keep implementing sdk.CheckRule directly. +type HeaderRuleSpec struct { + // Code is the rule's Name() and the prefix for every CheckState + // code it emits. + Code string + + // Description is returned by Description(). + Description string + + // Header is the response header to inspect. Lookups go through the + // lowercased map populated by the collector, so casing is flexible. + Header string + + // Required toggles the severity of an absent header: Warn when true, + // Info when false. + Required bool + + // Validate, when set, inspects the trimmed header value. Return + // (StatusOK, msg) to accept the value (emits ".ok" with msg) or any + // other status to flag it (emits ".invalid" with msg). When nil, + // presence alone is treated as OK with a generic message. + Validate func(value string) (sdk.Status, string) + + // FixHint, when set, is attached as Meta.fix on the ".missing" + // state. + FixHint string +} + +// HeaderRule constructs a self-contained sdk.CheckRule from a spec. +// Intended to be wired in init() via RegisterRule. +func HeaderRule(spec HeaderRuleSpec) sdk.CheckRule { + return &headerRule{spec: spec} +} + +type headerRule struct{ spec HeaderRuleSpec } + +func (r *headerRule) Name() string { return r.spec.Code } +func (r *headerRule) Description() string { return r.spec.Description } + +func (r *headerRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, _ sdk.CheckerOptions) []sdk.CheckState { + data, errSt := loadHTTPData(ctx, obs) + if errSt != nil { + return []sdk.CheckState{*errSt} + } + headerKey := strings.ToLower(r.spec.Header) + + return EvalPerHTTPS(data, r.spec.Code, func(p HTTPProbe) sdk.CheckState { + v := strings.TrimSpace(p.Headers[headerKey]) + if v == "" { + status := sdk.StatusWarn + if !r.spec.Required { + status = sdk.StatusInfo + } + st := sdk.CheckState{ + Status: status, + Code: r.spec.Code + ".missing", + Subject: p.Address, + Message: r.spec.Header + " is not set.", + } + if r.spec.FixHint != "" { + st.Meta = map[string]any{"fix": r.spec.FixHint} + } + return st + } + if r.spec.Validate == nil { + return sdk.CheckState{ + Status: sdk.StatusOK, + Code: r.spec.Code + ".ok", + Subject: p.Address, + Message: r.spec.Header + " is set.", + } + } + status, msg := r.spec.Validate(v) + suffix := ".invalid" + if status == sdk.StatusOK { + suffix = ".ok" + } + return sdk.CheckState{ + Status: status, + Code: r.spec.Code + suffix, + Subject: p.Address, + Message: msg, + } + }) +} diff --git a/checker/headers.go b/checker/headers.go new file mode 100644 index 0000000..92ca13d --- /dev/null +++ b/checker/headers.go @@ -0,0 +1,130 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "strconv" + "strings" +) + +// HSTSDirectives is the parsed form of a Strict-Transport-Security header +// (RFC 6797 §6.1). +type HSTSDirectives struct { + MaxAge int64 + IncludeSub bool + Preload bool +} + +// ParseHSTS pulls max-age, includeSubDomains and preload out of an HSTS +// value. Returns nil for an empty value so callers can distinguish "header +// absent" from "header present with max-age=0". +func ParseHSTS(v string) *HSTSDirectives { + v = strings.TrimSpace(v) + if v == "" { + return nil + } + h := &HSTSDirectives{} + for _, part := range strings.Split(v, ";") { + part = strings.TrimSpace(part) + switch { + case strings.HasPrefix(strings.ToLower(part), "max-age="): + val := strings.Trim(part[len("max-age="):], "\"") + if n, err := strconv.ParseInt(val, 10, 64); err == nil { + h.MaxAge = n + } + case strings.EqualFold(part, "includeSubDomains"): + h.IncludeSub = true + case strings.EqualFold(part, "preload"): + h.Preload = true + } + } + return h +} + +// CSPDirectives is the parsed form of a Content-Security-Policy header +// (W3C CSP3). Directive names are lowercased; source tokens keep their +// original casing because keywords like 'unsafe-inline' must round-trip +// verbatim when reported back to the user. +type CSPDirectives struct { + Raw string + Directives map[string][]string +} + +// ParseCSP splits a CSP header into its directive → sources map. +func ParseCSP(v string) *CSPDirectives { + v = strings.TrimSpace(v) + if v == "" { + return nil + } + c := &CSPDirectives{Raw: v, Directives: map[string][]string{}} + for _, d := range strings.Split(v, ";") { + d = strings.TrimSpace(d) + if d == "" { + continue + } + fields := strings.Fields(d) + name := strings.ToLower(fields[0]) + c.Directives[name] = fields[1:] + } + return c +} + +// HasDirective reports whether the named directive is declared at all. +func (c *CSPDirectives) HasDirective(name string) bool { + if c == nil { + return false + } + _, ok := c.Directives[strings.ToLower(name)] + return ok +} + +// HasSource reports whether the named directive lists the given source +// token (case-insensitive comparison; pass keywords with their quotes, +// e.g. "'unsafe-inline'"). +func (c *CSPDirectives) HasSource(directive, source string) bool { + if c == nil { + return false + } + for _, s := range c.Directives[strings.ToLower(directive)] { + if strings.EqualFold(s, source) { + return true + } + } + return false +} + +// HasUnsafe reports whether any directive uses 'unsafe-inline' or +// 'unsafe-eval' — the two keywords that nullify most of CSP's value. +func (c *CSPDirectives) HasUnsafe() bool { + if c == nil { + return false + } + for _, sources := range c.Directives { + for _, s := range sources { + ls := strings.ToLower(s) + if ls == "'unsafe-inline'" || ls == "'unsafe-eval'" { + return true + } + } + } + return false +} + +// ParsedHeaders bundles the structured headers we parse repeatedly. Fields +// are nil when the underlying header is absent on the probe; rules can +// nil-check or rely on the typed accessors which already handle nil. +type ParsedHeaders struct { + HSTS *HSTSDirectives + CSP *CSPDirectives +} + +// ParseHeaders builds a ParsedHeaders from a probe's raw header map. +// Header lookups use the lowercase keys produced by the collector. +func ParseHeaders(p HTTPProbe) ParsedHeaders { + return ParsedHeaders{ + HSTS: ParseHSTS(p.Headers["strict-transport-security"]), + CSP: ParseCSP(p.Headers["content-security-policy"]), + } +} diff --git a/checker/interactive.go b/checker/interactive.go new file mode 100644 index 0000000..86a1c7f --- /dev/null +++ b/checker/interactive.go @@ -0,0 +1,254 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +//go:build standalone + +package checker + +import ( + "encoding/json" + "errors" + "fmt" + "net" + "net/http" + "os" + "strconv" + "strings" + + "github.com/miekg/dns" + + sdk "git.happydns.org/checker-sdk-go/checker" + happydns "git.happydns.org/happyDomain/model" + "git.happydns.org/happyDomain/services/abstract" +) + +// RenderForm implements server.Interactive: the human-facing form +// exposed at GET /check when the checker runs as a standalone binary. +func (p *httpProvider) RenderForm() []sdk.CheckerOptionField { + return []sdk.CheckerOptionField{ + { + Id: "domain", + Type: "string", + Label: "Host name", + Placeholder: "www.example.com", + Required: true, + Description: "The HTTP/HTTPS server hostname to probe. A/AAAA records are looked up live.", + }, + { + Id: OptionProbeTimeoutMs, + Type: "number", + Label: "Per-request timeout (ms)", + Description: "Maximum time allowed for a single HTTP/HTTPS request.", + Default: float64(DefaultProbeTimeoutMs), + }, + { + Id: OptionMaxRedirects, + Type: "number", + Label: "Max redirects to follow", + Description: "Stop following redirects after this many hops.", + Default: float64(DefaultMaxRedirects), + }, + { + Id: OptionUserAgent, + Type: "string", + Label: "User-Agent", + Description: "User-Agent header sent with every request.", + Default: DefaultUserAgent, + }, + { + Id: OptionRequireHTTPS, + Type: "bool", + Label: "Require HTTPS", + Description: "Plain HTTP must redirect to HTTPS.", + Default: true, + }, + { + Id: OptionRequireHSTS, + Type: "bool", + Label: "Require HSTS", + Description: "HTTPS responses must include a Strict-Transport-Security header.", + Default: true, + }, + { + Id: OptionMinHSTSMaxAgeDays, + Type: "number", + Label: "Min HSTS max-age (days)", + Description: "Minimum acceptable max-age value (in days) for HSTS.", + Default: float64(DefaultMinHSTSMaxAge), + }, + { + Id: OptionRequireCSP, + Type: "bool", + Label: "Require Content-Security-Policy", + Description: "HTTPS responses must include a Content-Security-Policy header.", + Default: false, + }, + } +} + +// ParseForm implements server.Interactive: resolves the submitted +// hostname into an abstract.Server payload and wraps it in the +// ServiceMessage shape that Collect expects. +func (p *httpProvider) ParseForm(r *http.Request) (sdk.CheckerOptions, error) { + domain := strings.TrimSpace(r.FormValue("domain")) + domain = strings.TrimSuffix(domain, ".") + if domain == "" { + return nil, errors.New("host name is required") + } + fqdn := dns.Fqdn(domain) + + resolver, err := systemResolver() + if err != nil { + return nil, fmt.Errorf("resolver: %w", err) + } + + server := &abstract.Server{} + if a, err := lookupA(resolver, fqdn); err != nil { + return nil, fmt.Errorf("A lookup for %s: %w", domain, err) + } else if a != nil { + server.A = a + } + if aaaa, err := lookupAAAA(resolver, fqdn); err != nil { + return nil, fmt.Errorf("AAAA lookup for %s: %w", domain, err) + } else if aaaa != nil { + server.AAAA = aaaa + } + if server.A == nil && server.AAAA == nil { + return nil, fmt.Errorf("no A/AAAA records found for %s", domain) + } + + svcBody, err := json.Marshal(server) + if err != nil { + return nil, fmt.Errorf("marshal abstract.Server: %w", err) + } + + opts := sdk.CheckerOptions{ + OptionService: happydns.ServiceMessage{ + ServiceMeta: happydns.ServiceMeta{ + Type: "abstract.Server", + Domain: domain, + }, + Service: svcBody, + }, + } + + if raw := strings.TrimSpace(r.FormValue(OptionProbeTimeoutMs)); raw != "" { + v, err := strconv.ParseFloat(raw, 64) + if err != nil { + return nil, errors.New("timeout must be a number") + } + opts[OptionProbeTimeoutMs] = v + } + if raw := strings.TrimSpace(r.FormValue(OptionMaxRedirects)); raw != "" { + v, err := strconv.ParseFloat(raw, 64) + if err != nil { + return nil, errors.New("max redirects must be a number") + } + opts[OptionMaxRedirects] = v + } + if v := strings.TrimSpace(r.FormValue(OptionUserAgent)); v != "" { + opts[OptionUserAgent] = v + } + if raw := strings.TrimSpace(r.FormValue(OptionMinHSTSMaxAgeDays)); raw != "" { + v, err := strconv.ParseFloat(raw, 64) + if err != nil { + return nil, errors.New("HSTS max-age must be a number") + } + opts[OptionMinHSTSMaxAgeDays] = v + } + opts[OptionRequireHTTPS] = parseInteractiveBool(r, OptionRequireHTTPS, true) + opts[OptionRequireHSTS] = parseInteractiveBool(r, OptionRequireHSTS, true) + opts[OptionRequireCSP] = parseInteractiveBool(r, OptionRequireCSP, false) + + return opts, nil +} + +// parseInteractiveBool reads a checkbox-style field. HTML forms omit +// unchecked checkboxes entirely, so a missing key means false if the +// form was submitted (detected via the required "domain" field). +func parseInteractiveBool(r *http.Request, key string, def bool) bool { + if _, ok := r.Form[key]; !ok { + if _, submitted := r.Form["domain"]; submitted { + return false + } + return def + } + v := strings.ToLower(strings.TrimSpace(r.FormValue(key))) + switch v { + case "", "0", "false", "off", "no": + return false + default: + return true + } +} + +// systemResolver picks a DNS server to send explicit A/AAAA queries to. +// Resolution order: +// 1. CHECKER_DNS_RESOLVER env var (host or host:port) +// 2. The OS resolver config when one exists (resolvConfPath) +// 3. 1.1.1.1:53 as a last-resort public fallback +func systemResolver() (string, error) { + if env := strings.TrimSpace(os.Getenv("CHECKER_DNS_RESOLVER")); env != "" { + if _, _, err := net.SplitHostPort(env); err != nil { + env = net.JoinHostPort(env, "53") + } + return env, nil + } + if path := resolvConfPath(); path != "" { + if cfg, err := dns.ClientConfigFromFile(path); err == nil && len(cfg.Servers) > 0 { + return net.JoinHostPort(cfg.Servers[0], cfg.Port), nil + } + } + return net.JoinHostPort("1.1.1.1", "53"), nil +} + +func resolvConfPath() string { + for _, p := range []string{"/etc/resolv.conf"} { + if _, err := os.Stat(p); err == nil { + return p + } + } + return "" +} + +func dnsExchange(resolver, name string, qtype uint16) (*dns.Msg, error) { + msg := new(dns.Msg) + msg.SetQuestion(name, qtype) + msg.RecursionDesired = true + c := new(dns.Client) + in, _, err := c.Exchange(msg, resolver) + if err != nil { + return nil, err + } + if in.Rcode != dns.RcodeSuccess && in.Rcode != dns.RcodeNameError { + return nil, fmt.Errorf("rcode %s", dns.RcodeToString[in.Rcode]) + } + return in, nil +} + +func lookupA(resolver, fqdn string) (*dns.A, error) { + in, err := dnsExchange(resolver, fqdn, dns.TypeA) + if err != nil { + return nil, err + } + for _, rr := range in.Answer { + if a, ok := rr.(*dns.A); ok { + return a, nil + } + } + return nil, nil +} + +func lookupAAAA(resolver, fqdn string) (*dns.AAAA, error) { + in, err := dnsExchange(resolver, fqdn, dns.TypeAAAA) + if err != nil { + return nil, err + } + for _, rr := range in.Answer { + if aaaa, ok := rr.(*dns.AAAA); ok { + return aaaa, nil + } + } + return nil, nil +} diff --git a/checker/iter.go b/checker/iter.go new file mode 100644 index 0000000..3793ceb --- /dev/null +++ b/checker/iter.go @@ -0,0 +1,48 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import sdk "git.happydns.org/checker-sdk-go/checker" + +// EvalAggregateByScheme runs fn on the subset of probes matching scheme. +// If no probe was attempted, returns a single Unknown state with +// code+".no_probes". Otherwise it returns the per-probe states emitted by +// fn, falling back to a single OK state (code+".ok" with okMsg) when fn +// emitted nothing — the conventional "everything is fine" shape used by +// reachability and redirect rules. +func EvalAggregateByScheme(data *HTTPData, scheme, code, okMsg string, fn func(p HTTPProbe, emit func(sdk.CheckState))) []sdk.CheckState { + probes := probesByScheme(data.Probes, scheme) + if len(probes) == 0 { + return []sdk.CheckState{unknownState(code+".no_probes", "No probes were attempted.")} + } + var states []sdk.CheckState + emit := func(s sdk.CheckState) { states = append(states, s) } + for _, p := range probes { + fn(p, emit) + } + if len(states) == 0 { + return []sdk.CheckState{passState(code+".ok", okMsg)} + } + return states +} + +// EvalPerHTTPS calls fn for each successful HTTPS probe and returns the +// concatenated states. If no HTTPS probe succeeded, returns a single +// Unknown state with code+".no_https". +// +// Use this for rules that emit one CheckState per probe — the most common +// shape. Rules that need access to all probes at once (aggregation, +// cross-probe comparisons) should call successfulHTTPSProbes directly. +func EvalPerHTTPS(data *HTTPData, code string, fn func(p HTTPProbe) sdk.CheckState) []sdk.CheckState { + probes := successfulHTTPSProbes(data.Probes) + if len(probes) == 0 { + return []sdk.CheckState{unknownState(code+".no_https", "No successful HTTPS probe to evaluate.")} + } + out := make([]sdk.CheckState, 0, len(probes)) + for _, p := range probes { + out = append(out, fn(p)) + } + return out +} diff --git a/checker/provider.go b/checker/provider.go new file mode 100644 index 0000000..9d56aba --- /dev/null +++ b/checker/provider.go @@ -0,0 +1,20 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + sdk "git.happydns.org/checker-sdk-go/checker" +) + +// Provider returns a new HTTP/HTTPS observation provider. +func Provider() sdk.ObservationProvider { + return &httpProvider{} +} + +type httpProvider struct{} + +func (p *httpProvider) Key() sdk.ObservationKey { + return ObservationKeyHTTP +} diff --git a/checker/provider_test.go b/checker/provider_test.go new file mode 100644 index 0000000..feb9f0c --- /dev/null +++ b/checker/provider_test.go @@ -0,0 +1,244 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "encoding/json" + "net" + "sort" + "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 mkServer(t *testing.T, name string, ipv4, ipv6 string) *abstract.Server { + t.Helper() + s := &abstract.Server{} + if ipv4 != "" { + s.A = &dns.A{ + Hdr: dns.RR_Header{Name: name, Rrtype: dns.TypeA, Class: dns.ClassINET, Ttl: 300}, + A: net.ParseIP(ipv4), + } + } + if ipv6 != "" { + s.AAAA = &dns.AAAA{ + Hdr: dns.RR_Header{Name: name, Rrtype: dns.TypeAAAA, Class: dns.ClassINET, Ttl: 300}, + AAAA: net.ParseIP(ipv6), + } + } + return s +} + +func mkServiceMessage(t *testing.T, srv *abstract.Server) happydns.ServiceMessage { + t.Helper() + raw, err := json.Marshal(srv) + if err != nil { + t.Fatal(err) + } + return happydns.ServiceMessage{ + ServiceMeta: happydns.ServiceMeta{Type: "abstract.Server"}, + Service: raw, + } +} + +func TestProvider_KeyAndDefinition(t *testing.T) { + p := Provider() + if p.Key() != ObservationKeyHTTP { + t.Errorf("Key() = %q, want %q", p.Key(), ObservationKeyHTTP) + } + dp, ok := p.(sdk.CheckerDefinitionProvider) + if !ok { + t.Fatal("provider does not implement CheckerDefinitionProvider") + } + def := dp.Definition() + if def == nil || def.ID != "http" { + t.Fatalf("unexpected definition: %+v", def) + } + if !def.Availability.ApplyToService { + t.Errorf("ApplyToService should be true") + } + if len(def.Availability.LimitToServices) != 1 || def.Availability.LimitToServices[0] != "abstract.Server" { + t.Errorf("LimitToServices: %+v", def.Availability.LimitToServices) + } + if len(def.Rules) == 0 { + t.Error("Rules slice empty") + } + if def.Interval == nil || def.Interval.Default <= 0 { + t.Error("Interval default not set") + } + // User options must include expected keys. + idx := map[string]bool{} + for _, o := range def.Options.UserOpts { + idx[o.Id] = true + } + for _, want := range []string{OptionProbeTimeoutMs, OptionMaxRedirects, OptionUserAgent, OptionRequireHTTPS, OptionRequireHSTS, OptionMinHSTSMaxAgeDays, OptionRequireCSP} { + if !idx[want] { + t.Errorf("UserOpts missing %q", want) + } + } +} + +func TestResolveServer_Success(t *testing.T) { + srv := mkServer(t, "example.test.", "203.0.113.10", "") + opts := sdk.CheckerOptions{OptionService: mkServiceMessage(t, srv)} + got, err := resolveServer(opts) + if err != nil { + t.Fatalf("resolveServer: %v", err) + } + if got.A == nil || got.A.A.String() != "203.0.113.10" { + t.Errorf("unexpected server: %+v", got) + } +} + +func TestResolveServer_MissingService(t *testing.T) { + if _, err := resolveServer(sdk.CheckerOptions{}); err == nil { + t.Fatal("expected error for missing service option") + } +} + +func TestResolveServer_WrongType(t *testing.T) { + msg := happydns.ServiceMessage{ + ServiceMeta: happydns.ServiceMeta{Type: "abstract.NotServer"}, + Service: json.RawMessage(`{}`), + } + if _, err := resolveServer(sdk.CheckerOptions{OptionService: msg}); err == nil { + t.Fatal("expected error for wrong service type") + } +} + +func TestResolveServer_BadJSON(t *testing.T) { + msg := happydns.ServiceMessage{ + ServiceMeta: happydns.ServiceMeta{Type: "abstract.Server"}, + Service: json.RawMessage(`{not json`), + } + if _, err := resolveServer(sdk.CheckerOptions{OptionService: msg}); err == nil { + t.Fatal("expected error for malformed service payload") + } +} + +func TestDiscoverIPs_DedupesAndMerges(t *testing.T) { + // Stand up a loopback DNS server that returns multiple A and AAAA + // records, then point a custom resolver at it. + mux := dns.NewServeMux() + mux.HandleFunc("multi.test.", func(w dns.ResponseWriter, r *dns.Msg) { + m := new(dns.Msg) + m.SetReply(r) + switch r.Question[0].Qtype { + case dns.TypeA: + for _, ip := range []string{"203.0.113.10", "203.0.113.11"} { + m.Answer = append(m.Answer, &dns.A{ + Hdr: dns.RR_Header{Name: "multi.test.", Rrtype: dns.TypeA, Class: dns.ClassINET, Ttl: 60}, + A: net.ParseIP(ip), + }) + } + case dns.TypeAAAA: + m.Answer = append(m.Answer, &dns.AAAA{ + Hdr: dns.RR_Header{Name: "multi.test.", Rrtype: dns.TypeAAAA, Class: dns.ClassINET, Ttl: 60}, + AAAA: net.ParseIP("2001:db8::a"), + }) + } + _ = w.WriteMsg(m) + }) + + pc, err := net.ListenPacket("udp", "127.0.0.1:0") + if err != nil { + t.Fatalf("listen: %v", err) + } + srv := &dns.Server{PacketConn: pc, Handler: mux} + go func() { _ = srv.ActivateAndServe() }() + defer srv.Shutdown() + + prev := resolver + resolver = &net.Resolver{ + PreferGo: true, + Dial: func(ctx context.Context, network, _ string) (net.Conn, error) { + d := net.Dialer{} + return d.DialContext(ctx, "udp", pc.LocalAddr().String()) + }, + } + defer func() { resolver = prev }() + + seen := map[string]struct{}{"203.0.113.10": {}} // already pinned + got := discoverIPs(context.Background(), "multi.test", seen) + sort.Strings(got) + want := []string{"2001:db8::a", "203.0.113.11"} + if len(got) != len(want) { + t.Fatalf("got %v, want %v", got, want) + } + for i := range got { + if got[i] != want[i] { + t.Errorf("ip[%d] = %q, want %q", i, got[i], want[i]) + } + } +} + +func TestDiscoverIPs_LookupFailureIsNonFatal(t *testing.T) { + prev := resolver + resolver = &net.Resolver{ + PreferGo: true, + Dial: func(ctx context.Context, network, address string) (net.Conn, error) { + return nil, net.ErrClosed + }, + } + defer func() { resolver = prev }() + + if got := discoverIPs(context.Background(), "nope.test", map[string]struct{}{}); got != nil { + t.Errorf("expected nil on resolver failure, got %v", got) + } +} + +func TestAddressesFromServer(t *testing.T) { + cases := []struct { + name string + srv *abstract.Server + wantHost string + wantIPs []string + }{ + { + name: "v4 only", + srv: mkServer(t, "example.test.", "203.0.113.1", ""), + wantHost: "example.test", + wantIPs: []string{"203.0.113.1"}, + }, + { + name: "v6 only", + srv: mkServer(t, "v6.example.test.", "", "2001:db8::1"), + wantHost: "v6.example.test", + wantIPs: []string{"2001:db8::1"}, + }, + { + name: "dual stack", + srv: mkServer(t, "dual.example.test.", "203.0.113.2", "2001:db8::2"), + wantHost: "dual.example.test", + wantIPs: []string{"203.0.113.2", "2001:db8::2"}, + }, + { + name: "empty", + srv: &abstract.Server{}, + wantHost: "", + wantIPs: nil, + }, + } + for _, c := range cases { + t.Run(c.name, func(t *testing.T) { + host, ips := addressesFromServer(c.srv) + if host != c.wantHost { + t.Errorf("host = %q, want %q", host, c.wantHost) + } + if len(ips) != len(c.wantIPs) { + t.Fatalf("ips = %+v, want %+v", ips, c.wantIPs) + } + for i, ip := range ips { + if ip != c.wantIPs[i] { + t.Errorf("ip[%d] = %q, want %q", i, ip, c.wantIPs[i]) + } + } + }) + } +} diff --git a/checker/registry.go b/checker/registry.go new file mode 100644 index 0000000..f89561b --- /dev/null +++ b/checker/registry.go @@ -0,0 +1,50 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "sort" + "sync" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +// registry holds the rules and collectors that ship with the checker. +// Each rule/collector registers itself in an init() so that adding a new +// one is a single-file change — no central list to maintain. +var registry = struct { + mu sync.Mutex + rules []sdk.CheckRule + collectors []Collector +}{} + +// RegisterRule appends a rule to the global registry. Intended to be +// called from init() in each rule file. +func RegisterRule(r sdk.CheckRule) { + registry.mu.Lock() + defer registry.mu.Unlock() + registry.rules = append(registry.rules, r) +} + +// RegisterCollector appends a collector to the global registry. Reserved +// for step 4; the orchestrator currently wires only rootCollector +// directly. +func RegisterCollector(c Collector) { + registry.mu.Lock() + defer registry.mu.Unlock() + registry.collectors = append(registry.collectors, c) +} + +// Rules returns every registered rule, sorted by Name() so the output is +// stable across init-order changes (which Go does not guarantee between +// files). +func Rules() []sdk.CheckRule { + registry.mu.Lock() + out := make([]sdk.CheckRule, len(registry.rules)) + copy(out, registry.rules) + registry.mu.Unlock() + sort.Slice(out, func(i, j int) bool { return out[i].Name() < out[j].Name() }) + return out +} diff --git a/checker/rules.go b/checker/rules.go new file mode 100644 index 0000000..e909f7c --- /dev/null +++ b/checker/rules.go @@ -0,0 +1,58 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "fmt" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +// loadHTTPData fetches the HTTPData observation. On failure, returns a +// single error CheckState the caller should emit and bail out. +func loadHTTPData(ctx context.Context, obs sdk.ObservationGetter) (*HTTPData, *sdk.CheckState) { + var data HTTPData + if err := obs.Get(ctx, ObservationKeyHTTP, &data); err != nil { + return nil, &sdk.CheckState{ + Status: sdk.StatusError, + Message: fmt.Sprintf("failed to load HTTP observation: %v", err), + Code: "http.observation_error", + } + } + return &data, nil +} + +func passState(code, msg string) sdk.CheckState { + return sdk.CheckState{Status: sdk.StatusOK, Code: code, Message: msg} +} + +func unknownState(code, msg string) sdk.CheckState { + return sdk.CheckState{Status: sdk.StatusUnknown, Code: code, Message: msg} +} + +// probesByScheme returns the subset of probes for a given scheme. +func probesByScheme(probes []HTTPProbe, scheme string) []HTTPProbe { + var out []HTTPProbe + for _, p := range probes { + if p.Scheme == scheme { + out = append(out, p) + } + } + return out +} + +// successfulHTTPSProbes returns HTTPS probes that completed an HTTP +// transaction (status code != 0). These are the probes whose headers we +// can meaningfully inspect. +func successfulHTTPSProbes(probes []HTTPProbe) []HTTPProbe { + var out []HTTPProbe + for _, p := range probes { + if p.Scheme == "https" && p.StatusCode != 0 { + out = append(out, p) + } + } + return out +} diff --git a/checker/rules_cookies.go b/checker/rules_cookies.go new file mode 100644 index 0000000..8087ac7 --- /dev/null +++ b/checker/rules_cookies.go @@ -0,0 +1,70 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "fmt" + "strings" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func init() { RegisterRule(&cookieFlagsRule{}) } + +// cookieFlagsRule audits Set-Cookie attributes on HTTPS responses: every +// cookie should be Secure and HttpOnly, and SameSite should be set. +type cookieFlagsRule struct{} + +func (r *cookieFlagsRule) Name() string { return "http.cookie_flags" } +func (r *cookieFlagsRule) Description() string { + return "Verifies that cookies set over HTTPS use the Secure, HttpOnly and SameSite attributes." +} + +func (r *cookieFlagsRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, _ sdk.CheckerOptions) []sdk.CheckState { + data, errSt := loadHTTPData(ctx, obs) + if errSt != nil { + return []sdk.CheckState{*errSt} + } + probes := successfulHTTPSProbes(data.Probes) + if len(probes) == 0 { + return []sdk.CheckState{unknownState("http.cookie_flags.no_https", "No successful HTTPS probe to evaluate.")} + } + + var states []sdk.CheckState + totalCookies := 0 + for _, p := range probes { + for _, c := range p.Cookies { + totalCookies++ + var issues []string + if !c.Secure { + issues = append(issues, "missing Secure") + } + if !c.HttpOnly { + issues = append(issues, "missing HttpOnly") + } + if c.SameSite == "" { + issues = append(issues, "missing SameSite") + } else if strings.EqualFold(c.SameSite, "None") && !c.Secure { + issues = append(issues, "SameSite=None requires Secure") + } + if len(issues) > 0 { + states = append(states, sdk.CheckState{ + Status: sdk.StatusWarn, + Code: "http.cookie_flags.weak", + Subject: fmt.Sprintf("%s :: %s", p.Address, c.Name), + Message: fmt.Sprintf("Cookie %q on %s: %s", c.Name, p.Address, strings.Join(issues, ", ")), + }) + } + } + } + if totalCookies == 0 { + return []sdk.CheckState{passState("http.cookie_flags.none", "No cookies were set on the inspected responses.")} + } + if len(states) == 0 { + return []sdk.CheckState{passState("http.cookie_flags.ok", fmt.Sprintf("All %d cookies have proper Secure/HttpOnly/SameSite flags.", totalCookies))} + } + return states +} diff --git a/checker/rules_cookies_test.go b/checker/rules_cookies_test.go new file mode 100644 index 0000000..c556257 --- /dev/null +++ b/checker/rules_cookies_test.go @@ -0,0 +1,85 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "strings" + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func TestCookieFlagsRule_NoHTTPS(t *testing.T) { + data := &HTTPData{Probes: []HTTPProbe{httpProbe("a:80")}} + states := runRule(t, &cookieFlagsRule{}, data, nil) + mustStatus(t, states, sdk.StatusUnknown) +} + +func TestCookieFlagsRule_NoCookies(t *testing.T) { + data := &HTTPData{Probes: []HTTPProbe{httpsProbe("a:443")}} + states := runRule(t, &cookieFlagsRule{}, data, nil) + mustStatus(t, states, sdk.StatusOK) + if !hasCode(states, "http.cookie_flags.none") { + t.Errorf("missing 'none' code: %+v", states) + } +} + +func TestCookieFlagsRule_AllOK(t *testing.T) { + p := httpsProbe("a:443") + p.Cookies = []CookieInfo{ + {Name: "sid", Secure: true, HttpOnly: true, SameSite: "Strict"}, + {Name: "tok", Secure: true, HttpOnly: true, SameSite: "Lax"}, + } + states := runRule(t, &cookieFlagsRule{}, &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, sdk.StatusOK) + if !hasCode(states, "http.cookie_flags.ok") { + t.Errorf("missing ok code: %+v", states) + } +} + +func TestCookieFlagsRule_Issues(t *testing.T) { + p := httpsProbe("a:443") + p.Cookies = []CookieInfo{ + {Name: "no-secure", Secure: false, HttpOnly: true, SameSite: "Lax"}, + {Name: "no-httponly", Secure: true, HttpOnly: false, SameSite: "Lax"}, + {Name: "no-samesite", Secure: true, HttpOnly: true, SameSite: ""}, + {Name: "none-without-secure", Secure: false, HttpOnly: true, SameSite: "None"}, + } + states := runRule(t, &cookieFlagsRule{}, &HTTPData{Probes: []HTTPProbe{p}}, nil) + if len(states) != len(p.Cookies) { + t.Fatalf("got %d states, want %d", len(states), len(p.Cookies)) + } + mustStatus(t, states, sdk.StatusWarn) + + // Check each diagnostic mentions the cookie name and a relevant phrase. + wantSubstr := map[string]string{ + "no-secure": "missing Secure", + "no-httponly": "missing HttpOnly", + "no-samesite": "missing SameSite", + "none-without-secure": "SameSite=None requires Secure", + } + for _, st := range states { + matched := false + for name, phrase := range wantSubstr { + if strings.Contains(st.Message, name) && strings.Contains(st.Message, phrase) { + matched = true + break + } + } + if !matched { + t.Errorf("unexpected state message: %q", st.Message) + } + } +} + +func TestCookieFlagsRule_SameSiteNoneCaseInsensitive(t *testing.T) { + p := httpsProbe("a:443") + p.Cookies = []CookieInfo{{Name: "x", Secure: false, HttpOnly: true, SameSite: "none"}} + states := runRule(t, &cookieFlagsRule{}, &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, sdk.StatusWarn) + if !strings.Contains(states[0].Message, "SameSite=None requires Secure") { + t.Errorf("expected SameSite=None warning regardless of casing, got %q", states[0].Message) + } +} diff --git a/checker/rules_reachability.go b/checker/rules_reachability.go new file mode 100644 index 0000000..38050e6 --- /dev/null +++ b/checker/rules_reachability.go @@ -0,0 +1,62 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "fmt" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func init() { + RegisterRule(&reachabilityRule{scheme: "http", code: "http.tcp_reachable"}) + RegisterRule(&reachabilityRule{scheme: "https", code: "https.tcp_reachable"}) +} + +// reachabilityRule reports per-IP reachability for one scheme. +type reachabilityRule struct { + scheme string // "http" or "https" + code string +} + +func (r *reachabilityRule) Name() string { return r.code } +func (r *reachabilityRule) Description() string { + return fmt.Sprintf("Verifies that every probed IP accepts a %s connection on the standard port.", r.scheme) +} + +func (r *reachabilityRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, _ sdk.CheckerOptions) []sdk.CheckState { + data, errSt := loadHTTPData(ctx, obs) + if errSt != nil { + return []sdk.CheckState{*errSt} + } + + okMsg := fmt.Sprintf("All %s probes responded successfully.", r.scheme) + return EvalAggregateByScheme(data, r.scheme, r.code, okMsg, func(p HTTPProbe, emit func(sdk.CheckState)) { + switch { + case !p.TCPConnected: + emit(sdk.CheckState{ + Status: sdk.StatusCrit, + Code: r.code + ".unreachable", + Subject: p.Address, + Message: fmt.Sprintf("Cannot reach %s://%s on %s: %s", r.scheme, p.Host, p.Address, p.Error), + }) + case p.StatusCode == 0: + emit(sdk.CheckState{ + Status: sdk.StatusCrit, + Code: r.code + ".no_response", + Subject: p.Address, + Message: fmt.Sprintf("TCP open but no HTTP response from %s: %s", p.Address, p.Error), + }) + case p.StatusCode >= 500: + emit(sdk.CheckState{ + Status: sdk.StatusWarn, + Code: r.code + ".server_error", + Subject: p.Address, + Message: fmt.Sprintf("%s returned %d", p.Address, p.StatusCode), + }) + } + }) +} diff --git a/checker/rules_reachability_test.go b/checker/rules_reachability_test.go new file mode 100644 index 0000000..da2750a --- /dev/null +++ b/checker/rules_reachability_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. + +package checker + +import ( + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func TestReachabilityRule_NoProbes(t *testing.T) { + r := &reachabilityRule{scheme: "https", code: "https.tcp_reachable"} + states := runRule(t, r, &HTTPData{}, nil) + mustStatus(t, states, sdk.StatusUnknown) + if !hasCode(states, "https.tcp_reachable.no_probes") { + t.Errorf("expected no_probes code: %+v", states) + } +} + +func TestReachabilityRule_AllOK(t *testing.T) { + r := &reachabilityRule{scheme: "https", code: "https.tcp_reachable"} + data := &HTTPData{Probes: []HTTPProbe{httpsProbe("a:443"), httpsProbe("b:443")}} + states := runRule(t, r, data, nil) + mustStatus(t, states, sdk.StatusOK) + if !hasCode(states, "https.tcp_reachable.ok") { + t.Errorf("expected ok code: %+v", states) + } +} + +func TestReachabilityRule_Unreachable(t *testing.T) { + p := httpsProbe("a:443") + p.TCPConnected = false + p.StatusCode = 0 + p.Error = "i/o timeout" + r := &reachabilityRule{scheme: "https", code: "https.tcp_reachable"} + states := runRule(t, r, &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, sdk.StatusCrit) + if !hasCode(states, "https.tcp_reachable.unreachable") { + t.Errorf("expected unreachable: %+v", states) + } +} + +func TestReachabilityRule_NoResponse(t *testing.T) { + p := httpsProbe("a:443") + p.StatusCode = 0 + p.Error = "EOF" + // TCPConnected stays true (connection accepted, no HTTP response). + r := &reachabilityRule{scheme: "https", code: "https.tcp_reachable"} + states := runRule(t, r, &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, sdk.StatusCrit) + if !hasCode(states, "https.tcp_reachable.no_response") { + t.Errorf("expected no_response: %+v", states) + } +} + +func TestReachabilityRule_5xx(t *testing.T) { + p := httpsProbe("a:443") + p.StatusCode = 502 + r := &reachabilityRule{scheme: "https", code: "https.tcp_reachable"} + states := runRule(t, r, &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, sdk.StatusWarn) + if !hasCode(states, "https.tcp_reachable.server_error") { + t.Errorf("expected server_error: %+v", states) + } +} + +func TestReachabilityRule_FiltersByScheme(t *testing.T) { + // An HTTP failure should not surface in the HTTPS reachability rule. + pHTTPS := httpsProbe("a:443") + pHTTP := httpProbe("a:80") + pHTTP.TCPConnected = false + pHTTP.StatusCode = 0 + + r := &reachabilityRule{scheme: "https", code: "https.tcp_reachable"} + states := runRule(t, r, &HTTPData{Probes: []HTTPProbe{pHTTPS, pHTTP}}, nil) + mustStatus(t, states, sdk.StatusOK) +} diff --git a/checker/rules_redirect.go b/checker/rules_redirect.go new file mode 100644 index 0000000..2ec5ab7 --- /dev/null +++ b/checker/rules_redirect.go @@ -0,0 +1,69 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "fmt" + "net/url" + "strings" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func init() { RegisterRule(&httpsRedirectRule{}) } + +// httpsRedirectRule verifies that plain HTTP either redirects to HTTPS or +// fails (which is acceptable when HTTP is intentionally not served). +type httpsRedirectRule struct{} + +func (r *httpsRedirectRule) Name() string { return "http.https_redirect" } +func (r *httpsRedirectRule) Description() string { + return "Plain HTTP responses must redirect to an HTTPS URL on the same host." +} + +func (r *httpsRedirectRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, opts sdk.CheckerOptions) []sdk.CheckState { + data, errSt := loadHTTPData(ctx, obs) + if errSt != nil { + return []sdk.CheckState{*errSt} + } + require := sdk.GetBoolOption(opts, OptionRequireHTTPS, true) + + const okMsg = "HTTP redirects to HTTPS on every reachable IP." + return EvalAggregateByScheme(data, "http", "http.https_redirect", okMsg, func(p HTTPProbe, emit func(sdk.CheckState)) { + if !p.TCPConnected || p.StatusCode == 0 { + // Reachability rule handles this; an HTTP server that is + // simply not running is fine for redirect-purposes. + return + } + final := p.FinalURL + if final == "" && len(p.RedirectChain) > 0 { + final = p.RedirectChain[len(p.RedirectChain)-1].To + } + isHTTPS := false + if u, err := url.Parse(final); err == nil { + isHTTPS = strings.EqualFold(u.Scheme, "https") + } + switch { + case isHTTPS: + // Good. Aggregated below as a single OK. + case require: + emit(sdk.CheckState{ + Status: sdk.StatusWarn, + Code: "http.no_https_redirect", + Subject: p.Address, + Message: fmt.Sprintf("HTTP response on %s did not redirect to HTTPS (final URL: %s, status %d)", p.Address, final, p.StatusCode), + Meta: map[string]any{"fix": "Configure your web server to redirect every plain-HTTP request to https://."}, + }) + default: + emit(sdk.CheckState{ + Status: sdk.StatusInfo, + Code: "http.plain_http_served", + Subject: p.Address, + Message: fmt.Sprintf("HTTP responded directly without redirect (status %d)", p.StatusCode), + }) + } + }) +} diff --git a/checker/rules_redirect_test.go b/checker/rules_redirect_test.go new file mode 100644 index 0000000..772f681 --- /dev/null +++ b/checker/rules_redirect_test.go @@ -0,0 +1,72 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func TestHTTPSRedirectRule_NoProbes(t *testing.T) { + data := &HTTPData{Probes: []HTTPProbe{httpsProbe("a:443")}} + states := runRule(t, &httpsRedirectRule{}, data, nil) + mustStatus(t, states, sdk.StatusUnknown) +} + +func TestHTTPSRedirectRule_OKViaFinalURL(t *testing.T) { + p := httpProbe("a:80") + p.StatusCode = 301 + p.FinalURL = "https://example.test/" + states := runRule(t, &httpsRedirectRule{}, &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, sdk.StatusOK) + if !hasCode(states, "http.https_redirect.ok") { + t.Errorf("expected redirect.ok: %+v", states) + } +} + +func TestHTTPSRedirectRule_OKViaRedirectChain(t *testing.T) { + // FinalURL empty (non-following CheckRedirect path): fallback to last redirect step. + p := httpProbe("a:80") + p.StatusCode = 308 + p.FinalURL = "" + p.RedirectChain = []RedirectStep{{From: "http://example.test/", To: "https://example.test/"}} + states := runRule(t, &httpsRedirectRule{}, &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, sdk.StatusOK) +} + +func TestHTTPSRedirectRule_NoRedirect_Required(t *testing.T) { + p := httpProbe("a:80") + p.StatusCode = 200 + p.FinalURL = "http://example.test/" + states := runRule(t, &httpsRedirectRule{}, &HTTPData{Probes: []HTTPProbe{p}}, sdk.CheckerOptions{OptionRequireHTTPS: true}) + mustStatus(t, states, sdk.StatusWarn) + if !hasCode(states, "http.no_https_redirect") { + t.Errorf("expected no_https_redirect: %+v", states) + } +} + +func TestHTTPSRedirectRule_NoRedirect_NotRequired(t *testing.T) { + p := httpProbe("a:80") + p.StatusCode = 200 + p.FinalURL = "http://example.test/" + states := runRule(t, &httpsRedirectRule{}, &HTTPData{Probes: []HTTPProbe{p}}, sdk.CheckerOptions{OptionRequireHTTPS: false}) + mustStatus(t, states, sdk.StatusInfo) + if !hasCode(states, "http.plain_http_served") { + t.Errorf("expected plain_http_served: %+v", states) + } +} + +func TestHTTPSRedirectRule_SkipsUnreachable(t *testing.T) { + // HTTP not running on this IP: reachability rule handles it; redirect rule must skip. + p := httpProbe("a:80") + p.TCPConnected = false + p.StatusCode = 0 + states := runRule(t, &httpsRedirectRule{}, &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, sdk.StatusOK) + if !hasCode(states, "http.https_redirect.ok") { + t.Errorf("unreachable HTTP should leave redirect rule with summary OK, got %+v", states) + } +} diff --git a/checker/rules_security_headers.go b/checker/rules_security_headers.go new file mode 100644 index 0000000..92ade0c --- /dev/null +++ b/checker/rules_security_headers.go @@ -0,0 +1,231 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "fmt" + "strings" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func init() { + RegisterRule(&hstsRule{}) + RegisterRule(&cspRule{}) + RegisterRule(&xFrameOptionsRule{}) + RegisterRule(&xXSSProtectionRule{}) +} + +// hstsRule checks the Strict-Transport-Security header on HTTPS responses. +type hstsRule struct{} + +func (r *hstsRule) Name() string { return "http.hsts" } +func (r *hstsRule) Description() string { + return "Verifies the presence and quality of the Strict-Transport-Security header on HTTPS responses." +} + +func (r *hstsRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, opts sdk.CheckerOptions) []sdk.CheckState { + data, errSt := loadHTTPData(ctx, obs) + if errSt != nil { + return []sdk.CheckState{*errSt} + } + require := sdk.GetBoolOption(opts, OptionRequireHSTS, true) + minDays := sdk.GetIntOption(opts, OptionMinHSTSMaxAgeDays, DefaultMinHSTSMaxAge) + minSeconds := int64(minDays) * 86400 + + return EvalPerHTTPS(data, "http.hsts", func(p HTTPProbe) sdk.CheckState { + h := ParseHSTS(p.Headers["strict-transport-security"]) + if h == nil { + status := sdk.StatusWarn + if !require { + status = sdk.StatusInfo + } + return sdk.CheckState{ + Status: status, + Code: "http.hsts.missing", + Subject: p.Address, + Message: "Strict-Transport-Security header is missing.", + Meta: map[string]any{"fix": "Send `Strict-Transport-Security: max-age=15552000; includeSubDomains` from HTTPS responses."}, + } + } + if h.MaxAge < minSeconds { + return sdk.CheckState{ + Status: sdk.StatusWarn, + Code: "http.hsts.short_max_age", + Subject: p.Address, + Message: fmt.Sprintf("HSTS max-age=%d is below the recommended %d seconds (%d days).", h.MaxAge, minSeconds, minDays), + } + } + return sdk.CheckState{ + Status: sdk.StatusOK, + Code: "http.hsts.ok", + Subject: p.Address, + Message: fmt.Sprintf("HSTS present (max-age=%d, includeSubDomains=%v, preload=%v).", h.MaxAge, h.IncludeSub, h.Preload), + } + }) +} + +// cspRule checks for the presence of a Content-Security-Policy header. +type cspRule struct{} + +func (r *cspRule) Name() string { return "http.csp" } +func (r *cspRule) Description() string { + return "Verifies the presence of a Content-Security-Policy header on HTTPS responses." +} + +func (r *cspRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, opts sdk.CheckerOptions) []sdk.CheckState { + data, errSt := loadHTTPData(ctx, obs) + if errSt != nil { + return []sdk.CheckState{*errSt} + } + require := sdk.GetBoolOption(opts, OptionRequireCSP, false) + + return EvalPerHTTPS(data, "http.csp", func(p HTTPProbe) sdk.CheckState { + csp := ParseCSP(p.Headers["content-security-policy"]) + if csp == nil { + status := sdk.StatusInfo + if require { + status = sdk.StatusWarn + } + return sdk.CheckState{ + Status: status, + Code: "http.csp.missing", + Subject: p.Address, + Message: "Content-Security-Policy header is missing.", + Meta: map[string]any{"fix": "Define a CSP appropriate for your application (e.g. default-src 'self')."}, + } + } + if csp.HasUnsafe() { + return sdk.CheckState{ + Status: sdk.StatusWarn, + Code: "http.csp.unsafe", + Subject: p.Address, + Message: "Content-Security-Policy uses 'unsafe-inline' or 'unsafe-eval'.", + } + } + return sdk.CheckState{ + Status: sdk.StatusOK, + Code: "http.csp.ok", + Subject: p.Address, + Message: "Content-Security-Policy is set.", + } + }) +} + +// xFrameOptionsRule checks X-Frame-Options (or frame-ancestors in CSP as +// an acceptable substitute). +type xFrameOptionsRule struct{} + +func (r *xFrameOptionsRule) Name() string { return "http.x_frame_options" } +func (r *xFrameOptionsRule) Description() string { + return "Verifies that responses set X-Frame-Options or a CSP frame-ancestors directive." +} + +func (r *xFrameOptionsRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, _ sdk.CheckerOptions) []sdk.CheckState { + data, errSt := loadHTTPData(ctx, obs) + if errSt != nil { + return []sdk.CheckState{*errSt} + } + + return EvalPerHTTPS(data, "http.x_frame_options", func(p HTTPProbe) sdk.CheckState { + xfo := strings.ToUpper(strings.TrimSpace(p.Headers["x-frame-options"])) + hasFrameAncestors := ParseCSP(p.Headers["content-security-policy"]).HasDirective("frame-ancestors") + + switch { + case xfo == "DENY" || xfo == "SAMEORIGIN" || hasFrameAncestors: + return sdk.CheckState{ + Status: sdk.StatusOK, + Code: "http.x_frame_options.ok", + Subject: p.Address, + Message: "Clickjacking protection is in place.", + } + case xfo != "": + return sdk.CheckState{ + Status: sdk.StatusWarn, + Code: "http.x_frame_options.invalid", + Subject: p.Address, + Message: "X-Frame-Options has an unrecognised value: " + xfo, + } + default: + return sdk.CheckState{ + Status: sdk.StatusWarn, + Code: "http.x_frame_options.missing", + Subject: p.Address, + Message: "Neither X-Frame-Options nor CSP frame-ancestors is set.", + Meta: map[string]any{"fix": "Send `X-Frame-Options: DENY` (or SAMEORIGIN) or use CSP frame-ancestors."}, + } + } + }) +} + +func init() { + // Showcase: a rule expressed entirely as a HeaderRuleSpec. Compare + // with the hand-rolled rules above — the boilerplate vanishes once + // the only logic is "is this header present and well-formed?". + RegisterRule(HeaderRule(HeaderRuleSpec{ + Code: "http.x_content_type_options", + Description: "Verifies that responses set X-Content-Type-Options: nosniff.", + Header: "X-Content-Type-Options", + Required: true, + FixHint: "Add `X-Content-Type-Options: nosniff` to all responses.", + Validate: func(v string) (sdk.Status, string) { + if strings.EqualFold(v, "nosniff") { + return sdk.StatusOK, "X-Content-Type-Options: nosniff is set." + } + return sdk.StatusWarn, "X-Content-Type-Options has an unexpected value: " + strings.ToLower(v) + }, + })) +} + +// xXSSProtectionRule checks the legacy X-XSS-Protection header. Modern +// browsers ignore it, but if present we want it to be sane. +type xXSSProtectionRule struct{} + +func (r *xXSSProtectionRule) Name() string { return "http.x_xss_protection" } +func (r *xXSSProtectionRule) Description() string { + return "Reports the value of the legacy X-XSS-Protection header (disabled is preferred on modern browsers; CSP is the proper replacement)." +} + +func (r *xXSSProtectionRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, _ sdk.CheckerOptions) []sdk.CheckState { + data, errSt := loadHTTPData(ctx, obs) + if errSt != nil { + return []sdk.CheckState{*errSt} + } + + return EvalPerHTTPS(data, "http.x_xss_protection", func(p HTTPProbe) sdk.CheckState { + v := strings.TrimSpace(p.Headers["x-xss-protection"]) + switch { + case v == "": + return sdk.CheckState{ + Status: sdk.StatusInfo, + Code: "http.x_xss_protection.absent", + Subject: p.Address, + Message: "X-XSS-Protection is not set; CSP is the recommended replacement.", + } + case strings.HasPrefix(v, "0"): + return sdk.CheckState{ + Status: sdk.StatusOK, + Code: "http.x_xss_protection.disabled", + Subject: p.Address, + Message: "X-XSS-Protection is explicitly disabled (recommended).", + } + case strings.Contains(strings.ToLower(v), "mode=block"): + return sdk.CheckState{ + Status: sdk.StatusInfo, + Code: "http.x_xss_protection.enabled", + Subject: p.Address, + Message: "X-XSS-Protection is set to the historically recommended `1; mode=block`. Modern browsers ignore this header; CSP is the proper replacement.", + } + default: + return sdk.CheckState{ + Status: sdk.StatusInfo, + Code: "http.x_xss_protection.enabled", + Subject: p.Address, + Message: "X-XSS-Protection is enabled. Modern browsers ignore this header; CSP is the proper replacement.", + } + } + }) +} diff --git a/checker/rules_security_headers_test.go b/checker/rules_security_headers_test.go new file mode 100644 index 0000000..539a656 --- /dev/null +++ b/checker/rules_security_headers_test.go @@ -0,0 +1,223 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "testing" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func TestParseHSTS(t *testing.T) { + cases := []struct { + name string + in string + maxAge int64 + includeSub bool + preload bool + }{ + {"empty", "", 0, false, false}, + {"max-age only", "max-age=31536000", 31536000, false, false}, + {"includeSubDomains", "max-age=15552000; includeSubDomains", 15552000, true, false}, + {"all flags", "max-age=63072000; includeSubDomains; preload", 63072000, true, true}, + {"quoted max-age", `max-age="3600"`, 3600, false, false}, + {"case-insensitive directive", "MAX-AGE=42; INCLUDESUBDOMAINS; PRELOAD", 42, true, true}, + {"messy spaces", " max-age=10 ; includeSubDomains ", 10, true, false}, + {"unparseable max-age", "max-age=not-a-number", 0, false, false}, + {"no max-age, only flags", "includeSubDomains; preload", 0, true, true}, + } + for _, c := range cases { + t.Run(c.name, func(t *testing.T) { + h := ParseHSTS(c.in) + if c.in == "" { + if h != nil { + t.Errorf("ParseHSTS(%q) = %+v, want nil", c.in, h) + } + return + } + if h == nil { + t.Fatalf("ParseHSTS(%q) returned nil", c.in) + } + if h.MaxAge != c.maxAge || h.IncludeSub != c.includeSub || h.Preload != c.preload { + t.Errorf("ParseHSTS(%q) = (%d, %v, %v), want (%d, %v, %v)", + c.in, h.MaxAge, h.IncludeSub, h.Preload, c.maxAge, c.includeSub, c.preload) + } + }) + } +} + +func TestHSTSRule_NoHTTPSProbes(t *testing.T) { + data := &HTTPData{Probes: []HTTPProbe{httpProbe("a:80")}} + states := runRule(t, &hstsRule{}, data, nil) + mustStatus(t, states, sdk.StatusUnknown) + if !hasCode(states, "http.hsts.no_https") { + t.Errorf("missing no_https code: %+v", states) + } +} + +func TestHSTSRule_MissingRequired(t *testing.T) { + data := &HTTPData{Probes: []HTTPProbe{httpsProbe("a:443")}} + states := runRule(t, &hstsRule{}, data, sdk.CheckerOptions{OptionRequireHSTS: true}) + mustStatus(t, states, sdk.StatusWarn) + if !hasCode(states, "http.hsts.missing") { + t.Errorf("missing 'http.hsts.missing': %+v", states) + } +} + +func TestHSTSRule_MissingNotRequired(t *testing.T) { + data := &HTTPData{Probes: []HTTPProbe{httpsProbe("a:443")}} + states := runRule(t, &hstsRule{}, data, sdk.CheckerOptions{OptionRequireHSTS: false}) + mustStatus(t, states, sdk.StatusInfo) +} + +func TestHSTSRule_ShortMaxAge(t *testing.T) { + p := httpsProbe("a:443") + p.Headers["strict-transport-security"] = "max-age=60" + data := &HTTPData{Probes: []HTTPProbe{p}} + states := runRule(t, &hstsRule{}, data, nil) + mustStatus(t, states, sdk.StatusWarn) + if !hasCode(states, "http.hsts.short_max_age") { + t.Errorf("missing short_max_age code: %+v", states) + } +} + +func TestHSTSRule_OK(t *testing.T) { + p := httpsProbe("a:443") + p.Headers["strict-transport-security"] = "max-age=63072000; includeSubDomains; preload" + data := &HTTPData{Probes: []HTTPProbe{p}} + states := runRule(t, &hstsRule{}, data, nil) + mustStatus(t, states, sdk.StatusOK) + if !hasCode(states, "http.hsts.ok") { + t.Errorf("missing ok code: %+v", states) + } +} + +func TestHSTSRule_LoadFailure(t *testing.T) { + states := (&hstsRule{}).Evaluate(t.Context(), &fakeObs{failGet: true}, nil) + if len(states) != 1 || states[0].Status != sdk.StatusError { + t.Fatalf("expected single error state, got %+v", states) + } +} + +func TestCSPRule_Missing(t *testing.T) { + data := &HTTPData{Probes: []HTTPProbe{httpsProbe("a:443")}} + // Default: not required → Info. + states := runRule(t, &cspRule{}, data, nil) + mustStatus(t, states, sdk.StatusInfo) + // Required → Warn. + states = runRule(t, &cspRule{}, data, sdk.CheckerOptions{OptionRequireCSP: true}) + mustStatus(t, states, sdk.StatusWarn) +} + +func TestCSPRule_Unsafe(t *testing.T) { + for _, csp := range []string{"default-src 'self'; script-src 'unsafe-inline'", "default-src 'unsafe-eval'"} { + p := httpsProbe("a:443") + p.Headers["content-security-policy"] = csp + data := &HTTPData{Probes: []HTTPProbe{p}} + states := runRule(t, &cspRule{}, data, nil) + mustStatus(t, states, sdk.StatusWarn) + if !hasCode(states, "http.csp.unsafe") { + t.Errorf("csp=%q: missing unsafe code: %+v", csp, states) + } + } +} + +func TestCSPRule_OK(t *testing.T) { + p := httpsProbe("a:443") + p.Headers["content-security-policy"] = "default-src 'self'" + data := &HTTPData{Probes: []HTTPProbe{p}} + states := runRule(t, &cspRule{}, data, nil) + mustStatus(t, states, sdk.StatusOK) +} + +func TestXFrameOptionsRule(t *testing.T) { + cases := []struct { + name string + xfo string + csp string + want sdk.Status + wantSub string + }{ + {"DENY", "DENY", "", sdk.StatusOK, "http.x_frame_options.ok"}, + {"SAMEORIGIN lower", "sameorigin", "", sdk.StatusOK, "http.x_frame_options.ok"}, + {"frame-ancestors via CSP", "", "default-src 'self'; frame-ancestors 'none'", sdk.StatusOK, "http.x_frame_options.ok"}, + {"invalid value", "ALLOWALL", "", sdk.StatusWarn, "http.x_frame_options.invalid"}, + {"missing", "", "", sdk.StatusWarn, "http.x_frame_options.missing"}, + } + for _, c := range cases { + t.Run(c.name, func(t *testing.T) { + p := httpsProbe("a:443") + if c.xfo != "" { + p.Headers["x-frame-options"] = c.xfo + } + if c.csp != "" { + p.Headers["content-security-policy"] = c.csp + } + data := &HTTPData{Probes: []HTTPProbe{p}} + states := runRule(t, &xFrameOptionsRule{}, data, nil) + mustStatus(t, states, c.want) + if !hasCode(states, c.wantSub) { + t.Errorf("missing code %q in %+v", c.wantSub, states) + } + }) + } +} + +func TestXContentTypeOptionsRule(t *testing.T) { + cases := []struct { + val string + want sdk.Status + code string + }{ + {"nosniff", sdk.StatusOK, "http.x_content_type_options.ok"}, + {"NoSniff", sdk.StatusOK, "http.x_content_type_options.ok"}, + {"sniff", sdk.StatusWarn, "http.x_content_type_options.invalid"}, + {"", sdk.StatusWarn, "http.x_content_type_options.missing"}, + } + for _, c := range cases { + p := httpsProbe("a:443") + if c.val != "" { + p.Headers["x-content-type-options"] = c.val + } + states := runRule(t, ruleByName(t, "http.x_content_type_options"), &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, c.want) + if !hasCode(states, c.code) { + t.Errorf("val=%q: missing code %q in %+v", c.val, c.code, states) + } + } +} + +func TestXXSSProtectionRule(t *testing.T) { + cases := []struct { + val string + want sdk.Status + code string + }{ + {"", sdk.StatusInfo, "http.x_xss_protection.absent"}, + {"0", sdk.StatusOK, "http.x_xss_protection.disabled"}, + {"1; mode=block", sdk.StatusInfo, "http.x_xss_protection.enabled"}, + } + for _, c := range cases { + p := httpsProbe("a:443") + if c.val != "" { + p.Headers["x-xss-protection"] = c.val + } + states := runRule(t, &xXSSProtectionRule{}, &HTTPData{Probes: []HTTPProbe{p}}, nil) + mustStatus(t, states, c.want) + if !hasCode(states, c.code) { + t.Errorf("val=%q: want code %q, got %+v", c.val, c.code, states) + } + } +} + +func TestSecurityHeaders_NoHTTPS(t *testing.T) { + // Each header rule must emit Unknown when there are no successful HTTPS probes. + rules := []sdk.CheckRule{&hstsRule{}, &cspRule{}, &xFrameOptionsRule{}, ruleByName(t, "http.x_content_type_options"), &xXSSProtectionRule{}} + data := &HTTPData{Probes: []HTTPProbe{httpProbe("a:80")}} + for _, r := range rules { + states := runRule(t, r, data, nil) + mustStatus(t, states, sdk.StatusUnknown) + } +} diff --git a/checker/rules_sri.go b/checker/rules_sri.go new file mode 100644 index 0000000..d3c825f --- /dev/null +++ b/checker/rules_sri.go @@ -0,0 +1,81 @@ +// This file is part of the happyDomain (R) project. +// Copyright (c) 2020-2026 happyDomain +// Authors: Pierre-Olivier Mercier, et al. + +package checker + +import ( + "context" + "fmt" + + sdk "git.happydns.org/checker-sdk-go/checker" +) + +func init() { RegisterRule(&sriRule{}) } + +// sriRule reports cross-origin