Y
2 years ago
commit
fc864feca4
37 changed files with 2156 additions and 0 deletions
+ 674
- 0
LICENSE
View File
| @@ -0,0 +1,674 @@ | |||
| GNU GENERAL PUBLIC LICENSE | |||
| Version 3, 29 June 2007 | |||
| Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | |||
| 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. | |||
| <one line to give the program's name and a brief idea of what it does.> | |||
| Copyright (C) <year> <name of author> | |||
| 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 <https://www.gnu.org/licenses/>. | |||
| 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: | |||
| <program> Copyright (C) <year> <name of author> | |||
| 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 | |||
| <https://www.gnu.org/licenses/>. | |||
| 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 | |||
| <https://www.gnu.org/licenses/why-not-lgpl.html>. | |||
+ 35
- 0
README.md
View File
| @@ -0,0 +1,35 @@ | |||
| # Python peruser of systemd-journal | |||
| This program is intended to be used as a lightweight replacement for both epylog and fail2ban. | |||
| The wanted features are these: | |||
| * Peruse all log entries from systemd’s journal, and only those (ie: no log files). | |||
| * Passively wait on new entries; no active polling. | |||
| * Filter-out uninteresting log lines according to the settings. | |||
| * Act on matches in the journal, with some pre-defined actions. | |||
| * Create a daily report with 2 parts: | |||
| - events of interest (according to the settings), | |||
| - and other non-filtered-out log entries. | |||
| * Send an immediate email when something important happens (according to the settings). | |||
| Interesting [filtering entries](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html) are: | |||
| * `_TRANSPORT`: how the log entry got to the journal (`stdout`, `syslog`, `journal`) | |||
| * `PRIORITY`: see https://en.wikipedia.org/wiki/Syslog#Severity_level | |||
| * `SYSLOG_FACILITY`: see https://en.wikipedia.org/wiki/Syslog#Facility | |||
| * `_CAP_EFFECTIVE`: effective capabilities as an hexadecimal mask | |||
| * `_BOOT_ID`: boot identifier (may be used to detect reboots) | |||
| * `_MACHINE_ID`: internal systemd ID for the machine where the log entry occurred | |||
| * `_HOSTNAME`: short hostname of the machine where the log entry occurred | |||
| * `_UID`: user ID of the systemd service that produced the log entry | |||
| * `_GID`: group ID of the systemd service that produced the log entry | |||
| * `SYSLOG_IDENTIFIER`: service name as reported to the “syslog” API | |||
| * `_COMM`: name of the command that produced the log entry | |||
| * `_EXE`: path to the executable file launched by systemd | |||
| * `_SYSTEMD_CGROUP`: cgroup of the service, eg. `/system.slice/systemd-uwsgi.slice/uwsgi@nextcloud.service` | |||
| * `_SYSTEMD_UNIT`: name of the systemd unit that produced the log entry | |||
| * `_SYSTEMD_SLICE`: name of the systemd slice | |||
| * `_CMDLINE`: process name as reported by the main process of the systemd service | |||
| * `_PID`: process ID of the systemd unit’s main process | |||
| * `MESSAGE`: the actual message of the log entry | |||
| * `__REALTIME_TIMESTAMP`: Python `datetime` of the log entry, formatted as: `YYYY-MM-DD HH:MM:SS:µµµµµµ` | |||
+ 9
- 0
TODO.md
View File
| @@ -0,0 +1,9 @@ | |||
| # TODO | |||
| * Insert the GPL stuff in the source files. | |||
| * Create a filter that rejects all messages that match a series of regular expressions. | |||
| * Handle OTHER messages in a file in order to avoid filling the RAM waiting for the report to be sent. | |||
| * Write the systemd service that starts pyruse on boot. | |||
| * Write the systemd service+timer that restores bans after a reboot. | |||
| * Maybe switch from Step.run() recursion to Step.run()-in-a-loop to avoid too-deep call stacks. | |||
| * Eventually make the code more elegant, as I learn more about Python… | |||
+ 3
- 0
extra/bin/pyruse
View File
| @@ -0,0 +1,3 @@ | |||
| #!/usr/bin/python | |||
| from pyruse import main | |||
| main.main() | |||
+ 19
- 0
pyruse/actions/action_counterRaise.py
View File
| @@ -0,0 +1,19 @@ | |||
| import datetime | |||
| from pyruse import base, counter | |||
| class Action(base.Action, counter.Counter): | |||
| def __init__(self, args): | |||
| base.Action.__init__(self) | |||
| counter.Counter.__init__(self, args["counter"]) | |||
| self.keyName = args["for"] | |||
| self.save = args.get("save", None) | |||
| keepSeconds = args.get("keepSeconds", None) | |||
| if keepSeconds: | |||
| self.keepSeconds = datetime.timedelta(seconds = keepSeconds) | |||
| else: | |||
| self.keepSeconds = None | |||
| def act(self, entry): | |||
| count = self.augment(entry[self.keyName], self.keepSeconds) | |||
| if self.save: | |||
| entry[self.save] = count | |||
+ 19
- 0
pyruse/actions/action_counterReset.py
View File
| @@ -0,0 +1,19 @@ | |||
| import datetime | |||
| from pyruse import base, counter | |||
| class Action(base.Action, counter.Counter): | |||
| def __init__(self, args): | |||
| base.Action.__init__(self) | |||
| counter.Counter.__init__(self, args["counter"]) | |||
| self.keyName = args["for"] | |||
| self.save = args.get("save", None) | |||
| graceSeconds = args.get("graceSeconds", None) | |||
| if graceSeconds: | |||
| self.graceSeconds = datetime.timedelta(seconds = graceSeconds) | |||
| else: | |||
| self.graceSeconds = None | |||
| def act(self, entry): | |||
| self.reset(entry[self.keyName], self.graceSeconds) | |||
| if self.save: | |||
| entry[self.save] = 0 | |||
+ 113
- 0
pyruse/actions/action_dailyReport.py
View File
| @@ -0,0 +1,113 @@ | |||
| import datetime | |||
| import string | |||
| from pyruse import base, email | |||
| class Action(base.Action): | |||
| WARN = "WARN" | |||
| INFO = "INFO" | |||
| OTHER = "OTHER" | |||
| _messages = None | |||
| _hour = 0 | |||
| _txtDocStart = '= Pyruse Report\n\n' | |||
| _txtHeadWarn = '== WARNING Messages\n\n' | |||
| _txtHeadInfo = '\n== Information Messages\n\n' | |||
| _txtHeadOther = '\n== Other log events\n\n' | |||
| _txtTableDelim = '|===============================================================================\n' | |||
| _txtTableHeader = '|Count|Message |Date+time for each occurrence\n' | |||
| _txtPreDelim = '----------\n' | |||
| _htmDocStart = '<html>\n<head><meta charset="utf-8"/></head>\n<body>\n<h1>Pyruse Report</h1>\n' | |||
| _htmDocStop = '</body></html>' | |||
| _htmHeadWarn = '<h2>WARNING Messages</h2>\n' | |||
| _htmHeadInfo = '<h2>Information Messages</h2>\n' | |||
| _htmHeadOther = '<h2>Other log events</h2>\n' | |||
| _htmTableStart = '<table>\n<tr><th>Count</th><th>Message</th><th>Date+time for each occurrence</th></tr>\n' | |||
| _htmTableStop = '</table>\n' | |||
| _htmPreStart = '<pre>' | |||
| _htmPreStop = '</pre>\n' | |||
| def _encode(self, text): | |||
| return text.replace('&', '&').replace('<', '<').replace('>', '>') | |||
| def _toAdoc(self, msg, times): | |||
| return "\n|{count:^5d}|{text}\n |{times}\n".format_map( | |||
| {"count": len(times), "text": msg, "times": " +\n ".join(str(t) for t in times)} | |||
| ) | |||
| def _toHtml(self, msg, times): | |||
| return "<tr><td>{count}</td><td>{text}</td><td>{times}</td></tr>\n".format_map( | |||
| {"count": len(times), "text": self._encode(msg), "times": "<br/>".join(str(t) for t in times)} | |||
| ) | |||
| def __init__(self, args): | |||
| super().__init__() | |||
| self.level = args["level"] | |||
| self.isOther = self.level == Action.OTHER | |||
| self.template = args["message"] | |||
| values = {} | |||
| for (_void, name, _void, _void) in string.Formatter().parse(self.template): | |||
| if name: | |||
| values[name] = None | |||
| self.values = values | |||
| def act(self, entry): | |||
| messages = Action._messages[self.level] | |||
| for (name, _void) in self.values.items(): | |||
| self.values[name] = entry.get(name, None) | |||
| msg = self.template.format_map(self.values) | |||
| if self.isOther: | |||
| messages.append((entry["__REALTIME_TIMESTAMP"], msg)) | |||
| elif msg in messages: | |||
| messages[msg].append(entry["__REALTIME_TIMESTAMP"]) | |||
| else: | |||
| messages[msg] = [entry["__REALTIME_TIMESTAMP"]] | |||
| thisHour = datetime.datetime.today().hour | |||
| if thisHour < Action._hour: | |||
| self._sendReport() | |||
| Action._hour = thisHour | |||
| def _sendReport(self): | |||
| html = Action._htmDocStart + Action._htmHeadWarn | |||
| text = Action._txtDocStart + Action._txtHeadWarn | |||
| text += Action._txtTableDelim + Action._txtTableHeader | |||
| html += Action._htmTableStart | |||
| for (msg, times) in sorted(Action._messages[Action.WARN].items(), key = lambda i: i[0]): | |||
| text += self._toAdoc(msg, times) | |||
| html += self._toHtml(msg, times) | |||
| text += Action._txtTableDelim | |||
| html += Action._htmTableStop | |||
| text += Action._txtHeadInfo | |||
| html += Action._htmHeadInfo | |||
| text += Action._txtTableDelim + Action._txtTableHeader | |||
| html += Action._htmTableStart | |||
| for (msg, times) in sorted(Action._messages[Action.INFO].items(), key = lambda i: i[0]): | |||
| text += self._toAdoc(msg, times) | |||
| html += self._toHtml(msg, times) | |||
| text += Action._txtTableDelim | |||
| html += Action._htmTableStop | |||
| text += Action._txtHeadOther | |||
| html += Action._htmHeadOther | |||
| text += Action._txtPreDelim | |||
| html += Action._htmPreStart | |||
| for (time, msg) in Action._messages[Action.OTHER]: | |||
| m = '%s: %s\n' % (time, msg) | |||
| text += m | |||
| html += self._encode(m) | |||
| text += Action._txtPreDelim | |||
| html += Action._htmPreStop | |||
| html += Action._htmDocStop | |||
| email.Mail(text, html).send() | |||
| Action._messages = _resetMessages() | |||
| def _resetMessages(): | |||
| return {Action.WARN: {}, Action.INFO: {}, Action.OTHER: []} | |||
| Action._messages = _resetMessages() | |||
+ 19
- 0
pyruse/actions/action_email.py
View File
| @@ -0,0 +1,19 @@ | |||
| import string | |||
| from pyruse import base, email | |||
| class Action(base.Action): | |||
| def __init__(self, args): | |||
| super().__init__() | |||
| self.subject = args.get("subject", "Pyruse Notification") | |||
| self.template = args["message"] | |||
| values = {} | |||
| for (_void, name, _void, _void) in string.Formatter().parse(self.template): | |||
| if name: | |||
| values[name] = None | |||
| self.values = values | |||
| def act(self, entry): | |||
| for (name, _void) in self.values.items(): | |||
| self.values[name] = entry.get(name, None) | |||
| msg = self.template.format_map(self.values) | |||
| email.Mail(msg).setSubject(self.subject).send() | |||
+ 58
- 0
pyruse/actions/action_nftBan.py
View File
| @@ -0,0 +1,58 @@ | |||
| import datetime | |||
| import json | |||
| import os | |||
| import subprocess | |||
| from pyruse import base, config | |||
| class Action(base.Action): | |||
| _storage = config.Config().asMap().get("storage", "/var/lib/pyruse") \ | |||
| + "/" + os.path.basename(__file__) + ".json" | |||
| _nft = config.Config().asMap().get("nftBan", {}).get("nft", ["/usr/bin/nft"]) | |||
| def __init__(self, args): | |||
| super().__init__() | |||
| self.ipv4Set = args["nftSetIPv4"] | |||
| self.ipv6Set = args["nftSetIPv6"] | |||
| self.field = args["IP"] | |||
| self.banSeconds = args.get("banSeconds", None) | |||
| def act(self, entry): | |||
| ip = entry[self.field] | |||
| nftSet = self.ipv6Set if ":" in ip else self.ipv4Set | |||
| newBan = {"IP": ip, "nftSet": nftSet} | |||
| now = datetime.datetime.utcnow() | |||
| bans = [] | |||
| previousTS = None | |||
| try: | |||
| with open(Action._storage) as dataFile: | |||
| for ban in json.load(dataFile): | |||
| if ban["timestamp"] <= now.timestamp(): | |||
| continue | |||
| elif {k: ban[k] for k in newBan.keys()} == newBan: | |||
| # should not happen, since the IP is banned… | |||
| previousTS = ban["timestamp"] | |||
| else: | |||
| bans.append(ban) | |||
| except IOError: | |||
| pass # new file | |||
| if self.banSeconds: | |||
| until = now + datetime.timedelta(seconds = self.banSeconds) | |||
| timeout = " timeout %ss" % str(self.banSeconds) | |||
| else: | |||
| until = now + datetime.timedelta(days = 365) | |||
| timeout = "" | |||
| if previousTS: | |||
| cmd = list(Action._nft) | |||
| cmd.append("delete element %s {%s}" % (nftSet, ip)) | |||
| subprocess.run(cmd) | |||
| cmd = list(Action._nft) | |||
| cmd.append("add element %s {%s%s}" % (nftSet, ip, timeout)) | |||
| subprocess.run(cmd) | |||
| newBan["timestamp"] = until.timestamp() | |||
| bans.append(newBan) | |||
| with open(Action._storage, "w") as dataFile: | |||
| json.dump(bans, dataFile) | |||
+ 59
- 0
pyruse/base.py
View File
| @@ -0,0 +1,59 @@ | |||
| import abc | |||
| from pyruse import log | |||
| class Step(abc.ABC): | |||
| def __init__(self): | |||
| self.nextStep = None | |||
| @abc.abstractmethod | |||
| def run(self, entry): | |||
| pass | |||
| def setNextStep(self, obj): | |||
| self.nextStep = obj | |||
| class Filter(Step): | |||
| def __init__(self): | |||
| super().__init__() | |||
| self.altStep = None | |||
| def setAltStep(self, obj): | |||
| self.altStep = obj | |||
| @abc.abstractmethod | |||
| def filter(self, entry): | |||
| pass | |||
| def run(self, entry): | |||
| global filterFallback | |||
| try: | |||
| nextStep = self.nextStep if self.filter(entry) else self.altStep | |||
| except Exception as e: | |||
| log.error("Error while executing %s: %s." % (type(self), str(e))) | |||
| nextStep = self.altStep | |||
| if nextStep: | |||
| nextStep.run(entry) | |||
| elif filterFallback is not None: | |||
| filterFallback.run(entry) | |||
| class Action(Step): | |||
| def __init__(self): | |||
| super().__init__() | |||
| @abc.abstractmethod | |||
| def act(self, entry): | |||
| pass | |||
| def run(self, entry): | |||
| global actionFallback | |||
| try: | |||
| self.act(entry) | |||
| except Exception as e: | |||
| log.error("Error while executing %s: %s." % (type(self), str(e))) | |||
| if self.nextStep: | |||
| self.nextStep.run(entry) | |||
| elif self != filterFallback and self != actionFallback and actionFallback is not None: | |||
| actionFallback.run(entry) | |||
| filterFallback = None | |||
| actionFallback = None | |||
+ 30
- 0
pyruse/config.py
View File
| @@ -0,0 +1,30 @@ | |||
| import json | |||
| import os | |||
| from collections import OrderedDict | |||
| from pyruse import log | |||
| class Config: | |||
| CONF_NAME = "pyruse.conf" | |||
| _paths = None | |||
| # __main__ must be the first to create a Config object, then paths is remembered | |||
| def __init__(self, paths = None): | |||
| if paths is None: | |||
| paths = Config._paths | |||
| Config._paths = paths | |||
| conf = None | |||
| for p in paths: | |||
| try: | |||
| with open(os.path.join(p, "pyruse.json")) as conffile: | |||
| conf = json.load(conffile, object_pairs_hook = OrderedDict) | |||
| except IOError: | |||
| log.debug("IOError while opening %s\n" % conffile) | |||
| except json.JSONDecodeError: | |||
| log.debug("JSONDecodeError while opening %s\n" % conffile) | |||
| if conf is None: | |||
| raise FileNotFoundError("File `%s` not found in either of %s." \ | |||
| % (Config.CONF_NAME, paths)) | |||
| self.conf = conf | |||
| def asMap(self): | |||
| return self.conf | |||
+ 50
- 0
pyruse/counter.py
View File
| @@ -0,0 +1,50 @@ | |||
| import datetime | |||
| class Counter(): | |||
| _counters = {} | |||
| def _getCounter(self, counterName): | |||
| if counterName not in Counter._counters: | |||
| Counter._counters[counterName] = {} | |||
| return Counter._counters[counterName] | |||
| def _cleanTicks(self, ticks, refDT): | |||
| for tick in list(ticks): | |||
| if tick and tick < refDT: | |||
| ticks.remove(tick) | |||
| def __init__(self, counter): | |||
| self.counterName = counter | |||
| def augment(self, counterKey, duration = None): | |||
| counter = self._getCounter(self.counterName) | |||
| if counterKey not in counter: | |||
| counter[counterKey] = ([], None) # [countUntil,…], graceTermDate | |||
| (ticks, grace) = counter[counterKey] | |||
| now = datetime.datetime.utcnow() | |||
| self._cleanTicks(ticks, now) | |||
| if grace and grace < now: | |||
| grace = None | |||
| if not grace: | |||
| ticks.append(now + duration if duration else None) | |||
| counter[counterKey] = (ticks, grace) | |||
| return len(ticks) | |||
| def lower(self, counterKey): | |||
| counter = self._getCounter(self.counterName) | |||
| if counterKey not in counter: | |||
| return 0 | |||
| (ticks, _void) = counter[counterKey] | |||
| now = datetime.datetime.utcnow() | |||
| self._cleanTicks(ticks, now) | |||
| if len(ticks) > 0: | |||
| ticks.pop() | |||
| return len(ticks) | |||
| def reset(self, counterKey, graceDuration = None): | |||
| counter = self._getCounter(self.counterName) | |||
| if graceDuration: | |||
| now = datetime.datetime.utcnow() | |||
| counter[counterKey] = ([], now + graceDuration) | |||
| elif counterKey in counter: | |||
| del(counter[counterKey]) | |||
+ 34
- 0
pyruse/email.py
View File
| @@ -0,0 +1,34 @@ | |||
| import subprocess | |||
| from email.headerregistry import Address | |||
| from email.message import EmailMessage | |||
| from pyruse import config | |||
| class Mail: | |||
| _mailConf = config.Config().asMap().get("email", {}) | |||
| def __init__(self, text, html = None): | |||
| self.text = text | |||
| self.html = html | |||
| self.mailSubject = Mail._mailConf.get("subject", "Pyruse Report") | |||
| self.mailFrom = Mail._mailConf.get("from", "pyruse") | |||
| self.mailTo = Mail._mailConf.get("to", ["hostmaster"]) | |||
| def setSubject(self, subject): | |||
| if subject: | |||
| self.mailSubject = subject | |||
| return self | |||
| def send(self): | |||
| message = EmailMessage() | |||
| message["Subject"] = self.mailSubject | |||
| message["From"] = Address(addr_spec = self.mailFrom) | |||
| message["To"] = (Address(addr_spec = a) for a in self.mailTo) | |||
| message.set_content(self.text) | |||
| if self.html: | |||
| message.add_alternative(self.html, subtype = "html") | |||
| subprocess.run( | |||
| Mail._mailConf.get("sendmail", ["/usr/bin/sendmail", "-t"]), | |||
| input = message.as_bytes() | |||
| ) | |||
+ 10
- 0
pyruse/filters/filter_equals.py
View File
| @@ -0,0 +1,10 @@ | |||
| from pyruse import base | |||
| class Filter(base.Filter): | |||
| def __init__(self, args): | |||
| super().__init__() | |||
| self.field = args["field"] | |||
| self.value = args["value"] | |||
| def filter(self, entry): | |||
| return entry.get(self.field, None) == self.value | |||
+ 10
- 0
pyruse/filters/filter_greaterOrEquals.py
View File
| @@ -0,0 +1,10 @@ | |||
| from pyruse import base | |||
| class Filter(base.Filter): | |||
| def __init__(self, args): | |||
| super().__init__() | |||
| self.field = args["field"] | |||
| self.value = args["value"] | |||
| def filter(self, entry): | |||
| return entry.get(self.field, None) >= self.value | |||
+ 18
- 0
pyruse/filters/filter_pcre.py
View File
| @@ -0,0 +1,18 @@ | |||
| import re | |||
| from pyruse import base | |||
| class Filter(base.Filter): | |||
| def __init__(self, args): | |||
| super().__init__() | |||
| self.field = args["field"] | |||
| self.re = re.compile(args["re"]) | |||
| self.save = args.get("save", []) | |||
| def filter(self, entry): | |||
| match = self.re.search(entry.get(self.field, "")) | |||
| if match: | |||
| for group, name in enumerate(self.save, start = 1): | |||
| entry[name] = match.group(group) | |||
| for name, value in match.groupdict().items(): | |||
| entry[name] = value | |||
| return match | |||
+ 14
- 0
pyruse/filters/filter_userExists.py
View File
| @@ -0,0 +1,14 @@ | |||
| import pwd | |||
| from pyruse import base | |||
| class Filter(base.Filter): | |||
| def __init__(self, args): | |||
| super().__init__() | |||
| self.field = args["field"] | |||
| def filter(self, entry): | |||
| try: | |||
| pwd.getpwnam(entry.get(self.field, "")) | |||
| return True | |||
| except KeyError: | |||
| return False | |||
+ 21
- 0
pyruse/log.py
View File
| @@ -0,0 +1,21 @@ | |||
| from systemd import journal | |||
| EMERG = 0 # System is unusable. | |||
| ALERT = 1 # Action must be taken immediately. | |||
| CRIT = 2 # Critical conditions, such as hard device errors. | |||
| ERR = 3 # Error conditions. | |||
| WARNING = 4 # Warning conditions. | |||
| NOTICE = 5 # Normal but significant conditions. | |||
| INFO = 6 # Informational messages. | |||
| DEBUG = 7 | |||
| def log(level, string): | |||
| journal.send(string, PRIORITY = level) | |||
| def debug(string): | |||
| global DEBUG | |||
| log(DEBUG, string) | |||
| def error(string): | |||
| global ERR | |||
| log(ERR, string) | |||
+ 43
- 0
pyruse/main.py
View File
| @@ -0,0 +1,43 @@ | |||
| import os | |||
| import sys | |||
| from systemd import journal | |||
| from pyruse import base, config, module, workflow | |||
| PYRUSE_ENVVAR = "PYRUSE_EXTRA" | |||
| PYRUSE_PATHS = [] | |||
| def _setPyrusePaths(): | |||
| global PYRUSE_ENVVAR, PYRUSE_PATHS | |||
| for p in "/etc/pyruse", os.environ.get(PYRUSE_ENVVAR): | |||
| if p != "" and os.path.isdir(p): | |||
| PYRUSE_PATHS.insert(0, p) | |||
| sys.path.insert(1, p) | |||
| PYRUSE_PATHS.insert(0, os.curdir) | |||
| def _doForEachJournalEntry(fct): | |||
| j = journal.Reader(journal.SYSTEM_ONLY) | |||
| j.seek_tail() | |||
| j.get_previous() | |||
| while True: | |||
| event = j.wait(-1) | |||
| if event == journal.APPEND: | |||
| for entry in j: | |||
| fct(j) | |||
| def main(): | |||
| _setPyrusePaths() | |||
| conf = config.Config(PYRUSE_PATHS) | |||
| fback = conf.asMap().get("fallback", {}) | |||
| if "all_filters_failed" in fback: | |||
| base.filterFallback = module.get(fback.get("all_filters_failed")).module | |||
| else: | |||
| base.filterFallback = None | |||
| if "finalize_after_last_action" in fback: | |||
| base.actionFallback = module.get(fback.get("finalize_after_last_action")).module | |||
| else: | |||
| base.actionFallback = None | |||
| wf = workflow.Workflow(conf.asMap().get("actions", {})) | |||
| _doForEachJournalEntry(wf.run) | |||
| if __name__ == '__main__': | |||
| main() | |||
+ 39
- 0
pyruse/module.py
View File
| @@ -0,0 +1,39 @@ | |||
| import importlib | |||
| from pyruse import log | |||
| _modules = {} | |||
| class Module: | |||
| def __init__(self, isAction, module, thenRun, elseRun): | |||
| self.isAction = isAction | |||
| self.isFilter = not isAction | |||
| self.module = module | |||
| self.thenRun = thenRun | |||
| self.elseRun = elseRun | |||
| def get(moduleDesc): | |||
| if "filter" in moduleDesc: | |||
| isAction = False | |||
| mod = _getModule("pyruse.filters." + moduleDesc["filter"]) | |||
| obj = mod.Filter(moduleDesc.get("args", {})) | |||
| thenRun = None | |||
| elseRun = moduleDesc["else"] if "else" in moduleDesc else None | |||
| elif "action" in moduleDesc: | |||
| isAction = True | |||
| mod = _getModule("pyruse.actions." + moduleDesc["action"]) | |||
| obj = mod.Action(moduleDesc.get("args", {})) | |||
| thenRun = moduleDesc["then"] if "then" in moduleDesc else None | |||
| elseRun = None | |||
| else: | |||
| raise ValueError("Step is neither “filter” nor “action”: %s\n" % str(moduleDesc)) | |||
| return Module(isAction, obj, thenRun, elseRun) | |||
| def _getModule(modName): | |||
| if modName not in _modules: | |||
| try: | |||
| module = importlib.import_module(modName) | |||
| except ImportError as e: | |||
| log.error("Module %s not found.\n" % modName) | |||
| raise e | |||
| _modules[modName] = module | |||
| return _modules[modName] | |||
+ 66
- 0
pyruse/workflow.py
View File
| @@ -0,0 +1,66 @@ | |||
| from pyruse import log, module | |||
| class Workflow: | |||
| def __init__(self, actions): | |||
| seen = {} | |||
| dangling = [] | |||
| firstStep = None | |||
| for label in actions: | |||
| if not label in seen: | |||
| (entryPoint, seen, newDangling) = self._initChain(actions, label, seen) | |||
| if firstStep is None: | |||
| firstStep = entryPoint | |||
| elif len(dangling) > 0: | |||
| for setter in dangling: | |||
| setter(entryPoint) | |||
| dangling = newDangling | |||
| self.run = firstStep.run if firstStep else self._noRun | |||
| def _noRun(self, whatever): | |||
| pass | |||
| def _initChain(self, actions, label, seen): | |||
| dangling = [] | |||
| previousSetter = None | |||
| firstStep = None | |||
| isPreviousDangling = False | |||
| isThenCalled = False | |||
| for step in actions[label]: | |||
| if isThenCalled: | |||
| break | |||
| mod = module.get(step) | |||
| obj = mod.module | |||
| if mod.isAction: | |||
| if mod.thenRun: | |||
| (seen, dangling) = \ | |||
| self._branchToChain(obj.setNextStep, mod.thenRun, actions, seen, dangling) | |||
| isThenCalled = True | |||
| isPreviousDangling = False | |||
| else: | |||
| if mod.elseRun: | |||
| (seen, dangling) = \ | |||
| self._branchToChain(obj.setAltStep, mod.elseRun, actions, seen, dangling) | |||
| else: | |||
| dangling.append(obj.setAltStep) | |||
| isPreviousDangling = True | |||
| if previousSetter: | |||
| previousSetter(obj) | |||
| else: | |||
| firstStep = obj | |||
| previousSetter = obj.setNextStep | |||
| if isPreviousDangling: | |||
| dangling.append(previousSetter) | |||
| seen[label] = firstStep | |||
| return (firstStep, seen, dangling) | |||
| def _branchToChain(self, parentSetter, branchName, actions, seen, dangling): | |||
| if branchName in seen: | |||
| parentSetter(seen[branchName]) | |||
| elif branchName in actions: | |||
| (entryPoint, seen, newDangling) = \ | |||
| self._initChain(actions, branchName, seen) | |||
| parentSetter(entryPoint) | |||
| dangling.extend(newDangling) | |||
| else: | |||
| raise ValueError("Action chain not found: %s\n" % branchName) | |||
| return (seen, dangling) | |||
+ 2
- 0
tests/acted_on.log.test_ref
View File
| @@ -0,0 +1,2 @@ | |||
| {'__REALTIME_TIMESTAMP': datetime.datetime(2118, 1, 1, 8, 1, 1, 7), '_HOSTNAME': 'dmz', 'service': 'login', 'MESSAGE': 'Accepted password for root from 1.2.3.4', 'user': 'root', 'ip': '1.2.3.4'} | |||
| {'__REALTIME_TIMESTAMP': datetime.datetime(2118, 1, 1, 8, 1, 1, 10), '_HOSTNAME': 'dmz', 'service': 'login', 'MESSAGE': 'Failed password for foobar from 1.2.3.4', 'user': 'foobar', 'ip': '1.2.3.4', 'failsCount': 3} | |||
+ 49
- 0
tests/action_counterRaise.py
View File
| @@ -0,0 +1,49 @@ | |||
| import time | |||
| from pyruse.actions.action_counterRaise import Action | |||
| from pyruse.actions import action_counterReset | |||
| def whenNonExistingThenRaiseTo1(): | |||
| entry = {"k": "raise#1"} | |||
| Action({"counter": "test", "for": "k", "save": "action_counterRaise1"}).act(entry) | |||
| assert entry["action_counterRaise1"] == 1 | |||
| def whenKeepSecondsThenRaiseUntilTimeOut(): | |||
| entry = {"k": "raise#2"} | |||
| action = Action({"counter": "test", "for": "k", "save": "action_counterRaise2", "keepSeconds": 3}) | |||
| action.act(entry) | |||
| assert entry["action_counterRaise2"] == 1 | |||
| time.sleep(2) | |||
| action.act(entry) | |||
| assert entry["action_counterRaise2"] == 2 | |||
| time.sleep(2) | |||
| action.act(entry) | |||
| assert entry["action_counterRaise2"] == 2 # one tick timed out | |||
| def whenDifferentKeyThenDifferentCounter(): | |||
| entry1 = {"k": "raise#3"} | |||
| entry2 = {"k": "raise#4"} | |||
| action = Action({"counter": "test", "for": "k", "save": "action_counterRaise3"}) | |||
| action.act(entry1) | |||
| assert entry1["action_counterRaise3"] == 1 | |||
| action.act(entry2) | |||
| assert entry2["action_counterRaise3"] == 1 | |||
| action.act(entry2) | |||
| assert entry2["action_counterRaise3"] == 2 | |||
| action.act(entry2) | |||
| assert entry2["action_counterRaise3"] == 3 | |||
| action.act(entry1) | |||
| assert entry1["action_counterRaise3"] == 2 | |||
| def whenGraceTimeThenCountIs0(): | |||
| entry = {"k": "raise#5"} | |||
| raiseAct = Action({"counter": "test", "for": "k", "save": "action_counterRaise4"}) | |||
| graceAct = action_counterReset.Action({"counter": "test", "for": "k", "graceSeconds": 1, "save": "action_counterRaise4"}) | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterRaise4"] == 1 | |||
| graceAct.act(entry) | |||
| assert entry["action_counterRaise4"] == 0 | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterRaise4"] == 0 | |||
| time.sleep(1) | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterRaise4"] == 1 | |||
+ 48
- 0
tests/action_counterReset.py
View File
| @@ -0,0 +1,48 @@ | |||
| import time | |||
| from pyruse.actions.action_counterReset import Action | |||
| from pyruse.actions import action_counterRaise | |||
| def whenResetThenCountIs0(): | |||
| entry = {"k": "reset#1"} | |||
| resetAct = Action({"counter": "test", "for": "k", "save": "action_counterReset1"}) | |||
| raiseAct = action_counterRaise.Action({"counter": "test", "for": "k", "save": "action_counterReset1"}) | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterReset1"] == 1 | |||
| resetAct.act(entry) | |||
| assert entry["action_counterReset1"] == 0 | |||
| def whenNoGraceTimeThenRaiseWorks(): | |||
| entry = {"k": "reset#2"} | |||
| resetAct = Action({"counter": "test", "for": "k", "save": "action_counterReset2"}) | |||
| raiseAct = action_counterRaise.Action({"counter": "test", "for": "k", "save": "action_counterReset2"}) | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterReset2"] == 1 | |||
| resetAct.act(entry) | |||
| assert entry["action_counterReset2"] == 0 | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterReset2"] == 1 | |||
| def whenGraceTimeThenRaiseFails(): | |||
| entry = {"k": "reset#3"} | |||
| resetAct = Action({"counter": "test", "for": "k", "save": "action_counterReset3", "graceSeconds": 1}) | |||
| raiseAct = action_counterRaise.Action({"counter": "test", "for": "k", "save": "action_counterReset3"}) | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterReset3"] == 1 | |||
| resetAct.act(entry) | |||
| assert entry["action_counterReset3"] == 0 | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterReset3"] == 0 | |||
| def whenGraceTimeThenRaiseWorksAtGraceEnd(): | |||
| entry = {"k": "reset#4"} | |||
| resetAct = Action({"counter": "test", "for": "k", "save": "action_counterReset4", "graceSeconds": 1}) | |||
| raiseAct = action_counterRaise.Action({"counter": "test", "for": "k", "save": "action_counterReset4"}) | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterReset4"] == 1 | |||
| resetAct.act(entry) | |||
| assert entry["action_counterReset4"] == 0 | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterReset4"] == 0 | |||
| time.sleep(1) | |||
| raiseAct.act(entry) | |||
| assert entry["action_counterReset4"] == 1 | |||
+ 77
- 0
tests/action_dailyReport.py
View File
| @@ -0,0 +1,77 @@ | |||
| import os | |||
| import re | |||
| from datetime import datetime | |||
| from pyruse.actions.action_dailyReport import Action | |||
| from pyruse import config | |||
| mail_filename = "email.dump" | |||
| wAction = Action({"level": "WARN", "message": "WarnMsg {m}"}) | |||
| iAction = Action({"level": "INFO", "message": "InfoMsg {m}"}) | |||
| oAction = Action({"level": "OTHER", "message": "MiscMsg {m}"}) | |||
| def newEntry(m): | |||
| return {"__REALTIME_TIMESTAMP": datetime.utcnow(), "m": m} | |||
| def whenNewDayThenReport(): | |||
| if os.path.exists(mail_filename): | |||
| os.remove(mail_filename) | |||
| Action._hour = 0 | |||
| oAction.act(newEntry("message1")) | |||
| assert not os.path.exists(mail_filename) | |||
| Action._hour = 25 | |||
| oAction.act(newEntry("message2")) | |||
| assert os.path.exists(mail_filename) | |||
| os.remove(mail_filename) | |||
| def whenEmailThenCheckContents(): | |||
| if os.path.exists(mail_filename): | |||
| os.remove(mail_filename) | |||
| Action._hour = 0 | |||
| wAction.act(newEntry("messageW")) | |||
| iAction.act(newEntry("messageI")) | |||
| Action._hour = 25 | |||
| oAction.act(newEntry("messageO")) | |||
| assert os.path.exists(mail_filename) | |||
| conf = config.Config().asMap().get("email", {}) | |||
| reSubject = re.compile(r"^Subject: (.*)") | |||
| reFrom = re.compile(r"^From: (.*)") | |||
| reTo = re.compile(r"^To: (.*)") | |||
| subjOK = False | |||
| fromOK = False | |||
| toOK = False | |||
| nbWarn = 0 | |||
| nbInfo = 0 | |||
| nbMisc = 0 | |||
| with open(mail_filename, 'rt') as m: | |||
| for line in m: | |||
| match = reSubject.match(line) | |||
| if match: | |||
| subjOK = match.group(1) == conf.get("subject", "Pyruse Report") | |||
| match = reFrom.match(line) | |||
| if match: | |||
| fromOK = match.group(1) == conf.get("from", "pyruse") | |||
| match = reTo.match(line) | |||
| if match: | |||
| toOK = match.group(1).split(", ") == conf.get("to", ["hostmaster"]) | |||
| if "WarnMsg" in line: | |||
| nbWarn += 1 | |||
| if "InfoMsg" in line: | |||
| nbInfo += 1 | |||
| if "MiscMsg" in line: | |||
| nbMisc += 1 | |||
| assert subjOK | |||
| assert fromOK | |||
| assert toOK | |||
| assert nbWarn == 2 | |||
| assert nbInfo == 2 | |||
| assert nbMisc == 2 | |||
| os.remove(mail_filename) | |||
| def whenReportThenNewSetOfMessages(): | |||
| if os.path.exists(mail_filename): | |||
| os.remove(mail_filename) | |||
| Action._hour = 25 | |||
| oAction.act(newEntry("message3")) | |||
| assert os.path.exists(mail_filename) | |||
| os.remove(mail_filename) | |||
| whenEmailThenCheckContents() | |||
+ 70
- 0
tests/action_email.py
View File
| @@ -0,0 +1,70 @@ | |||
| import os | |||
| import re | |||
| from pyruse.actions.action_email import Action | |||
| from pyruse import config | |||
| mail_filename = "email.dump" | |||
| def whenEmailWithSubjectThenCheckContents(): | |||
| if os.path.exists(mail_filename): | |||
| os.remove(mail_filename) | |||
| Action({"subject": "Test1", "message": "TestMsg{m}"}).act({"m": "#1"}) | |||
| assert os.path.exists(mail_filename) | |||
| conf = config.Config().asMap().get("email", {}) | |||
| reSubject = re.compile(r"^Subject: (.*)") | |||
| reFrom = re.compile(r"^From: (.*)") | |||
| reTo = re.compile(r"^To: (.*)") | |||
| subjOK = False | |||
| fromOK = False | |||
| toOK = False | |||
| nbMsg = 0 | |||
| with open(mail_filename, 'rt') as m: | |||
| for line in m: | |||
| match = reSubject.match(line) | |||
| if match: | |||
| subjOK = match.group(1) == "Test1" | |||
| match = reFrom.match(line) | |||
| if match: | |||
| fromOK = match.group(1) == conf.get("from", "pyruse") | |||
| match = reTo.match(line) | |||
| if match: | |||
| toOK = match.group(1).split(", ") == conf.get("to", ["hostmaster"]) | |||
| if "TestMsg#1" in line: | |||
| nbMsg += 1 | |||
| assert subjOK | |||
| assert fromOK | |||
| assert toOK | |||
| assert nbMsg == 1 | |||
| os.remove(mail_filename) | |||
| def whenEmailWithoutSubjectThenCheckContents(): | |||
| if os.path.exists(mail_filename): | |||
| os.remove(mail_filename) | |||
| Action({"message": "TestMsg{m}"}).act({"m": "#2"}) | |||
| assert os.path.exists(mail_filename) | |||
| conf = config.Config().asMap().get("email", {}) | |||
| reSubject = re.compile(r"^Subject: (.*)") | |||
| reFrom = re.compile(r"^From: (.*)") | |||
| reTo = re.compile(r"^To: (.*)") | |||
| subjOK = False | |||
| fromOK = False | |||
| toOK = False | |||
| nbMsg = 0 | |||
| with open(mail_filename, 'rt') as m: | |||
| for line in m: | |||
| match = reSubject.match(line) | |||
| if match: | |||
| subjOK = match.group(1) == "Pyruse Notification" | |||
| match = reFrom.match(line) | |||
| if match: | |||
| fromOK = match.group(1) == conf.get("from", "pyruse") | |||
| match = reTo.match(line) | |||
| if match: | |||
| toOK = match.group(1).split(", ") == conf.get("to", ["hostmaster"]) | |||
| if "TestMsg#2" in line: | |||
| nbMsg += 1 | |||
| assert subjOK | |||
| assert fromOK | |||
| assert toOK | |||
| assert nbMsg == 1 | |||
| os.remove(mail_filename) | |||
+ 136
- 0
tests/action_nftBan.py
View File
| @@ -0,0 +1,136 @@ | |||
| import json | |||
| import os | |||
| import time | |||
| from pyruse.actions.action_nftBan import Action | |||
| nftBanCmd = "nftBan.cmd" | |||
| nftBanState = "action_nftBan.py.json" | |||
| def _clean(): | |||
| if os.path.exists(nftBanCmd): | |||
| os.remove(nftBanCmd) | |||
| if os.path.exists(nftBanState): | |||
| os.remove(nftBanState) | |||
| def whenBanIPv4ThenAddToIPv4Set(): | |||
| _clean() | |||
| Action({"IP": "ip", "nftSetIPv4": "I4 ban", "nftSetIPv6": "I6 ban"}).act({"ip": "10.0.0.1"}) | |||
| assert os.path.exists(nftBanCmd) | |||
| assert os.path.exists(nftBanState) | |||
| nbLines = 0 | |||
| with open(nftBanCmd, "rt") as c: | |||
| for line in c: | |||
| assert line == "add element I4 ban {10.0.0.1}\n", line | |||
| nbLines += 1 | |||
| assert nbLines == 1, nbLines | |||
| nbBans = 0 | |||
| with open(nftBanState) as s: | |||
| for ban in json.load(s): | |||
| assert ban["IP"] == "10.0.0.1" and ban["nftSet"] == "I4 ban", str(ban) | |||
| nbBans += 1 | |||
| assert nbBans == 1, nbBans | |||
| _clean() | |||
| def whenBanIPv6ThenAddToIPv6Set(): | |||
| _clean() | |||
| Action({"IP": "ip", "nftSetIPv4": "I4 ban", "nftSetIPv6": "I6 ban"}).act({"ip": "::1"}) | |||
| assert os.path.exists(nftBanCmd) | |||
| assert os.path.exists(nftBanState) | |||
| nbLines = 0 | |||
| with open(nftBanCmd, "rt") as c: | |||
| for line in c: | |||
| assert line == "add element I6 ban {::1}\n", line | |||
| nbLines += 1 | |||
| assert nbLines == 1, nbLines | |||
| nbBans = 0 | |||
| with open(nftBanState) as s: | |||
| for ban in json.load(s): | |||
| assert ban["IP"] == "::1" and ban["nftSet"] == "I6 ban", str(ban) | |||
| nbBans += 1 | |||
| assert nbBans == 1, nbBans | |||
| _clean() | |||
| def whenBanTwoIPThenTwoLinesInState(): | |||
| _clean() | |||
| action = Action({"IP": "ip", "nftSetIPv4": "I4 ban", "nftSetIPv6": "I6 ban"}) | |||
| action.act({"ip": "10.0.0.1"}) | |||
| action.act({"ip": "::1"}) | |||
| action.act({"ip": "10.0.0.1"}) | |||
| assert os.path.exists(nftBanState) | |||
| nbBans = 0 | |||
| with open(nftBanState) as s: | |||
| for ban in json.load(s): | |||
| if ban["IP"] == "10.0.0.1": | |||
| assert ban["nftSet"] == "I4 ban", str(ban) | |||
| elif ban["IP"] == "::1": | |||
| assert ban["nftSet"] == "I6 ban", str(ban) | |||
| else: | |||
| assert false, str(ban) | |||
| nbBans += 1 | |||
| assert nbBans == 2, nbBans | |||
| _clean() | |||
| def whenBanAnewThenNoDuplicate(): | |||
| _clean() | |||
| action = Action({"IP": "ip", "nftSetIPv4": "I4 ban", "nftSetIPv6": "I6 ban"}) | |||
| action.act({"ip": "10.0.0.1"}) | |||
| action.act({"ip": "10.0.0.1"}) | |||
| assert os.path.exists(nftBanCmd) | |||
| assert os.path.exists(nftBanState) | |||
| lineCount = 0 | |||
| with open(nftBanCmd, "rt") as c: | |||
| for line in c: | |||
| lineCount += 1 | |||
| if lineCount == 1: | |||
| assert line == "add element I4 ban {10.0.0.1}\n", line | |||
| elif lineCount == 2: | |||
| assert line == "delete element I4 ban {10.0.0.1}\n", line | |||
| elif lineCount == 3: | |||
| assert line == "add element I4 ban {10.0.0.1}\n", line | |||
| assert lineCount == 3, lineCount | |||
| nbBans = 0 | |||
| with open(nftBanState) as s: | |||
| for ban in json.load(s): | |||
| if ban["IP"] == "10.0.0.1": | |||
| assert ban["nftSet"] == "I4 ban", str(ban) | |||
| nbBans += 1 | |||
| assert nbBans == 1, nbBans | |||
| _clean() | |||
| def whenFinishedBanThenAsIfNotThere(): | |||
| _clean() | |||
| action = Action({"IP": "ip", "nftSetIPv4": "I4 ban", "nftSetIPv6": "I6 ban", "banSeconds": 1}) | |||
| action.act({"ip": "10.0.0.1"}) | |||
| time.sleep(1) | |||
| action.act({"ip": "10.0.0.1"}) | |||
| assert os.path.exists(nftBanCmd) | |||
| lineCount = 0 | |||
| with open(nftBanCmd, "rt") as c: | |||
| for line in c: | |||
| lineCount += 1 | |||
| if lineCount == 1: | |||
| assert line == "add element I4 ban {10.0.0.1 timeout 1s}\n", line | |||
| elif lineCount == 2: | |||
| assert line == "add element I4 ban {10.0.0.1 timeout 1s}\n", line | |||
| assert lineCount == 2, lineCount | |||
| _clean() | |||
| def whenUnfinishedBanThenTimeoutReset(): | |||
| _clean() | |||
| action = Action({"IP": "ip", "nftSetIPv4": "I4 ban", "nftSetIPv6": "I6 ban", "banSeconds": 2}) | |||
| action.act({"ip": "10.0.0.1"}) | |||
| time.sleep(1) | |||
| action.act({"ip": "10.0.0.1"}) | |||
| assert os.path.exists(nftBanCmd) | |||
| lineCount = 0 | |||
| with open(nftBanCmd, "rt") as c: | |||
| for line in c: | |||
| lineCount += 1 | |||
| if lineCount == 1: | |||
| assert line == "add element I4 ban {10.0.0.1 timeout 2s}\n", line | |||
| elif lineCount == 2: | |||
| assert line == "delete element I4 ban {10.0.0.1}\n", line | |||
| elif lineCount == 3: | |||
| assert line == "add element I4 ban {10.0.0.1 timeout 2s}\n", line | |||
| assert lineCount == 3, lineCount | |||
| _clean() | |||
+ 147
- 0
tests/email.dump.test_ref
View File
| @@ -0,0 +1,147 @@ | |||
| Subject: You should have a look | |||
| From: pyruse@localhost | |||
| To: hostmaster@localhost, webmaster@localhost | |||
| Content-Type: text/plain; charset="utf-8" | |||
| Content-Transfer-Encoding: 7bit | |||
| MIME-Version: 1.0 | |||
| Caution: Failed login as nobody@dmz on 2118-01-01 08:01:01.000003. | |||
| Subject: You should have a look | |||
| From: pyruse@localhost | |||
| To: hostmaster@localhost, webmaster@localhost | |||
| Content-Type: text/plain; charset="utf-8" | |||
| Content-Transfer-Encoding: 7bit | |||
| MIME-Version: 1.0 | |||
| Caution: Failed login as root@bck on 2118-01-01 08:01:01.000008. | |||
| Subject: You should have a look | |||
| From: pyruse@localhost | |||
| To: hostmaster@localhost, webmaster@localhost | |||
| Content-Type: text/plain; charset="utf-8" | |||
| Content-Transfer-Encoding: 7bit | |||
| MIME-Version: 1.0 | |||
| Caution: Failed login as nobody@bck on 2118-01-01 08:01:01.000009. | |||
| Subject: You should have a look | |||
| From: pyruse@localhost | |||
| To: hostmaster@localhost, webmaster@localhost | |||
| Content-Type: text/plain; charset="utf-8" | |||
| Content-Transfer-Encoding: 7bit | |||
| MIME-Version: 1.0 | |||
| Caution: Failed login as nobody@dmz on 2118-01-01 08:01:01.000011. | |||
| Subject: You should have a look | |||
| From: pyruse@localhost | |||
| To: hostmaster@localhost, webmaster@localhost | |||
| Content-Type: text/plain; charset="utf-8" | |||
| Content-Transfer-Encoding: 7bit | |||
| MIME-Version: 1.0 | |||
| Caution: Failed login as root@bck on 2118-01-01 08:01:01.000012. | |||
| Subject: Pyruse Test Report | |||
| From: pyruse@localhost | |||
| To: hostmaster@localhost, webmaster@localhost | |||
| MIME-Version: 1.0 | |||
| Content-Type: multipart/alternative; | |||
| boundary="===============1561885666140999446==" | |||
| --===============1561885666140999446== | |||
| Content-Type: text/plain; charset="utf-8" | |||
| Content-Transfer-Encoding: 7bit | |||
| = Pyruse Report | |||
| == WARNING Messages | |||
| |=============================================================================== | |||
| |Count|Message |Date+time for each occurrence | |||
| | 1 |Failed login as nobody from 1.2.3.4 | |||
| |2118-01-01 08:01:01.000009 | |||
| | 2 |Failed login as nobody from 5.6.7.8 | |||
| |2118-01-01 08:01:01.000003 + | |||
| 2118-01-01 08:01:01.000011 | |||
| | 1 |Failed login as root from 1.2.3.4 | |||
| |2118-01-01 08:01:01.000008 | |||
| | 1 |Failed login as root from ::1 | |||
| |2118-01-01 08:01:01.000012 | |||
| |=============================================================================== | |||
| == Information Messages | |||
| |=============================================================================== | |||
| |Count|Message |Date+time for each occurrence | |||
| | 1 |Failed login as Unknown User from 1.2.3.4 | |||
| |2118-01-01 08:01:01.000002 | |||
| | 1 |Failed login as User Unknown from 1.2.3.4 | |||
| |2118-01-01 08:01:01.000005 | |||
| | 1 |Failed login as foobar from 1.2.3.4 | |||
| |2118-01-01 08:01:01.000010 | |||
| | 1 |Login as root from 1.2.3.4 | |||
| |2118-01-01 08:01:01.000007 | |||
| |=============================================================================== | |||
| == Other log events | |||
| ---------- | |||
| 2118-01-01 08:01:01.000001: Filter came last [dmz:ftp] an ftp message | |||
| 2118-01-01 08:01:01.000002: Filter came last [dmz:login] Failed password for Unknown User from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000003: Filter came last [dmz:login] Failed password for nobody from 5.6.7.8 | |||
| 2118-01-01 08:01:01.000004: Filter came last [dmz:login] End of session for root on localhost | |||
| 2118-01-01 08:01:01.000005: Filter came last [dmz:login] Failed password for User Unknown from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000006: Filter came last [bck:ftp] file requested | |||
| 2118-01-01 08:01:01.000007: Action came last [dmz:login] Accepted password for root from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000008: Filter came last [bck:login] Failed password for root from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000009: Filter came last [bck:login] Failed password for nobody from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000010: Action came last [dmz:login] Failed password for foobar from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000011: Filter came last [dmz:login] Failed password for nobody from 5.6.7.8 | |||
| ---------- | |||
| --===============1561885666140999446== | |||
| Content-Type: text/html; charset="utf-8" | |||
| Content-Transfer-Encoding: 7bit | |||
| MIME-Version: 1.0 | |||
| <html> | |||
| <head><meta charset="utf-8"/></head> | |||
| <body> | |||
| <h1>Pyruse Report</h1> | |||
| <h2>WARNING Messages</h2> | |||
| <table> | |||
| <tr><th>Count</th><th>Message</th><th>Date+time for each occurrence</th></tr> | |||
| <tr><td>1</td><td>Failed login as nobody from 1.2.3.4</td><td>2118-01-01 08:01:01.000009</td></tr> | |||
| <tr><td>2</td><td>Failed login as nobody from 5.6.7.8</td><td>2118-01-01 08:01:01.000003<br/>2118-01-01 08:01:01.000011</td></tr> | |||
| <tr><td>1</td><td>Failed login as root from 1.2.3.4</td><td>2118-01-01 08:01:01.000008</td></tr> | |||
| <tr><td>1</td><td>Failed login as root from ::1</td><td>2118-01-01 08:01:01.000012</td></tr> | |||
| </table> | |||
| <h2>Information Messages</h2> | |||
| <table> | |||
| <tr><th>Count</th><th>Message</th><th>Date+time for each occurrence</th></tr> | |||
| <tr><td>1</td><td>Failed login as Unknown User from 1.2.3.4</td><td>2118-01-01 08:01:01.000002</td></tr> | |||
| <tr><td>1</td><td>Failed login as User Unknown from 1.2.3.4</td><td>2118-01-01 08:01:01.000005</td></tr> | |||
| <tr><td>1</td><td>Failed login as foobar from 1.2.3.4</td><td>2118-01-01 08:01:01.000010</td></tr> | |||
| <tr><td>1</td><td>Login as root from 1.2.3.4</td><td>2118-01-01 08:01:01.000007</td></tr> | |||
| </table> | |||
| <h2>Other log events</h2> | |||
| <pre>2118-01-01 08:01:01.000001: Filter came last [dmz:ftp] an ftp message | |||
| 2118-01-01 08:01:01.000002: Filter came last [dmz:login] Failed password for Unknown User from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000003: Filter came last [dmz:login] Failed password for nobody from 5.6.7.8 | |||
| 2118-01-01 08:01:01.000004: Filter came last [dmz:login] End of session for root on localhost | |||
| 2118-01-01 08:01:01.000005: Filter came last [dmz:login] Failed password for User Unknown from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000006: Filter came last [bck:ftp] file requested | |||
| 2118-01-01 08:01:01.000007: Action came last [dmz:login] Accepted password for root from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000008: Filter came last [bck:login] Failed password for root from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000009: Filter came last [bck:login] Failed password for nobody from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000010: Action came last [dmz:login] Failed password for foobar from 1.2.3.4 | |||
| 2118-01-01 08:01:01.000011: Filter came last [dmz:login] Failed password for nobody from 5.6.7.8 | |||
| </pre> | |||
| </body></html> | |||
| --===============1561885666140999446==-- | |||
+ 13
- 0
tests/filter_equals.py
View File
| @@ -0,0 +1,13 @@ | |||
| from pyruse.filters.filter_equals import Filter | |||
| def whenGreaterThenFalse(): | |||
| assert not Filter({"field": "v", "value": 2}).filter({"v": 3}) | |||
| def whenEqualSameTypeThenTrue(): | |||
| assert Filter({"field": "v", "value": 2}).filter({"v": 2}) | |||
| def whenEqualDiffTypeThenTrue(): | |||
| assert Filter({"field": "v", "value": 2.0}).filter({"v": 2}) | |||
| def whenLowerThenFalse(): | |||
| assert not Filter({"field": "v", "value": 2}).filter({"v": 0}) | |||
+ 16
- 0
tests/filter_greaterOrEquals.py
View File
| @@ -0,0 +1,16 @@ | |||
| from pyruse.filters.filter_greaterOrEquals import Filter | |||
| def whenGreaterPosIntThenTrue(): | |||
| assert Filter({"field": "v", "value": 2}).filter({"v": 3}) | |||
| def whenGreaterNegFloatThenTrue(): | |||
| assert Filter({"field": "v", "value": -2.1}).filter({"v": -1.9}) | |||
| def whenEqualSameTypeThenTrue(): | |||
| assert Filter({"field": "v", "value": 2}).filter({"v": 2}) | |||
| def whenEqualDiffTypeThenTrue(): | |||
| assert Filter({"field": "v", "value": 2.0}).filter({"v": 2}) | |||
| def whenLowerThenFalse(): | |||
| assert not Filter({"field": "v", "value": 2}).filter({"v": 0}) | |||
+ 17
- 0
tests/filter_pcre.py
View File
| @@ -0,0 +1,17 @@ | |||
| from pyruse.filters.filter_pcre import Filter | |||
| def whenMatchesThenTrue(): | |||
| assert Filter({"field": "v", "re": "ok"}).filter({"v": "joke"}) | |||
| def whenNoMatchThenFalse(): | |||
| assert not Filter({"field": "v", "re": "ko"}).filter({"v": "Koala"}) | |||
| def whenSaveThenGroupsInEntry(): | |||
| entry = {"v": "yet another test"} | |||
| Filter({"field": "v", "re": "^(.).* .*(.)r .*(.).$", "save": [ "y", "e", "s" ]}).filter(entry) | |||
| assert entry["y"] + entry["e"] + entry["s"] == "yes" | |||
| def whenNamedGroupsThenFoundInEntry(): | |||
| entry = {"v": "yet another test"} | |||
| Filter({"field": "v", "re": "^(?P<y>.).* .*(?P<e>.)r .*(?P<s>.).$"}).filter(entry) | |||
| assert entry["y"] + entry["e"] + entry["s"] == "yes" | |||
+ 7
- 0
tests/filter_userExists.py
View File
| @@ -0,0 +1,7 @@ | |||
| from pyruse.filters.filter_userExists import Filter | |||
| def whenUserExistsThenTrue(): | |||
| assert Filter({"field": "user"}).filter({"user": "root"}) | |||
| def whenGarbageThenFalse(): | |||
| assert not Filter({"field": "user"}).filter({"user": "auietsnr"}) | |||
+ 122
- 0
tests/main.py
View File
| @@ -0,0 +1,122 @@ | |||
| import os | |||
| import subprocess | |||
| import sys | |||
| from datetime import datetime | |||
| sys.path.insert(1, "..") | |||
| from pyruse import actions, base, config, module, workflow | |||
| def _clean(): | |||
| for f in ['acted_on.log', 'action_nftBan.py.json', 'email.dump', 'nftBan.cmd', 'unfiltered.log']: | |||
| if os.path.exists(f): | |||
| os.remove(f) | |||
| def main(): | |||
| global _microsec | |||
| conf = config.Config(os.curdir) | |||
| fback = conf.asMap().get("fallback", {}) | |||
| if "all_filters_failed" in fback: | |||
| base.filterFallback = module.get(fback.get("all_filters_failed")).module | |||
| else: | |||
| base.filterFallback = None | |||
| if "finalize_after_last_action" in fback: | |||
| base.actionFallback = module.get(fback.get("finalize_after_last_action")).module | |||
| else: | |||
| base.actionFallback = None | |||
| # Unit tests | |||
| import filter_equals, filter_greaterOrEquals, filter_pcre, filter_userExists | |||
| import action_counterRaise, action_counterReset, action_dailyReport, action_email, action_nftBan | |||
| filter_equals.whenGreaterThenFalse() | |||
| filter_equals.whenEqualSameTypeThenTrue() | |||
| filter_equals.whenEqualDiffTypeThenTrue() | |||
| filter_equals.whenLowerThenFalse() | |||
| filter_greaterOrEquals.whenGreaterPosIntThenTrue() | |||
| filter_greaterOrEquals.whenGreaterNegFloatThenTrue() | |||
| filter_greaterOrEquals.whenEqualSameTypeThenTrue() | |||
| filter_greaterOrEquals.whenEqualDiffTypeThenTrue() | |||
| filter_greaterOrEquals.whenLowerThenFalse() | |||
| filter_pcre.whenMatchesThenTrue() | |||
| filter_pcre.whenNoMatchThenFalse() | |||
| filter_pcre.whenSaveThenGroupsInEntry() | |||
| filter_pcre.whenNamedGroupsThenFoundInEntry() | |||
| filter_userExists.whenUserExistsThenTrue() | |||
| filter_userExists.whenGarbageThenFalse() | |||
| action_counterRaise.whenNonExistingThenRaiseTo1() | |||
| action_counterRaise.whenKeepSecondsThenRaiseUntilTimeOut() | |||
| action_counterRaise.whenDifferentKeyThenDifferentCounter() | |||
| action_counterRaise.whenGraceTimeThenCountIs0() | |||
| action_counterReset.whenResetThenCountIs0() | |||
| action_counterReset.whenNoGraceTimeThenRaiseWorks() | |||
| action_counterReset.whenGraceTimeThenRaiseFails() | |||
| action_counterReset.whenGraceTimeThenRaiseWorksAtGraceEnd() | |||
| action_dailyReport.whenNewDayThenReport() | |||
| action_dailyReport.whenEmailThenCheckContents() | |||
| action_dailyReport.whenReportThenNewSetOfMessages() | |||
| action_email.whenEmailWithSubjectThenCheckContents() | |||
| action_email.whenEmailWithoutSubjectThenCheckContents() | |||
| action_nftBan.whenBanIPv4ThenAddToIPv4Set() | |||
| action_nftBan.whenBanIPv6ThenAddToIPv6Set() | |||
| action_nftBan.whenBanTwoIPThenTwoLinesInState() | |||
| action_nftBan.whenBanAnewThenNoDuplicate() | |||
| action_nftBan.whenFinishedBanThenAsIfNotThere() | |||
| action_nftBan.whenUnfinishedBanThenTimeoutReset() | |||
| # Integration test | |||
| wf = workflow.Workflow(conf.asMap().get("actions", {})) | |||
| _microsec = 0 | |||
| test = [ | |||
| entry("dmz", "ftp", "an ftp message", 0), | |||
| entry("dmz", "login", "Failed password for Unknown User from 1.2.3.4"), | |||
| entry("dmz", "login", "Failed password for nobody from 5.6.7.8"), | |||
| entry("dmz", "login", "End of session for root on localhost"), | |||
| entry("dmz", "login", "Failed password for User Unknown from 1.2.3.4"), | |||
| entry("bck", "ftp", "file requested"), | |||
| entry("dmz", "login", "Accepted password for root from 1.2.3.4"), | |||
| entry("bck", "login", "Failed password for root from 1.2.3.4"), | |||
| entry("bck", "login", "Failed password for nobody from 1.2.3.4"), | |||
| entry("dmz", "login", "Failed password for foobar from 1.2.3.4"), | |||
| entry("dmz", "login", "Failed password for nobody from 5.6.7.8") | |||
| ] | |||
| _clean() | |||
| for e in test: | |||
| wf.run(e) | |||
| actions.action_dailyReport.Action._hour = 25 | |||