commit ac36b0c5916ffdebae39d13d03a11298cbf7ef20 Author: Ruel Tmeizeh - RuhNet Date: Sun Jul 14 14:58:31 2024 -0400 Initial Commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5065b0a --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +kazoo_firewall_agent_config.json +kazoo_firewall_agent +*.swp + + + 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/amqp.go b/amqp.go new file mode 100644 index 0000000..8035e06 --- /dev/null +++ b/amqp.go @@ -0,0 +1,257 @@ +package main + +import ( + "encoding/json" + "errors" + "fmt" + "log" + "os" + "os/signal" + "strings" + "syscall" + "time" + + "github.com/google/uuid" + rabbitmq "github.com/wagslane/go-rabbitmq" +) + +var publisher *rabbitmq.Publisher +var consumer *rabbitmq.Consumer + +var msgCatFilters []string +var msgNameFilters []string +var msgAppNameFilters []string + +type KzMessage struct { + MsgId string `json:"Msg-ID"` + AppName string `json:"App-Name"` //call_shield + AppVersion string `json:"App-Version"` //4.0.0 + EventName string `json:"Event-Name"` //request + EventCategory string `json:"Event-Category"` //firewall_add firewall_remove + ServerId string `json:"Server-ID"` + Server string `json:"Server,omitempty"` + IP string `json:"IP-Address,omitempty"` //e.g. 1.2.3.4 + Ports interface{} `json:"Ports,omitempty"` //e.g. sip http https 8443 [25,8443/tcp,53/udp,8080] + Node string `json:"Node,omitempty"` + //Node string `json:"Freeswitch-Node"` //freeswitch@server.com +} + +func handleAmqpMsg(d rabbitmq.Delivery) rabbitmq.Action { + logit(6, "RoutingKey: "+string(d.RoutingKey)) + logit(6, "AMQP message received: "+string(d.Body)) + + var msg KzMessage + err := json.Unmarshal(d.Body, &msg) + if err != nil { + log.Println("handleAmqpMsg(): Error unmarshalling AMQP message into map[string]interface{}...discarding. Message body: " + string(d.Body) + "\nUnmarshalling error: " + err.Error()) + return rabbitmq.NackDiscard + } + + for _, appname := range msgAppNameFilters { + if appconf.FilterEvtAppName == "*" || appname == msg.AppName { //only act if message matches a filter, OR if the filter is "*" + for _, cat := range msgCatFilters { + if appconf.FilterEvtCat == "*" || cat == msg.EventCategory { + for _, name := range msgNameFilters { + if appconf.FilterEvtName == "*" || name == msg.EventName { + firewall(msg.EventCategory, msg.IP, msg.Ports) + break + } + } + break + } + } + break + } + } + + /* + err := kazooPublish(ta.Domain, input.Data.ChallengeText, "request") + if err != nil { + log.Println(err.Error()) + return c.JSON(errorOut(http.StatusInternalServerError, "Error publishing message."+err.Error())) + } + */ + + return rabbitmq.Ack +} + +func kazooPublish(challenge, event string) error { + msg := KzMessage{ + MsgId: uuid.New().String(), + AppName: appname, + AppVersion: version, + EventCategory: "firewall_" + event, + EventName: "request", //"request" or "delete" + ServerId: appname + "@" + myHostname, + Server: myHostname, + Node: "freeswitch@" + myHostname, + } + + msg_json, err := json.Marshal(msg) + if err != nil { + return err + } + + err = publisher.Publish(msg_json, + []string{appconf.AmqpPubRoutingKey}, + rabbitmq.WithPublishOptionsContentType("application/json"), + rabbitmq.WithPublishOptionsExchange(appconf.AmqpPubExch), + ) + return errors.New("Error publishing to exchange '" + appconf.AmqpPubExch + "' with routing key '" + appconf.AmqpPubRoutingKey + "': \n" + string(msg_json) + " ERROR: " + err.Error()) +} + +func amqp() { + if appconf.AmqpDirectRoutingKey == "" { + appconf.AmqpDirectRoutingKey = "call_shield." + myHostname + ".*.*" + } + if appconf.AmqpSubRoutingKey == "" { + appconf.AmqpSubRoutingKey = "call_shield." + appconf.ServerType + ".firewall.*" + } + if appconf.AmqpSubExch == "" { + appconf.AmqpSubExch = appconf.AmqpExch + } + if appconf.AmqpPubExch == "" { + appconf.AmqpPubExch = appconf.AmqpExch + } + + ///////////////////////////////////////////// + // RabbitMQ Setup Connection + log.Println("Connecting to RabbitMQ: " + appconf.AmqpURI) + amqpConn, err := rabbitmq.NewConn( + appconf.AmqpURI, + rabbitmq.WithConnectionOptionsLogging, + ) + if err != nil { + fmt.Println("Unable to initialize RabbitMQ connection: " + err.Error()) + log.Fatal("Unable to initialize RabbitMQ connection: " + err.Error()) + } + defer amqpConn.Close() + + ///////////////////////////////////////////// + // Message Filters + msgCatFilters = strings.Split(appconf.FilterEvtCat, ",") + msgNameFilters = strings.Split(appconf.FilterEvtName, ",") + msgAppNameFilters = strings.Split(appconf.FilterEvtAppName, ",") + if (len(msgCatFilters) > 0 && len(msgNameFilters) > 0 && len(msgAppNameFilters) > 0) && (msgCatFilters[0] != "*" || msgNameFilters[0] != "*" || msgAppNameFilters[0] != "*") { + fmt.Println("Filtering event app names matching:", msgAppNameFilters) + fmt.Println("Filtering event categories matching:", msgCatFilters) + fmt.Println("Filtering event names matching:", msgNameFilters) + } + + ///////////////////////////////////////////// + // RabbitMQ Setup Publisher + publisher, err = rabbitmq.NewPublisher( + amqpConn, + rabbitmq.WithPublisherOptionsLogging, + rabbitmq.WithPublisherOptionsExchangeKind(appconf.AmqpExchType), + rabbitmq.WithPublisherOptionsExchangeName(appconf.AmqpPubExch), + rabbitmq.WithPublisherOptionsExchangeDeclare, + ) + if err != nil { + fmt.Println("Unable to initialize RabbitMQ publisher: " + err.Error()) + log.Fatal("Unable to initialize RabbitMQ publisher: " + err.Error()) + } + defer publisher.Close() + + logit(7, "Publisher configured on '"+appconf.AmqpExchType+"' exchange: '"+appconf.AmqpPubExch+"' with routing key: '"+appconf.AmqpPubRoutingKey+"'.") + + publisher.NotifyReturn(func(r rabbitmq.Return) { + logit(4, fmt.Sprintf("RabbitMQ published message returned from server: %s\n", string(r.Body))) + }) + publisher.NotifyPublish(func(c rabbitmq.Confirmation) { + logit(7, fmt.Sprintf("Message confirmed from RabbitMQ server. tag: %v, ack: %v\n", c.DeliveryTag, c.Ack)) + }) + + go publisher_loop() + + ///////////////////////////////////////////// + // RabbitMQ Setup Consumer + consumer, err = rabbitmq.NewConsumer( + amqpConn, + "q_"+appname+"_"+myHostname, + rabbitmq.WithConsumerOptionsExchangeName(appconf.AmqpSubExch), + rabbitmq.WithConsumerOptionsExchangeKind(appconf.AmqpExchType), + rabbitmq.WithConsumerOptionsRoutingKey(appconf.AmqpSubRoutingKey), + rabbitmq.WithConsumerOptionsRoutingKey(appconf.AmqpDirectRoutingKey), + rabbitmq.WithConsumerOptionsConsumerName("consumer_"+appname+"_"+myHostname), + rabbitmq.WithConsumerOptionsQueueAutoDelete, + rabbitmq.WithConsumerOptionsConcurrency(appconf.AmqpWorkers), + rabbitmq.WithConsumerOptionsExchangeDeclare, + //rabbitmq.WithConsumerOptionsQuorum, + //rabbitmq.WithConsumerOptionsQueueDurable, + //rabbitmq.WithConsumerOptionsBindingExchangeDurable, + ) + if err != nil { + fmt.Println("Unable to initialize RabbitMQ consumer: " + err.Error()) + log.Fatal("Unable to initialize RabbitMQ consumer: " + err.Error()) + } + defer consumer.Close() + + logit(6, "Consuming on '"+appconf.AmqpExchType+"' exchange: '"+appconf.AmqpSubExch+"' with routing key: '"+appconf.AmqpSubRoutingKey+"' using queue: 'q_"+appname+"_"+myHostname+"'.") + + //logit(6, "Using "+fmt.Sprintf("%d", appconf.AmqpWorkers)+" concurrent workers to process inbound AMQP messages.") + + log.Println(appnameFull + " system started.\n-----> [READY]") + fmt.Println(appnameFull + " system started.\n-----> [READY]") + + // block main thread + err = consumer.Run(handleAmqpMsg) //this is the function that we want to call to consume presence messages + if err != nil { + fmt.Println("Unable to start/run RabbitMQ consumer: " + err.Error()) + log.Fatal("Unable to start/run RabbitMQ consumer: " + err.Error()) + } + +} + +func publisher_loop() { + ///////////////////////////////////////////// + // RabbitMQ Publish Test + sigch := make(chan os.Signal, 1) + signal.Notify(sigch, syscall.SIGUSR1, syscall.SIGUSR2) + + //create test message to send + pubtest := KzMessage{ + MsgId: uuid.New().String(), + AppName: appname, + AppVersion: version, + EventCategory: "firewall_remove", + EventName: "request", + ServerId: appname + "@" + myHostname, + Server: myHostname, + Node: "freeswitch@" + myHostname, + } + + msg_pubtest, err := json.Marshal(pubtest) + if err != nil { + log.Println("Unable to marshal pubtest into JSON! Published test message will be blank.") + } + + // block thread + + for { + select { + case sig := <-sigch: + log.Println("Received signal " + fmt.Sprintf("%s", sig) + " on pubch channel. Publishing test message... ") + if sig == syscall.SIGUSR2 { + msgFromFile, err := readJsonFile(appconf.PubMessageFile) + if err == nil { + msg_pubtest = msgFromFile + } + log.Println("Publishing test message to exchange '" + appconf.AmqpPubExch + "' with routing key '" + appconf.AmqpPubRoutingKey + "': \n" + string(msg_pubtest)) + err = publisher.Publish(msg_pubtest, + []string{appconf.AmqpPubRoutingKey}, + rabbitmq.WithPublishOptionsContentType("application/json"), + rabbitmq.WithPublishOptionsExchange(appconf.AmqpPubExch), + ) + if err != nil { + log.Println("Error publishing message: " + err.Error()) + } else { + log.Println("Message PUBLISHED.") + } + } + case <-time.After(50 * time.Millisecond): + //case <-time.After(time.Second): + //fmt.Println("tick") + } + } +} diff --git a/cache.go b/cache.go new file mode 100644 index 0000000..3d6975c --- /dev/null +++ b/cache.go @@ -0,0 +1,88 @@ +package main + +import ( + "sync" + "time" + +) + +// item represents a cache item with a value and an expiration time. +type item struct { + value string + expiry time.Time +} + +func (i item) isExpired() bool { + return time.Now().After(i.expiry) +} + +type TTLCache struct { + items map[string]item // The map storing cache items. + mu sync.Mutex //Mutex for controlling concurrent access to the cache. +} + +// NewTTL creates a new TTLCache instance and starts a goroutine to periodically +// remove expired items every s seconds. +func NewTTL(s int64, callbackFunc func(ipaddr, portstring string) error) *TTLCache { + c := &TTLCache{ + items: make(map[string]item), + } + + + go func() { + for range time.Tick(time.Duration(int64(s/4)) * time.Second) { + c.mu.Lock() + + + // Iterate over the cache ad delete expired ones. + for key, item := range c.items { + if item.isExpired() { + logit(7,"Deleting expired cache item: "+key) + delete(c.items, key) + //_ = callbackFunc(key, "") + go callbackFunc(key, "") + } + } + + c.mu.Unlock() + } + }() + + return c +} + +// Set adds a new item to the cache with time-to-live (TTL). +func (c *TTLCache) Set(key, value string, ttl time.Duration) { + c.mu.Lock() + defer c.mu.Unlock() + + c.items[key] = item{ + value: value, + expiry: time.Now().Add(ttl), + } +} + +func (c *TTLCache) Get(key string) (string, bool) { + c.mu.Lock() + defer c.mu.Unlock() + + item, found := c.items[key] + if !found { + return item.value, false + } + + if item.isExpired() { + // If the item has expired, remove it from the cache and return the value and false. + delete(c.items, key) + return item.value, false + } + + return item.value, true +} + +func (c *TTLCache) Remove(key string) { + c.mu.Lock() + defer c.mu.Unlock() + + delete(c.items, key) +} diff --git a/config.go b/config.go new file mode 100644 index 0000000..851cfce --- /dev/null +++ b/config.go @@ -0,0 +1,151 @@ +package main + +import ( + "encoding/json" + "fmt" + "io/ioutil" + "log" + "os" + "reflect" + "regexp" + "strconv" +) + +var appconf *AppConfig + +func initConfig() { + //Read config: + configFilename := appname + "_config.json" + configDir := os.Getenv("CONFDIR") + if configDir == "" { + confDirs := []string{ + "/opt/" + appname, + "/opt/" + appname + "/etc", + "/usr/lib/" + appname, + "/usr/lib/" + appname + "/etc", + "/var/lib/" + appname, + "/var/lib/" + appname + "/etc", + "/usr/local/etc", + "/etc", + ".", + } + configDir = "." //the fallback + for _, cd := range confDirs { + if _, err := os.Stat(cd + "/" + configFilename); os.IsNotExist(err) { //doesn't exist... + continue //..so check next one + } + configDir = cd + } + } + configFile := configDir + "/" + configFilename + jsonFile, err := os.Open(configFile) + if err != nil { + log.Println("Could not open config file: " + configFile + "\n" + err.Error()) + fmt.Println("Could not open config file: " + configFile + "\n" + err.Error()) + } else { + defer jsonFile.Close() + fileBytes, _ := ioutil.ReadAll(jsonFile) + + //strip out // comments from config file: + re := regexp.MustCompile(`([\s]//.*)|(^//.*)`) + fileCleanedBytes := re.ReplaceAll(fileBytes, nil) + + err = json.Unmarshal(fileCleanedBytes, &appconf) //populate the config struct with JSON data from the config file + if err != nil { + log.Fatal("Could not parse config file: " + configFile + "\n" + err.Error()) + } + } + + appconf.checkConfig(configFilename) +} + +func (f *AppConfig) checkConfig(configFileName string) { + var invalid bool + + s := reflect.ValueOf(f).Elem() //the reflected struct + for i := 0; i < s.NumField(); i++ { //NumField() returns the number of fields in the struct + fieldValue := s.Field(i) //value of this i'th field + t := s.Type().Field(i) + //fmt.Println(t.Name + fmt.Sprintf(" is of kind: %d", t.Type.Kind())) + if fieldValue.Interface() == "" || fieldValue.Interface() == nil || fieldValue.Interface() == 0 || (t.Type.Kind() != reflect.Bool && fieldValue.IsZero()) { //field is not set already + //fmt.Println(t.Name + " is empty or zero.") + if t.Type.Kind() == reflect.String || t.Type.Kind() == reflect.Bool || t.Type.Kind() == reflect.Float64 || t.Type.Kind() == reflect.Int64 || t.Type.Kind() == reflect.Int { + if !fieldValue.CanSet() { + log.Printf("Config item '%s' cannot be set!\n", t.Name) + invalid = true + } else { + env, ok := os.LookupEnv(t.Tag.Get("env")) + if ok && len(env) > 0 { + //fmt.Println("ENV: " + t.Tag.Get("env") + " is found and is: " + env + " Setting...") + if err := setField(fieldValue, env); err != nil { + invalid = true + log.Println("Error setting '" + t.Name + "' to env '" + env + "'. Error: " + err.Error()) + fmt.Println("Error setting '" + t.Name + "' to env '" + env + "'. Error: " + err.Error()) + } else { + continue + } + } else { //env not found + //fmt.Println("ENV: '" + t.Tag.Get("env") + "' is NOT FOUND; checking for default value...") + // Look for user-defined default value + dflt, ok := t.Tag.Lookup("default") + //fmt.Println("DEFAULT is: " + dflt) + if ok { + if err := setField(fieldValue, dflt); err != nil { + log.Println("Error setting '" + t.Name + "' to default '" + dflt + "'. Error: " + err.Error()) + fmt.Println("Error setting '" + t.Name + "' to default '" + dflt + "'. Error: " + err.Error()) + invalid = true + } else { + continue + } + } + } + } + } else { + log.Printf("Config item '%s' of type %s cannot be set using environment variable %s.", s.Type().Field(i).Name, fieldValue.Type(), s.Type().Field(i).Tag.Get("env")) + invalid = true + } + + if !invalid { + log.Println("===========| ERRORS IN '" + configFileName + "' CONFIG FILE: |===========") + fmt.Println("--------------------------------------------------------------------------------") + fmt.Println(" ===========| ERRORS IN '" + configFileName + "' CONFIG FILE: |===========") + fmt.Println("") + } + invalid = true + log.Printf(" - Required config item '%s' and/or environment variable '%s' is missing or invalid.\n", t.Tag.Get("json"), t.Tag.Get("env")) + fmt.Printf(" - Required config item '%s' and/or environment variable '%s' is missing or invalid.\n", t.Tag.Get("json"), t.Tag.Get("env")) + } + } + if invalid { + fmt.Println("--------------------------------------------------------------------------------") + log.Fatal("Exiting!") + } +} + +func setField(fieldValue reflect.Value, value string) (err error) { + switch fieldValue.Kind() { + case reflect.Bool: + var b bool + if b, err = strconv.ParseBool(value); err != nil { + return err + } + fieldValue.SetBool(b) + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: + var i int64 + if i, err = strconv.ParseInt(value, 0, 64); err != nil { + return err + } + fieldValue.SetInt(int64(i)) + case reflect.Float32, reflect.Float64: + var f float64 + if f, err = strconv.ParseFloat(value, 64); err != nil { + return err + } + fieldValue.SetFloat(f) + case reflect.String: + fieldValue.SetString(value) + default: + return fmt.Errorf("%s is not a supported config type. Please use bool, float64 float32, int64, int, or string.", fieldValue.Kind()) + } + return +} diff --git a/firewall.go b/firewall.go new file mode 100644 index 0000000..023c766 --- /dev/null +++ b/firewall.go @@ -0,0 +1,239 @@ +package main + +import ( + "errors" + "os/exec" + "strconv" + "strings" + "time" + // "kazoo_firewall_agent/cache" +) + +func firewall(action, ipaddr string, inputports interface{}) (err error) { + switch p := inputports.(type) { + case []interface{}: + for _, porti := range p { + switch port := porti.(type) { + case string: + firewallAction(action, ipaddr, port) + case float64: + firewallAction(action, ipaddr, strconv.Itoa(int(port))) + case int64: + firewallAction(action, ipaddr, strconv.Itoa(int(port))) + case int: + firewallAction(action, ipaddr, strconv.Itoa(port)) + } + } + case []string: + for _, port := range p { + firewallAction(action, ipaddr, port) + } + case float64: + firewallAction(action, ipaddr, strconv.Itoa(int(p))) + case string: + splitPorts := strings.Split(p, ",") + for _, port := range splitPorts { + firewallAction(action, ipaddr, port) + } + case nil: + firewallAction(action, ipaddr, "") + default: + } + return nil +} + +func parsePortProto(p string) PortProto { + var pp PortProto + pparsed := strings.Split(p, "/") //"8443/tcp" --> [8443, tcp] + + if len(pparsed) < 1 { + return pp + } + + pp.Port = pparsed[0] + + pp.Proto = "tcp" + if len(pparsed) > 1 { + switch pparsed[1] { + case "tcp": + pp.Proto = "tcp" + case "TCP": + pp.Proto = "tcp" + case "udp": + pp.Proto = "udp" + case "UDP": + pp.Proto = "udp" + default: + } + } + return pp +} + +func firewallAction(action, ipaddr string, portstring string) (err error) { + switch action { + case "firewall_add": + err = firewallAdd(ipaddr, portstring) + case "firewall_remove": + err = firewallDelete(ipaddr, portstring) + } + + return err +} + +func firewallAdd(ipaddr, portstring string) error { + var pp PortProto + pp = parsePortProto(portstring) + zone := determineZone(ipaddr, pp) + + logit(5, "Firewall adding to zone '"+zone+"': "+ipaddr+":"+pp.Port+"/"+pp.Proto) + //ipcache.Set(ipaddr+":"+pp.Port+"/"+pp.Proto, zone, time.Duration(appconf.CacheTimeout) * time.Second) + + if len(pp.Port) > 0 { + err := maybeAddPort(zone, pp, false) + if err != nil { + logit(3, err.Error()) + return err + } + } + + //if it's already cached, then don't add it, just refresh the expiry time and return + _, alreadyExists := ipcache.Get(ipaddr) + if alreadyExists { + ipcache.Set(ipaddr, zone, time.Duration(appconf.CacheTimeout)*time.Second) + return nil + } + + fwOutput, err := exec.Command("firewall-cmd", "--zone="+zone, "--add-source="+ipaddr).CombinedOutput() + if err != nil { + logit(3, "Error executing firewall-cmd: "+err.Error()+" OUTPUT: "+string(fwOutput)) + return errors.New("Error executing firewall-cmd: " + err.Error()) + } + ipcache.Set(ipaddr, zone, time.Duration(appconf.CacheTimeout)*time.Second) + + return nil +} + +func firewallDelete(ipaddr, portstring string) error { + var pp PortProto + pp = parsePortProto(portstring) + zone := determineZone(ipaddr, pp) + + logit(5, "Firewall removing from zone '"+zone+"': "+ipaddr) + + fwOutput, err := exec.Command("firewall-cmd", "--zone="+zone, "--remove-source="+ipaddr).CombinedOutput() + if err != nil { + logit(3, "Error executing firewall-cmd: "+err.Error()+" OUTPUT: "+string(fwOutput)) + return errors.New("Error executing firewall-cmd: " + err.Error()) + } + ipcache.Remove(ipaddr) + //ipcache.Remove(ipaddr+":"+pp.Port+"/"+pp.Proto) + + return nil +} + +func maybeAddPort(zone string, pp PortProto, permanent bool) error { + var found bool + ports, err := getZonePorts(zone) + if err != nil { + return err + } + for _, port := range ports { + if port == pp.Port+"/"+pp.Proto { + found = true + return nil + } + } + if !found { + return addZonePort(zone, pp.Port+"/"+pp.Proto, permanent) + } + + return nil +} +func addZonePort(zone, port string, permanent bool) error { + cmd := exec.Command("firewall-cmd", "--zone="+zone, "--add-port="+port) + if permanent { + cmd = exec.Command("firewall-cmd", "--zone="+zone, "--add-port="+port, "--permanent") + } + output, err := cmd.CombinedOutput() + if err != nil { + return errors.New(string(output) + " | " + err.Error()) + } + ipcache.Remove("zone_" + zone) + return nil +} + +func getZonePorts(zone string) ([]string, error) { + logit(7, "Get ports in zone: '"+zone+"'...") + + ports, found := ipcache.Get("zone_" + zone) //check cache first + if found { + logit(7, "Ports for zone: '"+zone+"' are in cache; returning.") + return strings.Split(ports, " "), nil + } + + logit(7, "Ports for zone: '"+zone+"' are not cached; getting from firewalld.") + cmd := exec.Command("firewall-cmd", "--zone="+zone, "--list-ports") + output, err := cmd.CombinedOutput() + + outputArr := strings.Split(string(output), " ") + ipcache.Set("zone_"+zone, string(output), time.Duration(appconf.CacheTimeout)*time.Second) + return outputArr, err +} + +func maybeSetupZone(zone string) error { + cmd := exec.Command("firewall-cmd", "--zone="+zone, "--list-ports") + output, err := cmd.CombinedOutput() + if err != nil { + logit(3, "Error querying zone '"+zone+"': "+err.Error()+" : "+string(output)+" : Zone may not exist. Trying to create...") + + cmd = exec.Command("firewall-cmd", "--new-zone="+zone, "--permanent") + output, err = cmd.CombinedOutput() + if err != nil { + logit(3, "Error creating zone '"+zone+"': "+err.Error()+" : "+string(output)) + return err + } + } + err = maybeAddDefaultPorts(zone) + if err != nil { + return err + } + + return reload() +} + +func maybeAddDefaultPorts(zone string) error { + var ports []string + if len(appconf.Ports) > 0 { + ports = strings.Split(appconf.Ports, ",") + for _, port := range ports { + pp := parsePortProto(port) + err := maybeAddPort(zone, pp, true) + if err != nil { + logit(3, err.Error()) + return err + } + } + } + + return nil +} + +func reload() error { + cmd := exec.Command("firewall-cmd", "--reload") + output, err := cmd.CombinedOutput() + if err != nil { + logit(3, "Unable to reload firewalld! Output: "+string(output)+"Error: "+err.Error()) + } + logit(5, "Reload firewalld: "+string(output)) + return err +} + +func determineZone(ipaddr string, pp PortProto) string { + var zone string + logit(7, "Determine zone for ipaddr '"+ipaddr+"'...") + + //do stuff + + zone = appconf.FirewallZone + return zone +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..cf4f6cb --- /dev/null +++ b/go.mod @@ -0,0 +1,11 @@ +module kazoo_firewall_agent + +go 1.22.2 + +require ( + github.com/google/uuid v1.6.0 // indirect + github.com/jellydator/ttlcache/v3 v3.2.0 // indirect + github.com/rabbitmq/amqp091-go v1.7.0 // indirect + github.com/wagslane/go-rabbitmq v0.13.0 // indirect + golang.org/x/sync v0.1.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..80235e7 --- /dev/null +++ b/go.sum @@ -0,0 +1,51 @@ +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jellydator/ttlcache/v3 v3.2.0 h1:6lqVJ8X3ZaUwvzENqPAobDsXNExfUJd61u++uW8a3LE= +github.com/jellydator/ttlcache/v3 v3.2.0/go.mod h1:hi7MGFdMAwZna5n2tuvh63DvFLzVKySzCVW6+0gA2n4= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rabbitmq/amqp091-go v1.7.0 h1:V5CF5qPem5OGSnEo8BoSbsDGwejg6VUJsKEdneaoTUo= +github.com/rabbitmq/amqp091-go v1.7.0/go.mod h1:wfClAtY0C7bOHxd3GjmF26jEHn+rR/0B3+YV+Vn9/NI= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/wagslane/go-rabbitmq v0.13.0 h1:u2JfKbwi3cbxCExKV34RrhKBZjW2HoRwyPTA8pERyrs= +github.com/wagslane/go-rabbitmq v0.13.0/go.mod h1:1sUJ53rrW2AIA7LEp8ymmmebHqqq8ksH/gXIfUP0I0s= +github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= +go.uber.org/goleak v1.2.0/go.mod h1:XJYK+MuIchqpmGmUSAzotztawfKvYLUIgg7guXrwVUo= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/kazoo_firewall_agent.service b/kazoo_firewall_agent.service new file mode 100644 index 0000000..ea210fc --- /dev/null +++ b/kazoo_firewall_agent.service @@ -0,0 +1,16 @@ +[Unit] +Description=Kazoo Firewall Agent +After=network.target +#After=nebula.service +#Before=couchdb.service haproxy.service nginx.service + +[Service] +Type=simple +#ExecStartPre= +ExecStart=/opt/kazoo_firewall_agent/kazoo_firewall_agent +ExecReload=/bin/kill -USR1 $MAINPID +Restart=on-failure + +[Install] +WantedBy=multi-user.target + diff --git a/kazoo_firewall_agent_config.json.sample b/kazoo_firewall_agent_config.json.sample new file mode 100644 index 0000000..c40c0ed --- /dev/null +++ b/kazoo_firewall_agent_config.json.sample @@ -0,0 +1,19 @@ +//You may also set any config parameters via the environment variables listed. +{ +// "server_type":"freeswitch", // env:"SERVER_TYPE" default:"freeswitch" +// "amqp_uri":"amqp://guest:guest@localhost:5672", // env:"AMQP_URI" default:"amqp://guest:guest@localhost:5672" +// "amqp_exchange":"call_shield", // env:"AMQP_EXCH" default:"call_shield" +// "amqp_exchange_type":"topic", // env:"AMQP_EXCH_TYPE" default:"topic" +// "amqp_sub_routing_key":"", // env:"AMQP_SUB_ROUTING_KEY" default:"call_shield.{server_type}.firewall.*" +// "amqp_pub_routing_key":"call_shield.test", // env:"AMQP_PUB_ROUTING_KEY" default:"call_shield.test" +// "amqp_direct_routing_key":"", // env:"AMQP_DIRECT_ROUTING_KEY" default:"call_shield.{hostname}.*.*" +// "amqp_workers":4, // env:"AMQP_WORKERS" default:"4" +// "pub_message_file":"/tmp/message.json", // env:"PUB_MSG_FILE" default:"/tmp/message.json" +// "ports":"11000/udp,11000,11001/tcp,16384-32768/udp", // env:"PORTS" default:"11000/udp,11000,11001/tcp,16384-32768/udp" +// "cache_timeout_sec":10800, // env:"CACHE_TIMEOUT" default:"43200" (12hr) +// "firewall_type":"firewalld", // env:"FIREWALL_ZONE" default:"firewalld" +// "firewall_zone":"SIPFS", // env:"FIREWALL_ZONE" default:"SIPFS" +// "log_file":"/var/log/kazoo_firewall_agent.log", // env:"LOG_FILE" default:"/var/log/kazoo_firewall_agent.log" +// "log_level":5 // env:"LOG_LEVEL" default:"5" +} + diff --git a/main.go b/main.go new file mode 100644 index 0000000..8c257ed --- /dev/null +++ b/main.go @@ -0,0 +1,143 @@ +//////////////////////////////////////////////////////////////////////// +// KazooFirewallAgent (c) 2024-, RuhNet +// Author: Ruel Tmeizeh, RuhNet www.ruhnet.co +// License: GPL v3 https://www.gnu.org/licenses/gpl-3.0.txt +//////////////////////////////////////////////////////////////////////// +package main + +import ( + "fmt" + //"kazoo_firewall_agent/cache" + "log" + "os" + + //"os/signal" + "strings" + //"syscall" + "time" +) + +const appnameFull string = "RuhNet Kazoo Firewall Agent" +const appname string = "kazoo_firewall_agent" +const version string = "0.9" +const serverVersion string = "RuhNet " + appname + " v" + version +const website string = "https://ruhnet.co" + +var startupTime time.Time +var myHostname, myHostnameShort string + +const banner = ` +--⟶____ __ _ _ __ +-⟶/ ___\ __ __/ /_ / \ / /__ __/ /_ +⟶/ /_/ // /_/ / _ \/ / \/ //__\_ __/ +/_/ \_\\ ___/_/ /_/_/ \__/ \__,/_/ %s +_____________________________________________________ +` + +var ipcache *TTLCache +var done = make(chan bool, 1) + +var portProtos []PortProto + +type PortProto struct { + Port string + Proto string +} + +type AppConfig struct { + ServerType string `json:"server_type" env:"SERVER_TYPE" default:"freeswitch"` + AmqpURI string `json:"amqp_uri" env:"AMQP_URI" default:"amqp://guest:guest@localhost:5672"` + AmqpExch string `json:"amqp_exchange" env:"AMQP_EXCH" default:"call_shield"` + AmqpSubExch string `json:"amqp_sub_exchange" env:"AMQP_SUB_EXCH" default:""` + AmqpPubExch string `json:"amqp_pub_exchange" env:"AMQP_PUB_EXCH" default:""` + AmqpExchType string `json:"amqp_exchange_type" env:"AMQP_EXCH_TYPE" default:"topic"` + AmqpDirectRoutingKey string `json:"amqp_direct_routing_key" env:"AMQP_DIRECT_ROUTING_KEY" default:""` //call_shield.{hostname}.*.* + AmqpSubRoutingKey string `json:"amqp_sub_routing_key" env:"AMQP_SUB_ROUTING_KEY" default:""` //"call_shield.{server_type}.firewall.*" + AmqpPubRoutingKey string `json:"amqp_pub_routing_key" env:"AMQP_PUB_ROUTING_KEY" default:"call_shield.test"` + AmqpWorkers int `json:"amqp_workers" env:"AMQP_WORKERS" default:"4"` + PubMessageFile string `json:"pub_message_file" env:"PUB_MSG_FILE" default:"/tmp/message.json"` + Ports string `json:"ports" env:"PORTS" default:"11000/udp,11000,11001/tcp,16384-32768/udp"` + FilterEvtCat string `json:"filter_event_category" env:"FLT_EVT_CAT" default:"*"` //allow comma separated string for multiple + FilterEvtName string `json:"filter_event_name" env:"FLT_EVT_NAME" default:"*"` + FilterEvtAppName string `json:"filter_event_appname" env:"FLT_EVT_APPNAME" default:"*"` + CacheTimeout int64 `json:"cache_timeout_sec" env:"CACHE_TIMEOUT" default:"43200"` //43200 is 12hr + FirewallType string `json:"firewall_type" env:"FIREWALL_ZONE" default:"firewalld"` //firewalld, iptables + FirewallZone string `json:"firewall_zone" env:"FIREWALL_ZONE" default:"SIPFS"` + LogFile string `json:"log_file" env:"LOG_FILE" default:"/var/log/kazoo_firewall_agent.log"` + LogLevel int `json:"log_level" env:"LOG_LEVEL" default:"5"` +} + +func main() { + var err error + startupTime = time.Now() + + ///////////////////////////////////////////// + // Setup + initConfig() + + fmt.Println("Configuration OK, starting " + appname + "...") + logit(5, "Configuration OK, starting "+appname+"...") + + ///////////////////////////////////////////// + // Logging + appLogFile, err := os.OpenFile(appconf.LogFile, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0664) + if err != nil { + log.Println("Could not open log file: " + appconf.LogFile + "\n" + err.Error()) + appLogFile, err = os.OpenFile("/tmp/"+appname+".log", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0664) + if err != nil { + fmt.Println("Can't open even /tmp log file!\n" + err.Error()) + log.Fatal("Can't open even /tmp log file!\n" + err.Error()) + } + } + defer appLogFile.Close() + //set other logging to same file + log.SetOutput(appLogFile) + + //Startup Banner + fmt.Printf(banner, website) + fmt.Printf(serverVersion + "\n\n") + + logit(5, appname+"v"+version+" starting up... ") + logit(5, fmt.Sprintf("Logging with level: %d", appconf.LogLevel)) + + //Hostname + myHostname, err = os.Hostname() + logit(5, "Detecting my hostname... "+myHostname) + if err != nil { + fmt.Println("Hostname could not be auto-detected from system: " + err.Error()) + log.Fatal("Hostname could not be auto-detected from system: " + err.Error()) + } + myHostnameShort = strings.SplitN(myHostname, ".", 2)[0] + + //fmt.Println() + + //create the IP address cache with expiry and function to run when cached entry expires + ipcache = NewTTL(appconf.CacheTimeout, firewallDelete) + + if appconf.FirewallType == "firewalld" { + //_ = reload() //reload firewalld to reset firewall state (done as part of maybeCreateZone) + err = maybeSetupZone(appconf.FirewallZone) //reload firewalld to reset firewall state + if err != nil { + fmt.Println("Firewall zone '" + appconf.FirewallZone + "' could not be created. (Is firewalld running?): " + err.Error()) + log.Fatal("Firewall zone '" + appconf.FirewallZone + "' could not be created. (Is firewalld running?): " + err.Error()) + } + } + + /* + log.Println(appnameFull + " system started.\n-----> [READY]") + fmt.Println(appnameFull + " system started.\n-----> [READY]") + + // block main thread - wait for shutdown signal + sigs := make(chan os.Signal, 1) + + signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM) + go func() { + sig := <-sigs + fmt.Printf("Received signal: ") + fmt.Println(sig) + done <- true + }() + */ + + amqp() //this func will block the main thread, until receiving on the 'done' channel. +} diff --git a/message.json b/message.json new file mode 100644 index 0000000..1f8bc84 --- /dev/null +++ b/message.json @@ -0,0 +1,11 @@ +{ + "Node": "call_shield@kazoo.ruhnet.net", + "Msg-ID": "f05991c5d8cdb480", + "Event-Name": "request", + "Event-Category": "firewall_add", + "App-Version": "1.0.0", + "App-Name": "call_shield", + "IP-Address": "1.1.1.1", + "Ports":"8443,53/udp" +} + diff --git a/util.go b/util.go new file mode 100644 index 0000000..8439f8d --- /dev/null +++ b/util.go @@ -0,0 +1,49 @@ +package main + +import ( + "fmt" + "io/ioutil" + "log" + "os" + "regexp" + "strings" + + "github.com/google/uuid" +) + +func readJsonFile(filePath string) (jsonBytes []byte, err error) { + jsonFile, err := os.Open(filePath) + if err != nil { + log.Println("Could not open JSON file: " + filePath + "\n" + err.Error()) + return jsonBytes, err + } + defer jsonFile.Close() + fileBytes, _ := ioutil.ReadAll(jsonFile) + + //strip out // comments from file: + re := regexp.MustCompile(`([\s]//.*)|(^//.*)`) + fileCleanedBytes := re.ReplaceAll(fileBytes, nil) + + return fileCleanedBytes, err +} + +func generateUUID() string { + return strings.Replace(uuid.New().String(), "-", "", -1) +} + +func fileExists(filename string) bool { + info, err := os.Stat(filename) + if os.IsNotExist(err) { + return false + } + return !info.IsDir() +} + +func logit(level int, message string) { + if appconf.LogLevel >= int(level) { + log.Println(message) + } + if appconf.LogLevel >= 8 { + fmt.Println(message) + } +}