commit 18d4e036a3794ff0e0c1214d5fcaab3767fa2ea3 Author: David Bürgin Date: Thu Jan 30 21:27:28 2020 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4d63f78 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# Cargo +/target/ diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..c0ad0a3 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,256 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +[[package]] +name = "ansi_term" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "atty" +version = "0.2.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "hermit-abi 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)", + "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)", + "winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "autocfg" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "bitflags" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "chrono" +version = "0.4.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "num-integer 0.1.42 (registry+https://github.com/rust-lang/crates.io-index)", + "num-traits 0.2.11 (registry+https://github.com/rust-lang/crates.io-index)", + "time 0.1.42 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "clap" +version = "2.33.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "ansi_term 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)", + "atty 0.2.14 (registry+https://github.com/rust-lang/crates.io-index)", + "bitflags 1.2.1 (registry+https://github.com/rust-lang/crates.io-index)", + "strsim 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)", + "textwrap 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)", + "unicode-width 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)", + "vec_map 0.8.1 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "hermit-abi" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "ipnet" +version = "2.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "libc" +version = "0.2.66" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "milter" +version = "0.1.7" +dependencies = [ + "bitflags 1.2.1 (registry+https://github.com/rust-lang/crates.io-index)", + "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)", + "milter-callback 0.1.7", + "milter-sys 0.1.4 (registry+https://github.com/rust-lang/crates.io-index)", + "once_cell 1.3.1 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "milter-callback" +version = "0.1.7" +dependencies = [ + "proc-macro2 1.0.8 (registry+https://github.com/rust-lang/crates.io-index)", + "quote 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)", + "syn 1.0.14 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "milter-sys" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)", + "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "num-integer" +version = "0.1.42" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "autocfg 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)", + "num-traits 0.2.11 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "num-traits" +version = "0.2.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "autocfg 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "once_cell" +version = "1.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "pkg-config" +version = "0.3.17" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "proc-macro2" +version = "1.0.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "unicode-xid 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "quote" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "proc-macro2 1.0.8 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "redox_syscall" +version = "0.1.56" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "spamassassin-milter" +version = "0.0.1" +dependencies = [ + "chrono 0.4.10 (registry+https://github.com/rust-lang/crates.io-index)", + "clap 2.33.0 (registry+https://github.com/rust-lang/crates.io-index)", + "ipnet 2.1.0 (registry+https://github.com/rust-lang/crates.io-index)", + "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)", + "milter 0.1.7", + "once_cell 1.3.1 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "strsim" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "syn" +version = "1.0.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "proc-macro2 1.0.8 (registry+https://github.com/rust-lang/crates.io-index)", + "quote 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)", + "unicode-xid 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "textwrap" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "unicode-width 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "time" +version = "0.1.42" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)", + "redox_syscall 0.1.56 (registry+https://github.com/rust-lang/crates.io-index)", + "winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "unicode-width" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "unicode-xid" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "vec_map" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "winapi" +version = "0.3.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +dependencies = [ + "winapi-i686-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)", + "winapi-x86_64-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" + +[metadata] +"checksum ansi_term 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ee49baf6cb617b853aa8d93bf420db2383fab46d314482ca2803b40d5fde979b" +"checksum atty 0.2.14 (registry+https://github.com/rust-lang/crates.io-index)" = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8" +"checksum autocfg 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)" = "f8aac770f1885fd7e387acedd76065302551364496e46b3dd00860b2f8359b9d" +"checksum bitflags 1.2.1 (registry+https://github.com/rust-lang/crates.io-index)" = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693" +"checksum chrono 0.4.10 (registry+https://github.com/rust-lang/crates.io-index)" = "31850b4a4d6bae316f7a09e691c944c28299298837edc0a03f755618c23cbc01" +"checksum clap 2.33.0 (registry+https://github.com/rust-lang/crates.io-index)" = "5067f5bb2d80ef5d68b4c87db81601f0b75bca627bc2ef76b141d7b846a3c6d9" +"checksum hermit-abi 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)" = "eff2656d88f158ce120947499e971d743c05dbcbed62e5bd2f38f1698bbc3772" +"checksum ipnet 2.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "f2f4b06b21db0228860c8dfd17d2106c49c7c6bd07477a4036985347d84def04" +"checksum libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)" = "d515b1f41455adea1313a4a2ac8a8a477634fbae63cc6100e3aebb207ce61558" +"checksum milter-sys 0.1.4 (registry+https://github.com/rust-lang/crates.io-index)" = "a1b559636bc813ff22619c3a9910ab8a7abfcfede7defe1d2f70b0b5cfba1f76" +"checksum num-integer 0.1.42 (registry+https://github.com/rust-lang/crates.io-index)" = "3f6ea62e9d81a77cd3ee9a2a5b9b609447857f3d358704331e4ef39eb247fcba" +"checksum num-traits 0.2.11 (registry+https://github.com/rust-lang/crates.io-index)" = "c62be47e61d1842b9170f0fdeec8eba98e60e90e5446449a0545e5152acd7096" +"checksum once_cell 1.3.1 (registry+https://github.com/rust-lang/crates.io-index)" = "b1c601810575c99596d4afc46f78a678c80105117c379eb3650cf99b8a21ce5b" +"checksum pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)" = "05da548ad6865900e60eaba7f589cc0783590a92e940c26953ff81ddbab2d677" +"checksum proc-macro2 1.0.8 (registry+https://github.com/rust-lang/crates.io-index)" = "3acb317c6ff86a4e579dfa00fc5e6cca91ecbb4e7eb2df0468805b674eb88548" +"checksum quote 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)" = "053a8c8bcc71fcce321828dc897a98ab9760bef03a4fc36693c231e5b3216cfe" +"checksum redox_syscall 0.1.56 (registry+https://github.com/rust-lang/crates.io-index)" = "2439c63f3f6139d1b57529d16bc3b8bb855230c8efcc5d3a896c8bea7c3b1e84" +"checksum strsim 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)" = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a" +"checksum syn 1.0.14 (registry+https://github.com/rust-lang/crates.io-index)" = "af6f3550d8dff9ef7dc34d384ac6f107e5d31c8f57d9f28e0081503f547ac8f5" +"checksum textwrap 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)" = "d326610f408c7a4eb6f51c37c330e496b08506c9457c9d34287ecc38809fb060" +"checksum time 0.1.42 (registry+https://github.com/rust-lang/crates.io-index)" = "db8dcfca086c1143c9270ac42a2bbd8a7ee477b78ac8e45b19abfb0cbede4b6f" +"checksum unicode-width 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)" = "caaa9d531767d1ff2150b9332433f32a24622147e5ebb1f26409d5da67afd479" +"checksum unicode-xid 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)" = "826e7639553986605ec5979c7dd957c7895e93eabed50ab2ffa7f6128a75097c" +"checksum vec_map 0.8.1 (registry+https://github.com/rust-lang/crates.io-index)" = "05c78687fb1a80548ae3250346c3db86a80a7cdd77bda190189f2d0a0987c81a" +"checksum winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)" = "8093091eeb260906a183e6ae1abdba2ef5ef2257a21801128899c3fc699229c6" +"checksum winapi-i686-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" +"checksum winapi-x86_64-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..56b83c2 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "spamassassin-milter" +version = "0.0.1" +authors = ["David Bürgin "] +edition = "2018" +keywords = ["email", "milter", "spam", "spamassassin"] +categories = ["email"] +license = "GPL-3.0-or-later" + +[dependencies] +chrono = "0.4" +clap = "2" +ipnet = "2" +libc = "0.2" +milter = { version = "0.1", path = "../milter" } +once_cell = "1" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7832006 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# SpamAssassin Milter + +This milter applies mail filtering through SpamAssassin server using the spamc +client. + +This program is intended as a replacement for spamass-milter. + +## Usage + +**This program is under development.** (I do already use it to filter mail on my +own domain, though.) + +The easiest way of setting up SpamAssassin Milter is to edit the provided +systemd service file spamassassin-milter.service, and install it in +/etc/systemd/system. + +## Licence + +Copyright © 2020 David Bürgin + +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. diff --git a/spamassassin-milter.8 b/spamassassin-milter.8 new file mode 100644 index 0000000..750db58 --- /dev/null +++ b/spamassassin-milter.8 @@ -0,0 +1,27 @@ +.TH SPAMASSASSIN-MILTER 8 2020-01-30 +.SH NAME +spamassassin-milter \- milter for spam filtering with SpamAssassin +.SH SYNOPSIS +.B spamassassin-milter +[\fB\-\-trusted-networks\fR \fIBITS\fR] +[\fB\-v\fR] +.IR SOCKET +[\fB\-\-\fR \fISPAMC_ARGS\fR...] +.SH DESCRIPTION +.B spamassassin-milter +is a milter that filters email through a SpamAssassin server. +.PP +This is currently being developed. +Start every sentence on a new line apparently. +To do. +.SH OPTIONS +.TP +.BR \-v ", " \-\-verbose +Enable verbose operation logging. +.TP +.BR \-\-max-message-size =\fISIZE\fR +Maximum message size in bytes to pass to spamc. +.SH SEE ALSO +.BR spamassassin (1p), +.BR spamd (8p), +.BR spamc (1) diff --git a/spamassassin-milter.service b/spamassassin-milter.service new file mode 100644 index 0000000..c66da42 --- /dev/null +++ b/spamassassin-milter.service @@ -0,0 +1,8 @@ +[Unit] +Description=SpamAssassin Milter + +[Service] +ExecStart=/usr/sbin/spamassassin-milter inet:3001:localhost + +[Install] +WantedBy=multi-user.target diff --git a/src/callbacks.rs b/src/callbacks.rs new file mode 100644 index 0000000..eb5fe9f --- /dev/null +++ b/src/callbacks.rs @@ -0,0 +1,232 @@ +use crate::{ + client::{Client, Spamc}, + config, +}; +use chrono::Local; +use milter::{ + on_abort, on_body, on_close, on_connect, on_data, on_eoh, on_eom, on_header, on_helo, on_mail, + on_negotiate, on_rcpt, Actions, Context, MacroValue, ProtocolOpts, Stage, Status, +}; +use std::net::{IpAddr, Ipv4Addr, SocketAddr}; + +struct Connection { + client_ip: IpAddr, + helo_host: Option, + client: Option, +} + +impl Connection { + fn new(ip: IpAddr) -> Self { + Self { + client_ip: ip, + helo_host: None, + client: None, + } + } + + fn set_helo_host(&mut self, helo_host: String) { + self.helo_host = Some(helo_host); + } +} + +#[on_negotiate(negotiate_callback)] +fn handle_negotiate( + ctx: Context, + actions: Actions, + protocol_opts: ProtocolOpts, +) -> milter::Result<(Status, Actions, ProtocolOpts)> { + let mut req_actions = Actions::empty(); + if !config::get().monitor() { + req_actions |= Actions::ADD_HEADER | Actions::REPLACE_HEADER; + + if !config::get().preserve_body() { + req_actions |= Actions::REPLACE_BODY; + } + } + + let req_protocol_opts = ProtocolOpts::SKIP; + + assert!(actions.contains(req_actions)); + assert!(protocol_opts.contains(req_protocol_opts)); + + ctx.api.request_macros(Stage::Connect, "")?; + ctx.api.request_macros(Stage::Helo, "")?; + ctx.api.request_macros(Stage::Mail, "{auth_authen}")?; + ctx.api.request_macros(Stage::Rcpt, "")?; + ctx.api.request_macros(Stage::Data, "i j _ {tls_version} v")?; + ctx.api.request_macros(Stage::Eoh, "")?; + ctx.api.request_macros(Stage::Eom, "")?; + + Ok((Status::Continue, req_actions, req_protocol_opts)) +} + +#[on_connect(connect_callback)] +fn handle_connect( + mut ctx: Context, + _: &str, + socket_addr: Option, +) -> milter::Result { + let ip = socket_addr.map_or_else(|| IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), |a| a.ip()); + + if config::get().has_trusted_networks() { + if config::get().is_in_trusted_networks(&ip) { + verbose!("accepted connection from trusted network address {}", ip); + + return Ok(Status::Accept); + } + } else if ip.is_loopback() { + verbose!("accepted local connection"); + + return Ok(Status::Accept); + } + + let conn = Connection::new(ip); + ctx.data.replace(conn)?; + + Ok(Status::Continue) +} + +#[on_helo(helo_callback)] +fn handle_helo(mut ctx: Context, helo_host: &str) -> milter::Result { + let conn = ctx.data.borrow_mut().unwrap(); + + conn.set_helo_host(helo_host.to_owned()); + + Ok(Status::Continue) +} + +#[on_mail(mail_callback)] +fn handle_mail(mut ctx: Context, smtp_args: Vec<&str>) -> milter::Result { + let conn = ctx.data.borrow_mut().unwrap(); + + if !config::get().filter_authenticated() { + if let Some(login) = ctx.api.macro_value("{auth_authen}")? { + verbose!("accepted message from sender authenticated as \"{}\"", login); + + return Ok(Status::Accept); + } + } + + let spamc = Spamc::new(config::get().spamc_args().to_vec()); + let sender = smtp_args[0].to_owned(); + conn.client.replace(Client::new(spamc, sender)); + + Ok(Status::Continue) +} + +#[on_rcpt(rcpt_callback)] +fn handle_rcpt(mut ctx: Context, smtp_args: Vec<&str>) -> milter::Result { + let conn = ctx.data.borrow_mut().unwrap(); + + let recipient = smtp_args[0].to_owned(); + conn.client.as_mut().unwrap().add_recipient(recipient); + + Ok(Status::Continue) +} + +#[on_data(data_callback)] +fn handle_data(mut ctx: Context) -> milter::Result { + let conn = ctx.data.borrow_mut().unwrap(); + let client = conn.client.as_mut().unwrap(); + + let client_ip = conn.client_ip.to_string(); + + client.connect()?; + client.send_envelope_sender()?; + client.send_envelope_recipients()?; + client.send_forged_received_header( + conn.helo_host.as_ref().unwrap_or(&client_ip), + ctx.api.macro_value("_")?.unwrap_or(&client_ip), + ctx.api.macro_value("j")?.unwrap_or("localhost"), + ctx.api.macro_value("v")? + .and_then(|v| v.split_ascii_whitespace().next()) + .unwrap_or("Postfix"), + ctx.api.macro_value("{tls_version}")?.is_some(), + queue_id(&ctx.api)?, + &Local::now().to_rfc2822(), + )?; + + Ok(Status::Continue) +} + +#[on_header(header_callback)] +fn handle_header(mut ctx: Context, name: &str, value: &str) -> milter::Result { + let conn = ctx.data.borrow_mut().unwrap(); + let client = conn.client.as_mut().unwrap(); + + client.send_header(name, value)?; + + Ok(Status::Continue) +} + +#[on_eoh(eoh_callback)] +fn handle_eoh(mut ctx: Context) -> milter::Result { + let conn = ctx.data.borrow_mut().unwrap(); + let client = conn.client.as_mut().unwrap(); + + client.send_eoh()?; + + Ok(Status::Continue) +} + +#[on_body(body_callback)] +fn handle_body(mut ctx: Context, content: &[u8]) -> milter::Result { + let conn = ctx.data.borrow_mut().unwrap(); + let client = conn.client.as_mut().unwrap(); + + client.send_body_chunk(content)?; + + let max = config::get().max_message_size(); + Ok(if client.bytes_written() >= max { + let id = queue_id(&ctx.api)?; + verbose!("{}: skipping rest of message larger than {} bytes", id, max); + + Status::Skip + } else { + Status::Continue + }) +} + +#[on_eom(eom_callback)] +fn handle_eom(mut ctx: Context) -> milter::Result { + let conn = ctx.data.borrow_mut().unwrap(); + let client = conn.client.take().unwrap(); + + let id = queue_id(&ctx.api)?; + + client.process(id, &ctx.api) +} + +#[on_abort(abort_callback)] +fn handle_abort(mut ctx: Context) -> milter::Result { + ctx.data.borrow_mut().unwrap().client.take(); + + Ok(Status::Continue) +} + +#[on_close(close_callback)] +fn handle_close(mut ctx: Context) -> milter::Result { + ctx.data.take()?; + + Ok(Status::Continue) +} + +fn queue_id(macros: &impl MacroValue) -> milter::Result<&str> { + macros.macro_value("i").map(|i| i.unwrap_or("NONE")) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_mimimi() { + let actions = Actions::ADD_HEADER | Actions::REPLACE_HEADER | Actions::REPLACE_BODY; + let all = Actions::all(); + assert!(all.contains(actions)); + + let aa = all & actions; + + assert_eq!(aa, actions); + } +} diff --git a/src/client.rs b/src/client.rs new file mode 100644 index 0000000..e9a25cd --- /dev/null +++ b/src/client.rs @@ -0,0 +1,235 @@ +use crate::{ + config, + email::{self, Email, HeaderMap, HeaderRewriter}, + error::{Error, Result}, +}; +use milter::{ActionMethods, Status}; +use std::{ + io::Write, + process::{Child, Command, Stdio}, +}; + +pub trait Process { + fn connect(&mut self) -> Result<()>; + fn writer(&mut self) -> &mut dyn Write; + fn finish(&mut self) -> Result>; +} + +pub struct Spamc { + spamc_args: Vec, + spamc: Option, +} + +impl Spamc { + const SPAMC_PROGRAM: &'static str = "spamc"; + + pub fn new(spamc_args: Vec) -> Self { + Self { + spamc_args, + spamc: None, + } + } +} + +impl Process for Spamc { + fn connect(&mut self) -> Result<()> { + // sudo -H -u spamass-milter spamc --socket=/run/spamassassin/spamd.sock --headers < ham-msg + let child = Command::new(Spamc::SPAMC_PROGRAM) + .args(&self.spamc_args) + .stdin(Stdio::piped()) + .stdout(Stdio::piped()) + .spawn()?; + + self.spamc = Some(child); + + Ok(()) + } + + fn writer(&mut self) -> &mut dyn Write { + let spamc = self.spamc.as_mut().expect("spamc process not started"); + spamc.stdin.as_mut().unwrap() + } + + fn finish(&mut self) -> Result> { + let output = self.spamc.take().expect("spamc process not started").wait_with_output()?; + + if output.status.success() { + Ok(output.stdout) + } else { + Err(Error::IoError) + } + } +} + +impl Drop for Spamc { + fn drop(&mut self) { + // Kill the child: a child process will continue to run even after its + // `Child` handle has gone out of scope. + if let Some(spamc) = self.spamc.as_mut() { + let _ = spamc.kill(); + } + } +} + +pub struct Client { + process: Box, + pub sender: String, // TODO + recipients: Vec, + headers: HeaderMap<'static>, // canonical-form &'static str keys + byte_count: usize, +} + +impl Client { + pub fn new(process: impl Process + 'static, sender: String) -> Self { + Self { + process: Box::new(process), + sender, + recipients: vec![], + headers: HeaderMap::new(), + byte_count: 0, + } + } + + pub fn bytes_written(&self) -> usize { + self.byte_count + } + + pub fn add_recipient(&mut self, r: String) { + self.recipients.push(r); + } + + pub fn connect(&mut self) -> Result<()> { + self.process.connect() + } + + pub fn send_envelope_sender(&mut self) -> Result<()> { + let buf = format!("X-Envelope-From: {}\r\n", &self.sender); + + let writer = self.process.writer(); + + Ok(self.byte_count += writer.write(buf.as_bytes())?) + } + + pub fn send_envelope_recipients(&mut self) -> Result<()> { + let buf = format!("X-Envelope-To: {}\r\n", self.recipients.join(",\r\n\t")); + + let writer = self.process.writer(); + + Ok(self.byte_count += writer.write(buf.as_bytes())?) + } + + pub fn send_forged_received_header( + &mut self, + helo_host: &str, + client_name_addr: &str, + my_hostname: &str, + mta: &str, + tls: bool, + queue_id: &str, + date_time: &str, + ) -> Result<()> { + let protocol = if tls { "ESMTPS" } else { "ESMTP" }; + + let buf = format!( + "Received: from {} ({})\r\n\ + \tby {} ({}) with {} id {};\r\n\ + \t{}\r\n\ + \t(envelope-from {})\r\n", + helo_host, client_name_addr, my_hostname, mta, protocol, queue_id, date_time, &self.sender + ); + + let writer = self.process.writer(); + + Ok(self.byte_count += writer.write(buf.as_bytes())?) + } + + pub fn send_header(&mut self, name: &str, value: &str) -> Result<()> { + // Record some SpamAssassin headers, but never pass any on. + if email::is_spam_assassin_header(name) { + if let Some(canonical_name) = email::SPAM_ASSASSIN_HEADERS.get(name) { + self.headers.insert_if_absent(canonical_name, email::ensure_crlf(value)); + } + + return Ok(()); + } + + let value = email::ensure_crlf(value); + let buf = format!("{}: {}\r\n", name, &value); + + if let Some(canonical_name) = email::REWRITE_HEADERS.get(name) + .or_else(|| email::REPORT_HEADERS.get(name)) + { + self.headers.insert_if_absent(canonical_name, value); + } + + let writer = self.process.writer(); + + Ok(self.byte_count += writer.write(buf.as_bytes())?) + } + + pub fn send_eoh(&mut self) -> Result<()> { + let writer = self.process.writer(); + + Ok(self.byte_count += writer.write(b"\r\n")?) + } + + pub fn send_body_chunk(&mut self, bytes: &[u8]) -> Result<()> { + let writer = self.process.writer(); + + Ok(self.byte_count += writer.write(bytes)?) + } + + pub fn process(mut self, id: &str, actions: &impl ActionMethods) -> milter::Result { + let output = match self.process.finish() { + Ok(output) => output, + Err(e) => { + eprintln!("{}: unable to wait for spamc: {}", id, e); + + return Ok(Status::Tempfail); + } + }; + + // println!("{}", String::from_utf8_lossy(&output).escape_default()); + + let email = match Email::parse(&output) { + Ok(email) => email, + Err(e) => { + eprintln!("{}: unable to parse response from spamc: {}", id, e); + + return Ok(Status::Tempfail); + } + }; + + let mut rewriter = HeaderRewriter::new(self.headers); + + for header in email.header { + rewriter.process_header(header.name, header.value); + } + + let spam = rewriter.is_flagged_spam(); + + if spam && config::get().reject_spam() { + verbose!("{}: rejected message flagged as spam", id); + + return Ok(Status::Reject); + } + + if !config::get().monitor() { + rewriter.rewrite_spam_assassin_headers(id, actions)?; + + if !config::get().preserve_headers() { + rewriter.rewrite_rewrite_headers(id, actions)?; + } + + if spam && !config::get().preserve_body() { + rewriter.rewrite_report_headers(id, actions)?; + + verbose!("{}: replacing message body", id); + actions.append_body_chunk(email.body)?; + } + } + + verbose!("{}: finished processing", id); + Ok(Status::Accept) + } +} diff --git a/src/collections.rs b/src/collections.rs new file mode 100644 index 0000000..b6332a2 --- /dev/null +++ b/src/collections.rs @@ -0,0 +1,92 @@ +use std::{collections::HashSet, mem, str}; + +/// An array map with ASCII-case-insensitive `&str` keys. +#[derive(Clone, Debug, Default)] +pub struct StrArrayMap<'a, V> { + entries: Vec<(&'a str, V)>, +} + +impl<'a, V> StrArrayMap<'a, V> { + pub fn new() -> Self { + Self { entries: Default::default() } + } + + // also add get_or_insert()? + + pub fn insert(&mut self, key: &'a str, value: V) -> Option { + match self.entries.iter_mut().find(|e| e.0.eq_ignore_ascii_case(key)) { + Some(e) => Some(mem::replace(&mut e.1, value)), + None => { + self.entries.push((key, value)); + None + } + } + } + + pub fn insert_if_absent(&mut self, key: &'a str, value: V) -> Option { + if self.contains_key(key) { + Some(value) + } else { + self.entries.push((key, value)); + None + } + } + + pub fn iter(&self) -> impl Iterator + '_ { + self.entries.iter() + } + + pub fn keys(&self) -> impl Iterator + '_ { + self.entries.iter().map(|e| e.0) + } + + pub fn contains_key(&self, key: &str) -> bool { + self.entries.iter().any(|e| e.0.eq_ignore_ascii_case(key)) + } + + pub fn get(&self, key: &str) -> Option<&V> { + self.entries.iter().find(|e| e.0.eq_ignore_ascii_case(key)).map(|e| &e.1) + } + + pub fn get_mut(&mut self, key: &str) -> Option<&mut V> { + self.entries.iter_mut().find(|e| e.0.eq_ignore_ascii_case(key)).map(|e| &mut e.1) + } + + pub fn get_key_value(&self, key: &str) -> Option<(&&str, &V)> { + self.entries.iter().find(|e| e.0.eq_ignore_ascii_case(key)).map(|e| (&e.0, &e.1)) + } +} + +/// An array set with ASCII-case-insensitive `&str` elements. +#[derive(Clone, Debug, Default)] +pub struct StrArraySet<'a> { + map: StrArrayMap<'a, ()>, +} + +impl<'a> StrArraySet<'a> { + pub fn new() -> Self { + Default::default() + } + + // also add: + // pub fn get_or_insert(&mut self, value: T) -> &T + pub fn insert(&mut self, key: &'a str) -> bool { + self.map.insert(key, ()).is_none() + } + + pub fn insert_if_absent(&mut self, key: &'a str) -> bool { + self.map.insert_if_absent(key, ()).is_none() + } + + pub fn contains(&self, key: &str) -> bool { + self.map.contains_key(key) + } + + pub fn get(&self, key: &str) -> Option<&str> { + self.map.get_key_value(key).map(|(&k, _)| k) + } + + pub fn iter(&self) -> impl Iterator + '_ { + self.map.keys() + } +} diff --git a/src/config.rs b/src/config.rs new file mode 100644 index 0000000..97be9a8 --- /dev/null +++ b/src/config.rs @@ -0,0 +1,165 @@ +use ipnet::IpNet; +use once_cell::sync::OnceCell; +use std::{collections::HashSet, net::IpAddr}; + +/// A builder for [`Config`] objects. +/// +/// [`Config`]: struct.Config.html +#[derive(Clone, Debug, Default)] +pub struct ConfigBuilder { + filter_authenticated: bool, + reject_spam: bool, + preserve_headers: bool, + preserve_body: bool, + monitor: bool, + has_trusted_networks: bool, + trusted_networks: HashSet, + spamc_args: Vec, + max_message_size: usize, + verbose: bool, +} + +impl ConfigBuilder { + pub fn set_has_trusted_networks(&mut self, value: bool) -> &mut Self { + self.has_trusted_networks = value; + self + } + + pub fn add_trusted_network(&mut self, value: IpNet) -> &mut Self { + self.has_trusted_networks = true; + self.trusted_networks.insert(value); + self + } + + pub fn set_filter_authenticated(&mut self, value: bool) -> &mut Self { + self.filter_authenticated = value; + self + } + + pub fn set_reject_spam(&mut self, value: bool) -> &mut Self { + self.reject_spam = value; + self + } + + pub fn set_monitor(&mut self, value: bool) -> &mut Self { + self.monitor = value; + self + } + + pub fn set_preserve_headers(&mut self, value: bool) -> &mut Self { + self.preserve_headers = value; + self + } + + pub fn set_preserve_body(&mut self, value: bool) -> &mut Self { + self.preserve_body = value; + self + } + + pub fn set_spamc_args(&mut self, spamc_args: Vec) -> &mut Self { + self.spamc_args = spamc_args; + self + } + + pub fn set_max_message_size(&mut self, value: usize) -> &mut Self { + self.max_message_size = value; + self + } + + pub fn set_verbose(&mut self, value: bool) -> &mut Self { + self.verbose = value; + self + } + + pub fn build(self) -> Config { + Config { + filter_authenticated: self.filter_authenticated, + reject_spam: self.reject_spam, + preserve_headers: self.preserve_headers, + preserve_body: self.preserve_body, + monitor: self.monitor, + has_trusted_networks: self.has_trusted_networks, + trusted_networks: self.trusted_networks, + spamc_args: self.spamc_args, + max_message_size: self.max_message_size, + verbose: self.verbose, + } + } +} + +/// A configuration object for SpamAssassin Milter. +#[derive(Clone, Debug, Default)] +pub struct Config { + filter_authenticated: bool, + reject_spam: bool, + preserve_headers: bool, + preserve_body: bool, + monitor: bool, + has_trusted_networks: bool, + trusted_networks: HashSet, + spamc_args: Vec, + max_message_size: usize, + verbose: bool, +} + +impl Config { + /// Returns a new `ConfigBuilder` with default settings. + /// + /// [`ConfigBuilder`]: struct.ConfigBuilder.html + pub fn builder() -> ConfigBuilder { + ConfigBuilder { + max_message_size: 512_000, + ..Default::default() + } + } + + pub fn filter_authenticated(&self) -> bool { + self.filter_authenticated + } + + pub fn reject_spam(&self) -> bool { + self.reject_spam + } + + pub fn preserve_body(&self) -> bool { + self.preserve_body + } + + pub fn preserve_headers(&self) -> bool { + self.preserve_headers + } + + pub fn monitor(&self) -> bool { + self.monitor + } + + pub fn has_trusted_networks(&self) -> bool { + self.has_trusted_networks + } + + pub fn is_in_trusted_networks(&self, ip: &IpAddr) -> bool { + self.trusted_networks.iter().any(|n| n.contains(ip)) + } + + pub fn spamc_args(&self) -> &[String] { + &self.spamc_args + } + + pub fn max_message_size(&self) -> usize { + self.max_message_size + } + + pub fn verbose(&self) -> bool { + self.verbose + } +} + +static CONFIG: OnceCell = OnceCell::new(); + +pub fn init(config: Config) { + CONFIG.set(config).unwrap(); +} + +pub fn get() -> &'static Config { + CONFIG.get().expect("configuration not initialized") +} diff --git a/src/email.rs b/src/email.rs new file mode 100644 index 0000000..46b0551 --- /dev/null +++ b/src/email.rs @@ -0,0 +1,268 @@ +use crate::{ + collections::{StrArrayMap, StrArraySet}, + error::{Error, Result}, +}; +use milter::ActionMethods; +use once_cell::sync::Lazy; +use std::{ + cmp, + fmt::{self, Display, Formatter}, + str, +}; + +#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] +pub struct Header<'a> { + pub name: &'a str, + pub value: &'a str, +} + +#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] +pub struct Email<'a> { + pub header: Vec>, + pub body: &'a [u8], +} + +impl<'a> Email<'a> { + pub fn parse(bytes: &'a [u8]) -> Result { + let (header, body) = split_at_eoh(bytes)?; + + let header = header_lines(header) + .into_iter() + .map(|h| parse_header_line(h)) + .collect::>>()?; + + Ok(Self { header, body }) + } +} + +fn split_at_eoh(bytes: &[u8]) -> Result<(&[u8], &[u8])> { + bytes + .windows(4) + .position(|w| w == b"\r\n\r\n") + .map(|i| (&bytes[..(i + 2)], &bytes[(i + 4)..])) + .ok_or(Error::ParseEmail) +} + +fn header_lines(header: &[u8]) -> Vec<&[u8]> { + let mut lines = Vec::new(); + + let mut i = 0; + let mut start = i; + + while i < header.len() - 1 { + // Assume line breaks are always encoded as b"\r\n". + if header[i] == b'\r' && header[i + 1] == b'\n' { + if i + 2 < header.len() && (header[i + 2] == b' ' || header[i + 2] == b'\t') { + i += 3; + } else { + lines.push(&header[start..i]); + i += 2; + start = i; + } + } else { + i += 1; + } + } + + if start != header.len() { + lines.push(&header[start..]); + } + + lines +} + +fn parse_header_line(bytes: &[u8]) -> Result> { + let line = str::from_utf8(bytes).map_err(|_| Error::ParseEmail)?; + let (name, value) = line.split_at(line.find(':').ok_or(Error::ParseEmail)?); + + // TODO is whitespace? + if name.is_empty() { + return Err(Error::ParseEmail); + } + + let ascii_whitespace: &[_] = &[' ', '\t']; + let value = (&value[1..]).trim_start_matches(ascii_whitespace); + + Ok(Header { name, value }) +} + +pub fn ensure_crlf(s: &str) -> String { + // Ensure existing occurrences of "\r\n" remain unchanged. + s.split('\n') + .map(|line| match line.as_bytes().last() { + Some(&last) if last == b'\r' => &line[..(line.len() - 1)], + _ => line, + }) + .collect::>() + .join("\r\n") +} + +pub fn ensure_lf(s: &str) -> String { + s.replace("\r\n", "\n") +} + +pub fn is_spam_assassin_header(name: &str) -> bool { + let prefix = b"X-Spam-"; + let name = name.as_bytes(); + + name[..cmp::min(prefix.len(), name.len())].eq_ignore_ascii_case(prefix) +} + +// Values are normalised to using CRLF line breaks. +pub type HeaderMap<'a> = StrArrayMap<'a, String>; + +pub type HeaderSet<'a> = StrArraySet<'a>; + +pub static SPAM_ASSASSIN_HEADERS: Lazy> = Lazy::new(|| { + let mut h = HeaderSet::new(); + h.insert("X-Spam-Checker-Version"); + h.insert("X-Spam-Flag"); + h.insert("X-Spam-Level"); + h.insert("X-Spam-Status"); + h.insert("X-Spam-Report"); + h +}); + +pub static REWRITE_HEADERS: Lazy> = Lazy::new(|| { + let mut h = HeaderSet::new(); + h.insert("Subject"); + h.insert("From"); + h.insert("To"); + h +}); + +pub static REPORT_HEADERS: Lazy> = Lazy::new(|| { + let mut h = HeaderSet::new(); + h.insert("MIME-Version"); + h.insert("Content-Type"); + h +}); + +/// A header rewriter going between incoming headers, and headers returned from +/// the SpamAssassin service. Operates only on the first occurrence of headers +/// with the same name. +#[derive(Clone, Debug, Default)] +pub struct HeaderRewriter<'a> { + original: HeaderMap<'a>, + processed: HeaderSet<'a>, + spam_assassin_mods: Vec>, + rewrite_mods: Vec>, + report_mods: Vec>, +} + +impl<'a> HeaderRewriter<'a> { + pub fn new(original: HeaderMap<'a>) -> Self { + Self { + original, + ..Default::default() + } + } + + pub fn process_header(&mut self, name: &'a str, value: &'a str) { + if is_spam_assassin_header(name) { + if let Some(m) = self.convert_to_header_mod(name, value) { + self.spam_assassin_mods.push(m); + } + } else if REWRITE_HEADERS.contains(name) { + if let Some(m) = self.convert_to_header_mod(name, value) { + self.rewrite_mods.push(m); + } + } else if REPORT_HEADERS.contains(name) { + if let Some(m) = self.convert_to_header_mod(name, value) { + self.report_mods.push(m); + } + } + } + + fn convert_to_header_mod(&mut self, name: &'a str, value: &'a str) -> Option> { + if !self.processed.insert_if_absent(name) { + return None; + } + + match self.original.get(name) { + Some(original_value) => { + if original_value != value { + Some(HeaderMod::Replace { name, value }) + } else { + None + } + } + None => Some(HeaderMod::Add { name, value }), + } + } + + pub fn is_flagged_spam(&self) -> bool { + use HeaderMod::*; + + self.spam_assassin_mods.iter().any(|m| match m { + Add { name, value } | Replace { name, value } => { + name.eq_ignore_ascii_case("X-Spam-Flag") && value.eq_ignore_ascii_case("YES") + } + _ => false, + }) + } + + pub fn rewrite_report_headers(&self, id: &str, actions: &impl ActionMethods) -> milter::Result<()> { + execute_mods(id, self.report_mods.iter(), actions) + } + + pub fn rewrite_rewrite_headers(&self, id: &str, actions: &impl ActionMethods) -> milter::Result<()> { + execute_mods(id, self.rewrite_mods.iter(), actions) + } + + pub fn rewrite_spam_assassin_headers(&self, id: &str, actions: &impl ActionMethods) -> milter::Result<()> { + execute_mods(id, self.spam_assassin_mods.iter(), actions)?; + + // Delete incoming SpamAssassin headers not returned by SpamAssassin. + let deletions = SPAM_ASSASSIN_HEADERS.iter() + .filter(|h| self.original.contains_key(h) && !self.processed.contains(h)) + .map(|name| HeaderMod::Delete { name }) + .collect::>(); + + execute_mods(id, deletions.iter(), actions) + } +} + +fn execute_mods<'a, I>(id: &str, mods: I, actions: &impl ActionMethods) -> milter::Result<()> +where + I: IntoIterator>, +{ + Ok(for m in mods.into_iter() { + verbose!("{}: rewriting header: {}", id, m); + + m.execute(actions)?; + }) +} + +// Header rewriting modification operation, operates only on the first of +// headers occurring multiple times (index = 1). +#[derive(Clone, Copy, Debug)] +enum HeaderMod<'a> { + Add { name: &'a str, value: &'a str }, + Replace { name: &'a str, value: &'a str }, + Delete { name: &'a str }, +} + +impl HeaderMod<'_> { + fn execute(&self, actions: &impl ActionMethods) -> milter::Result<()> { + use HeaderMod::*; + + match self { + Add { name, value } => actions.add_header(name, &ensure_lf(value)), + Replace { name, value } => actions.replace_header(name, 1, Some(&ensure_lf(value))), + Delete { name } => actions.replace_header(name, 1, None), + } + } +} + +impl Display for HeaderMod<'_> { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + use HeaderMod::*; + + match self { + Add { name, .. } => write!(f, "add header \"{}\"", name), + Replace { name, .. } => write!(f, "replace header \"{}\"", name), + Delete { name } => write!(f, "delete header \"{}\"", name), + } + } +} diff --git a/src/error.rs b/src/error.rs new file mode 100644 index 0000000..fb51101 --- /dev/null +++ b/src/error.rs @@ -0,0 +1,50 @@ +use std::{ + error, + fmt::{self, Display, Formatter}, + io, result, +}; + +pub type Result = result::Result; + +#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] +pub enum Error { + ParseEmail, + IoError, + // Milter(MilterError), +} + +// #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] +// pub enum MilterError { +// Main, +// Socket, +// } + +impl Display for Error { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + use Error::*; + + match self { + ParseEmail => write!(f, "could not parse email response from spamc"), + _ => write!(f, "TODO"), + } + } +} + +impl error::Error for Error { + fn source(&self) -> Option<&(dyn error::Error + 'static)> { + // TODO + None + } +} + +impl From for Error { + fn from(_: io::Error) -> Self { + Error::IoError + } +} + +impl From for milter::Error { + fn from(mine: Error) -> Self { + milter::Error::Custom(mine.into()) + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..d03d69d --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,59 @@ +//! The SpamAssassin Milter application library. + +#![macro_use] + +macro_rules! verbose { + ($($arg:tt)*) => { + if $crate::config::get().verbose() { + ::std::eprintln!($($arg)*); + } + }; +} + +mod callbacks; +mod client; +mod collections; +mod config; +mod email; +mod error; + +use crate::callbacks::*; +pub use crate::config::{Config, ConfigBuilder}; +use milter::Milter; + +/// The name of the SpamAssassin Milter application. +pub const MILTER_NAME: &str = "SpamAssassin Milter"; + +/// The current version string of SpamAssassin Milter. +pub const VERSION: &str = "0.0.1"; + +/// Starts SpamAssassin Milter at the given socket using the supplied +/// configuration. +/// +/// This is a blocking call. +pub fn run(socket: &str, config: Config) -> milter::Result<()> { + config::init(config); + + eprintln!("{} {} starting", MILTER_NAME, VERSION); + + // TODO should return our Result type? + let result = Milter::new(socket) + .name(MILTER_NAME) + .on_negotiate(negotiate_callback) + .on_connect(connect_callback) + .on_helo(helo_callback) + .on_mail(mail_callback) + .on_rcpt(rcpt_callback) + .on_data(data_callback) + .on_header(header_callback) + .on_eoh(eoh_callback) + .on_body(body_callback) + .on_eom(eom_callback) + .on_abort(abort_callback) + .on_close(close_callback) + .run(); + + eprintln!("{} {} shut down", MILTER_NAME, VERSION); + + result +} diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..3221b9e --- /dev/null +++ b/src/main.rs @@ -0,0 +1,123 @@ +use clap::{App, Arg, ArgMatches}; +use ipnet::{IpNet, Ipv4Net, Ipv6Net}; +use spamassassin_milter::Config; +use std::{ + net::{AddrParseError, IpAddr}, + process, +}; + +const ARG_SOCKET: &str = "SOCKET"; +const ARG_TRUSTED_NETWORKS: &str = "TRUSTED_NETWORKS"; +const ARG_FILTER_AUTHENTICATED: &str = "FILTER_AUTHENTICATED"; +const ARG_MONITOR: &str = "MONITOR"; +const ARG_PRESERVE_HEADERS: &str = "PRESERVE_HEADERS"; +const ARG_PRESERVE_BODY: &str = "PRESERVE_BODY"; +const ARG_REJECT_SPAM: &str = "REJECT_SPAM"; +const ARG_MAX_MESSAGE_SIZE: &str = "MAX_MESSAGE_SIZE"; +const ARG_SPAMC_ARGS: &str = "SPAMC_ARGS"; +const ARG_VERBOSE: &str = "VERBOSE"; + +fn main() { + let matches = App::new(spamassassin_milter::MILTER_NAME) + .version(spamassassin_milter::VERSION) + .arg(Arg::with_name(ARG_SOCKET) + .help("Listening socket of the milter") + .required(true)) + .arg(Arg::with_name(ARG_TRUSTED_NETWORKS) + .long("trusted-networks") + .short("t") + .value_name("NETS") + .use_delimiter(true) + .help("Trust connections from comma-separated networks")) + .arg(Arg::with_name(ARG_FILTER_AUTHENTICATED) + .long("filter-authenticated") + .help("Also filter messages of authenticated senders")) + .arg(Arg::with_name(ARG_MONITOR) + .long("monitor") + .conflicts_with_all(&[ARG_PRESERVE_HEADERS, ARG_PRESERVE_BODY]) + .help("Process message but preserve message exactly as-is")) + .arg(Arg::with_name(ARG_PRESERVE_HEADERS) + .long("preserve-headers") + .help("Suppress Subject, To, From header rewriting")) + .arg(Arg::with_name(ARG_PRESERVE_BODY) + .long("preserve-body") + .help("Suppress rewriting of message body")) + .arg(Arg::with_name(ARG_REJECT_SPAM) + .long("reject-spam") + .conflicts_with(ARG_MONITOR) + .help("Reject messages flagged as spam")) + .arg(Arg::with_name(ARG_MAX_MESSAGE_SIZE) + .long("max-message-size") + .value_name("SIZE") + .help("Maximum message size in bytes to pass to spamc")) + .arg(Arg::with_name(ARG_VERBOSE) + .short("v") + .long("verbose") + .help("Enable verbose operation logging")) + .arg(Arg::with_name(ARG_SPAMC_ARGS) + .last(true) + .multiple(true) + .help("Additional arguments to pass to spamc")) + .get_matches(); + + let socket = matches.value_of(ARG_SOCKET).unwrap(); + let config = build_config(&matches); + + // println!("{:?}", i); + // println!("{:?}", matches.values_of("spamc")); + + if let Err(e) = spamassassin_milter::run(socket, config) { + eprintln!("error: {}", e); + process::exit(1); + } +} + +fn build_config(matches: &ArgMatches<'_>) -> Config { + let mut config = Config::builder(); + + if let Some(t) = matches.values_of(ARG_TRUSTED_NETWORKS) { + config.set_has_trusted_networks(true); + + for x in t.filter(|x| !x.trim().is_empty()) { + config.add_trusted_network(parse_ip_net(x).unwrap()); + } + }; + + if matches.is_present(ARG_FILTER_AUTHENTICATED) { + config.set_filter_authenticated(true); + } + if matches.is_present(ARG_REJECT_SPAM) { + config.set_reject_spam(true); + } + if matches.is_present(ARG_MONITOR) { + config.set_monitor(true); + } + if matches.is_present(ARG_PRESERVE_HEADERS) { + config.set_preserve_headers(true); + } + if matches.is_present(ARG_PRESERVE_BODY) { + config.set_preserve_body(true); + } + if matches.is_present(ARG_VERBOSE) { + config.set_verbose(true); + } + + if let Some(s) = matches.value_of(ARG_MAX_MESSAGE_SIZE) { + config.set_max_message_size(s.parse::().unwrap()); + } + + if let Some(s) = matches.values_of(ARG_SPAMC_ARGS) { + config.set_spamc_args(s.map(|arg| arg.to_owned()).collect::>()); + }; + + config.build() +} + +fn parse_ip_net(i: &str) -> Result { + i.parse::().or_else(|_| { + i.parse::().map(|addr| match addr { + IpAddr::V4(addr) => IpNet::V4(Ipv4Net::new(addr, 32).unwrap()), + IpAddr::V6(addr) => IpNet::V6(Ipv6Net::new(addr, 128).unwrap()), + }) + }) +}