diff options
| -rw-r--r-- | COPYING | 674 | ||||
| -rw-r--r-- | README | 27 | ||||
| -rw-r--r-- | milter_api.adb | 778 | ||||
| -rw-r--r-- | milter_api.ads | 427 |
4 files changed, 1906 insertions, 0 deletions
@@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>. @@ -0,0 +1,27 @@ + The Ada Milter API + + The Ada Milter API is a binding to Libmilter, the Sendmail mail filtering + API. A milter is a daemon that assists a Mail Transfer Agent, such as + Sendmail or Postfix, in checking messages and deciding whether to accept, + reject or modify them. This binding lets you write milters in Ada. + +Compatibility + + Version 1.1.1 of the Milter API is intended to match the version of + Libmilter that comes with Sendmail 8.13.8, where the value of SMFI_VERSION + is 2. It provides almost all of the features in that version of Libmilter, + but lacks features introduced in later versions. This version of the + Milter API has been used successfully with Postfix 2.3.8. + +Documentation + + There is documentation in the form of comments in the package + specification. In addition to those you should probably read the Libmilter + documentation, which is available at Milter.org and is also included with + Sendmail. + +License + + The Ada Milter API is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License version 3, as + published by the Free Software Foundation. diff --git a/milter_api.adb b/milter_api.adb new file mode 100644 index 0000000..f99235d --- /dev/null +++ b/milter_api.adb @@ -0,0 +1,778 @@ +-- Milter API for Ada, a binding to Libmilter, the Sendmail mail filtering API +-- Copyright 2009 B. Persson, Bjorn@Rombobeorn.se +-- +-- This library is free software: you can redistribute it and/or modify it +-- under the terms of the GNU General Public License version 3, as published +-- by the Free Software Foundation. + + +with Ada.Exceptions; use Ada.Exceptions; +with Ada.Strings.Fixed; +with System_Log; use System_Log; + +package body Milter_API is + + pragma Linker_Options("-lmilter"); + pragma Linker_Options("-lpthread"); + + use Ada.Strings.Unbounded; + use type String_Arrays.Pointer; + + + Version : constant Binding_Version_Type := (1, 1, 1); + + function Binding_Version return Binding_Version_Type is + begin + return Version; + end Binding_Version; + + function Binding_Version_String return String is + use Ada.Strings, Ada.Strings.Fixed; + begin + return Trim(Version.Specification_Major'Img, Left) & '.' & + Trim(Version.Specification_Minor'Img, Left) & '.' & + Trim(Version.Implementation'Img, Left); + end Binding_Version_String; + + Target_Version : constant int := 2; + -- Target_Version is the value of SMFI_VERSION in the version of Libmilter + -- that this version of Milter_API is intended to match. + + + Real_Connect_Handler : Connect_Handler; + Real_Helo_Handler : Helo_Handler; + Real_Envelope_Sender_Handler : Envelope_Sender_Handler; + Real_Envelope_Recipient_Handler : Envelope_Recipient_Handler; + Real_Header_Handler : Header_Handler; + Real_End_Of_Headers_Handler : End_Of_Headers_Handler; + Real_Body_Handler : Body_Handler; + Real_End_Of_Message_Handler : End_Of_Message_Handler; + Real_Abort_Handler : Abort_Handler; + Real_Close_Handler : Close_Handler; + Real_Unknown_Command_Handler : Unknown_Command_Handler; + Real_Data_Handler : Data_Handler; + + + type sfsistat is new int; + + + procedure Oops(E : Exception_Occurrence) is + begin + Log(Error, Exception_Information(E)); + Stop; + end Oops; + + function Oops(E : Exception_Occurrence) return sfsistat is + begin + Oops(E); + return sfsistat(Accept_Definitely); + end Oops; + + + type C_Connect_Handler is access function + (ctx : SMFICTX_Pointer; + hostname : chars_ptr; + hostaddr : access Dummy_Type) + return sfsistat; + pragma convention(C, C_Connect_Handler); + + function Connect_Relay + (ctx : SMFICTX_Pointer; + hostname : chars_ptr; + hostaddr : access Dummy_Type) + return sfsistat; + pragma convention(C, Connect_Relay); + + function Connect_Relay + (ctx : SMFICTX_Pointer; + hostname : chars_ptr; + hostaddr : access Dummy_Type) + return sfsistat + is + Dummy : Sockaddr; + begin + return sfsistat(Real_Connect_Handler(ctx, Value(hostname), Dummy)); + exception + when E : others => + return Oops(E); + end Connect_Relay; + + type C_Helo_Handler is access function + (ctx : SMFICTX_Pointer; + helohost : chars_ptr) + return sfsistat; + pragma convention(C, C_Helo_Handler); + + function Helo_Relay + (ctx : SMFICTX_Pointer; + helohost : chars_ptr) + return sfsistat; + pragma convention(C, Helo_Relay); + + function Helo_Relay + (ctx : SMFICTX_Pointer; + helohost : chars_ptr) + return sfsistat + is + begin + return sfsistat(Real_Helo_Handler(ctx, Value(helohost))); + exception + when E : others => + return Oops(E); + end Helo_Relay; + + type C_Envelope_Sender_Handler is access function + (ctx : SMFICTX_Pointer; + argv : String_Arrays.Pointer) + return sfsistat; + pragma convention(C, C_Envelope_Sender_Handler); + + function Envelope_Sender_Relay + (ctx : SMFICTX_Pointer; + argv : String_Arrays.Pointer) + return sfsistat; + pragma convention(C, Envelope_Sender_Relay); + + function Envelope_Sender_Relay + (ctx : SMFICTX_Pointer; + argv : String_Arrays.Pointer) + return sfsistat + is + begin + return sfsistat(Real_Envelope_Sender_Handler + (ctx, Value(argv.all), (Pointer => argv + 1))); + exception + when E : others => + return Oops(E); + end Envelope_Sender_Relay; + + type C_Envelope_Recipient_Handler is access function + (ctx : SMFICTX_Pointer; + argv : String_Arrays.Pointer) + return sfsistat; + pragma convention(C, C_Envelope_Recipient_Handler); + + function Envelope_Recipient_Relay + (ctx : SMFICTX_Pointer; + argv : String_Arrays.Pointer) + return sfsistat; + pragma convention(C, Envelope_Recipient_Relay); + + function Envelope_Recipient_Relay + (ctx : SMFICTX_Pointer; + argv : String_Arrays.Pointer) + return sfsistat + is + begin + return sfsistat(Real_Envelope_Recipient_Handler + (ctx, Value(argv.all), (Pointer => argv + 1))); + exception + when E : others => + return Oops(E); + end Envelope_Recipient_Relay; + + type C_Data_Handler is access function + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, C_Data_Handler); + + function Data_Relay + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, Data_Relay); + + function Data_Relay + (ctx : SMFICTX_Pointer) + return sfsistat + is + begin + return sfsistat(Real_Data_Handler(ctx)); + exception + when E : others => + return Oops(E); + end Data_Relay; + + type C_Unknown_Command_Handler is access function + (ctx : SMFICTX_Pointer; + arg : chars_ptr) + return sfsistat; + pragma convention(C, C_Unknown_Command_Handler); + + function Unknown_Command_Relay + (ctx : SMFICTX_Pointer; + arg : chars_ptr) + return sfsistat; + pragma convention(C, Unknown_Command_Relay); + + function Unknown_Command_Relay + (ctx : SMFICTX_Pointer; + arg : chars_ptr) + return sfsistat + is + begin + return sfsistat(Real_Unknown_Command_Handler(ctx, Value(arg))); + exception + when E : others => + return Oops(E); + end Unknown_Command_Relay; + + type C_Header_Handler is access function + (ctx : SMFICTX_Pointer; + headerf : chars_ptr; + headerv : chars_ptr) + return sfsistat; + pragma convention(C, C_Header_Handler); + + function Header_Relay + (ctx : SMFICTX_Pointer; + headerf : chars_ptr; + headerv : chars_ptr) + return sfsistat; + pragma convention(C, Header_Relay); + + function Header_Relay + (ctx : SMFICTX_Pointer; + headerf : chars_ptr; + headerv : chars_ptr) + return sfsistat + is + begin + return sfsistat(Real_Header_Handler(ctx, Value(headerf), Value(headerv))); + exception + when E : others => + return Oops(E); + end Header_Relay; + + type C_End_Of_Headers_Handler is access function + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, C_End_Of_Headers_Handler); + + function End_Of_Headers_Relay + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, End_Of_Headers_Relay); + + function End_Of_Headers_Relay + (ctx : SMFICTX_Pointer) + return sfsistat + is + begin + return sfsistat(Real_End_Of_Headers_Handler(ctx)); + exception + when E : others => + return Oops(E); + end End_Of_Headers_Relay; + + type C_Body_Handler is access function + (ctx : SMFICTX_Pointer; + bodyp : chars_ptr; + len : size_t) + return sfsistat; + pragma convention(C, C_Body_Handler); + + function Body_Relay + (ctx : SMFICTX_Pointer; + bodyp : chars_ptr; + len : size_t) + return sfsistat; + pragma convention(C, Body_Relay); + + function Body_Relay + (ctx : SMFICTX_Pointer; + bodyp : chars_ptr; + len : size_t) + return sfsistat + is + begin + return sfsistat(Real_Body_Handler(ctx, Value(bodyp, len))); + exception + when E : others => + return Oops(E); + end Body_Relay; + + type C_End_Of_Message_Handler is access function + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, C_End_Of_Message_Handler); + + function End_Of_Message_Relay + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, End_Of_Message_Relay); + + function End_Of_Message_Relay + (ctx : SMFICTX_Pointer) + return sfsistat + is + begin + return sfsistat(Real_End_Of_Message_Handler(ctx)); + exception + when E : others => + return Oops(E); + end End_Of_Message_Relay; + + type C_Abort_Handler is access function + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, C_Abort_Handler); + + function Abort_Relay + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, Abort_Relay); + + function Abort_Relay + (ctx : SMFICTX_Pointer) + return sfsistat + is + begin + Real_Abort_Handler(ctx); + return sfsistat(Continue); + exception + when E : others => + return Oops(E); + end Abort_Relay; + + type C_Close_Handler is access function + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, C_Close_Handler); + + function Close_Relay + (ctx : SMFICTX_Pointer) + return sfsistat; + pragma convention(C, Close_Relay); + + function Close_Relay + (ctx : SMFICTX_Pointer) + return sfsistat + is + begin + Real_Close_Handler(ctx); + return sfsistat(Continue); + exception + when E : others => + return Oops(E); + end Close_Relay; + + + procedure Check_For_Error(Function_Name : String; Result_Code : int) is + MI_SUCCESS : constant := 0; + MI_FAILURE : constant := -1; + begin + case Result_Code is + when MI_SUCCESS => + return; + when MI_FAILURE => + raise Failure with Function_Name & " reported failure."; + when others => + raise Unknown_Error with + Function_Name & " returned the undocumented result code " & + Ada.Strings.Fixed.Trim(Result_Code'Img, Ada.Strings.Left) & '.'; + end case; + end Check_For_Error; + + + procedure Register + (Name : String; + Connected : Connect_Handler := null; + Helo : Helo_Handler := null; + Envelope_Sender : Envelope_Sender_Handler := null; + Envelope_Recipient : Envelope_Recipient_Handler := null; + Data : Data_Handler := null; + Unknown_Command : Unknown_Command_Handler := null; + Header : Header_Handler := null; + End_Of_Headers : End_Of_Headers_Handler := null; + Body_Chunk : Body_Handler := null; + End_Of_Message : End_Of_Message_Handler := null; + Aborted : Abort_Handler := null; + Closed : Close_Handler := null; + May_Add_Headers : Boolean := False; + May_Change_Or_Delete_Headers : Boolean := False; + May_Replace_Body : Boolean := False; + May_Add_Recepients : Boolean := False; + May_Remove_Recepients : Boolean := False; + May_Quarantine : Boolean := False) + is + + SMFIF_ADDHDRS : constant := 16#1#; -- add headers + SMFIF_CHGBODY : constant := 16#2#; -- replace body + SMFIF_ADDRCPT : constant := 16#4#; -- add envelope recipients + SMFIF_DELRCPT : constant := 16#8#; -- delete envelope recipients + SMFIF_CHGHDRS : constant := 16#10#; -- change/delete headers + SMFIF_QUARANTINE : constant := 16#20#; -- quarantine envelope + + function BI(B : Boolean) return unsigned_long is + begin + if B then + return 1; + else + return 0; + end if; + end BI; + + type smfiDesc is record + xxfi_name : chars_ptr := New_String(Name); + xxfi_version : int := Target_Version; + xxfi_flags : unsigned_long := + SMFIF_ADDHDRS * BI(May_Add_Headers) + + SMFIF_CHGHDRS * BI(May_Change_Or_Delete_Headers) + + SMFIF_CHGBODY * BI(May_Replace_Body) + + SMFIF_ADDRCPT * BI(May_Add_Recepients) + + SMFIF_DELRCPT * BI(May_Remove_Recepients) + + SMFIF_QUARANTINE * BI(May_Quarantine); + xxfi_connect : C_Connect_Handler := null; + xxfi_helo : C_Helo_Handler := null; + xxfi_envfrom : C_Envelope_Sender_Handler := null; + xxfi_envrcpt : C_Envelope_Recipient_Handler := null; + xxfi_header : C_Header_Handler := null; + xxfi_eoh : C_End_Of_Headers_Handler := null; + xxfi_body : C_Body_Handler := null; + xxfi_eom : C_End_Of_Message_Handler := null; + xxfi_abort : C_Abort_Handler := null; + xxfi_close : C_Close_Handler := null; + xxfi_unknown : C_Unknown_Command_Handler := null; + xxfi_data : C_Data_Handler := null; + end record; + pragma convention(C_Pass_By_Copy, smfiDesc); + Definition : smfiDesc; + + function smfi_register(descr : smfiDesc) return int; + pragma import(C, smfi_register); + + begin -- Register + + if Connected /= null then + Real_Connect_Handler := Connected; + Definition.xxfi_connect := Connect_Relay'Access; + end if; + if Helo /= null then + Real_Helo_Handler := Helo; + Definition.xxfi_helo := Helo_Relay'Access; + end if; + if Envelope_Sender /= null then + Real_Envelope_Sender_Handler := Envelope_Sender; + Definition.xxfi_envfrom := Envelope_Sender_Relay'Access; + end if; + if Envelope_Recipient /= null then + Real_Envelope_Recipient_Handler := Envelope_Recipient; + Definition.xxfi_envrcpt := Envelope_Recipient_Relay'Access; + end if; + if Header /= null then + Real_Header_Handler := Header; + Definition.xxfi_header := Header_Relay'Access; + end if; + if End_Of_Headers /= null then + Real_End_Of_Headers_Handler := End_Of_Headers; + Definition.xxfi_eoh := End_Of_Headers_Relay'Access; + end if; + if Body_Chunk /= null then + Real_Body_Handler := Body_Chunk; + Definition.xxfi_body := Body_Relay'Access; + end if; + if End_Of_Message /= null then + Real_End_Of_Message_Handler := End_Of_Message; + Definition.xxfi_eom := End_Of_Message_Relay'Access; + end if; + if Aborted /= null then + Real_Abort_Handler := Aborted; + Definition.xxfi_abort := Abort_Relay'Access; + end if; + if Closed /= null then + Real_Close_Handler := Closed; + Definition.xxfi_close := Close_Relay'Access; + end if; + if Unknown_Command /= null then + Real_Unknown_Command_Handler := Unknown_Command; + Definition.xxfi_unknown := Unknown_Command_Relay'Access; + end if; + if Data /= null then + Real_Data_Handler := Data; + Definition.xxfi_data := Data_Relay'Access; + end if; + + Check_For_Error("smfi_register", smfi_register(Definition)); + + end Register; + + + procedure Set_Timeout(Timeout : Natural) is + function smfi_settimeout(otimeout : int) return int; + pragma import(C, smfi_settimeout); + begin + Check_For_Error("smfi_settimeout", smfi_settimeout(int(Timeout))); + end Set_Timeout; + + procedure Set_Connection_Queue_Length(Length : Positive) is + function smfi_setbacklog(obacklog : int) return int; + pragma import(C, smfi_setbacklog); + begin + Check_For_Error("smfi_setbacklog", smfi_setbacklog(int(Length))); + end Set_Connection_Queue_Length; + + procedure Set_Socket(Address : String) is + function smfi_setconn(oconn : char_array) return int; + pragma import(C, smfi_setconn); + begin + Check_For_Error("smfi_setconn", smfi_setconn(To_C(Address))); + end Set_Socket; + + procedure Open_Socket(Remove_Old_Socket : Boolean) is + function smfi_opensocket(rmsocket : int) return int; + -- rmsocket is declared as bool. I hope a bool is always an int. + pragma import(C, smfi_opensocket); + function I(B : Boolean) return int is + begin if B then return 1; else return 0; end if; end I; + begin + Check_For_Error("smfi_opensocket", smfi_opensocket(I(Remove_Old_Socket))); + end Open_Socket; + + procedure Main is + function smfi_main return int; + pragma import(C, smfi_main); + begin + Check_For_Error("smfi_main", smfi_main); + end Main; + + procedure Set_Debug_Level(Level : Natural) is + function smfi_setdbg(level : int) return int; + pragma import(C, smfi_setdbg); + begin + Check_For_Error("smfi_setdbg", smfi_setdbg(int(Level))); + end Set_Debug_Level; + + procedure Stop is + procedure smfi_stop; + pragma import(C, smfi_stop); + begin + smfi_stop; + end Stop; + + function Arguments(Handle : Arguments_Handle) return Unbounded_Strings is + Ustrings : Unbounded_Strings + (1 .. Natural(String_Arrays.Virtual_Length(Handle.Pointer))); + Current : String_Arrays.Pointer := Handle.Pointer; + begin + for Index in Ustrings'Range loop + Set_Unbounded_String(Ustrings(Index), Value(Current.all)); + String_Arrays.Increment(Current); + end loop; + return Ustrings; + end Arguments; + + procedure Get_Symbol_Value + (Context : in SMFICTX_Pointer; + Name : in String; + Defined : out Boolean; + Value : out Unbounded_String) + is + function smfi_getsymval + (ctx : SMFICTX_Pointer; + symname : char_array) + return chars_ptr; + pragma import(C, smfi_getsymval); + Answer : chars_ptr; + begin + Answer := smfi_getsymval(Context, To_C(Name)); + Defined := Answer /= Null_Ptr; + if Defined then + Set_Unbounded_String(Value, Strings.Value(Answer)); + end if; + end Get_Symbol_Value; + + procedure Set_Private_Data + (Context : SMFICTX_Pointer; + Data : Milter_Data_Pointer) + is + pragma Warnings(Off); -- Milter_Data doesn't correspond to any C type. + function smfi_setpriv + (ctx : SMFICTX_Pointer; + privatedata : Milter_Data_Pointer) + return int; + pragma Warnings(On); + pragma import(C, smfi_setpriv); + -- It doesn't matter that Milter_Data doesn't correspond to any C type, + -- because Libmilter only stores the pointer and doesn't care what it + -- points to. + begin + Check_For_Error("smfi_setpriv", smfi_setpriv(Context, Data)); + end Set_Private_Data; + + function Private_Data + (Context : SMFICTX_Pointer) + return Milter_Data_Pointer + is + pragma Warnings(Off); -- Milter_Data doesn't correspond to any C type. + function smfi_getpriv(ctx : SMFICTX_Pointer) return Milter_Data_Pointer; + pragma Warnings(On); + pragma import(C, smfi_getpriv); + begin + return smfi_getpriv(Context); + end Private_Data; + + procedure Set_Reply + (Context : SMFICTX_Pointer; + Reply_Code : String_Of_Three; + Extended_Code : String := ""; + Message : String := "") + is + function smfi_setreply + (ctx : SMFICTX_Pointer; + rcode : char_array; + xcode : chars_ptr; + message : chars_ptr) + return int; + pragma import(C, smfi_setreply); + C_Extended_Code : aliased char_array := To_C(Extended_Code); + C_Message : aliased char_array := To_C(Message); + Extended_Code_Ptr : chars_ptr := Null_Ptr; + Message_Ptr : chars_ptr := Null_Ptr; + begin + if Extended_Code'Length > 0 then + Extended_Code_Ptr := To_Chars_Ptr(C_Extended_Code'Unchecked_Access); + end if; + if Message'Length > 0 then + Message_Ptr := To_Chars_Ptr(C_Message'Unchecked_Access); + end if; + Check_For_Error("smfi_setreply", + smfi_setreply(Context, + To_C(Reply_Code), + Extended_Code_Ptr, + Message_Ptr)); + end Set_Reply; + + + procedure Add_Header + (Context : SMFICTX_Pointer; + Name : String; + Value : String) + is + function smfi_addheader + (ctx : SMFICTX_Pointer; + headerf : char_array; + headerv : char_array) + return int; + pragma import(C, smfi_addheader); + begin + Check_For_Error("smfi_addheader", + smfi_addheader(Context, To_C(Name), To_C(Value))); + end Add_Header; + + procedure Change_Header + (Context : SMFICTX_Pointer; + Name : String; + Index : Positive; + Value : String) + is + function smfi_chgheader + (ctx : SMFICTX_Pointer; + headerf : char_array; + hdridx : int; + headerv : char_array) + return int; + pragma import(C, smfi_chgheader); + begin + Check_For_Error("smfi_chgheader", + smfi_chgheader(Context, + To_C(Name), + int(Index), + To_C(Value))); + end Change_Header; + + procedure Delete_Header + (Context : SMFICTX_Pointer; + Name : String; + Index : Positive) + is + function smfi_chgheader + (ctx : SMFICTX_Pointer; + headerf : char_array; + hdridx : int; + headerv : chars_ptr) + return int; + pragma import(C, smfi_chgheader); + begin + Check_For_Error("smfi_chgheader", + smfi_chgheader(Context, + To_C(Name), + int(Index), + Null_Ptr)); + end Delete_Header; + + procedure Insert_Header + (Context : SMFICTX_Pointer; + Index : Positive; + Name : String; + Value : String) + is + function smfi_insheader + (ctx : SMFICTX_Pointer; + hdridx : int; + headerf : char_array; + headerv : char_array) + return int; + pragma import(C, smfi_insheader); + begin + Check_For_Error("smfi_insheader", + smfi_insheader(Context, + int(Index - 1), + To_C(Name), + To_C(Value))); + end Insert_Header; + + procedure Add_Recipient(Context : SMFICTX_Pointer; Address : String) is + function smfi_addrcpt + (ctx : SMFICTX_Pointer; + rcpt : char_array) + return int; + pragma import(C, smfi_addrcpt); + begin + Check_For_Error("smfi_addrcpt", smfi_addrcpt(Context, To_C(Address))); + end Add_Recipient; + + procedure Delete_Recipient(Context : SMFICTX_Pointer; Address : String) is + function smfi_delrcpt + (ctx : SMFICTX_Pointer; + rcpt : char_array) + return int; + pragma import(C, smfi_delrcpt); + begin + Check_For_Error("smfi_delrcpt", smfi_delrcpt(Context, To_C(Address))); + end Delete_Recipient; + + procedure Replace_Body(Context : SMFICTX_Pointer; Data : String) is + function smfi_replacebody + (ctx : SMFICTX_Pointer; + bodyp : char_array; + bodylen : int) + return int; + pragma import(C, smfi_replacebody); + begin + Check_For_Error("smfi_replacebody", + smfi_replacebody(Context, + To_C(Item => Data, Append_Nul => False), + Data'Length)); + end Replace_Body; + + + procedure Report_Progress(Context : SMFICTX_Pointer) is + function smfi_progress(ctx : SMFICTX_Pointer) return int; + pragma import(C, smfi_progress); + begin + Check_For_Error("smfi_progress", smfi_progress(Context)); + end Report_Progress; + + procedure Quarantine_Message(Context : SMFICTX_Pointer; Reason : String) is + function smfi_quarantine + (ctx : SMFICTX_Pointer; + reason : char_array) + return int; + pragma import(C, smfi_quarantine); + begin + Check_For_Error("smfi_quarantine", + smfi_quarantine(Context, To_C(Reason))); + end Quarantine_Message; + + +end Milter_API; diff --git a/milter_api.ads b/milter_api.ads new file mode 100644 index 0000000..3e37163 --- /dev/null +++ b/milter_api.ads @@ -0,0 +1,427 @@ +-- Milter API for Ada, a binding to Libmilter, the Sendmail mail filtering API +-- Copyright 2009 B. Persson, Bjorn@Rombobeorn.se +-- +-- This library is free software: you can redistribute it and/or modify it +-- under the terms of the GNU General Public License version 3, as published +-- by the Free Software Foundation. + + +with Ada.Strings.Unbounded; +with Interfaces.C.Strings; +with Interfaces.C.Pointers; + +package Milter_API is + + + -- + -- Version numbers + -- + + type Binding_Version_Type is record + Specification_Major : Positive; + Specification_Minor : Positive; + Implementation : Positive; + end record; + + function Binding_Version return Binding_Version_Type; + -- Binding_Version returns the version of Milter_API that the program is + -- linked with. If it is dynamically linked, then this is the version that + -- is loaded at run time. + -- The fields in the result are: + -- · Specification_Major: incremented for each new major version of the + -- Milter_API specification (this file). + -- · Specification_Minor: incremented when changes are made to the + -- specification and the major version number cannot be incremented. + -- · Implementation: incremented for each new version of Milter_API + -- when the specification is unchanged. + + function Binding_Version_String return String; + -- Binding_Version_String returns the same version information as + -- Binding_Version, but in string form. + + + -- + -- Data types and constants + -- + + type SMFICTX_Pointer is private; + -- SMFICTX_Pointer is the type of the opaque context pointers that Libmilter + -- passes to the callback routines, and that these in turn must pass to the + -- data access and message handling routines. + + type Milter_Data is limited interface; + type Milter_Data_Pointer is access all Milter_Data'Class; + pragma Convention(C, Milter_Data_Pointer); + -- In order to keep some data between callback invocations, the milter must + -- derive a type from Milter_Data and allocate one object of that type for + -- each SMTP session. The pointer to that object must be stored with + -- Set_Private_Data and retrieved with Private_Data. + + type Action is private; + -- Action is returned by callback routines. The value is an instruction to + -- the MTA on how to proceed with the message or connection. + + Continue : constant Action; + -- Continue processing the message/connection. + -- (SMFIS_CONTINUE) + + Reject : constant Action; + -- Reject the message/connection. + -- No further routines will be called for this message + -- (or connection, if returned from a connection-oriented routine). + -- (SMFIS_REJECT) + + Discard : constant Action; + -- Accept the message, + -- but silently discard the message. + -- No further routines will be called for this message. + -- This is only meaningful from message-oriented routines. + -- (SMFIS_DISCARD) + + Accept_Definitely : constant Action; + -- Accept the message/connection. + -- No further routines will be called for this message + -- (or connection, if returned from a connection-oriented routine; + -- in this case, it causes all messages on this connection + -- to be accepted without filtering). + -- (SMFIS_ACCEPT) + + Fail_Temporarily : constant Action; + -- Return a temporary failure, i.e., + -- the corresponding SMTP command will return a 4xx status code. + -- In some cases this may prevent further routines from + -- being called on this message or connection, + -- although in other cases (e.g., when processing an envelope + -- recipient) processing of the message will continue. + -- (SMFIS_TEMPFAIL) + + type Sockaddr is private; + + type Arguments_Handle is private; + + type Unbounded_Strings is + array(Positive range <>) of Ada.Strings.Unbounded.Unbounded_String; + + + -- + -- Callback types + -- + + type Connect_Handler is access function + (Context : SMFICTX_Pointer; -- the opaque context handle + Client_Name : String; -- the name of the client + Client_Address : Sockaddr) -- the address of the client + return Action; + -- called at the start of each SMTP connection + -- corresponds to xxfi_connect + -- Client_Name is the host name of the client, as determined by a reverse + -- lookup on the host address. Client_Address describes the client's endpoint + -- of the SMTP connection. The means to access the contents of Client_Address + -- are not implemented. + + type Helo_Handler is access function + (Context : SMFICTX_Pointer; -- the opaque context handle + Stated_Name : String) -- what the client sent as parameter to + -- the HELO or EHLO command + return Action; + -- called when the client sends a HELO or EHLO command + -- corresponds to xxfi_helo + + type Envelope_Sender_Handler is access function + (Context : SMFICTX_Pointer; -- the opaque context handle + Sender : String; -- the envelope sender address + Arguments : Arguments_Handle) -- ESMTP arguments to the MAIL command + return Action; + -- called once at the beginning of each message + -- corresponds to xxfi_envfrom + + type Envelope_Recipient_Handler is access function + (Context : SMFICTX_Pointer; -- the opaque context handle + Recipient : String; -- an envelope recipient address + Arguments : Arguments_Handle) -- ESMTP arguments to the RCPT command + return Action; + -- called once per recipient + -- corresponds to xxfi_envrcpt + + type Data_Handler is access function + (Context : SMFICTX_Pointer) -- the opaque context handle + return Action; + -- called when the client sends the DATA command + -- corresponds to xxfi_data + + type Unknown_Command_Handler is access function + (Context : SMFICTX_Pointer; -- the opaque context handle + Command : String) -- the unknown command including arguments + return Action; + -- called if the client sends an SMTP command that is either unknown or not + -- implemented by the MTA + -- corresponds to xxfi_unknown + + type Header_Handler is access function + (Context : SMFICTX_Pointer; -- the opaque context handle + Name : String; -- the name of the header + Value : String) -- the content of the header + return Action; + -- called once per message header + -- corresponds to xxfi_header + + type End_Of_Headers_Handler is access function + (Context : SMFICTX_Pointer) -- the opaque context handle + return Action; + -- called after all headers have been processed + -- corresponds to xxfi_eoh + + type Body_Handler is access function + (Context : SMFICTX_Pointer; -- the opaque context handle + Body_Chunk : String) -- a piece of the message body + return Action; + -- called zero or more times between End_Of_Headers_Handler and + -- End_Of_Message_Handler + -- corresponds to xxfi_body + + type End_Of_Message_Handler is access function + (Context : SMFICTX_Pointer) -- the opaque context handle + return Action; + -- called at the end of a message + -- This is the place to call message modification procedures. + -- corresponds to xxfi_eom + + type Abort_Handler is access procedure + (Context : SMFICTX_Pointer); -- the opaque context handle + -- called at any time during message processing if the message is aborted + -- corresponds to xxfi_abort + + type Close_Handler is access procedure + (Context : SMFICTX_Pointer); -- the opaque context handle + -- called once at the end of each connection + -- corresponds to xxfi_close + + + -- + -- Exceptions + -- + + Failure : exception; + -- A call to an API procedure failed. + -- (The corresponding C function returned MI_FAILURE.) + + Unknown_Error : exception; + -- A C function returned an undocumented result code. + + + -- + -- Library control procedures + -- + + procedure Register + (Name : String; + Connected : Connect_Handler := null; + Helo : Helo_Handler := null; + Envelope_Sender : Envelope_Sender_Handler := null; + Envelope_Recipient : Envelope_Recipient_Handler := null; + Data : Data_Handler := null; + Unknown_Command : Unknown_Command_Handler := null; + Header : Header_Handler := null; + End_Of_Headers : End_Of_Headers_Handler := null; + Body_Chunk : Body_Handler := null; + End_Of_Message : End_Of_Message_Handler := null; + Aborted : Abort_Handler := null; + Closed : Close_Handler := null; + May_Add_Headers : Boolean := False; + May_Change_Or_Delete_Headers : Boolean := False; + May_Replace_Body : Boolean := False; + May_Add_Recepients : Boolean := False; + May_Remove_Recepients : Boolean := False; + May_Quarantine : Boolean := False); + -- Register must be called exactly once before Main. It registers the + -- callbacks and properties of the milter (calls smfi_register). + + procedure Set_Timeout(Timeout : Natural); + -- Set_Timeout should only be called before Main. It sets the number of + -- seconds Libmilter will wait for an MTA connection before timing out a + -- socket (calls smfi_settimeout). + + procedure Set_Connection_Queue_Length(Length : Positive); + -- Set_Connection_Queue_Length should only be called before Main. It + -- sets the number of incoming connections to allow in the listen queue + -- (calls smfi_setbacklog). + + procedure Set_Socket(Address : String); + -- Set_Socket must be called once before Main. It specifies the socket + -- through which the milter should communicate with the MTA (calls + -- smfi_setconn). + + procedure Open_Socket(Remove_Old_Socket : Boolean); + -- Open_Socket should only be called before Main. It creates the socket + -- specified previously by a call to Set_Socket (calls smfi_opensocket). + -- This allows the calling application to ensure that the socket can be + -- created. If the socket is specified as a Unix domain socket and + -- Remove_Old_Socket is true, then Libmilter will try to remove any existing + -- socket before creating a new one. + -- If Open_Socket is not called, then Main will create the socket. + + procedure Main; + -- Hands control to the Libmilter event loop (calls smfi_main). + + procedure Set_Debug_Level(Level : Natural); + -- Set_Debug_Level may be called from any routine at any time. It changes + -- Libmilter's internal debug logging level (calls smfi_setdbg). A value of + -- zero turns off debug logging. The greater the value the more detailed the + -- logging. + + procedure Stop; + -- Stop may be called from any of the callback routines or any error-handling + -- routines at any time. It tells Libmilter to shut down the milter (calls + -- smfi_stop). + + + -- + -- Data access subprograms + -- + + function Arguments(Handle : Arguments_Handle) return Unbounded_Strings; + -- Converts the ESMTP arguments to a MAIL or RCPT command into an array of + -- unbounded strings. + + procedure Get_Symbol_Value + (Context : in SMFICTX_Pointer; -- the opaque context handle + Name : in String; -- the name of the requested symbol + Defined : out Boolean; -- whether the requested symbol exists + Value : out Ada.Strings.Unbounded.Unbounded_String); + -- Requests the value of a symbol ("macro") from the MTA. Value is + -- meaningful only if Defined is True. + + procedure Set_Private_Data + (Context : SMFICTX_Pointer; -- the opaque context handle + Data : Milter_Data_Pointer); -- pointer to private data + -- Sets the private data pointer to be returned by future calls to + -- Private_Data for this connection (calls smfi_setpriv). + + function Private_Data + (Context : SMFICTX_Pointer) -- the opaque context handle + return Milter_Data_Pointer; + -- Retrieves the private data pointer previously stored with Set_Private_Data + -- for this connection (calls smfi_getpriv). + + subtype String_Of_Three is String(1..3); + procedure Set_Reply + (Context : SMFICTX_Pointer; -- the opaque context handle + Reply_Code : String_Of_Three; -- three-digit (RFC 2821) reply code + Extended_Code : String := ""; -- extended (RFC 2034) reply code + Message : String := ""); -- the text part of the reply + -- Sets the reply codes and message to be used in subsequent SMTP error + -- replies caused by the milter (calls smfi_setreply). + -- There is no interface to smfi_setmlreply yet. + + + -- + -- Message modification procedures + -- + -- These procedures may only be called from a callback function registered as + -- End_Of_Message. + + procedure Add_Header + (Context : SMFICTX_Pointer; -- the opaque context handle + Name : String; -- the header field name + Value : String); -- the header field body + -- Adds a header field to the current message (calls smfi_addheader). + + procedure Change_Header + (Context : SMFICTX_Pointer; -- the opaque context handle + Name : String; -- the header field name + Index : Positive; -- index among headers with the same name + Value : String); -- the new header field body + -- Replaces the header field body of the specified header field in the + -- current message (calls smfi_chgheader). Index specifies which of the + -- headers with the name Name shall be changed. + + procedure Delete_Header + (Context : SMFICTX_Pointer; -- the opaque context handle + Name : String; -- the header field name + Index : Positive); -- index among headers with the same name + -- Removes the specified header field from the current message (calls + -- smfi_chgheader with headerv set to null). + + procedure Insert_Header + (Context : SMFICTX_Pointer; -- the opaque context handle + Index : Positive; -- index among all headers + Name : String; -- the header field name + Value : String); -- the header field body + -- Adds a header field at a specified position in the current message + -- (calls smfi_insheader). Index specifies where in the list of headers it + -- shall be inserted. 1 makes it the first header, 2 the second and so on. + + procedure Add_Recipient + (Context : SMFICTX_Pointer; -- the opaque context handle + Address : String); -- the new recipient's address + -- Adds a recepient address to the envelope of the current message (calls + -- smfi_addrcpt). + + procedure Delete_Recipient + (Context : SMFICTX_Pointer; -- the opaque context handle + Address : String); -- the recipient address to be removed + -- Removes the specified recepient address from the envelope of the current + -- message (calls smfi_delrcpt). + + procedure Replace_Body + (Context : SMFICTX_Pointer; -- the opaque context handle + Data : String); -- the new message body + -- Replaces the body of the current message (calls smfi_replacebody). If + -- called more than once, subsequent calls append data to the new body. + + + -- + -- Other message handling procedures + -- + -- These procedures may only be called from a callback function registered as + -- End_Of_Message. + + procedure Report_Progress + (Context : SMFICTX_Pointer); -- the opaque context handle + -- Notifies the MTA that the milter is still working on a message (calls + -- smfi_progress). + + procedure Quarantine_Message + (Context : SMFICTX_Pointer; -- the opaque context handle + Reason : String); -- the quarantine reason + -- Quarantines the current message (calls smfi_quarantine). + + +private + + type Dummy_Type is null record; + type SMFICTX_Pointer is access Dummy_Type; + pragma convention(C, Dummy_Type); + pragma convention(C, SMFICTX_Pointer); + + type Action is range 0 .. 10; + Continue : constant Action := 0; + Reject : constant Action := 1; + Discard : constant Action := 2; + Accept_Definitely : constant Action := 3; + Fail_Temporarily : constant Action := 4; + All_Options : constant Action := 10; + + type Sockaddr is null record; + -- Accessing socket addresses isn't implemented. The type is declared just + -- so that there's a chance that the API will be compatible if this gets + -- implemented in the future. + + use Interfaces.C; + use Interfaces.C.Strings; + + type chars_ptr_array is array(size_t range <>) of aliased chars_ptr; + -- This type definition can be removed if and when Interfaces.C.Strings gets + -- updated to conform to Ada 2005. + + package String_Arrays is + new Interfaces.C.Pointers(Index => size_t, + Element => chars_ptr, + Element_Array => chars_ptr_array, + Default_Terminator => Null_Ptr); + + type Arguments_Handle is record + Pointer : String_Arrays.Pointer; + end record; + +end Milter_API; |