diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..286ac9a --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.idea/ +.vscode/ +cmd/dynafire/dynafire diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..afc8b3b --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +dynafire - real-time threat detection for any Linux system += + +[Turris Sentinel](https://view.sentinel.turris.cz/?period=1w) is a real-time threat detection & attack prevention system from +the creators of the [Turris](https://www.turris.com/en/) series of open-source routers, however this service is normally only available via the router interface. +This makes it impractical to use the real-time data provided by Turris Sentinel on a VPS for example, which you cannot easily put behind a Turris router hardware. + +`dynafire` is a lightweight Linux daemon that lets any Linux system running the industry standard `firewalld` firewall update its firewall rules in real-time based on Sentinel data. + +Installation via package managers +- +TODO + +Manual installation +- +Because `dynafire` ships as a single binary, it is easy to install it manually on practically any `systemd`-based distro. + +Before proceeding please ensure that both `NetworkManager` and `firewalld` are installed and running: + +```shell +$ sudo systemctl check NetworkManager +active + +$ sudo systemctl check firewalld +active +``` + +Download the binary: + +TODO + +Ensure the binary is executable: + +`$ chmod +x dynafire` + +Copy the binary to your `$PATH`: + +`$ sudo cp dynafire /usr/bin/` + + +Next, download the `systemd` service definition file: + +TODO + +Building from source +- + +TODO + +Configuration +- + +The `dynafire` configuration file is created upon first launch under `/etc/dynafire/config.json`. +By default, it has the following values: + +```json +{ + "log_level": "INFO", + "zone_target_policy": "ACCEPT" +} +``` + +The `log_level` can be set to `DEBUG` (most verbose), `INFO` and `ERROR` (least verbose). + +By default, the `dynafire` firewalld zone is set to `ACCEPT` every packet that is NOT on the Turris Sentinel blacklist, so as not to accidentally block legitimate traffic. +However, you can make this stricter by changing the `zone_target_policy` to i.e. `REJECT` or `DROP`, see [firewalld zone options](https://firewalld.org/documentation/zone/options.html) for details. + +Contributing +- +Bug reports and pull requests are welcome. Do not hesitate to open a PR / file an issue or a feature request. diff --git a/cmd/dynafire/main.go b/cmd/dynafire/main.go new file mode 100644 index 0000000..31af7d8 --- /dev/null +++ b/cmd/dynafire/main.go @@ -0,0 +1,99 @@ +package main + +import ( + "context" + "fmt" + "log/slog" + "os" + "sync" + + "github.com/MatejLach/dynafire/firewall/firewalld" + "github.com/MatejLach/dynafire/provider/turris" +) + +func main() { + slog.SetDefault(slog.New(slog.NewTextHandler(os.Stderr, nil))) + + fwc, err := firewalld.New() + if err != nil { + slog.Error("Initialization failed; host system pre-requisites not met", "details", err) + os.Exit(1) + } + + tc, err := turris.NewClient(turris.Url, turris.Port) + if err != nil { + slog.Error("Unable to initialize Turris dynafire client", "details", err) + os.Exit(1) + } + + err = tc.Connect() + if err != nil { + slog.Error("Unable to connect to Turris firewall update server", "details", err) + os.Exit(1) + } + + wg := sync.WaitGroup{} + sem := make(chan struct{}, 1) + + wg.Add(1) + go func() { + defer wg.Done() + tc.RequestMessages(context.Background()) + }() + + wg.Add(1) + go func() { + defer wg.Done() + for listMsg := range tc.ListChan { + slog.Info(fmt.Sprintf("adding %d IPs to the blacklist", len(listMsg.Blacklist))) + sem <- struct{}{} + + err = fwc.ResetFirewallRules() + if err != nil { + slog.Error("unable to clear old IP blacklist", "details", err) + os.Exit(1) + } + + err = fwc.BlockIPList(listMsg.Blacklist) + if err != nil { + slog.Error("unable to initialize IP blacklist", "details", err) + os.Exit(1) + } + slog.Info("Starting to process delta updates...") + <-sem + } + }() + + wg.Add(1) + go func() { + defer wg.Done() + + for deltaMsg := range tc.DeltaChan { + sem <- struct{}{} + + // 'positive' operation adds an IP to the blacklist + // 'negative' removes an existing IP from the blacklist + switch deltaMsg.Operation { + case "positive": + err = fwc.BlockIP(deltaMsg.IP) + if err != nil { + slog.Error("unable to blacklist IP", "details", err) + os.Exit(1) + } + + slog.Debug("blacklisting", "IP", deltaMsg.IP.String()) + case "negative": + err = fwc.UnblockIP(deltaMsg.IP) + if err != nil { + slog.Error("unable to whitelist IP", "details", err) + os.Exit(1) + } + + slog.Debug("whitelisting", "IP", deltaMsg.IP.String()) + } + <-sem + } + }() + + wg.Wait() +} diff --git a/dist/systemd/dynafire.service b/dist/systemd/dynafire.service new file mode 100644 index 0000000..c8dd635 --- /dev/null +++ b/dist/systemd/dynafire.service @@ -0,0 +1,14 @@ +[Unit] +Description=dynafire - real-time threat detection for any Linux system +After=network.target + +[Install] +WantedBy=multi-user.target + +[Service] +User=root +Type=simple +ExecStart="/usr/bin/dynafire" +TimeoutStopSec=20 +KillMode=process +Restart=on-failure diff --git a/firewall/blocker.go b/firewall/blocker.go new file mode 100644 index 0000000..1d7ce39 --- /dev/null +++ b/firewall/blocker.go @@ -0,0 +1,10 @@ +package firewall + +import "net" + +type Blocker interface { + BlockIP(address net.IP) error + BlockIPList(blacklist []net.IP) error + UnblockIP(address net.IP) error + ResetFirewallRules() error +} diff --git a/firewall/firewalld/config.go b/firewall/firewalld/config.go new file mode 100644 index 0000000..0e1299e --- /dev/null +++ b/firewall/firewalld/config.go @@ -0,0 +1,79 @@ +package firewalld + +import ( + "encoding/json" + "log/slog" + "os" + "strings" +) + +type Config struct { + LogLevel string `json:"log_level"` + ZoneTargetPolicy string `json:"zone_target_policy"` +} + +func initConfig() { + slog.Info("No config.json found, creating new config...") + config := Config{ + LogLevel: "INFO", + ZoneTargetPolicy: "ACCEPT", + } + + jsonBytes, err := json.MarshalIndent(config, "", " ") + if err != nil { + slog.Error("unable to parse config file", "details", err) + os.Exit(1) + } + + err = os.MkdirAll("/etc/dynafire", 0775) + if err != nil { + slog.Error("unable to make config directory", "details", err) + os.Exit(1) + } + + err = os.WriteFile("/etc/dynafire/config.json", jsonBytes, 0775) + if err != nil { + slog.Error("unable to save default config file", "details", err) + os.Exit(1) + } + + slog.Info("New config.json created, feel free to modify the defaults, then restart for your changes to take effect.") +} + +func parseConfig() (Config, error) { + var config Config + cfgData, err := os.ReadFile("/etc/dynafire/config.json") + if err != nil { + return Config{}, err + } + + err = json.Unmarshal(cfgData, &config) + if err != nil { + return Config{}, err + } + + slog.SetDefault(slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{Level: parseLogLevel(config.LogLevel)}))) + + return config, nil +} + +func configExists() bool { + if _, err := os.Stat("/etc/dynafire/config.json"); os.IsNotExist(err) { + return false + } + + return true +} + +func parseLogLevel(level string) slog.Level { + switch strings.ToUpper(level) { + case "DEBUG": + return slog.LevelDebug + case "INFO": + return slog.LevelInfo + case "ERROR": + return slog.LevelError + default: + return slog.LevelInfo + } +} diff --git a/firewall/firewalld/firewalld.go b/firewall/firewalld/firewalld.go new file mode 100644 index 0000000..3605c2f --- /dev/null +++ b/firewall/firewalld/firewalld.go @@ -0,0 +1,505 @@ +package firewalld + +import ( + "errors" + "fmt" + "log/slog" + "net" + "os" + "os/exec" + "strings" + "text/template" +) + +const ( + existingRulesZoneFilePath = "/etc/firewalld/zones/dynafire.xml" + oldRulesZoneFilePath = "/etc/firewalld/zones/dynafire.xml.old" + richRuleTemplate = ` + +{{ range . }} + + + <{{.Rule}}/> + +{{ end }} + +` +) + +type FirewallCmd struct { + Config Config + rules []RichRule +} + +type RichRule struct { + IPFamily string + IP net.IP + Rule string +} + +func New() (*FirewallCmd, error) { + // init config + if !configExists() { + initConfig() + } + + conf, err := parseConfig() + if err != nil { + return nil, err + } + + cmd := &FirewallCmd{ + Config: conf, + rules: make([]RichRule, 0), + } + + // check host requirements + ok, err := cmd.hostNetworkManagerRunning() + if err != nil { + return nil, err + } + + if !ok { + return nil, errors.New("please ensure NetworkManager is installed and running before continuing") + } + + ok, err = cmd.hostFirewalldRunning() + if err != nil { + return nil, err + } + + if !ok { + return nil, errors.New("please ensure firewalld is installed and running before continuing") + } + + ok, err = cmd.hostHasRequiredZone() + if err != nil { + return nil, err + } + + if !ok { + err = cmd.createRequiredZoneOnHost() + if err != nil { + return nil, err + } + } + + ok, err = cmd.isHostDefaultZoneDynafire() + if err != nil { + return nil, err + } + + if !ok { + err = cmd.saveAndReloadConfig() + if err != nil { + return nil, err + } + + err = cmd.setHostDefaultZone() + if err != nil { + return nil, err + } + } + + err = cmd.saveAndReloadConfig() + if err != nil { + return nil, err + } + + err = cmd.checkConfig() + if err != nil { + return nil, err + } + + return cmd, nil +} + +func (fwc *FirewallCmd) hostNetworkManagerRunning() (bool, error) { + cmd := exec.Command("systemctl", "check", "NetworkManager") + out, err := cmd.CombinedOutput() + if err != nil { + if strings.TrimSpace(string(out)) != "inactive" { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("checking NetworkManager service status did not complete successfully", "command", "systemctl check NetworkManager", "error", exErr) + } else { + slog.Error("could not run systemctl to check NetworkManager service status", "error", err) + } + + return false, err + } + } + + if strings.TrimSpace(string(out)) == "active" { + return true, nil + } + + return false, nil +} + +func (fwc *FirewallCmd) hostFirewalldRunning() (bool, error) { + cmd := exec.Command("systemctl", "check", "firewalld") + out, err := cmd.CombinedOutput() + if err != nil { + if strings.TrimSpace(string(out)) != "inactive" { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("checking firewalld service status did not complete successfully", "command", "systemctl check firewalld", "error", exErr) + } else { + slog.Error("could not run systemctl to check firewalld service status", "error", err) + } + + return false, err + } + } + + if strings.TrimSpace(string(out)) == "active" { + return true, nil + } + + return false, nil +} + +func (fwc *FirewallCmd) hostHasRequiredZone() (bool, error) { + cmd := exec.Command("firewall-cmd", "--get-zones") + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("checking existing firewalld zones did not complete successfully", "command", "firewall-cmd --get-zones", "error", exErr) + } else { + slog.Error("could not run `firewall-cmd --get-zones` to check existing firewalld zones", "error", err) + } + + return false, err + } + + zones := strings.Split(strings.TrimSpace(string(out)), " ") + for _, zone := range zones { + if zone == "dynafire" { + return true, nil + } + } + + return false, nil +} + +func (fwc *FirewallCmd) createRequiredZoneOnHost() error { + cmd := exec.Command("firewall-cmd", "--permanent", "--new-zone=dynafire") + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("creating the 'dynafire' firewalld zone did not complete successfully", "command", "firewall-cmd --permanent --new-zone=dynafire", "error", exErr) + } else { + slog.Error("could not run `firewall-cmd --permanent --new-zone=dynafire` to create new 'dynafire' firewalld zone", "error", err) + } + + return nil + } + + if strings.TrimSpace(string(out)) != "success" { + return fmt.Errorf("unexpected output while creating new 'dynafire' firewalld zone; expected 'success' but got %s", strings.TrimSpace(string(out))) + } + + return nil +} + +func (fwc *FirewallCmd) reloadHostFirewalldConfig() error { + cmd := exec.Command("firewall-cmd", "--reload") + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("reloading firewalld", "command", "firewall-cmd --reload", "error", exErr) + } else { + slog.Error("could not run `firewall-cmd --reload` to reload firewalld configuration", "error", err) + } + + return nil + } + + if strings.TrimSpace(string(out)) != "success" { + return fmt.Errorf("unexpected output while reloading firewalld; expected 'success' but got %s", strings.TrimSpace(string(out))) + } + + return nil +} + +func (fwc *FirewallCmd) ResetFirewallRules() error { + // clear any rules that have been saved to permanent config + // there may be many, so deleting the zone config file itself is much faster than via firewall-cmd + if _, err := os.Stat(existingRulesZoneFilePath); err == nil { + err = os.Remove(existingRulesZoneFilePath) + if err != nil { + return err + } + } else if !errors.Is(err, os.ErrNotExist) { + return err + } + + if _, err := os.Stat(oldRulesZoneFilePath); err == nil { + err = os.Remove(oldRulesZoneFilePath) + if err != nil { + return err + } + } else if !errors.Is(err, os.ErrNotExist) { + return err + } + + err := fwc.reloadHostFirewalldConfig() + if err != nil { + return err + } + + return nil +} + +func (fwc *FirewallCmd) saveAndReloadConfig() error { + err := fwc.saveHostRuntimeFirewalldConfig() + if err != nil { + return err + } + + err = fwc.reloadHostFirewalldConfig() + if err != nil { + return err + } + + return nil +} + +func (fwc *FirewallCmd) saveHostRuntimeFirewalldConfig() error { + cmd := exec.Command("firewall-cmd", "--runtime-to-permanent") + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("saving runtime firewalld configuration as permanent did not complete successfully", "command", "firewall-cmd --runtime-to-permanent", "error", exErr) + } else { + slog.Error("could not run `firewall-cmd --runtime-to-permanent` to save runtime firewalld configuration", "error", err) + } + + return nil + } + + if strings.TrimSpace(string(out)) != "success" { + return fmt.Errorf("unexpected output while saving runtime firewalld configuration as permanent; expected 'success' but got %s", strings.TrimSpace(string(out))) + } + + return nil +} + +func (fwc *FirewallCmd) isHostDefaultZoneDynafire() (bool, error) { + cmd := exec.Command("firewall-cmd", "--get-default-zone") + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("listing firewalld default zone", "command", "firewall-cmd --get-default-zone", "error", exErr) + } else { + slog.Error("could not run `firewall-cmd --get-default-zone` to list firewalld default zone", "error", err) + } + + return false, nil + } + + if strings.TrimSpace(string(out)) == "dynafire" { + return true, nil + } + + return false, nil +} + +func (fwc *FirewallCmd) setHostDefaultZone() error { + cmd := exec.Command("firewall-cmd", "--set-default-zone=dynafire") + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("setting firewalld default zone", "command", "firewall-cmd --set-default-zone=dynafire", "error", exErr) + } else { + slog.Error("could not run `firewall-cmd --set-default-zone=dynafire` to set firewalld default zone", "error", err) + } + + return nil + } + + if strings.TrimSpace(string(out)) != "success" { + return fmt.Errorf("setting firewalld default zone; unexpected output: %s", strings.TrimSpace(string(out))) + } + + return nil +} + +func (fwc *FirewallCmd) setHostDefaultZonePolicy(policy string) error { + switch strings.ToUpper(policy) { + case "REJECT", "DROP", "ACCEPT": + break + default: + return errors.New("unknown firewalld target policy") + } + + cmd := exec.Command("firewall-cmd", "--permanent", "--zone=dynafire", fmt.Sprintf("--set-target=%s", policy)) + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("setting firewalld default zone traffic acceptance policy", "command", "firewall-cmd --permanent --zone=dynafire --set-target=ACCEPT", "error", exErr) + } else { + slog.Error("could not run `firewall-cmd --permanent --zone=dynafire --set-target=ACCEPT` to set firewalld default zone traffic acceptance policy", "error", err) + } + + return nil + } + + if strings.TrimSpace(string(out)) != "success" { + return fmt.Errorf("setting firewalld default zone traffic acceptance policy; unexpected output: %s", strings.TrimSpace(string(out))) + } + + err = fwc.reloadHostFirewalldConfig() + if err != nil { + return err + } + + return nil +} + +func (fwc *FirewallCmd) ruleExists(address net.IP) bool { + var ruleStr string + if address.To4() != nil { + ruleStr = fmt.Sprintf("rule family=ipv4 source address=%s drop", address.String()) + } else { + ruleStr = fmt.Sprintf("rule family=ipv6 source address=%s drop", address.String()) + } + + cmd := exec.Command("firewall-cmd", "--zone=dynafire", "--query-rich-rule", ruleStr) + + // ignoring the error here as it is sometimes non-zero but still gives the output we want + out, _ := cmd.CombinedOutput() + if strings.TrimSpace(string(out)) == "yes" { + return true + } + + return false +} + +func (fwc *FirewallCmd) BlockIP(address net.IP) error { + var ruleStr string + if address.To4() != nil { + ruleStr = fmt.Sprintf("rule family=ipv4 source address=%s drop", address.String()) + } else { + ruleStr = fmt.Sprintf("rule family=ipv6 source address=%s drop", address.String()) + } + + if fwc.ruleExists(address) { + slog.Debug("skipping adding existing rule", "rule", ruleStr) + return nil + } + + cmd := exec.Command("firewall-cmd", "--zone=dynafire", "--add-rich-rule", ruleStr) + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("adding firewalld rich rule to block an IP", "command", fmt.Sprintf("firewall-cmd --zone=dynafire --add-rich-rule %s to blacklist an IP", ruleStr), "error", exErr) + } else { + slog.Error(fmt.Sprintf("could not run `firewall-cmd --zone=dynafire --add-rich-rule %s` to blacklist an IP", ruleStr), "error", err) + } + + return nil + } + + if strings.TrimSpace(string(out)) != "success" { + return fmt.Errorf("unexpected output while adding a firewalld rich rule to blacklist an IP; expected 'success' but got %s", strings.TrimSpace(string(out))) + } + + return nil +} + +func (fwc *FirewallCmd) BlockIPList(blacklist []net.IP) error { + // For speed reasons, write out a new zone.xml rules file rather than using firewall-cmd + zoneConfigFile, err := os.OpenFile(existingRulesZoneFilePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) + if err != nil { + return err + } + + for _, ip := range blacklist { + var ipFamily string + if ip.To4() != nil { + ipFamily = "ipv4" + } else { + ipFamily = "ipv6" + } + + fwc.rules = append(fwc.rules, RichRule{ + IPFamily: ipFamily, + IP: ip, + Rule: "drop", + }) + } + + tmpl, err := template.New("dynafire.xml").Parse(richRuleTemplate) + if err != nil { + return err + } + + err = tmpl.Execute(zoneConfigFile, fwc.rules) + if err != nil { + return err + } + + err = fwc.reloadHostFirewalldConfig() + if err != nil { + return err + } + + err = fwc.setHostDefaultZonePolicy(strings.ToUpper(fwc.Config.ZoneTargetPolicy)) + if err != nil { + return err + } + + return nil +} + +func (fwc *FirewallCmd) UnblockIP(address net.IP) error { + var ruleStr string + if address.To4() != nil { + ruleStr = fmt.Sprintf("rule family=ipv4 source address=%s drop", address.String()) + } else { + ruleStr = fmt.Sprintf("rule family=ipv6 source address=%s drop", address.String()) + } + + if !fwc.ruleExists(address) { + slog.Debug("skipping removing non-existent rule", "rule", ruleStr) + return nil + } + + cmd := exec.Command("firewall-cmd", "--zone=dynafire", "--remove-rich-rule", ruleStr) + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("removing firewalld rich rule to whitelist an IP", "command", fmt.Sprintf("firewall-cmd --zone=dynafire --remove-rich-rule %s to block an IP", ruleStr), "error", exErr) + } else { + slog.Error(fmt.Sprintf("could not run `firewall-cmd --zone=dynafire --remove-rich-rule %s` to whitelist an IP", ruleStr), "error", err) + } + + return nil + } + + if strings.TrimSpace(string(out)) != "success" { + return fmt.Errorf("unexpected output while removing a firewalld rich rule to whitelist an IP; expected 'success' but got %s", strings.TrimSpace(string(out))) + } + + return nil +} + +func (fwc *FirewallCmd) checkConfig() error { + cmd := exec.Command("firewall-cmd", "--check-config") + out, err := cmd.CombinedOutput() + if err != nil { + if exErr, ok := err.(*exec.ExitError); ok { + slog.Error("checking firewalld configuration", "command", "firewall-cmd --check-config'`", "error", exErr) + } else { + slog.Error("could not run `firewall-cmd --check-config'`", "error", err) + } + + return nil + } + + if strings.TrimSpace(string(out)) != "success" { + return fmt.Errorf("unexpected output while checking firewalld configuration; expected 'success' but got %s", strings.TrimSpace(string(out))) + } + + return nil +} diff --git a/firewall/netfaces.go b/firewall/netfaces.go new file mode 100644 index 0000000..479433f --- /dev/null +++ b/firewall/netfaces.go @@ -0,0 +1,42 @@ +package firewall + +import "net" + +type NetInterface struct { + Name string + Addresses []string +} + +// TODO: Add config option to bind to a specific network interface +func ListNetInterfaces() ([]NetInterface, error) { + interfaces, err := net.Interfaces() + if err != nil { + return nil, err + } + + result := make([]NetInterface, 0) + for _, netface := range interfaces { + addrs, err := netface.Addrs() + if err != nil { + return nil, err + } + + if len(addrs) == 0 { + continue + } + + addresses := make([]string, 0) + for _, addr := range addrs { + addresses = append(addresses, addr.String()) + } + + netf := NetInterface{ + Name: netface.Name, + Addresses: addresses, + } + + result = append(result, netf) + } + + return result, err +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..88c63da --- /dev/null +++ b/go.mod @@ -0,0 +1,10 @@ +module github.com/MatejLach/dynafire + +go 1.21 + +require ( + github.com/pebbe/zmq4 v1.2.9 + github.com/vmihailenco/msgpack/v5 v5.3.5 +) + +require github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..5d2eb28 --- /dev/null +++ b/go.sum @@ -0,0 +1,16 @@ +github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/pebbe/zmq4 v1.2.9 h1:JlHcdgq6zpppNR1tH0wXJq0XK03pRUc4lBlHTD7aj/4= +github.com/pebbe/zmq4 v1.2.9/go.mod h1:nqnPueOapVhE2wItZ0uOErngczsJdLOGkebMxaO8r48= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= +github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/vmihailenco/msgpack/v5 v5.3.5 h1:5gO0H1iULLWGhs2H5tbAHIZTV8/cYafcFOr9znI5mJU= +github.com/vmihailenco/msgpack/v5 v5.3.5/go.mod h1:7xyJ9e+0+9SaZT0Wt1RGleJXzli6Q/V5KbhBonMG9jc= +github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g= +github.com/vmihailenco/tagparser/v2 v2.0.0/go.mod h1:Wri+At7QHww0WTrCBeu4J6bNtoV6mEfg5OIWRZA9qds= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/provider/turris/delta.go b/provider/turris/delta.go new file mode 100644 index 0000000..05fa5ce --- /dev/null +++ b/provider/turris/delta.go @@ -0,0 +1,50 @@ +package turris + +import ( + "bytes" + "errors" + "fmt" + "net" + "time" + + "github.com/vmihailenco/msgpack/v5" +) + +type Delta struct { + Operation string + IP net.IP + Serial uint32 + Timestamp time.Time +} + +var deltaMapExpectedKeys = []string{ + "delta", "ip", "serial", "ts", +} + +func (c *Client) decodeDelta(rawMsg []byte) (Delta, error) { + buf := bytes.NewReader(rawMsg) + d := msgpack.NewDecoder(buf) + + rawMap, err := d.DecodeMap() + if err != nil { + return Delta{}, fmt.Errorf("unable to decode delta message: %w", err) + } + + for _, key := range deltaMapExpectedKeys { + if _, ok := rawMap[key]; !ok { + return Delta{}, errors.New("malformed delta message") + } + } + + operation := rawMap["delta"].(string) + ip := rawMap["ip"].(string) + serial := rawMap["serial"].(uint32) + ts := rawMap["ts"].(uint32) + + return Delta{ + Operation: operation, + IP: net.ParseIP(ip), + Serial: serial, + Timestamp: time.Unix(int64(ts), 0), + }, nil +} diff --git a/provider/turris/list.go b/provider/turris/list.go new file mode 100644 index 0000000..e2304a7 --- /dev/null +++ b/provider/turris/list.go @@ -0,0 +1,57 @@ +package turris + +import ( + "bytes" + "errors" + "fmt" + "net" + "time" + + "github.com/vmihailenco/msgpack/v5" +) + +type List struct { + Version time.Time + Serial uint32 + Blacklist []net.IP + Timestamp time.Time +} + +var listMapExpectedKeys = []string{ + "ts", "version", "serial", "list", +} + +func (c *Client) decodeList(rawMsg []byte) (List, error) { + buf := bytes.NewReader(rawMsg) + d := msgpack.NewDecoder(buf) + blacklist := make([]net.IP, 0) + + rawMap, err := d.DecodeMap() + if err != nil { + return List{}, fmt.Errorf("unable to decode list message: %w", err) + } + + for _, key := range listMapExpectedKeys { + if _, ok := rawMap[key]; !ok { + return List{}, errors.New("malformed list message") + } + } + + version := rawMap["version"].(uint32) + serial := rawMap["serial"].(uint32) + rawBlocklist := rawMap["list"].([]interface{}) + ts := rawMap["ts"].(uint32) + + for _, ip := range rawBlocklist { + if ipStr, ok := ip.(string); ok { + blacklist = append(blacklist, net.ParseIP(ipStr)) + } + } + + return List{ + Version: time.Unix(int64(version), 0), + Serial: serial, + Blacklist: blacklist, + Timestamp: time.Unix(int64(ts), 0), + }, nil +} diff --git a/provider/turris/turris.go b/provider/turris/turris.go new file mode 100644 index 0000000..3f44c6d --- /dev/null +++ b/provider/turris/turris.go @@ -0,0 +1,211 @@ +package turris + +import ( + "bytes" + "context" + "errors" + "fmt" + "io" + "log/slog" + "net/http" + + zmq "github.com/pebbe/zmq4" +) + +const ( + Url = "sentinel.turris.cz" + Port = 7087 + CertUrl = "https://repo.turris.cz/sentinel/dynfw.pub" +) + +type Client struct { + zmqClient *zmq.Socket + zmqClientPrivateKey string + zmqClientPublicKey string + zmqServerPublicKey string + zmqServerUrl string + zmqServerPort int + ListChan chan List + DeltaChan chan Delta +} + +func NewClient(zmqServerUrl string, zmqServerPort int) (*Client, error) { + zmqCtx, err := zmq.NewContext() + if err != nil { + return nil, err + } + + zmqClient, err := zmqCtx.NewSocket(zmq.SUB) + if err != nil { + return nil, err + } + + zmqServerPubKey, err := getServerPubKey(CertUrl) + if err != nil { + return nil, err + } + + zmqClientPubKey, zmqClientPrivateKey, err := zmq.NewCurveKeypair() + if err != nil { + return nil, err + } + + err = zmqClient.SetSubscribe("dynfw/") + if err != nil { + return nil, err + } + + return &Client{ + zmqClient: zmqClient, + zmqClientPrivateKey: zmqClientPrivateKey, + zmqClientPublicKey: zmqClientPubKey, + zmqServerPublicKey: zmqServerPubKey, + zmqServerUrl: zmqServerUrl, + zmqServerPort: zmqServerPort, + ListChan: make(chan List), + DeltaChan: make(chan Delta), + }, nil +} + +// Close is called automatically when you cancel the context passed in to RequestMessages +// Manual invocation of Close should be done only If you passed in context.Background() +func (c *Client) Close() { + if c.zmqClient == nil { + slog.Warn("ZMQ client not initialised, nothing to close") + } + + err := c.zmqClient.SetUnsubscribe("dynfw/") + if err != nil { + slog.Error("unable to unsubscribe from Turris dynfw/ topic", "details", err) + } + + err = c.zmqClient.Close() + if err != nil { + slog.Error("unable to close ZMQ client", "details", err) + } + + close(c.DeltaChan) + close(c.ListChan) +} + +func (c *Client) Connect() error { + err := c.zmqClient.ClientAuthCurve(c.zmqServerPublicKey, c.zmqClientPublicKey, c.zmqClientPrivateKey) + if err != nil { + return err + } + + err = c.zmqClient.Connect(fmt.Sprintf("tcp://%s:%d", c.zmqServerUrl, c.zmqServerPort)) + if err != nil { + return err + } + + recvTestMsg, err := c.zmqClient.RecvMessageBytes(0) + if err != nil { + return fmt.Errorf("failed to verify connection, failed to receive dynfw/ test message: %w", err) + } + + if len(recvTestMsg) == 0 { + return errors.New("failed to verify connection, dynfw/ test message has no data") + } + + return nil +} + +func (c *Client) RequestMessages(ctx context.Context) { + var previousDeltaSerial uint32 + refreshList := true // upon launch, initialize the list + + for { + payloadB, err := c.zmqClient.RecvMessageBytes(0) + if err != nil { + slog.Error("unable to receive dynfw message", "details", err) + return + } + + if len(payloadB) != 2 { + slog.Error("malformed dynfw message") + return + } + + switch string(payloadB[0]) { + case "dynfw/event": + continue + case "dynfw/delta": + if refreshList { + continue + } + + dRes, err := c.decodeDelta(payloadB[1]) + if err != nil { + slog.Warn("unable to decode delta message", "details", err) + continue + } + + if !serialOk(previousDeltaSerial, dRes.Serial) { + refreshList = true + previousDeltaSerial = 0 + } + + previousDeltaSerial = dRes.Serial + c.DeltaChan <- dRes + case "dynfw/list": + if refreshList { + lRes, err := c.decodeList(payloadB[1]) + if err != nil { + slog.Warn("unable to decode list message", "details", err) + continue + } + + refreshList = false + c.ListChan <- lRes + } else { + continue + } + } + + select { + case <-ctx.Done(): + c.Close() + return + default: + continue + } + } +} + +func serialOk(oldSerial, currentSerial uint32) bool { + if (oldSerial+1 == currentSerial) || oldSerial == 0 { + return true + } + + return false +} + +func getServerPubKey(certDlUri string) (string, error) { + resp, err := http.Get(certDlUri) + defer func(resp *http.Response) { + if resp == nil { + return + } + + err := resp.Body.Close() + if err != nil { + slog.Error("unable to close HTTP response body", "details", err) + return + } + }(resp) + + if err != nil { + return "", err + } + + certB, err := io.ReadAll(resp.Body) + if err != nil { + return "", err + } + + keyStartIdx := bytes.IndexByte(certB, '"') + keyEndIdx := bytes.LastIndexByte(certB, '"') + + return string(certB[keyStartIdx+1 : keyEndIdx]), nil +}