From e41f8bba2ac531b55ae4fa7268d0b0d01db0fdf1 Mon Sep 17 00:00:00 2001 From: Thomas Oettli Date: Sun, 3 Mar 2019 22:22:56 +0100 Subject: [PATCH] Initial commit of source code and docs --- LICENSE | 674 ++++++++++++++++++++++++++ MANIFEST.in | 3 + README.md | 100 ++++ docs/pyquarantine.conf.example | 113 +++++ docs/templates/notification.template | 10 + docs/templates/removed.png | Bin 0 -> 2136 bytes misc/openrc/pyquarantine-milter.confd | 17 + misc/openrc/pyquarantine-milter.initd | 50 ++ pyquarantine/__init__.py | 292 +++++++++++ pyquarantine/mailer.py | 65 +++ pyquarantine/notifications.py | 216 +++++++++ pyquarantine/quarantines.py | 74 +++ pyquarantine/run.py | 98 ++++ pyquarantine/whitelists.py | 141 ++++++ setup.py | 35 ++ 15 files changed, 1888 insertions(+) create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.md create mode 100644 docs/pyquarantine.conf.example create mode 100644 docs/templates/notification.template create mode 100644 docs/templates/removed.png create mode 100644 misc/openrc/pyquarantine-milter.confd create mode 100755 misc/openrc/pyquarantine-milter.initd create mode 100644 pyquarantine/__init__.py create mode 100644 pyquarantine/mailer.py create mode 100644 pyquarantine/notifications.py create mode 100644 pyquarantine/quarantines.py create mode 100644 pyquarantine/run.py create mode 100644 pyquarantine/whitelists.py create mode 100644 setup.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..ca4758c --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +include LICENSE README.md +recursive-include docs * +recursive-include misc * diff --git a/README.md b/README.md new file mode 100644 index 0000000..086b3bd --- /dev/null +++ b/README.md @@ -0,0 +1,100 @@ +# pyquarantine-milter +A pymilter based sendmail/postfix pre-queue filter with the ability to quarantine e-mails, sending notifications +to recipients and respond with a milter-action (ACCEPT, DISCARD or REJECT). + +It is useful in many cases because of its felxible configuration and the ability to handle any number of quarantines. +The MTA can check e-mail headers using regular expressions to determine if and which quarantine to use. +Each quarantine can be configured with a quarantine type, notification type, whitelist and an action to respond with. + +The project is currently in alpha status, but will soon be used in a productive enterprise environment and possibly existing bugs will be fixed. + +## Requirements +* pymilter +* peewee +* BeautifulSoup + +## Configuration +The pyquarantine module uses an INI-style configuration file. The sections are described below. + +### Section "global" +Any available configuration option can be set in the global section as default instead of in a quarantine section. + +The following configuration options are mandatory in the global section: +* **quarantines** + Comma-separated, ordered list of active quarantines. For each, there must be a section of the same name in the configuration. +* **smtp_host** + SMTP host to inject original e-mails. This is needed if not all recipients of an e-mail are whitelisted +* **smtp_port** + SMTP port + +### Quarantine sections +The following configuration options are mandatory in each quarantine section: +* **regex** + Regular expression to filter e-mail headers. +* **type** + One of the quarantine-types described below. +* **action** + One of the actions described below. +* **notification** + One of the notification types described below. +* **whitelist** + Database connection string (e.g. mysql://user:password@host:port) or NONE to disable whitelist. + +### Quarantine types +* **NONE** + Original e-mails scrapped, sent to nirvana, black-holed or however you want to call it. + +* **FILE** + Original e-mails are stored on the filesystem with a unique filename. The filename is available as a + template variable used in notifiaction templates. + The following configuration options are mandatory for this quarantine type: + * **directory** + The directory in which quarantined e-mails are stored. + + +### Notification types +* **NONE** + No quarantine notifications will be sent. + +* **EMAIL** + Quarantine e-mail notifications are sent to recipients. The SMTP host and port, E-mail template, from-address and the subject are configurable for each quarantine. The templates must contain the notification e-mail text in HTML form. + + The following template variables are available: + * **{EMAIL_FROM}** + E-mail from-address received by the milter (envelope-from). + * **{EMAIL_TO}** + E-mail recipient address of this notification. + * **{EMAIL_SUBJECT}** + Configured e-mail subject. + * **{EMAIL_QUARANTINE_ID}** + Quarantine-ID of the original e-mail if available, empty otherwise. + +The following configuration options are mandatory for this notification type: +* **notification_email_from** + Notification e-mail from-address. +* **notification_email_subject** + Notification e-mail subject. +* **notification_email_template** + Notification e-mail template to use. +* **notification_email_replacement_img** + An image to replace images in e-mail. + + +### Actions +Every quarantine responds with a milter-action if an e-mail header matches the configured regular expression. +The following actions are available: +* **ACCEPT** + Continue processing e-mails. +* **DISCARD** + Silently discard e-mails. +* **REJECT** + Reject e-mails. + + +### Whitelist +If a whitelist database connection string is configured, the following configuration options are mandatory: +* **whitelist_table** + Database table to use. + +## Developer information +Everyone who wants to improve or extend this project is very welcome. diff --git a/docs/pyquarantine.conf.example b/docs/pyquarantine.conf.example new file mode 100644 index 0000000..f89aa38 --- /dev/null +++ b/docs/pyquarantine.conf.example @@ -0,0 +1,113 @@ +# This is an example /etc/pyquarantine/pyquarantine.conf file. +# Copy it into place before use. +# +# Comments: use '#' for comment lines and ';' (following a space) for inline comments. +# +# If an option is not present in a quarantine section, it will be read from +# the global section. +# + + +[global] + +# Option: quarantines +# Notes: Set active quarantines (comma-separated). +# Each active quarantine must have a section with the same name below. +# The quarantine name 'global' is forbidden and will be ignored. +# Quarantine names must be unique. +# Values: [ ACTIVE ] +# +quarantines = spam + +# Option: smtp_host +# Notes: Set the SMTP host. It will be used to (re-)inject emails. +# Values: [ HOSTNAME | IP_ADDRESS ] +# +smtp_host = 127.0.0.1 + +# Option: smtp_port +# Notes: Set the SMTP port. +# Values: [ PORT ] +# +smtp_port = 25 + + +[spam] + +# Option: regex +# Notes: Set the regular expression to match against email headers. +# If the regex matches any of the email headers, the email +# will be processed by this quarantine. +# Values: [ REGEX ] +# +regex = ^X-Spam-Flag: YES + +# Option: type +# Notes: Set the quarantine type. +# Values: [ file | none ] +# +type = file + +# Option: directory +# Notes: Set the directory to store quarantined emails. +# This option is needed by quarantine type 'file'. +# Values: [ DIRECTORY ] +# +directory = /var/lib/pyquarantine/spam + +# Option: action +# Notes: Set the milter action to perform if email is processed by this quarantine. +# Values: [ accept | discard | reject ] +# +action = discard + +# Option: notification +# Notes: Set the notification type. +# Values: [ email | none ] +# +notification = email + +# Option: notification_email_from +# Notes: Set the from address used when sending notification emails. +# This option is needed by notification type 'email'. +# Values: [ FROM_ADDRESS ] +# +notification_email_from = notification@domain.tld + +# Option: notification_email_usbject +# Notes: Set the subject used when sending notification emails. +# This option is needed by notification type 'email'. +# Values: [ SUBJECT ] +# +notification_email_subject = Spam Quarantine Notification + +# Option: notification_email_template +# Notes: Set the template used when sending notification emails. +# A relative path to this config file can be used. +# This option is needed by notification type 'email'. +# Values: [ TEMPLATE_FILE ] +# +notification_email_template = templates/notification.template + +# Option: notification_email_replacement_img +# Notes: Set the replacement image for images within emails. +# A relative path to this config file can be used. +# This option is needed by notification type 'email'. +# Values: [ IMAGE_FILE ] +# +notification_email_replacement_img = templates/removed.png + +# Option: whitelist +# Notes: Set the whitelist of this quarantine. +# If a whitelist is used, the configured user must have +# read/write access to the table configured below. +# Values: [ DB_CONNECTION_STRING | none ] +# +whitelist = mysql://user:password@localhost/database + +# Option: whitelist_table +# Notes: Set the database table name. +# This option is needed if a whitelist is configured. +# Values: [ DATABASE_TABLE] +# +whitelist_table = whitelist diff --git a/docs/templates/notification.template b/docs/templates/notification.template new file mode 100644 index 0000000..985ae5e --- /dev/null +++ b/docs/templates/notification.template @@ -0,0 +1,10 @@ + + +

This is a spam notification mail

+From: {EMAIL_FROM}
+To: {EMAIL_TO}
+Subject: {EMAIL_SUBJECT}
+Quarantine-ID: {EMAIL_QUARANTINE_ID}


+{EMAIL_HTML_TEXT} + + diff --git a/docs/templates/removed.png b/docs/templates/removed.png new file mode 100644 index 0000000000000000000000000000000000000000..a5081b7f7c5d1a977fecaaca8076afd98b71283a GIT binary patch literal 2136 zcmZvec|6p67sr3Y2xZWyT!~y{xw13Dlr>8X8s(OK8%)N?jJ+@nYS1*6+_BSG>K2|X z7g-`}V;QncBfG{L5^gn?`*82`yk5^A&mZUeI_G@P`F{U-pU>-%>}<>-$Il)I003fX zVTuF*5cJS@=i@p&U3=~vU4ZaNb7P=l;N0?I0QNOP7y-bm$0znYcn)L!yB4?c03g_Y zWT5WAXWjt7yJl%>bR*n#E!QejwoEXwu?hS*%Jmc?0EU^WoQ>UY8~3?@rLQ|XJ65`2K!8{Ul7i5W5wsM94)}dkOfeDHgmLeQR5Am~2Dz&d>6gBw=!ET@yTP`o@1%n5R3s|H2M) zqrA#{Ic*drEL2oFm{Ws7%@>vC_;|?#0mhgtJ%p;O!4Rjvi?u_=4J9Gwq)5bwk`74` zBPgp=jG3Iq>AzhY9mRTBzh0?ar%V3<^d~+V)VMyX{#Nl4(~YO%YlD5*CRU6;NN$cDIf~FfYwFER72- zz0M!7dek)+1lMPE>Q+%}yM|Sja#9IZ6a<#N2gIgIr25u*70MUed&_+8Q6fwPDJ^={ zL@uX#S104W)%z8dbt2Qu(A2C6kmFH@J#}DpKy(#cp(-BI|2-1UPP-^{^Zl>o0tE?+ z+vCX>)^8}aL$1k{3!I-h6DGdJ6X=olf|yR!Fi+ zr$D>FcfKkeQb7T^^PaWzVh^>(1_p1Bo)RZx|v_~>n7X^Alsz(_5luF8A@mW z^SdJo%Wjem*&px-vzW?1;eh5RM(}v#-hI`y-TbVI6NC+}(@pD2pnCL5-ZA%TCRyux z_#fY7KQ!;=A2UzuR~g_>j)-E7486FDVQ%B(q+e>^zO1gnzC^SMbAB1=$+Q?lI~eqI zP1mVEfJf!pp5so(nR`EI;4#e4Qpsv-JB*)Y* z@CDQh?A$Yv_eyNb(4pt0-G;1Unc|Y;-sQrEtr1ow(pK`;9lfLoqcQqW$__0p(XvD~fHD zr>l;-H^XTz)k%&F`iIIvJ?U{p;^v6WM~de$7e4*%kiGj-RFe?jfCBA1*OY}J#OOE~qsjF$)-0|0Xn&--b-l$h@c57`` zZ?{%=a#ErL=fxy8ulvU>yVy@TlaxDy&1wsk@>`RARS+VK1kZQS(TmozxL{U|?!De_ zi?RlVHYl%&@mL53Z#PZniuxQx!N9exxTItz=s)%|EpGV-WHaukIc%um>zc(JDe27k zKlSQx(GpN%gGrZ+bp}K=>?8dP_jQtmQhPzdxCrrGl69@dp2L+j?0mEP#B9kr&hO-S zh~Wimih{W7cH!wsyxnG9`O=jWs`}M9)6ca}?+HRR7nN?8;ePZnVDXNp2H#`%5xrM^ z8lG$|rtf0x$xgXnO0H}cKT{-oJ;PDW)4&RrAGDH}`ZW#m z{LIVK)4cQMx<3q0mKFQ(jL9V;D-v2yrfZ9@@-wa@gm3w-rHMpu z%3o@=B5k;XzKfg#`Uq8^KyQvi`;i^djRb?58i1Eqoj|7g$ncW%${r zlgL=A9VdfI)wJ1P=peQc>O6jX)S$W2-_0AZ(|bzfNN{hlGal~y{oS;$FD72C#OTA7L(`QLS&A^dDJIw3Ww! zzIA+`N)(EB?`fZKg-3Nb>brDIE|*JDacVz(u`w$sE_wD%Y)uVa;!g;@));0x@6blb zq5REBBIl5q^CM2mtvNOVj<#?!z@&G|)k9!ax2u!!^pVzvRL>B&Jdbkw;faO&i K(+XqvxPJpND*fjG literal 0 HcmV?d00001 diff --git a/misc/openrc/pyquarantine-milter.confd b/misc/openrc/pyquarantine-milter.confd new file mode 100644 index 0000000..38d1d35 --- /dev/null +++ b/misc/openrc/pyquarantine-milter.confd @@ -0,0 +1,17 @@ +# /etc/conf.d/pyquarantine-milter: config file for /etc/init.d/pyquarantine-milter + +# Set the socket used to communicate with the MTA. +# Examples: +# unix:/path/to/socket a named pipe +# inet:8899 listen on ANY interface +# inet:8899@localhost listen on a specific interface +# inet6:8899 listen on ANY interface +# inet6:8899@[2001:db8:1234::1] listen on a specific interface +SOCKET="inet:8899@127.0.0.1" + +# Start the daemon as the user. You can optionally append a group name here also. +# USER="daemon" +# USER="daemon:nobody" + +# Optional parameters for pyquarantine-milter +# MILTER_OPTS="" diff --git a/misc/openrc/pyquarantine-milter.initd b/misc/openrc/pyquarantine-milter.initd new file mode 100755 index 0000000..3205f28 --- /dev/null +++ b/misc/openrc/pyquarantine-milter.initd @@ -0,0 +1,50 @@ +#!/sbin/openrc-run + +user=${USER:-daemon:nobody} +socket="${SOCKET:-}" +milter_opts="${MILTER_OPTS:-}" + +pidfile="/run/${RC_SVCNAME}.pid" +command="/usr/bin/pyquarantine-milter" +command_args="-s ${socket} ${milter_opts}" +command_background=true +start_stop_daemon_args="--user ${user}" + +extra_commands="configtest" + +depend() { + need net + before mta +} + +checkconfig() { + if [ -z "${socket}" ]; then + eerror "No socket specified in config!" + fi + OUTPUT=$( ${command} ${command_args} -t 2>&1 ) + ret=$? + if [ $ret -ne 0 ]; then + eerror "${SVCNAME} has detected an error in your configuration:" + printf "%s\n" "${OUTPUT}" + fi + + return $ret +} + +configtest() { + ebegin "Checking ${SVCNAME} configuration" + checkconfig + eend $? +} + +start_pre() { + if [ "${RC_CMD}" != "restart" ]; then + checkconfig || return $? + fi +} + +stop_pre() { + if [ "${RC_CMD}" != "restart" ]; then + checkconfig || return $? + fi +} diff --git a/pyquarantine/__init__.py b/pyquarantine/__init__.py new file mode 100644 index 0000000..d5f9ec5 --- /dev/null +++ b/pyquarantine/__init__.py @@ -0,0 +1,292 @@ +#!/usr/bin/env python2 +# +# PyQuarantine-Milter 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. +# +# PyQuarantine-Milter 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 PyQuarantineMilter. If not, see . +# + +__all__ = ["QuarantineMilter", "generate_milter_config", "reload_config", "mailer", "notifications", "run", "quarantines", "whitelists"] + +import ConfigParser +import Milter +import StringIO +import logging +import os +import re +import sys + +import mailer +import quarantines +import notifications +import whitelists + +from Milter.utils import parse_addr + + + +class QuarantineMilter(Milter.Base): + """QuarantineMilter based on Milter.Base to implement milter communication + + The class variable config needs to be filled with the result of the generate_milter_config function. + + """ + config = None + + # list of default config files + _config_files = ["/etc/pyquarantine/pyquarantine.conf", os.path.expanduser('~/pyquarantine.conf'), "pyquarantine.conf"] + # list of possible actions + _actions = {"ACCEPT": Milter.ACCEPT, "REJECT": Milter.REJECT, "DISCARD": Milter.DISCARD} + + + def __init__(self): + self.logger = logging.getLogger(__name__) + # save config, it must not change during runtime + self.config = QuarantineMilter.config + + @staticmethod + def get_configfiles(): + return QuarantineMilter._config_files + + @staticmethod + def get_actions(): + return QuarantineMilter._actions + + @staticmethod + def set_configfiles(config_files): + QuarantineMilter._config_files = config_files + + @Milter.noreply + def envfrom(self, mailfrom, *str): + self.mailfrom = "@".join(parse_addr(mailfrom)).lower() + self.recipients = set() + return Milter.CONTINUE + + @Milter.noreply + def envrcpt(self, to, *str): + self.recipients.add("@".join(parse_addr(to)).lower()) + return Milter.CONTINUE + + @Milter.noreply + def data(self): + self.queueid = self.getsymval('i') + self.logger.debug("{}: received queue-id from MTA".format(self.queueid)) + self.recipients = list(self.recipients) + self.headers = [] + self.subject = "" + return Milter.CONTINUE + + @Milter.noreply + def header(self, name, value): + self.headers.append("{}: {}".format(name, value)) + if name.lower() == "subject": + self.subject = value + return Milter.CONTINUE + + def eoh(self): + self.matched = None + self.whitelist = whitelists.WhitelistCache() + # iterate email headers + for header in self.headers: + self.logger.debug("{}: checking header '{}' against regex of every configured quarantine".format(self.queueid, header)) + # iterate quarantines + for name, quarantine in self.config.items(): + if self.matched != None and quarantine["index"] == self.matched["index"]: + # a quarantine with higher precedence already matched, skip checks of quarantines with lower precedence + self.logger.debug("{}: quarantine '{}' matched already, skip further checks of this header".format(self.queueid, name)) + break + self.logger.debug("{}: checking header against quarantine '{}'".format(self.queueid, name)) + # check if header matches regex + if quarantine["regex_compiled"].match(header): + if quarantine["whitelist"] != None and \ + len(self.whitelist.get_whitelisted_recipients(quarantine["whitelist"], self.mailfrom, self.recipients)) == len(self.recipients): + # all recipients are whitelisted, continue with header checks + self.logger.debug("{}: header matched regex, but all recipients are whitelisted in quarantine '{}', continue checking this header".format(self.queueid, name)) + continue + self.matched = quarantine + # skip checks of this header with quarantines with lower precedence + self.logger.debug("{}: header matched regex in quarantine '{}', further checks of this header will be skipped".format(self.queueid, name)) + break + if self.matched != None and self.matched["index"] == 0: + self.logger.debug("{}: skipping checks of remaining headers, the quarantine with highest precedence matched already".format(self.queueid)) + break + if self.matched != None: + self.logger.info("{}: email matched quarantine '{}'".format(self.queueid, self.matched["name"])) + # one of the configured quarantines matched + if self.matched["quarantine"] != None or self.matched["notification"] != None: + self.logger.debug("{}: initializing memory buffer to save email data".format(self.queueid)) + # quarantine or notification configured, initialize memory buffer to save mail + self.fp = StringIO.StringIO() + # write email headers to memory buffer + self.fp.write("{}\n".format("\n".join(self.headers))) + else: + # quarantine and notification disabled, return configured action + self.logger.debug("{}: ".format(self.queueid)) + self.logger.info("{}: quarantine and notification disabled, responding with configured action: {}".format(self.queueid, self.matched["action"].upper())) + return self.matched["milter_action"] + else: + # no quarantine matched, accept mail + self.logger.info("{}: email passed clean".format(self.queueid)) + return Milter.ACCEPT + return Milter.CONTINUE + + def body(self, chunk): + # save received body chunk + self.fp.write(chunk) + return Milter.CONTINUE + + def eom(self): + if self.matched["whitelist"] != None: + whitelisted_recipients = self.whitelist.get_whitelisted_recipients(self.matched["whitelist"], self.mailfrom, self.recipients) + if len(whitelisted_recipients) > 0: + for recipient in whitelisted_recipients: + self.recipients.remove(recipient) + self.fp.seek(0) + self.logger.info("{}: sending original email to whitelisted recipient(s): {}".format(self.queueid, "<{}>".format(">,<".join(whitelisted_recipients)))) + try: + mailer.sendmail(self.matched["smtp_host"], self.matched["smtp_port"], self.queueid, self.mailfrom, whitelisted_recipients, self.fp.read()) + except Exception as e: + self.logger.error("{}: unable to send original email: {}".format(self.queueid, e)) + return Milter.TEMPFAIL + if len(self.recipients) > 0: + quarantine_id = "" + if self.matched["quarantine"] != None: + # add email to quarantine + self.fp.seek(0) + try: + quarantine_id = self.matched["quarantine"].add(self.queueid, self.mailfrom, self.recipients, fp=self.fp) + except Exception as e: + self.logger.error("{}: unable to add email to quarantine: {}".format(self.queueid, e)) + return Milter.TEMPFAIL + else: + self.logger.info("{}: added email to quarantine of recipient(s): {}".format(self.queueid, "<{}>".format(">,<".join(self.recipients)))) + if self.matched["notification"] != None: + # notify + self.fp.seek(0) + try: + self.matched["notification"].notify(self.queueid, quarantine_id, self.subject, self.mailfrom, self.recipients, fp=self.fp) + except Exception as e: + self.logger.error("{}: unable to send notification(s): {}".format(self.queueid, e)) + return Milter.TEMPFAIL + else: + self.logger.info("{}: sent notification(s) to: {}".format(self.queueid, "<{}>".format(">,<".join(self.recipients)))) + self.fp.close() + # return configured action + self.logger.info("{}: responding with configured action: {}".format(self.queueid, self.matched["action"].upper())) + return self.matched["milter_action"] + + + +def generate_milter_config(configtest=False): + "Generate the configuration for QuarantineMilter class." + logger = logging.getLogger(__name__) + # read config file + parser = ConfigParser.ConfigParser() + config_files = parser.read(QuarantineMilter.get_configfiles()) + if len(config_files) == 0: + raise RuntimeError("config file not found") + QuarantineMilter.set_configfiles(config_files) + os.chdir(os.path.dirname(config_files[0])) + # check if mandatory config options in global section are present + if "global" not in parser.sections(): + raise RuntimeError("mandatory section 'global' not present in config file") + for option in ["quarantines"]: + if not parser.has_option("global", option): + raise RuntimeError("mandatory option '{}' not present in config section 'global'".format(option)) + config = {} + config["global"] = dict(parser.items("global")) + # iterate configured quarantines + quarantine_names = list(set(map(str.strip, parser.get("global", "quarantines").split(",")))) + if "global" in quarantine_names: + logger.warning("removed illegal quarantine name 'global' from list of active quarantines") + del(quarantine_names["global"]) + if len(quarantine_names) == 0: + raise RuntimeError("no quarantines configured") + idx = 0 + for name in quarantine_names: + name = name.strip() + # check if config section for current quarantine is present + if name not in parser.sections(): + raise RuntimeError("config section '{}' is not present".format(name)) + config[name] = dict(parser.items(name)) + config[name]["name"] = name + # check if mandatory config options are present in config + for option in ["regex", "type", "notification", "action", "whitelist", "smtp_host", "smtp_port"]: + if option not in config[name].keys() and \ + option in config["global"].keys(): + config[name][option] = config["global"][option] + if option not in config[name].keys(): + raise RuntimeError("mandatory option '{}' not present in config section '{}' or 'global'".format(option, name)) + logger.debug("preparing configuration for quarantine '{}' ...".format(name)) + ## add the index + config[name]["index"] = idx + idx += 1 + # compile regex + regex = config[name]["regex"] + logger.debug("=> compiling regex '{}'".format(regex)) + config[name]["regex_compiled"] = re.compile(regex) + # create quarantine instance + quarantine_type = config[name]["type"].lower() + if quarantine_type in quarantines.quarantine_types.keys(): + logger.debug("=> initializing quarantine type '{}'".format(quarantine_type)) + quarantine = quarantines.quarantine_types[quarantine_type](name, config, configtest) + elif quarantine_type == "none": + logger.debug("=> setting quarantine to NONE") + quarantine = None + else: + raise RuntimeError("unknown quarantine_type '{}'".format(quarantine_type)) + config[name]["quarantine"] = quarantine + # create whitelist instance + whitelist = config[name]["whitelist"] + if whitelist.lower() == "none": + logger.debug("=> setting whitelist to NONE") + config[name]["whitelist"] = None + else: + logger.debug("=> initializing whitelist database") + config[name]["whitelist"] = whitelists.Whitelist(name, config, configtest) + # create notification instance + notification_type = config[name]["notification"].lower() + if notification_type in notifications.notification_types.keys(): + logger.debug("=> initializing notification type '{}'".format(notification_type)) + notification = notifications.notification_types[notification_type](name, config, configtest) + elif notification_type == "none": + logger.debug("=> setting notification to NONE") + notification = None + else: + raise RuntimeError("unknown notification type '{}'".format(notification_type)) + config[name]["notification"] = notification + # determining milter action for this quarantine + action = config[name]["action"].upper() + if action in QuarantineMilter.get_actions().keys(): + logger.debug("=> setting action to {}".format(action)) + config[name]["milter_action"] = QuarantineMilter.get_actions()[action] + else: + raise RuntimeError("unknown action '{}' configured for quarantine '{}'".format(action, name)) + # remove global section from config, every section should be a quarantine + del(config["global"]) + if configtest: + print("Configuration ok") + return config + + + +def reload_config(): + "Reload the configuration of QuarantineMilter class." + logger = logging.getLogger(__name__) + logger.debug("received SIGUSR1") + try: + config = generate_milter_config() + except RuntimeError as e: + logger.info(e) + logger.info("daemon is still running with previous configuration") + else: + logger.info("reloading configuration") + QuarantineMilter.config = config diff --git a/pyquarantine/mailer.py b/pyquarantine/mailer.py new file mode 100644 index 0000000..82bbb66 --- /dev/null +++ b/pyquarantine/mailer.py @@ -0,0 +1,65 @@ +#!/usr/bin/env python2 +# +# PyQuarantine-Milter 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. +# +# PyQuarantine-Milter 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 PyQuarantineMilter. If not, see . +# + +import logging +import smtplib +import sys +from multiprocessing import Process, Queue + + +logger = logging.getLogger(__name__) +queue = Queue(maxsize=50) +process = None + + + +def mailprocess(): + "Mailer process to send emails asynchronously." + global logger + global queue + try: + while True: + m = queue.get() + if not m: break + smtp_host, smtp_port, queueid, mailfrom, recipient, mail = m + try: + s = smtplib.SMTP(host=smtp_host, port=smtp_port) + s.sendmail(mailfrom, [recipient], mail) + except Exception as e: + logger.error("{}: error while sending email to <{}> via {}: {}".format(queueid, recipient, smtp_host, e)) + else: + logger.info("{}: email to <{}> sent successfully".format(queueid, recipient)) + s.quit() + except KeyboardInterrupt: + pass + logger.debug("mailer process terminated") + + +def sendmail(smtp_host, smtp_port, queueid, mailfrom, recipients, mail): + "Send an email." + global logger + global process + global queue + if type(recipients) == str: + recipients = [recipients] + # start mailprocess if it is not started yet + if process == None: + process = Process(target=mailprocess) + process.daemon = True + logger.debug("starting mailer process") + process.start() + for recipient in recipients: + queue.put((smtp_host, smtp_port, queueid, mailfrom, recipient, mail)) diff --git a/pyquarantine/notifications.py b/pyquarantine/notifications.py new file mode 100644 index 0000000..de3dd51 --- /dev/null +++ b/pyquarantine/notifications.py @@ -0,0 +1,216 @@ +#!/usr/bin/env python2 +# +# PyQuarantine-Milter 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. +# +# PyQuarantine-Milter 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 PyQuarantineMilter. If not, see . +# + +import email +import logging +import mailer +import re + +from bs4 import BeautifulSoup +from email.mime.multipart import MIMEMultipart +from email.mime.text import MIMEText +from email.mime.image import MIMEImage + + + +class BaseNotification(object): + "Notification base class" + def __init__(self, quarantine_name, config, configtest=False): + self.quarantine_name = quarantine_name + self.config = config[quarantine_name] + self.global_config = config["global"] + self.logger = logging.getLogger(__name__) + + def notify(self, queueid, quarantine_id, subject, mailfrom, recipients, fp): + pass + + + +class EMailNotification(BaseNotification): + "Notification class to send notifications via mail." + _html_text = "text/html" + _plain_text = "text/plain" + _bad_tags = [ + "applet", + "embed", + "frame", + "frameset", + "head", + "iframe", + "script" + ] + _good_tags = [ + "a", + "b", + "br", + "center", + "div", + "font", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6", + "i", + "img", + "li", + "span", + "table", + "td", + "th", + "tr", + "tt", + "u", + "ul" + ] + good_attributes = [ + "align", + "alt", + "bgcolor", + "border", + "cellpadding", + "cellspacing", + "colspan", + "dir", + "headers", + "height", + "name", + "rowspan", + "size", + "src", + "style", + "title", + "type", + "value", + "width" + ] + + def __init__(self, quarantine_name, config, configtest=False): + super(EMailNotification, self).__init__(quarantine_name, config, configtest) + # check if mandatory options are present in config + for option in ["smtp_host", "smtp_port", "notification_email_from", "notification_email_subject", "notification_email_template", "notification_email_replacement_img"]: + if option not in self.config.keys() and option in self.global_config.keys(): + self.config[option] = self.global_config[option] + if option not in self.config.keys(): + raise RuntimeError("mandatory option '{}' not present in config section '{}' or 'global'".format(option, self.quarantine_name)) + self.smtp_host = self.config["smtp_host"] + self.smtp_port = self.config["smtp_port"] + self.mailfrom = self.config["notification_email_from"] + self.subject = self.config["notification_email_subject"] + try: + self.template = open(self.config["notification_email_template"], "rb").read() + except Exception as e: + raise RuntimeError("error reading email template: {}".format(e)) + try: + self.replacement_img = MIMEImage(open(self.config["notification_email_replacement_img"], "rb").read()) + except Exception as e: + raise RuntimeError("error reading email replacement image: {}".format(e)) + else: + self.replacement_img.add_header("Content-ID", "") + + def get_text(self, part): + "Get the mail text in html form from email part." + mimetype = part.get_content_type() + text = part.get_payload(decode=True) + if mimetype == EMailNotification._plain_text: + text = re.sub(r"^(.*)$", r"\1
\n", text, flags=re.MULTILINE) + soup = BeautifulSoup(text, "lxml", from_encoding=part.get_content_charset()) + return soup + + def get_text_multipart(self, msg, preferred=_html_text): + "Get the mail text of a multipart email in html form." + soup = None + for part in msg.get_payload(): + mimetype = part.get_content_type() + if mimetype in [EMailNotification._plain_text, EMailNotification._html_text]: + soup = self.get_text(part) + elif mimetype.startswith("multipart"): + soup = self.get_text_multipart(part, preferred) + if soup != None and mimetype == preferred: + break + return soup + + def sanitize(self, soup): + "Sanitize mail html text." + # completly remove bad elements + for element in soup(EMailNotification._bad_tags): + element.extract() + # remove not whitelisted elements, but keep their content + for element in soup.find_all(True): + if element.name not in EMailNotification._good_tags: + element.replaceWithChildren() + # remove not whitelisted attributes + for element in soup.find_all(True): + for attribute in element.attrs.keys(): + if attribute not in EMailNotification.good_attributes: + del(element.attrs[attribute]) + # set href attribute for all a-tags to # + for element in soup("a"): + element["href"] = "#" + return soup + + def get_html_text_part(self, msg): + "Get the mail text of an email in html form." + soup = None + mimetype = msg.get_content_type() + if mimetype in [EMailNotification._plain_text, EMailNotification._html_text]: + soup = self.get_text(msg) + elif mimetype.startswith("multipart"): + soup = self.get_text_multipart(msg) + if soup == None: + text = "ERROR: unable to extract text from email body" + soup = BeautifulSoup(text, "lxml", "UTF-8") + return soup + + def notify(self, queueid, quarantine_id, subject, mailfrom, recipients, fp): + "Notify recipients via email." + super(EMailNotification, self).notify(queueid, quarantine_id, subject, mailfrom, recipients, fp) + self.logger.debug("{}: generating notification email".format(queueid)) + # extract html text from email + self.logger.debug("{}: extraction email text from original email".format(queueid)) + soup = self.get_html_text_part(email.message_from_file(fp)) + # replace picture sources + picture_replaced = False + for element in soup("img"): + if "src" in element: + self.logger.debug("{}: replacing image: {}".format(queueid, element["src"])) + element["src"] = "cid:removed_for_security_reasons" + picture_replaced = True + for recipient in recipients: + self.logger.debug("{}: sending notification to <{}>".format(queueid, recipient)) + self.logger.debug("{}: parsing email template".format(queueid)) + htmltext = self.template.format( \ + EMAIL_HTML_TEXT=self.sanitize(soup), \ + EMAIL_FROM=mailfrom, \ + EMAIL_TO=recipient, \ + EMAIL_SUBJECT=subject, \ + EMAIL_QUARANTINE_ID=quarantine_id + ) + msg = MIMEMultipart('alternative') + msg["Subject"] = self.subject + msg["From"] = "<{}>".format(self.mailfrom) + msg["To"] = "<{}>".format(recipient) + msg["Date"] = email.utils.formatdate() + msg.attach(MIMEText(htmltext, "html", 'UTF-8')) + if picture_replaced: + msg.attach(self.replacement_img) + mailer.sendmail(self.smtp_host, self.smtp_port, queueid, self.mailfrom, recipient, msg.as_string()) + + + +# list of notification types and their related notification classes +notification_types = {"email": EMailNotification} diff --git a/pyquarantine/quarantines.py b/pyquarantine/quarantines.py new file mode 100644 index 0000000..965802a --- /dev/null +++ b/pyquarantine/quarantines.py @@ -0,0 +1,74 @@ +#!/usr/bin/env python2 +# +# PyQuarantine-Milter 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. +# +# PyQuarantine-Milter 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 PyQuarantineMilter. If not, see . +# + +import datetime +import json +import logging +import os + +from shutil import copyfileobj + + + +class BaseQuarantine(object): + "Quarantine base class" + def __init__(self, name, config, configtest=False): + self.name = name + self.config = config[name] + self.global_config = config["global"] + self.logger = logging.getLogger(__name__) + + def add(self, queueid, mailfrom, recipients, fp): + "Add mail to quarantine." + return "" + + + +class FileQuarantine(BaseQuarantine): + "Quarantine class to store mails on filesystem." + def __init__(self, name, config, configtest=False): + super(FileQuarantine, self).__init__(name, config, configtest) + # check if mandatory options are present in config + for option in ["directory"]: + if option not in self.config.keys() and option in self.global_config.keys(): + self.config[option] = self.global_config[option] + if option not in self.config.keys(): + raise RuntimeError("mandatory option '{}' not present in config section '{}' or 'global'".format(option, self.name)) + self.directory = self.config["directory"] + # check if quarantine directory exists and is writable + if not os.path.isdir(self.directory) or not os.access(self.directory, os.W_OK): + raise RuntimeError("file quarantine directory '{}' does not exist or is not writable".format(self.directory)) + + def add(self, queueid, mailfrom, recipients, fp): + "Add mail to file quarantine and return quarantine-id." + super(FileQuarantine, self).add(queueid, mailfrom, recipients, fp) + quarantine_id = "{}_{}".format(datetime.datetime.now().strftime("%Y-%m-%d_%H%M%S"), queueid) + # save mail + with open(os.path.join(self.directory, quarantine_id), "wb") as f: + copyfileobj(fp, f) + # save metadata + metadata = { + "from": mailfrom, + "recipients": recipients + } + with open(os.path.join(self.directory, "{}.metadata".format(quarantine_id)), "wb") as f: + json.dump(metadata, f, indent=2) + return quarantine_id + + + +# list of quarantine types and their related quarantine classes +quarantine_types = {"file": FileQuarantine} diff --git a/pyquarantine/run.py b/pyquarantine/run.py new file mode 100644 index 0000000..10eb0ef --- /dev/null +++ b/pyquarantine/run.py @@ -0,0 +1,98 @@ +#!/usr/bin/env python2 +# +# PyQuarantine-Milter 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. +# +# PyQuarantine-Milter 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 PyQuarantineMilter. If not, see . +# + +import Milter +import argparse +import logging +import logging.handlers +import sys + +import pyquarantine + + + +def main(): + "Run PyQuarantine-Milter." + # parse command line + parser = argparse.ArgumentParser(description="Quarantine milter daemon", + formatter_class=lambda prog: argparse.HelpFormatter(prog, max_help_position=45, width=140)) + parser.add_argument('-c', '--config', help='list of config files', nargs='+', + default=pyquarantine.QuarantineMilter.get_configfiles()) + parser.add_argument('-s', '--socket', help='socket used to communicatewith the MTA', required=True) + parser.add_argument('-d', '--debug', help='log debugging messages', action='store_true') + parser.add_argument('-t', '--test', help='check configuration', action='store_true') + args = parser.parse_args() + # setup logging + loglevel = logging.INFO + logname = "pyquarantine-milter" + syslog_name = logname + if args.debug: + loglevel = logging.DEBUG + logname = "{}[%(name)s]".format(logname) + syslog_name = "{}: [%(name)s] %(levelname)s".format(syslog_name) + # set config files for milter class + pyquarantine.QuarantineMilter.set_configfiles(args.config) + logger = logging.getLogger() + logger.setLevel(loglevel) + # setup console log + stdouthandler = logging.StreamHandler(sys.stdout) + stdouthandler.setLevel(logging.DEBUG) + formatter = logging.Formatter("%(message)s".format(logname)) + stdouthandler.setFormatter(formatter) + logger.addHandler(stdouthandler) + logger = logging.getLogger(__name__) + if args.test: + try: + pyquarantine.generate_milter_config(args.test) + except RuntimeError as e: + logger.error(e) + sys.exit(255) + else: + sys.exit(0) + formatter = logging.Formatter("%(asctime)s {}: %(levelname)s - %(message)s".format(logname), datefmt="%Y-%m-%d %H:%M:%S") + stdouthandler.setFormatter(formatter) + # setup syslog + sysloghandler = logging.handlers.SysLogHandler(address="/dev/log", facility=logging.handlers.SysLogHandler.LOG_MAIL) + sysloghandler.setLevel(loglevel) + formatter = logging.Formatter("{}: %(message)s".format(syslog_name)) + sysloghandler.setFormatter(formatter) + logger.addHandler(sysloghandler) + logger.info("PyQuarantine-Milter starting") + try: + # generate milter config + pyquarantine.QuarantineMilter.config = pyquarantine.generate_milter_config() + except RuntimeError as e: + logger.error(e) + sys.exit(255) + # register to have the Milter factory create instances of your class: + Milter.factory = pyquarantine.QuarantineMilter + Milter.set_exception_policy(Milter.TEMPFAIL) + #Milter.set_flags(0) # tell sendmail which features we use + # run milter + rc = 0 + try: + Milter.runmilter("pyquarantine-milter", socketname=args.socket, timeout=300) + except Milter.milter.error as e: + logger.error(e) + rc = 255 + pyquarantine.mailer.queue.put(None) + logger.info("PyQuarantine-Milter terminated") + sys.exit(rc) + + + +if __name__ == "__main__": + main() diff --git a/pyquarantine/whitelists.py b/pyquarantine/whitelists.py new file mode 100644 index 0000000..9986e9b --- /dev/null +++ b/pyquarantine/whitelists.py @@ -0,0 +1,141 @@ +#!/usr/bin/env python2 +# +# PyQuarantine-Milter 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. +# +# PyQuarantine-Milter 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 PyQuarantineMilter. If not, see . +# + +import datetime +import logging +import peewee +import re +import sys +from playhouse.db_url import connect + + + +class WhitelistModel(peewee.Model): + mailfrom = peewee.CharField() + recipient = peewee.CharField() + created = peewee.DateTimeField(default=datetime.datetime.now) + last_used = peewee.DateTimeField(default=datetime.datetime.now) + comment = peewee.TextField(default="") + permanent = peewee.BooleanField(default=False) + + + +class Meta(object): + indexes = ( + (('mailfrom', 'recipient'), True), # trailing comma is mandatory if only one index should be created + ) + + + +class Whitelist(object): + "Whitelist base class" + _whitelists = {} + + def __init__(self, name, config, configtest=False): + self.name = name + self.config = config[name] + self.global_config = config["global"] + self.logger = logging.getLogger(__name__) + # check if mandatory options are present in config + for option in ["whitelist_table"]: + if option not in self.config.keys() and option in self.global_config.keys(): + self.config[option] = self.global_config[option] + if option not in self.config.keys(): + raise RuntimeError("mandatory option '{}' not present in config section '{}' or 'global'".format(option, self.name)) + self.tablename = self.config["whitelist_table"] + connection_string = self.config["whitelist"] + if connection_string in Whitelist._whitelists.keys(): + self.db = Whitelist._whitelists[connection_string] + return + try: + # connect to database + self.logger.debug("connecting to database '{}'".format(re.sub(r"(.*?://.*?):.*?(@.*)", r"\1:\2", connection_string))) + self.db = connect(connection_string) + except Exception as e: + raise RuntimeError("unable to connect to database: {}".format(e)) + else: + Whitelist._whitelists[connection_string] = self.db + if configtest: return + self.Meta = Meta + self.Meta.database = self.db + self.Meta.table_name = self.tablename + self.Whitelist = type("WhitelistModel_{}".format(name), (WhitelistModel,), { + "Meta": self.Meta + }) + try: + self.db.create_tables([self.Whitelist]) + except Exception as e: + raise RuntimeError("unable to initialize table '{}': {}".format(self.tablename, e)) + + def get_weight(self, entry): + value = 0 + for address in [entry.mailfrom, entry.recipient]: + if address == "": + value += 2 + elif address[0] == "@": + value += 1 + return value + + def check(self, mailfrom, recipient): + # generate list of possible mailfroms + self.logger.debug("query database for whitelist entries from <{}> to <{}>".format(mailfrom, recipient)) + mailfroms = [""] + if "@" in mailfrom: + mailfroms.append("@{}".format(mailfrom.split("@")[1])) + mailfroms.append(mailfrom) + # generate list of possible recipients + recipients = [""] + if "@" in recipient: + recipients.append("@{}".format(recipient.split("@")[1])) + recipients.append(recipient) + # query the database + try: + entries = list(self.Whitelist.select().where(self.Whitelist.mailfrom.in_(mailfroms), self.Whitelist.recipient.in_(recipients))) + except Exception as e: + entries = [] + self.logger.error("unable to query whitelist database: {}".format(e)) + if len(entries) == 0: + # no whitelist entry found + return False + print(entries) + if len(entries) > 1: + entries.sort(key=lambda x: self.get_weight(x)) + # use entry with the highest weight + entry = entries[-1] + entry.last_used = datetime.datetime.now() + entry.save() + return True + + + +class WhitelistCache(object): + def __init__(self): + self.cache = {} + + def load(self, whitelist, mailfrom, recipients): + for recipient in recipients: + self.check(whitelist, mailfrom, recipient) + + def check(self, whitelist, mailfrom, recipient): + if whitelist not in self.cache.keys(): self.cache[whitelist] = {} + if recipient not in self.cache[whitelist].keys(): self.cache[whitelist][recipient] = None + if self.cache[whitelist][recipient] == None: + self.cache[whitelist][recipient] = whitelist.check(mailfrom, recipient) + return self.cache[whitelist][recipient] + + def get_whitelisted_recipients(self, whitelist, mailfrom, recipients): + self.load(whitelist, mailfrom, recipients) + return filter(lambda x: self.cache[whitelist][x] == True, self.cache[whitelist].keys()) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..cb97991 --- /dev/null +++ b/setup.py @@ -0,0 +1,35 @@ +from setuptools import setup + +def read_file(fname): + with open(fname, 'r') as f: + return f.read() + +setup(name = "pyquarantine", + version = "1.0.0", + author = "Thomas Oettli", + author_email = "spacefreak86@gmx.ch", + description = "A milter to handle multiple quarantines.", + license = "GPL 3", + keywords = "quarantine milter", + url = "https://github.com/spacefreak86/pyquarantine-milter", + packages = ["pyquarantine"], + long_description = read_file("README.md"), + classifiers = [ + # 3 - Alpha + # 4 - Beta + # 5 - Production/Stable + "Development Status :: 3 - Alpha", + "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 2.7", + "Topic :: Communications :: Email :: Quarantine" + ], + entry_points = { + "console_scripts": [ + "pyquarantine-milter=pyquarantine.run:main" + ] + }, + install_requires = ["pymilter", "peewee"], + python_requires = ">=2.7,<3" +)