diff --git a/LICENSE b/LICENSE index 818433e..94a9ed0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +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 -. + 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/lang/sv b/lang/sv index 3068c01..379ccce 100755 --- a/lang/sv +++ b/lang/sv @@ -1,4 +1,3 @@ - #!/bin/bash #################################################################### # Prey - by Tomas Pollak (http://bootlog.org) diff --git a/platform/linux/bin/sendEmail b/platform/linux/bin/sendEmail index 54cdcbf..9f9392e 100755 --- a/platform/linux/bin/sendEmail +++ b/platform/linux/bin/sendEmail @@ -1,2235 +1,2235 @@ -#!/usr/bin/perl -w -############################################################################## -## sendEmail -## Written by: Brandon Zehm -## -## License: -## sendEmail (hereafter referred to as "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 -## 2 of the License, or (at your option) any later version. -## When redistributing modified versions of this source code it is recommended -## that that this disclaimer and the above coder's names are included in the -## modified code. -## -## Disclaimer: -## This program is provided with no warranty of any kind, either expressed or -## implied. It is the responsibility of the user (you) to fully research and -## comprehend the usage of this program. As with any tool, it can be misused, -## either intentionally (you're a vandal) or unintentionally (you're a moron). -## THE AUTHOR(S) IS(ARE) NOT RESPONSIBLE FOR ANYTHING YOU DO WITH THIS PROGRAM -## or anything that happens because of your use (or misuse) of this program, -## including but not limited to anything you, your lawyers, or anyone else -## can dream up. And now, a relevant quote directly from the GPL: -## -## NO WARRANTY -## -## 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. -## -############################################################################## -use strict; -use IO::Socket; - - -######################## -## Global Variables ## -######################## - -my %conf = ( - ## General - "programName" => $0, ## The name of this program - "version" => '1.56', ## The version of this program - "authorName" => 'Brandon Zehm', ## Author's Name - "authorEmail" => 'caspian@dotconf.net', ## Author's Email Address - "timezone" => '+0000', ## We always use +0000 for the time zone - "hostname" => 'changeme', ## Used in printmsg() for all output (is updated later in the script). - "debug" => 0, ## Default debug level - "error" => '', ## Error messages will often be stored here - - ## Logging - "stdout" => 1, - "logging" => 0, ## If this is true the printmsg function prints to the log file - "logFile" => '', ## If this is specified (form the command line via -l) this file will be used for logging. - - ## Network - "server" => 'localhost', ## Default SMTP server - "port" => 25, ## Default port - "bindaddr" => '', ## Default local bind address - "alarm" => '', ## Default timeout for connects and reads, this gets set from $opt{'timeout'} - "tls_client" => 0, ## If TLS is supported by the client (us) - "tls_server" => 0, ## If TLS is supported by the remote SMTP server - - ## Email - "delimiter" => "----MIME delimiter for sendEmail-" ## MIME Delimiter - . rand(1000000), ## Add some randomness to the delimiter - "Message-ID" => rand(1000000) . "-sendEmail", ## Message-ID for email header - -); - - -## This hash stores the options passed on the command line via the -o option. -my %opt = ( - ## Addressing - "reply-to" => '', ## Reply-To field - - ## Message - "message-file" => '', ## File to read message body from - "message-header" => '', ## Additional email header line(s) - "message-format" => 'normal', ## If "raw" is specified the message is sent unmodified - "message-charset" => 'iso-8859-1', ## Message character-set - "message-content-type" => 'auto', ## auto, text, html or an actual string to put into the content-type header. - - ## Network - "timeout" => 60, ## Default timeout for connects and reads, this is copied to $conf{'alarm'} later. - "fqdn" => 'changeme', ## FQDN of this machine, used during SMTP communication (is updated later in the script). - - ## eSMTP - "username" => '', ## Username used in SMTP Auth - "password" => '', ## Password used in SMTP Auth - "tls" => 'auto', ## Enable or disable TLS support. Options: auto, yes, no - -); - -## More variables used later in the program -my $SERVER; -my $CRLF = "\015\012"; -my $subject = ''; -my $header = ''; -my $message = ''; -my $from = ''; -my @to = (); -my @cc = (); -my @bcc = (); -my @attachments = (); -my @attachments_names = (); - -## For printing colors to the console -my ${colorRed} = "\033[31;1m"; -my ${colorGreen} = "\033[32;1m"; -my ${colorCyan} = "\033[36;1m"; -my ${colorWhite} = "\033[37;1m"; -my ${colorNormal} = "\033[m"; -my ${colorBold} = "\033[1m"; -my ${colorNoBold} = "\033[0m"; - -## Don't use shell escape codes on Windows systems -if ($^O =~ /win/i) { - ${colorRed} = ${colorGreen} = ${colorCyan} = ${colorWhite} = ${colorNormal} = ${colorBold} = ${colorNoBold} = ""; -} - -## Load IO::Socket::SSL if it's available -eval { require IO::Socket::SSL; }; -if ($@) { $conf{'tls_client'} = 0; } -else { $conf{'tls_client'} = 1; } - - - - - - -############################# -## ## -## FUNCTIONS ## -## ## -############################# - - - - - -############################################################################################### -## Function: initialize () -## -## Does all the script startup jibberish. -## -############################################################################################### -sub initialize { - - ## Set STDOUT to flush immediatly after each print - $| = 1; - - ## Intercept signals - $SIG{'QUIT'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; - $SIG{'INT'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; - $SIG{'KILL'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; - $SIG{'TERM'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; - - ## ALARM and HUP signals are not supported in Win32 - unless ($^O =~ /win/i) { - $SIG{'HUP'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; - $SIG{'ALRM'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; - } - - ## Fixup $conf{'programName'} - $conf{'programName'} =~ s/(.)*[\/,\\]//; - $0 = $conf{'programName'} . " " . join(" ", @ARGV); - - ## Fixup $conf{'hostname'} and $opt{'fqdn'} - if ($opt{'fqdn'} eq 'changeme') { $opt{'fqdn'} = get_hostname(1); } - if ($conf{'hostname'} eq 'changeme') { $conf{'hostname'} = $opt{'fqdn'}; $conf{'hostname'} =~ s/\..*//; } - - return(1); -} - - - - - - - - - - - - - - - -############################################################################################### -## Function: processCommandLine () -## -## Processes command line storing important data in global vars (usually %conf) -## -############################################################################################### -sub processCommandLine { - - - ############################ - ## Process command line ## - ############################ - - my @ARGS = @ARGV; ## This is so later we can re-parse the command line args later if we need to - my $numargv = @ARGS; - help() unless ($numargv); - my $counter = 0; - - for ($counter = 0; $counter < $numargv; $counter++) { - - if ($ARGS[$counter] =~ /^-h$/i) { ## Help ## - help(); - } - - elsif ($ARGS[$counter] eq "") { ## Ignore null arguments - ## Do nothing - } - - elsif ($ARGS[$counter] =~ /^--help/) { ## Topical Help ## - $counter++; - if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { - helpTopic($ARGS[$counter]); - } - else { - help(); - } - } - - elsif ($ARGS[$counter] =~ /^-o$/i) { ## Options specified with -o ## - $counter++; - ## Loop through each option passed after the -o - while ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { - - if ($ARGS[$counter] !~ /(\S+)=(\S.*)/) { - printmsg("WARNING => Name/Value pair [$ARGS[$counter]] is not properly formatted", 0); - printmsg("WARNING => Arguments proceeding -o should be in the form of \"name=value\"", 0); - } - else { - if (exists($opt{$1})) { - if ($1 eq 'message-header') { - $opt{$1} .= $2 . $CRLF; - } - else { - $opt{$1} = $2; - } - printmsg("DEBUG => Assigned \$opt{} key/value: $1 => $2", 3); - } - else { - printmsg("WARNING => Name/Value pair [$ARGS[$counter]] will be ignored: unknown key [$1]", 0); - printmsg("HINT => Try the --help option to find valid command line arguments", 1); - } - } - $counter++; - } $counter--; - } - - elsif ($ARGS[$counter] =~ /^-f$/) { ## From ## - $counter++; - if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { $from = $ARGS[$counter]; } - else { printmsg("WARNING => The argument after -f was not an email address!", 0); $counter--; } - } - - elsif ($ARGS[$counter] =~ /^-t$/) { ## To ## - $counter++; - while ($ARGS[$counter] && ($ARGS[$counter] !~ /^-/)) { - if ($ARGS[$counter] =~ /[;,]/) { - push (@to, split(/[;,]/, $ARGS[$counter])); - } - else { - push (@to,$ARGS[$counter]); - } - $counter++; - } $counter--; - } - - elsif ($ARGS[$counter] =~ /^-cc$/) { ## Cc ## - $counter++; - while ($ARGS[$counter] && ($ARGS[$counter] !~ /^-/)) { - if ($ARGS[$counter] =~ /[;,]/) { - push (@cc, split(/[;,]/, $ARGS[$counter])); - } - else { - push (@cc,$ARGS[$counter]); - } - $counter++; - } $counter--; - } - - elsif ($ARGS[$counter] =~ /^-bcc$/) { ## Bcc ## - $counter++; - while ($ARGS[$counter] && ($ARGS[$counter] !~ /^-/)) { - if ($ARGS[$counter] =~ /[;,]/) { - push (@bcc, split(/[;,]/, $ARGS[$counter])); - } - else { - push (@bcc,$ARGS[$counter]); - } - $counter++; - } $counter--; - } - - elsif ($ARGS[$counter] =~ /^-m$/) { ## Message ## - $counter++; - $message = ""; - while ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { - if ($message) { $message .= " "; } - $message .= $ARGS[$counter]; - $counter++; - } $counter--; - - ## Replace '\n' with $CRLF. - ## This allows newlines with messages sent on the command line - $message =~ s/\\n/$CRLF/g; - } - - elsif ($ARGS[$counter] =~ /^-u$/) { ## Subject ## - $counter++; - $subject = ""; - while ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { - if ($subject) { $subject .= " "; } - $subject .= $ARGS[$counter]; - $counter++; - } $counter--; - } - - elsif ($ARGS[$counter] =~ /^-s$/) { ## Server ## - $counter++; - if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { - $conf{'server'} = $ARGS[$counter]; - if ($conf{'server'} =~ /:/) { ## Port ## - ($conf{'server'},$conf{'port'}) = split(":",$conf{'server'}); - } - } - else { printmsg("WARNING - The argument after -s was not the server!", 0); $counter--; } - } - - elsif ($ARGS[$counter] =~ /^-b$/) { ## Bind Address ## - $counter++; - if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { - $conf{'bindaddr'} = $ARGS[$counter]; - } - else { printmsg("WARNING - The argument after -b was not the bindaddr!", 0); $counter--; } - } - - elsif ($ARGS[$counter] =~ /^-a$/) { ## Attachments ## - $counter++; - while ($ARGS[$counter] && ($ARGS[$counter] !~ /^-/)) { - push (@attachments,$ARGS[$counter]); - $counter++; - } $counter--; - } - - elsif ($ARGS[$counter] =~ /^-xu$/) { ## AuthSMTP Username ## - $counter++; - if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { - $opt{'username'} = $ARGS[$counter]; - } - else { - printmsg("WARNING => The argument after -xu was not valid username!", 0); - $counter--; - } - } - - elsif ($ARGS[$counter] =~ /^-xp$/) { ## AuthSMTP Password ## - $counter++; - if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { - $opt{'password'} = $ARGS[$counter]; - } - else { - printmsg("WARNING => The argument after -xp was not valid password!", 0); - $counter--; - } - } - - elsif ($ARGS[$counter] =~ /^-l$/) { ## Logging ## - $counter++; - $conf{'logging'} = 1; - if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { $conf{'logFile'} = $ARGS[$counter]; } - else { printmsg("WARNING - The argument after -l was not the log file!", 0); $counter--; } - } - - elsif ($ARGS[$counter] =~ s/^-v+//i) { ## Verbosity ## - my $tmp = (length($&) - 1); - $conf{'debug'} += $tmp; - } - - elsif ($ARGS[$counter] =~ /^-q$/) { ## Quiet ## - $conf{'stdout'} = 0; - } - - else { - printmsg("Error: \"$ARGS[$counter]\" is not a recognized option!", 0); - help(); - } - - } - - - - - - - - - ################################################### - ## Verify required variables are set correctly ## - ################################################### - - ## Make sure we have something in $conf{hostname} and $opt{fqdn} - if ($opt{'fqdn'} =~ /\./) { - $conf{'hostname'} = $opt{'fqdn'}; - $conf{'hostname'} =~ s/\..*//; - } - - if (!$conf{'server'}) { $conf{'server'} = 'localhost'; } - if (!$conf{'port'}) { $conf{'port'} = 25; } - if (!$from) { - quit("ERROR => You must specify a 'from' field! Try --help.", 1); - } - if ( ((scalar(@to)) + (scalar(@cc)) + (scalar(@bcc))) <= 0) { - quit("ERROR => You must specify at least one recipient via -t, -cc, or -bcc", 1); - } - - ## Make sure email addresses look OK. - foreach my $addr (@to, @cc, @bcc, $from, $opt{'reply-to'}) { - if ($addr) { - if (!returnAddressParts($addr)) { - printmsg("ERROR => Can't use improperly formatted email address: $addr", 0); - printmsg("HINT => Try viewing the extended help on addressing with \"--help addressing\"", 1); - quit("", 1); - } - } - } - - ## Make sure all attachments exist. - foreach my $file (@attachments) { - if ( (! -f $file) or (! -r $file) ) { - printmsg("ERROR => The attachment [$file] doesn't exist!", 0); - printmsg("HINT => Try specifying the full path to the file or reading extended help with \"--help message\"", 1); - quit("", 1); - } - } - - if ($conf{'logging'} and (!$conf{'logFile'})) { - quit("ERROR => You used -l to enable logging but didn't specify a log file!", 1); - } - - if ( $opt{'username'} ) { - if (!$opt{'password'}) { - ## Prompt for a password since one wasn't specified with the -xp option. - $SIG{'ALRM'} = sub { quit("ERROR => Timeout waiting for password inpupt", 1); }; - alarm(60) if ($^O !~ /win/i); ## alarm() doesn't work in win32 - print "Password: "; - $opt{'password'} = ; chomp $opt{'password'}; - if (!$opt{'password'}) { - quit("ERROR => A username for SMTP authentication was specified, but no password!", 1); - } - } - } - - ## Validate the TLS setting - $opt{'tls'} = lc($opt{'tls'}); - if ($opt{'tls'} !~ /^(auto|yes|no)$/) { - quit("ERROR => Invalid TLS setting ($opt{'tls'}). Must be one of auto, yes, or no.", 1); - } - - ## If TLS is set to "yes", make sure sendEmail loaded the libraries needed. - if ($opt{'tls'} eq 'yes' and $conf{'tls_client'} == 0) { - quit("ERROR => No TLS support! SendEmail can't load required libraries. (try installing Net::SSLeay and IO::Socket::SSL)", 1); - } - - ## Return 0 errors - return(0); -} - - - - - - - - - - - - - - - - -## getline($socketRef) -sub getline { - my ($socketRef) = @_; - local ($/) = "\r\n"; - return $$socketRef->getline; -} - - - - -## Receive a (multiline?) SMTP response from ($socketRef) -sub getResponse { - my ($socketRef) = @_; - my ($tmp, $reply); - local ($/) = "\r\n"; - return undef unless defined($tmp = getline($socketRef)); - return("getResponse() socket is not open") unless ($$socketRef->opened); - ## Keep reading lines if it's a multi-line response - while ($tmp =~ /^\d{3}-/o) { - $reply .= $tmp; - return undef unless defined($tmp = getline($socketRef)); - } - $reply .= $tmp; - $reply =~ s/\r?\n$//o; - return $reply; -} - - - - -############################################################################################### -## Function: SMTPchat ( [string $command] ) -## -## Description: Sends $command to the SMTP server (on SERVER) and awaits a successful -## reply form the server. If the server returns an error, or does not reply -## within $conf{'alarm'} seconds an error is generated. -## NOTE: $command is optional, if no command is specified then nothing will -## be sent to the server, but a valid response is still required from the server. -## -## Input: [$command] A (optional) valid SMTP command (ex. "HELO") -## -## -## Output: Returns zero on success, or non-zero on error. -## Error messages will be stored in $conf{'error'} -## A copy of the last SMTP response is stored in the global variable -## $conf{'SMTPchat_response'} -## -## -## Example: SMTPchat ("HELO mail.isp.net"); -############################################################################################### -sub SMTPchat { - my ($command) = @_; - - printmsg("INFO => Sending: \t$command", 1) if ($command); - - ## Send our command - print $SERVER "$command$CRLF" if ($command); - - ## Read a response from the server - $SIG{'ALRM'} = sub { $conf{'error'} = "alarm"; $SERVER->close(); }; - alarm($conf{'alarm'}) if ($^O !~ /win/i); ## alarm() doesn't work in win32; - my $result = $conf{'SMTPchat_response'} = getResponse(\$SERVER); - alarm(0) if ($^O !~ /win/i); ## alarm() doesn't work in win32; - - ## Generate an alert if we timed out - if ($conf{'error'} eq "alarm") { - $conf{'error'} = "ERROR => Timeout while reading from $conf{'server'}:$conf{'port'} There was no response after $conf{'alarm'} seconds."; - return(1); - } - - ## Make sure the server actually responded - if (!$result) { - $conf{'error'} = "ERROR => $conf{'server'}:$conf{'port'} returned a zero byte response to our query."; - return(2); - } - - ## Validate the response - if (evalSMTPresponse($result)) { - ## conf{'error'} will already be set here - return(2); - } - - ## Print the success messsage - printmsg($conf{'error'}, 1); - - ## Return Success - return(0); -} - - - - - - - - - - - - -############################################################################################### -## Function: evalSMTPresponse (string $message ) -## -## Description: Searches $message for either an SMTP success or error code, and returns -## 0 on success, and the actual error code on error. -## -## -## Input: $message Data received from a SMTP server (ex. "220 -## -## -## Output: Returns zero on success, or non-zero on error. -## Error messages will be stored in $conf{'error'} -## -## -## Example: SMTPchat ("HELO mail.isp.net"); -############################################################################################### -sub evalSMTPresponse { - my ($message) = @_; - - ## Validate input - if (!$message) { - $conf{'error'} = "ERROR => No message was passed to evalSMTPresponse(). What happened?"; - return(1) - } - - printmsg("DEBUG => evalSMTPresponse() - Checking for SMTP success or error status in the message: $message ", 3); - - ## Look for a SMTP success code - if ($message =~ /^([23]\d\d)/) { - printmsg("DEBUG => evalSMTPresponse() - Found SMTP success code: $1", 2); - $conf{'error'} = "SUCCESS => Received: \t$message"; - return(0); - } - - ## Look for a SMTP error code - if ($message =~ /^([45]\d\d)/) { - printmsg("DEBUG => evalSMTPresponse() - Found SMTP error code: $1", 2); - $conf{'error'} = "ERROR => Received: \t$message"; - return($1); - } - - ## If no SMTP codes were found return an error of 1 - $conf{'error'} = "ERROR => Received a message with no success or error code. The message received was: $message"; - return(2); - -} - - - - - - - - - - -######################################################### -# SUB: &return_month(0,1,etc) -# returns the name of the month that corrosponds -# with the number. returns 0 on error. -######################################################### -sub return_month { - my $x = $_[0]; - if ($x == 0) { return 'Jan'; } - if ($x == 1) { return 'Feb'; } - if ($x == 2) { return 'Mar'; } - if ($x == 3) { return 'Apr'; } - if ($x == 4) { return 'May'; } - if ($x == 5) { return 'Jun'; } - if ($x == 6) { return 'Jul'; } - if ($x == 7) { return 'Aug'; } - if ($x == 8) { return 'Sep'; } - if ($x == 9) { return 'Oct'; } - if ($x == 10) { return 'Nov'; } - if ($x == 11) { return 'Dec'; } - return (0); -} - - - - - - - - - - - - - - - - -######################################################### -# SUB: &return_day(0,1,etc) -# returns the name of the day that corrosponds -# with the number. returns 0 on error. -######################################################### -sub return_day { - my $x = $_[0]; - if ($x == 0) { return 'Sun'; } - if ($x == 1) { return 'Mon'; } - if ($x == 2) { return 'Tue'; } - if ($x == 3) { return 'Wed'; } - if ($x == 4) { return 'Thu'; } - if ($x == 5) { return 'Fri'; } - if ($x == 6) { return 'Sat'; } - return (0); -} - - - - - - - - - - - - - - - - -############################################################################################### -## Function: returnAddressParts(string $address) -## -## Description: Returns a two element array containing the "Name" and "Address" parts of -## an email address. -## -## Example: "Brandon Zehm " -## would return: ("Brandon Zehm", "caspian@dotconf.net"); -## -## "caspian@dotconf.net" -## would return: ("caspian@dotconf.net", "caspian@dotconf.net") -############################################################################################### -sub returnAddressParts { - my $input = $_[0]; - my $name = ""; - my $address = ""; - - ## Make sure to fail if it looks totally invalid - if ($input !~ /(\S+\@\S+)/) { - $conf{'error'} = "ERROR => The address [$input] doesn't look like a valid email address, ignoring it"; - return(undef()); - } - - ## Check 1, should find addresses like: "Brandon Zehm " - elsif ($input =~ /^\s*(\S(.*\S)?)\s*<(\S+\@\S+)>/o) { - ($name, $address) = ($1, $3); - } - - ## Otherwise if that failed, just get the address: - elsif ($input =~ /<(\S+\@\S+)>/o) { - $name = $address = $1; - } - - ## Or maybe it was formatted this way: caspian@dotconf.net - elsif ($input =~ /(\S+\@\S+)/o) { - $name = $address = $1; - } - - ## Something stupid happened, just return an error. - unless ($name and $address) { - printmsg("ERROR => Couldn't parse the address: $input", 0); - printmsg("HINT => If you think this should work, consider reporting this as a bug to $conf{'authorEmail'}", 1); - return(undef()); - } - - ## Make sure there aren't invalid characters in the address, and return it. - my $ctrl = '\000-\037'; - my $nonASCII = '\x80-\xff'; - if ($address =~ /[<> ,;:"'\[\]\\$ctrl$nonASCII]/) { - printmsg("WARNING => The address [$address] seems to contain invalid characters: continuing anyway", 0); - } - return($name, $address); -} - - - - - - - - - - - - - - - - -############################################################################################### -## Function: base64_encode(string $data, bool $chunk) -## -## Description: Returns $data as a base64 encoded string. -## If $chunk is true, the encoded data is returned in 76 character long lines -## with the final \CR\LF removed. -## -## Note: This is only used from the smtp auth section of code. -## At some point it would be nice to merge the code that encodes attachments and this. -############################################################################################### -sub base64_encode { - my $data = $_[0]; - my $chunk = $_[1]; - my $tmp = ''; - my $base64 = ''; - my $CRLF = "\r\n"; - - ################################### - ## Convert binary data to base64 ## - ################################### - while ($data =~ s/(.{45})//s) { ## Get 45 bytes from the binary string - $tmp = substr(pack('u', $&), 1); ## Convert the binary to uuencoded text - chop($tmp); - $tmp =~ tr|` -_|AA-Za-z0-9+/|; ## Translate from uuencode to base64 - $base64 .= $tmp; - } - - ########################## - ## Encode the leftovers ## - ########################## - my $padding = ""; - if ( ($data) and (length($data) > 0) ) { - $padding = (3 - length($data) % 3) % 3; ## Set flag if binary data isn't divisible by 3 - $tmp = substr(pack('u', $data), 1); ## Convert the binary to uuencoded text - chop($tmp); - $tmp =~ tr|` -_|AA-Za-z0-9+/|; ## Translate from uuencode to base64 - $base64 .= $tmp; - } - - ############################ - ## Fix padding at the end ## - ############################ - $data = ''; - $base64 =~ s/.{$padding}$/'=' x $padding/e if $padding; ## Fix the end padding if flag (from above) is set - if ($chunk) { - while ($base64 =~ s/(.{1,76})//s) { ## Put $CRLF after each 76 characters - $data .= "$1$CRLF"; - } - } - else { - $data = $base64; - } - - ## Remove any trailing CRLF's - $data =~ s/(\r|\n)*$//s; - return($data); -} - - - - - - - - - -######################################################### -# SUB: send_attachment("/path/filename") -# Sends the mime headers and base64 encoded file -# to the email server. -######################################################### -sub send_attachment { - my ($filename) = @_; ## Get filename passed - my (@fields, $y, $filename_name, $encoding, ## Local variables - @attachlines, $content_type); - my $bin = 1; - - @fields = split(/\/|\\/, $filename); ## Get the actual filename without the path - $filename_name = pop(@fields); - push @attachments_names, $filename_name; ## FIXME: This is only used later for putting in the log file - - ########################## - ## Autodetect Mime Type ## - ########################## - - @fields = split(/\./, $filename_name); - $encoding = $fields[$#fields]; - - if ($encoding =~ /txt|text|log|conf|^c$|cpp|^h$|inc|m3u/i) { $content_type = 'text/plain'; } - elsif ($encoding =~ /html|htm|shtml|shtm|asp|php|cfm/i) { $content_type = 'text/html'; } - elsif ($encoding =~ /sh$/i) { $content_type = 'application/x-sh'; } - elsif ($encoding =~ /tcl/i) { $content_type = 'application/x-tcl'; } - elsif ($encoding =~ /pl$/i) { $content_type = 'application/x-perl'; } - elsif ($encoding =~ /js$/i) { $content_type = 'application/x-javascript'; } - elsif ($encoding =~ /man/i) { $content_type = 'application/x-troff-man'; } - elsif ($encoding =~ /gif/i) { $content_type = 'image/gif'; } - elsif ($encoding =~ /jpg|jpeg|jpe|jfif|pjpeg|pjp/i) { $content_type = 'image/jpeg'; } - elsif ($encoding =~ /tif|tiff/i) { $content_type = 'image/tiff'; } - elsif ($encoding =~ /xpm/i) { $content_type = 'image/x-xpixmap'; } - elsif ($encoding =~ /bmp/i) { $content_type = 'image/x-MS-bmp'; } - elsif ($encoding =~ /pcd/i) { $content_type = 'image/x-photo-cd'; } - elsif ($encoding =~ /png/i) { $content_type = 'image/png'; } - elsif ($encoding =~ /aif|aiff/i) { $content_type = 'audio/x-aiff'; } - elsif ($encoding =~ /wav/i) { $content_type = 'audio/x-wav'; } - elsif ($encoding =~ /mp2|mp3|mpa/i) { $content_type = 'audio/x-mpeg'; } - elsif ($encoding =~ /ra$|ram/i) { $content_type = 'audio/x-pn-realaudio'; } - elsif ($encoding =~ /mpeg|mpg/i) { $content_type = 'video/mpeg'; } - elsif ($encoding =~ /mov|qt$/i) { $content_type = 'video/quicktime'; } - elsif ($encoding =~ /avi/i) { $content_type = 'video/x-msvideo'; } - elsif ($encoding =~ /zip/i) { $content_type = 'application/x-zip-compressed'; } - elsif ($encoding =~ /tar/i) { $content_type = 'application/x-tar'; } - elsif ($encoding =~ /jar/i) { $content_type = 'application/java-archive'; } - elsif ($encoding =~ /exe|bin/i) { $content_type = 'application/octet-stream'; } - elsif ($encoding =~ /ppt|pot|ppa|pps|pwz/i) { $content_type = 'application/vnd.ms-powerpoint'; } - elsif ($encoding =~ /mdb|mda|mde/i) { $content_type = 'application/vnd.ms-access'; } - elsif ($encoding =~ /xls|xlt|xlm|xld|xla|xlc|xlw|xll/i) { $content_type = 'application/vnd.ms-excel'; } - elsif ($encoding =~ /doc|dot/i) { $content_type = 'application/msword'; } - elsif ($encoding =~ /rtf/i) { $content_type = 'application/rtf'; } - elsif ($encoding =~ /pdf/i) { $content_type = 'application/pdf'; } - elsif ($encoding =~ /tex/i) { $content_type = 'application/x-tex'; } - elsif ($encoding =~ /latex/i) { $content_type = 'application/x-latex'; } - elsif ($encoding =~ /vcf/i) { $content_type = 'application/x-vcard'; } - else { $content_type = 'application/octet-stream'; } - - - ############################ - ## Process the attachment ## - ############################ - - ##################################### - ## Generate and print MIME headers ## - ##################################### - - $y = "$CRLF--$conf{'delimiter'}$CRLF"; - $y .= "Content-Type: $content_type;$CRLF"; - $y .= " name=\"$filename_name\"$CRLF"; - $y .= "Content-Transfer-Encoding: base64$CRLF"; - $y .= "Content-Disposition: attachment; filename=\"$filename_name\"$CRLF"; - $y .= "$CRLF"; - print $SERVER $y; - - - ########################################################### - ## Convert the file to base64 and print it to the server ## - ########################################################### - - open (FILETOATTACH, $filename) || do { - printmsg("ERROR => Opening the file [$filename] for attachment failed with the error: $!", 0); - return(1); - }; - binmode(FILETOATTACH); ## Hack to make Win32 work - - my $res = ""; - my $tmp = ""; - my $base64 = ""; - while () { ## Read a line from the (binary) file - $res .= $_; - - ################################### - ## Convert binary data to base64 ## - ################################### - while ($res =~ s/(.{45})//s) { ## Get 45 bytes from the binary string - $tmp = substr(pack('u', $&), 1); ## Convert the binary to uuencoded text - chop($tmp); - $tmp =~ tr|` -_|AA-Za-z0-9+/|; ## Translate from uuencode to base64 - $base64 .= $tmp; - } - - ################################ - ## Print chunks to the server ## - ################################ - while ($base64 =~ s/(.{76})//s) { - print $SERVER "$1$CRLF"; - } - - } - - ################################### - ## Encode and send the leftovers ## - ################################### - my $padding = ""; - if ( ($res) and (length($res) >= 1) ) { - $padding = (3 - length($res) % 3) % 3; ## Set flag if binary data isn't divisible by 3 - $res = substr(pack('u', $res), 1); ## Convert the binary to uuencoded text - chop($res); - $res =~ tr|` -_|AA-Za-z0-9+/|; ## Translate from uuencode to base64 - } - - ############################ - ## Fix padding at the end ## - ############################ - $res = $base64 . $res; ## Get left overs from above - $res =~ s/.{$padding}$/'=' x $padding/e if $padding; ## Fix the end padding if flag (from above) is set - if ($res) { - while ($res =~ s/(.{1,76})//s) { ## Send it to the email server. - print $SERVER "$1$CRLF"; - } - } - - close (FILETOATTACH) || do { - printmsg("ERROR - Closing the filehandle for file [$filename] failed with the error: $!", 0); - return(2); - }; - - ## Return 0 errors - return(0); - -} - - - - - - - - - -############################################################################################### -## Function: $string = get_hostname (boot $fqdn) -## -## Description: Tries really hard to returns the short (or FQDN) hostname of the current -## system. Uses techniques and code from the Sys-Hostname module. -## -## Input: $fqdn A true value (1) will cause this function to return a FQDN hostname -## rather than a short hostname. -## -## Output: Returns a string -############################################################################################### -sub get_hostname { - ## Assign incoming parameters to variables - my ( $fqdn ) = @_; - my $hostname = ""; - - ## STEP 1: Get short hostname - - ## Load Sys::Hostname if it's available - eval { require Sys::Hostname; }; - unless ($@) { - $hostname = Sys::Hostname::hostname(); - } - - ## If that didn't get us a hostname, try a few other things - else { - ## Windows systems - if ($^O !~ /win/i) { - if ($ENV{'COMPUTERNAME'}) { $hostname = $ENV{'COMPUTERNAME'}; } - if (!$hostname) { $hostname = gethostbyname('localhost'); } - if (!$hostname) { chomp($hostname = `hostname 2> NUL`) }; - } - - ## Unix systems - else { - local $ENV{PATH} = '/usr/bin:/bin:/usr/sbin:/sbin'; ## Paranoia - - ## Try the environment first (Help! What other variables could/should I be checking here?) - if ($ENV{'HOSTNAME'}) { $hostname = $ENV{'HOSTNAME'}; } - - ## Try the hostname command - eval { local $SIG{__DIE__}; local $SIG{CHLD}; $hostname = `hostname 2>/dev/null`; chomp($hostname); } || - - ## Try POSIX::uname(), which strictly can't be expected to be correct - eval { local $SIG{__DIE__}; require POSIX; $hostname = (POSIX::uname())[1]; } || - - ## Try the uname command - eval { local $SIG{__DIE__}; $hostname = `uname -n 2>/dev/null`; chomp($hostname); }; - - } - - ## If we can't find anything else, return "" - if (!$hostname) { - print "WARNING => No hostname could be determined, please specify one with -o fqdn=FQDN option!\n"; - return("unknown"); - } - } - - ## Return the short hostname - unless ($fqdn) { - $hostname =~ s/\..*//; - return(lc($hostname)); - } - - ## STEP 2: Determine the FQDN - - ## First, if we already have one return it. - if ($hostname =~ /\w\.\w/) { return(lc($hostname)); } - - ## Next try using - eval { $fqdn = (gethostbyname($hostname))[0]; }; - if ($fqdn) { return(lc($fqdn)); } - return(lc($hostname)); -} - - - - - - - - -############################################################################################### -## Function: printmsg (string $message, int $level) -## -## Description: Handles all messages - printing them to the screen only if the messages -## $level is >= the global debug level. If $conf{'logFile'} is defined it -## will also log the message to that file. -## -## Input: $message A message to be printed, logged, etc. -## $level The debug level of the message. If -## not defined 0 will be assumed. 0 is -## considered a normal message, 1 and -## higher is considered a debug message. -## -## Output: Prints to STDOUT -## -## Assumptions: $conf{'hostname'} should be the name of the computer we're running on. -## $conf{'stdout'} should be set to 1 if you want to print to stdout -## $conf{'logFile'} should be a full path to a log file if you want that -## $conf{'debug'} should be an integer between 0 and 10. -## -## Example: printmsg("WARNING: We believe in generic error messages... NOT!", 0); -############################################################################################### -sub printmsg { - ## Assign incoming parameters to variables - my ( $message, $level ) = @_; - - ## Make sure input is sane - $level = 0 if (!defined($level)); - $message =~ s/\s+$//sgo; - $message =~ s/\r?\n/, /sgo; - - ## Continue only if the debug level of the program is >= message debug level. - if ($conf{'debug'} >= $level) { - - ## Get the date in the format: Dec 3 11:14:04 - my ($sec, $min, $hour, $mday, $mon) = localtime(); - $mon = ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec')[$mon]; - my $date = sprintf("%s %02d %02d:%02d:%02d", $mon, $mday, $hour, $min, $sec); - - ## Print to STDOUT always if debugging is enabled, or if conf{stdout} is true. - if ( ($conf{'debug'} >= 1) or ($conf{'stdout'} == 1) ) { - print "$date $conf{'hostname'} $conf{'programName'}\[$$\]: $message\n"; - } - - ## Print to the log file if $conf{'logging'} is true - if ($conf{'logFile'}) { - if (openLogFile($conf{'logFile'})) { $conf{'logFile'} = ""; printmsg("ERROR => Opening the file [$conf{'logFile'}] for appending returned the error: $!", 1); } - print LOGFILE "$date $conf{'hostname'} $conf{'programName'}\[$$\]: $message\n"; - } - - } - - ## Return 0 errors - return(0); -} - - - - - - - - - - - - -############################################################################################### -## FUNCTION: -## openLogFile ( $filename ) -## -## -## DESCRIPTION: -## Opens the file $filename and attaches it to the filehandle "LOGFILE". Returns 0 on success -## and non-zero on failure. Error codes are listed below, and the error message gets set in -## global variable $!. -## -## -## Example: -## openFile ("/var/log/sendEmail.log"); -## -############################################################################################### -sub openLogFile { - ## Get the incoming filename - my $filename = $_[0]; - - ## Make sure our file exists, and if the file doesn't exist then create it - if ( ! -f $filename ) { - print STDERR "NOTICE: The log file [$filename] does not exist. Creating it now with mode [0600].\n" if ($conf{'stdout'}); - open (LOGFILE, ">>$filename"); - close LOGFILE; - chmod (0600, $filename); - } - - ## Now open the file and attach it to a filehandle - open (LOGFILE,">>$filename") or return (1); - - ## Put the file into non-buffering mode - select LOGFILE; - $| = 1; - select STDOUT; - - ## Return success - return(0); -} - - - - - - - - -############################################################################################### -## Function: read_file (string $filename) -## -## Description: Reads the contents of a file and returns a two part array: -## ($status, $file-contents) -## $status is 0 on success, non-zero on error. -## -## Example: ($status, $file) = read_file("/etc/passwd"); -############################################################################################### -sub read_file { - my ( $filename ) = @_; - - ## If the value specified is a file, load the file's contents - if ( (-e $filename and -r $filename) ) { - my $FILE; - if(!open($FILE, ' ' . $filename)) { - return((1, "")); - } - my $file = ''; - while (<$FILE>) { - $file .= $_; - } - ## Strip an ending \r\n - $file =~ s/\r?\n$//os; - } - return((1, "")); -} - - - - - - - - - -############################################################################################### -## Function: quit (string $message, int $errorLevel) -## -## Description: Exits the program, optionally printing $message. It -## returns an exit error level of $errorLevel to the -## system (0 means no errors, and is assumed if empty.) -## -## Example: quit("Exiting program normally", 0); -############################################################################################### -sub quit { - my ( $message, $errorLevel ) = @_; - $errorLevel = 0 if (!defined($errorLevel)); - - ## Print exit message - if ($message) { - printmsg($message, 0); - } - - ## Exit - exit($errorLevel); -} - - - - - - - - - - - - -############################################################################################### -## Function: help () -## -## Description: For all those newbies ;) -## Prints a help message and exits the program. -## -############################################################################################### -sub help { -exit(1) if (!$conf{'stdout'}); -print <${colorNoBold} - -Synopsis: $conf{'programName'} -f ADDRESS [options] - - ${colorRed}Required:${colorNormal} - -f ADDRESS from (sender) email address - * At least one recipient required via -t, -cc, or -bcc - * Message body required via -m, STDIN, or -o message-file=FILE - - ${colorGreen}Common:${colorNormal} - -t ADDRESS [ADDR ...] to email address(es) - -u SUBJECT message subject - -m MESSAGE message body - -s SERVER[:PORT] smtp mail relay, default is $conf{'server'}:$conf{'port'} - - ${colorGreen}Optional:${colorNormal} - -a FILE [FILE ...] file attachment(s) - -cc ADDRESS [ADDR ...] cc email address(es) - -bcc ADDRESS [ADDR ...] bcc email address(es) - -xu USERNAME username for SMTP authentication - -xp PASSWORD password for SMTP authentication - - ${colorGreen}Paranormal:${colorNormal} - -b BINDADDR[:PORT] local host bind address - -l LOGFILE log to the specified file - -v verbosity, use multiple times for greater effect - -q be quiet (i.e. no STDOUT output) - -o NAME=VALUE advanced options, for details try: --help misc - -o message-content-type= - -o message-file=FILE -o message-format=raw - -o message-header=HEADER -o message-charset=CHARSET - -o reply-to=ADDRESS -o timeout=SECONDS - -o username=USERNAME -o password=PASSWORD - -o tls= -o fqdn=FQDN - - - ${colorGreen}Help:${colorNormal} - --help the helpful overview you're reading now - --help addressing explain addressing and related options - --help message explain message body input and related options - --help networking explain -s, -b, etc - --help output explain logging and other output options - --help misc explain -o options, TLS, SMTP auth, and more - -EOM -exit(1); -} - - - - - - - - - -############################################################################################### -## Function: helpTopic ($topic) -## -## Description: For all those newbies ;) -## Prints a help message and exits the program. -## -############################################################################################### -sub helpTopic { - exit(1) if (!$conf{'stdout'}); - my ($topic) = @_; - - CASE: { - - - - -## ADDRESSING - ($topic eq 'addressing') && do { - print <" - Just Address: "john.doe\@gmail.com" - -The "Full Name" method is useful if you want a name, rather than a plain -email address, to be displayed in the recipient's From, To, or Cc fields -when they view the message. - - -${colorGreen}Multiple Recipients${colorNormal} -The -t, -cc, and -bcc options each accept multiple addresses. They may be -specified by separating them by either a white space, comma, or semi-colon -separated list. You may also specify the -t, -cc, and -bcc options multiple -times, each occurance will append the new recipients to the respective list. - -Examples: -(I used "-t" in these examples, but it can be "-cc" or "-bcc" as well) - - * Space separated list: - -t jane.doe\@yahoo.com "John Doe " - - * Semi-colon separated list: - -t "jane.doe\@yahoo.com; John Doe " - - * Comma separated list: - -t "jane.doe\@yahoo.com, John Doe " - - * Multiple -t, -cc, or -bcc options: - -t "jane.doe\@yahoo.com" -t "John Doe " - - -EOM - last CASE; - }; - - - - - - -## MESSAGE - ($topic eq 'message') && do { - print < - -o message-header=EMAIL HEADER - -o message-charset=CHARSET - -o message-format=raw - --u SUBJECT - This option allows you to specify the subject for your email message. - It is not required (anymore) that the subject be quoted, although it - is recommended. The subject will be read until an argument starting - with a hyphen (-) is found. - Examples: - -u "Contact information while on vacation" - -u New Microsoft vulnerability discovered - --m MESSAGE - This option is one of three methods that allow you to specify the message - body for your email. The message may be specified on the command line - with this -m option, read from a file with the -o message-file=FILE - option, or read from STDIN if neither of these options are present. - - It is not required (anymore) that the message be quoted, although it is - recommended. The message will be read until an argument starting with a - hyphen (-) is found. - Examples: - -m "See you in South Beach, Hawaii. -Todd" - -m Please ensure that you upgrade your systems right away - - Multi-line message bodies may be specified with the -m option by putting - a "\\n" into the message. Example: - -m "This is line 1.\\nAnd this is line 2." - - HTML messages are supported, simply begin your message with "" and - sendEmail will properly label the mime header so MUAs properly render - the message. It is currently not possible without "-o message-format=raw" - to send a message with both text and html parts with sendEmail. - --o message-file=FILE - This option is one of three methods that allow you to specify the message - body for your email. To use this option simply specify a text file - containing the body of your email message. Examples: - -o message-file=/root/message.txt - -o message-file="C:\\Program Files\\output.txt" - --o message-content-type= - This option allows you to specify the content-type of the email. If your - email message is an html message but is being displayed as a text message - just add "-o message-content-type=html" to the command line to force it - to display as an html message. This actually just changes the Content-Type: - header. Advanced users will be happy to know that if you specify anything - other than the three options listed above it will use that as the vaule - for the Content-Type header. - --o message-header=EMAIL HEADER - This option allows you to specify additional email headers to be included. - To add more than one message header simply use this option on the command - line more than once. If you specify a message header that sendEmail would - normally generate the one you specified will be used in it's place. - Do not use this unless you know what you are doing! - Example: - To scare a Microsoft Outlook user you may want to try this: - -o message-header="X-Message-Flag: Message contains illegal content" - Example: - To request a read-receipt try this: - -o message-header="Disposition-Notification-To: " - Example: - To set the message priority try this: - -o message-header="X-Priority: 1" - Priority reference: 1=highest, 2=high, 3=normal, 4=low, 5=lowest - --o message-charset=CHARSET - This option allows you to specify the character-set for the message body. - The default is iso-8859-1. - --o message-format=raw - This option instructs sendEmail to assume the message (specified with -m, - read from STDIN, or read from the file specified in -o message-file=FILE) - is already a *complete* email message. SendEmail will not generate any - headers and will transmit the message as-is to the remote SMTP server. - Due to the nature of this option the following command line options will - be ignored when this one is used: - -u SUBJECT - -o message-header=EMAIL HEADER - -o message-charset=CHARSET - -a ATTACHMENT - - -${colorGreen}The Message Body${colorNormal} -The email message body may be specified in one of three ways: - 1) Via the -m MESSAGE command line option. - Example: - -m "This is the message body" - - 2) By putting the message body in a file and using the -o message-file=FILE - command line option. - Example: - -o message-file=/root/message.txt - - 3) By piping the message body to sendEmail when nither of the above command - line options were specified. - Example: - grep "ERROR" /var/log/messages | sendEmail -t you\@domain.com ... - -If the message body begins with "" then the message will be treated as -an HTML message and the MIME headers will be written so that a HTML capable -email client will display the message in it's HTML form. -Any of the above methods may be used with the -o message-format=raw option -to deliver an already complete email message. - - -EOM - last CASE; - }; - - - - - - -## MISC - ($topic eq 'misc') && do { - print < - -o timeout=SECONDS - -o fqdn=FQDN - --a ATTACHMENT [ATTACHMENT ...] - This option allows you to attach any number of files to your email message. - To specify more than one attachment, simply separate each filename with a - space. Example: -a file1.txt file2.txt file3.txt - --xu USERNAME - Alias for -o username=USERNAME - --xp PASSWORD - Alias for -o password=PASSWORD - --o username=USERNAME (synonym for -xu) - These options allow specification of a username to be used with SMTP - servers that require authentication. If a username is specified but a - password is not, you will be prompted to enter one at runtime. - --o password=PASSWORD (synonym for -xp) - These options allow specification of a password to be used with SMTP - servers that require authentication. If a username is specified but a - password is not, you will be prompted to enter one at runtime. - --o tls= - This option allows you to specify if TLS (SSL for SMTP) should be enabled - or disabled. The default, auto, will use TLS automatically if your perl - installation has the IO::Socket::SSL and Net::SSLeay modules available, - and if the remote SMTP server supports TLS. To require TLS for message - delivery set this to yes. To disable TLS support set this to no. A debug - level of one or higher will reveal details about the status of TLS. - --o timeout=SECONDS - This option sets the timeout value in seconds used for all network reads, - writes, and a few other things. - --o fqdn=FQDN - This option sets the Fully Qualified Domain Name used during the initial - SMTP greeting. Normally this is automatically detected, but in case you - need to manually set it for some reason or get a warning about detection - failing, you can use this to override the default. - - -EOM - last CASE; - }; - - - - - - -## NETWORKING - ($topic eq 'networking') && do { - print < - -o timeout=SECONDS - --s SERVER[:PORT] - This option allows you to specify the SMTP server sendEmail should - connect to to deliver your email message to. If this option is not - specified sendEmail will try to connect to localhost:25 to deliver - the message. THIS IS MOST LIKELY NOT WHAT YOU WANT, AND WILL LIKELY - FAIL unless you have a email server (commonly known as an MTA) running - on your computer! - Typically you will need to specify your company or ISP's email server. - For example, if you use CableOne you will need to specify: - -s mail.cableone.net - If you have your own email server running on port 300 you would - probably use an option like this: - -s myserver.mydomain.com:300 - If you're a GMail user try: - -s smtp.gmail.com:587 -xu me\@gmail.com -xp PASSWD - --b BINDADDR[:PORT] - This option allows you to specify the local IP address (and optional - tcp port number) for sendEmail to bind to when connecting to the remote - SMTP server. This useful for people who need to send an email from a - specific network interface or source address and are running sendEmail on - a firewall or other host with several network interfaces. - --o tls= - This option allows you to specify if TLS (SSL for SMTP) should be enabled - or disabled. The default, auto, will use TLS automatically if your perl - installation has the IO::Socket::SSL and Net::SSLeay modules available, - and if the remote SMTP server supports TLS. To require TLS for message - delivery set this to yes. To disable TLS support set this to no. A debug - level of one or higher will reveal details about the status of TLS. - --o timeout=SECONDS - This option sets the timeout value in seconds used for all network reads, - writes, and a few other things. - - -EOM - last CASE; - }; - - - - - - -## OUTPUT - ($topic eq 'output') && do { - print < The help topic specified is not valid!", 1); - }; - -exit(1); -} - - - - - - - - - - - - - - - - - - - - - - -############################# -## ## -## MAIN PROGRAM ## -## ## -############################# - - -## Initialize -initialize(); - -## Process Command Line -processCommandLine(); -$conf{'alarm'} = $opt{'timeout'}; - -## Abort program after $conf{'alarm'} seconds to avoid infinite hangs -alarm($conf{'alarm'}) if ($^O !~ /win/i); ## alarm() doesn't work in win32 - - - - -################################################### -## Read $message from STDIN if -m was not used ## -################################################### - -if (!($message)) { - ## Read message body from a file specified with -o message-file= - if ($opt{'message-file'}) { - if (! -e $opt{'message-file'}) { - printmsg("ERROR => Message body file specified [$opt{'message-file'}] does not exist!", 0); - printmsg("HINT => 1) check spelling of your file; 2) fully qualify the path; 3) doubble quote it", 1); - quit("", 1); - } - if (! -r $opt{'message-file'}) { - printmsg("ERROR => Message body file specified can not be read due to restricted permissions!", 0); - printmsg("HINT => Check permissions on file specified to ensure it can be read", 1); - quit("", 1); - } - if (!open(MFILE, "< " . $opt{'message-file'})) { - printmsg("ERROR => Error opening message body file [$opt{'message-file'}]: $!", 0); - quit("", 1); - } - while () { - $message .= $_; - } - close(MFILE); - } - - ## Read message body from STDIN - else { - alarm($conf{'alarm'}) if ($^O !~ /win/i); ## alarm() doesn't work in win32 - if ($conf{'stdout'}) { - print "Reading message body from STDIN because the '-m' option was not used.\n"; - print "If you are manually typing in a message:\n"; - print " - First line must be received within $conf{'alarm'} seconds.\n" if ($^O !~ /win/i); - print " - End manual input with a CTRL-D on its own line.\n\n" if ($^O !~ /win/i); - print " - End manual input with a CTRL-Z on its own line.\n\n" if ($^O =~ /win/i); - } - while () { ## Read STDIN into $message - $message .= $_; - alarm(0) if ($^O !~ /win/i); ## Disable the alarm since at least one line was received - } - printmsg("Message input complete.", 0); - } -} - -## Replace bare LF's with CRLF's (\012 should always have \015 with it) -$message =~ s/(\015)?(\012|$)/\015\012/g; - -## Replace bare CR's with CRLF's (\015 should always have \012 with it) -$message =~ s/(\015)(\012|$)?/\015\012/g; - -## Check message for bare periods and encode them -$message =~ s/(^|$CRLF)(\.{1})($CRLF|$)/$1.$2$3/g; - -## Get the current date for the email header -my ($sec,$min,$hour,$mday,$mon,$year,$day) = gmtime(); -$year += 1900; $mon = return_month($mon); $day = return_day($day); -my $date = sprintf("%s, %s %s %d %.2d:%.2d:%.2d %s",$day, $mday, $mon, $year, $hour, $min, $sec, $conf{'timezone'}); - - - - -################################## -## Connect to the SMTP server ## -################################## -printmsg("DEBUG => Connecting to $conf{'server'}:$conf{'port'}", 1); -$SIG{'ALRM'} = sub { - printmsg("ERROR => Timeout while connecting to $conf{'server'}:$conf{'port'} There was no response after $conf{'alarm'} seconds.", 0); - printmsg("HINT => Try specifying a different mail relay with the -s option.", 1); - quit("", 1); -}; -alarm($conf{'alarm'}) if ($^O !~ /win/i); ## alarm() doesn't work in win32; -$SERVER = IO::Socket::INET->new( PeerAddr => $conf{'server'}, - PeerPort => $conf{'port'}, - LocalAddr => $conf{'bindaddr'}, - Proto => 'tcp', - Autoflush => 1, - timeout => $conf{'alarm'}, -); -alarm(0) if ($^O !~ /win/i); ## alarm() doesn't work in win32; - -## Make sure we got connected -if ( (!$SERVER) or (!$SERVER->opened()) ) { - printmsg("ERROR => Connection attempt to $conf{'server'}:$conf{'port'} failed: $@", 0); - printmsg("HINT => Try specifying a different mail relay with the -s option.", 1); - quit("", 1); -} - -## Save our IP address for later -$conf{'ip'} = $SERVER->sockhost(); -printmsg("DEBUG => My IP address is: $conf{'ip'}", 1); - - - - - - - -######################### -## Do the SMTP Dance ## -######################### - -## Read initial greeting to make sure we're talking to a live SMTP server -if (SMTPchat()) { quit($conf{'error'}, 1); } - -## We're about to use $opt{'fqdn'}, make sure it isn't empty -if (!$opt{'fqdn'}) { - ## Ok, that means we couldn't get a hostname, how about using the IP address for the HELO instead - $opt{'fqdn'} = "[" . $conf{'ip'} . "]"; -} - -## EHLO -if (SMTPchat('EHLO ' . $opt{'fqdn'})) { - printmsg($conf{'error'}, 0); - printmsg("NOTICE => EHLO command failed, attempting HELO instead"); - if (SMTPchat('HELO ' . $opt{'fqdn'})) { quit($conf{'error'}, 1); } - if ( $opt{'username'} and $opt{'password'} ) { - printmsg("WARNING => The mail server does not support SMTP authentication!", 0); - } -} -else { - - ## Determin if the server supports TLS - if ($conf{'SMTPchat_response'} =~ /STARTTLS/) { - $conf{'tls_server'} = 1; - printmsg("DEBUG => The remote SMTP server supports TLS :)", 2); - } - else { - $conf{'tls_server'} = 0; - printmsg("DEBUG => The remote SMTP server does NOT support TLS :(", 2); - } - - ## Start TLS if possible - if ($conf{'tls_server'} == 1 and $conf{'tls_client'} == 1 and $opt{'tls'} =~ /^(yes|auto)$/) { - printmsg("DEBUG => Starting TLS", 2); - if (SMTPchat('STARTTLS')) { quit($conf{'error'}, 1); } - if (! IO::Socket::SSL->start_SSL($SERVER, SSL_version => 'SSLv3 TLSv1')) { - quit("ERROR => TLS setup failed: " . IO::Socket::SSL::errstr(), 1); - } - printmsg("DEBUG => TLS: Using cipher: ". $SERVER->get_cipher(), 3); - printmsg("DEBUG => TLS session initialized :)", 1); - - ## Restart our SMTP session - if (SMTPchat('EHLO ' . $opt{'fqdn'})) { quit($conf{'error'}, 1); } - } - elsif ($opt{'tls'} eq 'yes' and $conf{'tls_server'} == 0) { - quit("ERROR => TLS not possible! Remote SMTP server, $conf{'server'}, does not support it.", 1); - } - - - ## Do SMTP Auth if required - if ( $opt{'username'} and $opt{'password'} ) { - if ($conf{'SMTPchat_response'} !~ /AUTH\s/) { - printmsg("NOTICE => Authentication not supported by the remote SMTP server!", 0); - } - else { - my $auth_succeeded = 0; - my $mutual_method = 0; - - # ## SASL CRAM-MD5 authentication method - # if ($conf{'SMTPchat_response'} =~ /\bCRAM-MD5\b/i) { - # printmsg("DEBUG => SMTP-AUTH: Using CRAM-MD5 authentication method", 1); - # if (SMTPchat('AUTH CRAM-MD5')) { quit($conf{'error'}, 1); } - # - # ## FIXME!! - # - # printmsg("DEBUG => User authentication was successful", 1); - # } - - ## SASL LOGIN authentication method - if ($auth_succeeded == 0 and $conf{'SMTPchat_response'} =~ /\bLOGIN\b/i) { - $mutual_method = 1; - printmsg("DEBUG => SMTP-AUTH: Using LOGIN authentication method", 1); - if (!SMTPchat('AUTH LOGIN')) { - if (!SMTPchat(base64_encode($opt{'username'}))) { - if (!SMTPchat(base64_encode($opt{'password'}))) { - $auth_succeeded = 1; - printmsg("DEBUG => User authentication was successful (Method: LOGIN)", 1); - } - } - } - if ($auth_succeeded == 0) { - printmsg("DEBUG => SMTP-AUTH: LOGIN authenticaion failed.", 1); - } - } - - ## SASL PLAIN authentication method - if ($auth_succeeded == 0 and $conf{'SMTPchat_response'} =~ /\bPLAIN\b/i) { - $mutual_method = 1; - printmsg("DEBUG => SMTP-AUTH: Using PLAIN authentication method", 1); - if (SMTPchat('AUTH PLAIN ' . base64_encode("$opt{'username'}\0$opt{'username'}\0$opt{'password'}"))) { - printmsg("DEBUG => SMTP-AUTH: PLAIN authenticaion failed.", 1); - } - else { - $auth_succeeded = 1; - printmsg("DEBUG => User authentication was successful (Method: PLAIN)", 1); - } - } - - ## If none of the authentication methods supported by sendEmail were supported by the server, let the user know - if ($mutual_method == 0) { - printmsg("WARNING => SMTP-AUTH: No mutually supported authentication methods available", 0); - } - - ## If we didn't get authenticated, log an error message and exit - if ($auth_succeeded == 0) { - quit("ERROR => ERROR => SMTP-AUTH: Authentication to $conf{'server'}:$conf{'port'} failed.", 1); - } - } - } -} - -## MAIL FROM -if (SMTPchat('MAIL FROM:<' .(returnAddressParts($from))[1]. '>')) { quit($conf{'error'}, 1); } - -## RCPT TO -my $oneRcptAccepted = 0; -foreach my $rcpt (@to, @cc, @bcc) { - my ($name, $address) = returnAddressParts($rcpt); - if (SMTPchat('RCPT TO:<' . $address . '>')) { - printmsg("WARNING => The recipient <$address> was rejected by the mail server, error follows:", 0); - $conf{'error'} =~ s/^ERROR/WARNING/o; - printmsg($conf{'error'}, 0); - } - elsif ($oneRcptAccepted == 0) { - $oneRcptAccepted = 1; - } -} -## If no recipients were accepted we need to exit with an error. -if ($oneRcptAccepted == 0) { - quit("ERROR => Exiting. No recipients were accepted for delivery by the mail server.", 1); -} - -## DATA -if (SMTPchat('DATA')) { quit($conf{'error'}, 1); } - - -############################### -## Build and send the body ## -############################### -printmsg("INFO => Sending message body",1); - -## If the message-format is raw just send the message as-is. -if ($opt{'message-format'} =~ /^raw$/i) { - print $SERVER $message; -} - -## If the message-format isn't raw, then build and send the message, -else { - - ## Message-ID: - if ($opt{'message-header'} !~ /^Message-ID:/iom) { - $header .= 'Message-ID: <' . $conf{'Message-ID'} . '@' . $conf{'hostname'} . '>' . $CRLF; - } - - ## From: "Name" (the pointless test below is just to keep scoping correct) - if ($from and $opt{'message-header'} !~ /^From:/iom) { - my ($name, $address) = returnAddressParts($from); - $header .= 'From: "' . $name . '" <' . $address . '>' . $CRLF; - } - - ## Reply-To: - if ($opt{'reply-to'} and $opt{'message-header'} !~ /^Reply-To:/iom) { - my ($name, $address) = returnAddressParts($opt{'reply-to'}); - $header .= 'Reply-To: "' . $name . '" <' . $address . '>' . $CRLF; - } - - ## To: "Name" - if ($opt{'message-header'} =~ /^To:/iom) { - ## The user put the To: header in via -o message-header - dont do anything - } - elsif (scalar(@to) > 0) { - $header .= "To:"; - for (my $a = 0; $a < scalar(@to); $a++) { - my $msg = ""; - - my ($name, $address) = returnAddressParts($to[$a]); - $msg = " \"$name\" <$address>"; - - ## If we're not on the last address add a comma to the end of the line. - if (($a + 1) != scalar(@to)) { - $msg .= ","; - } - - $header .= $msg . $CRLF; - } - } - ## We always want a To: line so if the only recipients were bcc'd they don't see who it was sent to - else { - $header .= "To: \"Undisclosed Recipients\" <>$CRLF"; - } - - if (scalar(@cc) > 0 and $opt{'message-header'} !~ /^Cc:/iom) { - $header .= "Cc:"; - for (my $a = 0; $a < scalar(@cc); $a++) { - my $msg = ""; - - my ($name, $address) = returnAddressParts($cc[$a]); - $msg = " \"$name\" <$address>"; - - ## If we're not on the last address add a comma to the end of the line. - if (($a + 1) != scalar(@cc)) { - $msg .= ","; - } - - $header .= $msg . $CRLF; - } - } - - if ($opt{'message-header'} !~ /^Subject:/iom) { - $header .= 'Subject: ' . $subject . $CRLF; ## Subject - } - if ($opt{'message-header'} !~ /^Date:/iom) { - $header .= 'Date: ' . $date . $CRLF; ## Date - } - if ($opt{'message-header'} !~ /^X-Mailer:/iom) { - $header .= 'X-Mailer: sendEmail-'.$conf{'version'}.$CRLF; ## X-Mailer - } - ## I wonder if I should put this in by default? - # if ($opt{'message-header'} !~ /^X-Originating-IP:/iom) { - # $header .= 'X-Originating-IP: ['.$conf{'ip'}.']'.$CRLF; ## X-Originating-IP - # } - - ## Encode all messages with MIME. - if ($opt{'message-header'} !~ /^MIME-Version:/iom) { - $header .= "MIME-Version: 1.0$CRLF"; - } - if ($opt{'message-header'} !~ /^Content-Type:/iom) { - my $content_type = 'multipart/mixed'; - if (scalar(@attachments) == 0) { $content_type = 'multipart/related'; } - $header .= "Content-Type: $content_type; boundary=\"$conf{'delimiter'}\"$CRLF"; - } - - ## Send additional message header line(s) if specified - if ($opt{'message-header'}) { - $header .= $opt{'message-header'}; - } - - ## Send the message header to the server - print $SERVER $header . $CRLF; - - ## Start sending the message body to the server - print $SERVER "This is a multi-part message in MIME format. To properly display this message you need a MIME-Version 1.0 compliant Email program.$CRLF"; - print $SERVER "$CRLF"; - - - ## Send message body - print $SERVER "--$conf{'delimiter'}$CRLF"; - ## Send a message content-type header: - ## If the message contains HTML... - if ($opt{'message-content-type'} eq 'html' or ($opt{'message-content-type'} eq 'auto' and $message =~ /^\s*( 0) { - ## Disable the alarm so people on modems can send big attachments - alarm(0) if ($^O !~ /win/i); ## alarm() doesn't work in win32 - - ## Send the attachments - foreach my $filename (@attachments) { - ## This is check 2, we already checked this above, but just in case... - if ( ! -f $filename ) { - printmsg("ERROR => The file [$filename] doesn't exist! Email will be sent, but without that attachment.", 0); - } - elsif ( ! -r $filename ) { - printmsg("ERROR => Couldn't open the file [$filename] for reading: $! Email will be sent, but without that attachment.", 0); - } - else { - printmsg("DEBUG => Sending the attachment [$filename]", 1); - send_attachment($filename); - } - } - } - - - ## End the mime encoded message - print $SERVER "$CRLF--$conf{'delimiter'}--$CRLF"; -} - - -## Tell the server we are done sending the email -print $SERVER "$CRLF.$CRLF"; -if (SMTPchat()) { quit($conf{'error'}, 1); } - - - -#################### -# We are done!!! # -#################### - -## Disconnect from the server (don't SMTPchat(), it breaks when using TLS) -print $SERVER "QUIT$CRLF"; -close $SERVER; - - - - - - -####################################### -## Generate exit message/log entry ## -####################################### - -if ($conf{'debug'} or $conf{'logging'}) { - printmsg("Generating a detailed exit message", 3); - - ## Put the message together - my $output = "Email was sent successfully! From: <" . (returnAddressParts($from))[1] . "> "; - - if (scalar(@to) > 0) { - $output .= "To: "; - for ($a = 0; $a < scalar(@to); $a++) { - $output .= "<" . (returnAddressParts($to[$a]))[1] . "> "; - } - } - if (scalar(@cc) > 0) { - $output .= "Cc: "; - for ($a = 0; $a < scalar(@cc); $a++) { - $output .= "<" . (returnAddressParts($cc[$a]))[1] . "> "; - } - } - if (scalar(@bcc) > 0) { - $output .= "Bcc: "; - for ($a = 0; $a < scalar(@bcc); $a++) { - $output .= "<" . (returnAddressParts($bcc[$a]))[1] . "> "; - } - } - $output .= "Subject: [$subject] " if ($subject); - if (scalar(@attachments_names) > 0) { - $output .= "Attachment(s): "; - foreach(@attachments_names) { - $output .= "[$_] "; - } - } - $output .= "Server: [$conf{'server'}:$conf{'port'}]"; - - -###################### -# Exit the program # -###################### - - ## Print / Log the detailed message - quit($output, 0); -} -else { - ## Or the standard message - quit("Email was sent successfully!", 0); -} - +#!/usr/bin/perl -w +############################################################################## +## sendEmail +## Written by: Brandon Zehm +## +## License: +## sendEmail (hereafter referred to as "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 +## 2 of the License, or (at your option) any later version. +## When redistributing modified versions of this source code it is recommended +## that that this disclaimer and the above coder's names are included in the +## modified code. +## +## Disclaimer: +## This program is provided with no warranty of any kind, either expressed or +## implied. It is the responsibility of the user (you) to fully research and +## comprehend the usage of this program. As with any tool, it can be misused, +## either intentionally (you're a vandal) or unintentionally (you're a moron). +## THE AUTHOR(S) IS(ARE) NOT RESPONSIBLE FOR ANYTHING YOU DO WITH THIS PROGRAM +## or anything that happens because of your use (or misuse) of this program, +## including but not limited to anything you, your lawyers, or anyone else +## can dream up. And now, a relevant quote directly from the GPL: +## +## NO WARRANTY +## +## 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. +## +############################################################################## +use strict; +use IO::Socket; + + +######################## +## Global Variables ## +######################## + +my %conf = ( + ## General + "programName" => $0, ## The name of this program + "version" => '1.56', ## The version of this program + "authorName" => 'Brandon Zehm', ## Author's Name + "authorEmail" => 'caspian@dotconf.net', ## Author's Email Address + "timezone" => '+0000', ## We always use +0000 for the time zone + "hostname" => 'changeme', ## Used in printmsg() for all output (is updated later in the script). + "debug" => 0, ## Default debug level + "error" => '', ## Error messages will often be stored here + + ## Logging + "stdout" => 1, + "logging" => 0, ## If this is true the printmsg function prints to the log file + "logFile" => '', ## If this is specified (form the command line via -l) this file will be used for logging. + + ## Network + "server" => 'localhost', ## Default SMTP server + "port" => 25, ## Default port + "bindaddr" => '', ## Default local bind address + "alarm" => '', ## Default timeout for connects and reads, this gets set from $opt{'timeout'} + "tls_client" => 0, ## If TLS is supported by the client (us) + "tls_server" => 0, ## If TLS is supported by the remote SMTP server + + ## Email + "delimiter" => "----MIME delimiter for sendEmail-" ## MIME Delimiter + . rand(1000000), ## Add some randomness to the delimiter + "Message-ID" => rand(1000000) . "-sendEmail", ## Message-ID for email header + +); + + +## This hash stores the options passed on the command line via the -o option. +my %opt = ( + ## Addressing + "reply-to" => '', ## Reply-To field + + ## Message + "message-file" => '', ## File to read message body from + "message-header" => '', ## Additional email header line(s) + "message-format" => 'normal', ## If "raw" is specified the message is sent unmodified + "message-charset" => 'iso-8859-1', ## Message character-set + "message-content-type" => 'auto', ## auto, text, html or an actual string to put into the content-type header. + + ## Network + "timeout" => 60, ## Default timeout for connects and reads, this is copied to $conf{'alarm'} later. + "fqdn" => 'changeme', ## FQDN of this machine, used during SMTP communication (is updated later in the script). + + ## eSMTP + "username" => '', ## Username used in SMTP Auth + "password" => '', ## Password used in SMTP Auth + "tls" => 'auto', ## Enable or disable TLS support. Options: auto, yes, no + +); + +## More variables used later in the program +my $SERVER; +my $CRLF = "\015\012"; +my $subject = ''; +my $header = ''; +my $message = ''; +my $from = ''; +my @to = (); +my @cc = (); +my @bcc = (); +my @attachments = (); +my @attachments_names = (); + +## For printing colors to the console +my ${colorRed} = "\033[31;1m"; +my ${colorGreen} = "\033[32;1m"; +my ${colorCyan} = "\033[36;1m"; +my ${colorWhite} = "\033[37;1m"; +my ${colorNormal} = "\033[m"; +my ${colorBold} = "\033[1m"; +my ${colorNoBold} = "\033[0m"; + +## Don't use shell escape codes on Windows systems +if ($^O =~ /win/i) { + ${colorRed} = ${colorGreen} = ${colorCyan} = ${colorWhite} = ${colorNormal} = ${colorBold} = ${colorNoBold} = ""; +} + +## Load IO::Socket::SSL if it's available +eval { require IO::Socket::SSL; }; +if ($@) { $conf{'tls_client'} = 0; } +else { $conf{'tls_client'} = 1; } + + + + + + +############################# +## ## +## FUNCTIONS ## +## ## +############################# + + + + + +############################################################################################### +## Function: initialize () +## +## Does all the script startup jibberish. +## +############################################################################################### +sub initialize { + + ## Set STDOUT to flush immediatly after each print + $| = 1; + + ## Intercept signals + $SIG{'QUIT'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; + $SIG{'INT'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; + $SIG{'KILL'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; + $SIG{'TERM'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; + + ## ALARM and HUP signals are not supported in Win32 + unless ($^O =~ /win/i) { + $SIG{'HUP'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; + $SIG{'ALRM'} = sub { quit("EXITING: Received SIG$_[0]", 1); }; + } + + ## Fixup $conf{'programName'} + $conf{'programName'} =~ s/(.)*[\/,\\]//; + $0 = $conf{'programName'} . " " . join(" ", @ARGV); + + ## Fixup $conf{'hostname'} and $opt{'fqdn'} + if ($opt{'fqdn'} eq 'changeme') { $opt{'fqdn'} = get_hostname(1); } + if ($conf{'hostname'} eq 'changeme') { $conf{'hostname'} = $opt{'fqdn'}; $conf{'hostname'} =~ s/\..*//; } + + return(1); +} + + + + + + + + + + + + + + + +############################################################################################### +## Function: processCommandLine () +## +## Processes command line storing important data in global vars (usually %conf) +## +############################################################################################### +sub processCommandLine { + + + ############################ + ## Process command line ## + ############################ + + my @ARGS = @ARGV; ## This is so later we can re-parse the command line args later if we need to + my $numargv = @ARGS; + help() unless ($numargv); + my $counter = 0; + + for ($counter = 0; $counter < $numargv; $counter++) { + + if ($ARGS[$counter] =~ /^-h$/i) { ## Help ## + help(); + } + + elsif ($ARGS[$counter] eq "") { ## Ignore null arguments + ## Do nothing + } + + elsif ($ARGS[$counter] =~ /^--help/) { ## Topical Help ## + $counter++; + if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { + helpTopic($ARGS[$counter]); + } + else { + help(); + } + } + + elsif ($ARGS[$counter] =~ /^-o$/i) { ## Options specified with -o ## + $counter++; + ## Loop through each option passed after the -o + while ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { + + if ($ARGS[$counter] !~ /(\S+)=(\S.*)/) { + printmsg("WARNING => Name/Value pair [$ARGS[$counter]] is not properly formatted", 0); + printmsg("WARNING => Arguments proceeding -o should be in the form of \"name=value\"", 0); + } + else { + if (exists($opt{$1})) { + if ($1 eq 'message-header') { + $opt{$1} .= $2 . $CRLF; + } + else { + $opt{$1} = $2; + } + printmsg("DEBUG => Assigned \$opt{} key/value: $1 => $2", 3); + } + else { + printmsg("WARNING => Name/Value pair [$ARGS[$counter]] will be ignored: unknown key [$1]", 0); + printmsg("HINT => Try the --help option to find valid command line arguments", 1); + } + } + $counter++; + } $counter--; + } + + elsif ($ARGS[$counter] =~ /^-f$/) { ## From ## + $counter++; + if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { $from = $ARGS[$counter]; } + else { printmsg("WARNING => The argument after -f was not an email address!", 0); $counter--; } + } + + elsif ($ARGS[$counter] =~ /^-t$/) { ## To ## + $counter++; + while ($ARGS[$counter] && ($ARGS[$counter] !~ /^-/)) { + if ($ARGS[$counter] =~ /[;,]/) { + push (@to, split(/[;,]/, $ARGS[$counter])); + } + else { + push (@to,$ARGS[$counter]); + } + $counter++; + } $counter--; + } + + elsif ($ARGS[$counter] =~ /^-cc$/) { ## Cc ## + $counter++; + while ($ARGS[$counter] && ($ARGS[$counter] !~ /^-/)) { + if ($ARGS[$counter] =~ /[;,]/) { + push (@cc, split(/[;,]/, $ARGS[$counter])); + } + else { + push (@cc,$ARGS[$counter]); + } + $counter++; + } $counter--; + } + + elsif ($ARGS[$counter] =~ /^-bcc$/) { ## Bcc ## + $counter++; + while ($ARGS[$counter] && ($ARGS[$counter] !~ /^-/)) { + if ($ARGS[$counter] =~ /[;,]/) { + push (@bcc, split(/[;,]/, $ARGS[$counter])); + } + else { + push (@bcc,$ARGS[$counter]); + } + $counter++; + } $counter--; + } + + elsif ($ARGS[$counter] =~ /^-m$/) { ## Message ## + $counter++; + $message = ""; + while ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { + if ($message) { $message .= " "; } + $message .= $ARGS[$counter]; + $counter++; + } $counter--; + + ## Replace '\n' with $CRLF. + ## This allows newlines with messages sent on the command line + $message =~ s/\\n/$CRLF/g; + } + + elsif ($ARGS[$counter] =~ /^-u$/) { ## Subject ## + $counter++; + $subject = ""; + while ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { + if ($subject) { $subject .= " "; } + $subject .= $ARGS[$counter]; + $counter++; + } $counter--; + } + + elsif ($ARGS[$counter] =~ /^-s$/) { ## Server ## + $counter++; + if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { + $conf{'server'} = $ARGS[$counter]; + if ($conf{'server'} =~ /:/) { ## Port ## + ($conf{'server'},$conf{'port'}) = split(":",$conf{'server'}); + } + } + else { printmsg("WARNING - The argument after -s was not the server!", 0); $counter--; } + } + + elsif ($ARGS[$counter] =~ /^-b$/) { ## Bind Address ## + $counter++; + if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { + $conf{'bindaddr'} = $ARGS[$counter]; + } + else { printmsg("WARNING - The argument after -b was not the bindaddr!", 0); $counter--; } + } + + elsif ($ARGS[$counter] =~ /^-a$/) { ## Attachments ## + $counter++; + while ($ARGS[$counter] && ($ARGS[$counter] !~ /^-/)) { + push (@attachments,$ARGS[$counter]); + $counter++; + } $counter--; + } + + elsif ($ARGS[$counter] =~ /^-xu$/) { ## AuthSMTP Username ## + $counter++; + if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { + $opt{'username'} = $ARGS[$counter]; + } + else { + printmsg("WARNING => The argument after -xu was not valid username!", 0); + $counter--; + } + } + + elsif ($ARGS[$counter] =~ /^-xp$/) { ## AuthSMTP Password ## + $counter++; + if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { + $opt{'password'} = $ARGS[$counter]; + } + else { + printmsg("WARNING => The argument after -xp was not valid password!", 0); + $counter--; + } + } + + elsif ($ARGS[$counter] =~ /^-l$/) { ## Logging ## + $counter++; + $conf{'logging'} = 1; + if ($ARGS[$counter] && $ARGS[$counter] !~ /^-/) { $conf{'logFile'} = $ARGS[$counter]; } + else { printmsg("WARNING - The argument after -l was not the log file!", 0); $counter--; } + } + + elsif ($ARGS[$counter] =~ s/^-v+//i) { ## Verbosity ## + my $tmp = (length($&) - 1); + $conf{'debug'} += $tmp; + } + + elsif ($ARGS[$counter] =~ /^-q$/) { ## Quiet ## + $conf{'stdout'} = 0; + } + + else { + printmsg("Error: \"$ARGS[$counter]\" is not a recognized option!", 0); + help(); + } + + } + + + + + + + + + ################################################### + ## Verify required variables are set correctly ## + ################################################### + + ## Make sure we have something in $conf{hostname} and $opt{fqdn} + if ($opt{'fqdn'} =~ /\./) { + $conf{'hostname'} = $opt{'fqdn'}; + $conf{'hostname'} =~ s/\..*//; + } + + if (!$conf{'server'}) { $conf{'server'} = 'localhost'; } + if (!$conf{'port'}) { $conf{'port'} = 25; } + if (!$from) { + quit("ERROR => You must specify a 'from' field! Try --help.", 1); + } + if ( ((scalar(@to)) + (scalar(@cc)) + (scalar(@bcc))) <= 0) { + quit("ERROR => You must specify at least one recipient via -t, -cc, or -bcc", 1); + } + + ## Make sure email addresses look OK. + foreach my $addr (@to, @cc, @bcc, $from, $opt{'reply-to'}) { + if ($addr) { + if (!returnAddressParts($addr)) { + printmsg("ERROR => Can't use improperly formatted email address: $addr", 0); + printmsg("HINT => Try viewing the extended help on addressing with \"--help addressing\"", 1); + quit("", 1); + } + } + } + + ## Make sure all attachments exist. + foreach my $file (@attachments) { + if ( (! -f $file) or (! -r $file) ) { + printmsg("ERROR => The attachment [$file] doesn't exist!", 0); + printmsg("HINT => Try specifying the full path to the file or reading extended help with \"--help message\"", 1); + quit("", 1); + } + } + + if ($conf{'logging'} and (!$conf{'logFile'})) { + quit("ERROR => You used -l to enable logging but didn't specify a log file!", 1); + } + + if ( $opt{'username'} ) { + if (!$opt{'password'}) { + ## Prompt for a password since one wasn't specified with the -xp option. + $SIG{'ALRM'} = sub { quit("ERROR => Timeout waiting for password inpupt", 1); }; + alarm(60) if ($^O !~ /win/i); ## alarm() doesn't work in win32 + print "Password: "; + $opt{'password'} = ; chomp $opt{'password'}; + if (!$opt{'password'}) { + quit("ERROR => A username for SMTP authentication was specified, but no password!", 1); + } + } + } + + ## Validate the TLS setting + $opt{'tls'} = lc($opt{'tls'}); + if ($opt{'tls'} !~ /^(auto|yes|no)$/) { + quit("ERROR => Invalid TLS setting ($opt{'tls'}). Must be one of auto, yes, or no.", 1); + } + + ## If TLS is set to "yes", make sure sendEmail loaded the libraries needed. + if ($opt{'tls'} eq 'yes' and $conf{'tls_client'} == 0) { + quit("ERROR => No TLS support! SendEmail can't load required libraries. (try installing Net::SSLeay and IO::Socket::SSL)", 1); + } + + ## Return 0 errors + return(0); +} + + + + + + + + + + + + + + + + +## getline($socketRef) +sub getline { + my ($socketRef) = @_; + local ($/) = "\r\n"; + return $$socketRef->getline; +} + + + + +## Receive a (multiline?) SMTP response from ($socketRef) +sub getResponse { + my ($socketRef) = @_; + my ($tmp, $reply); + local ($/) = "\r\n"; + return undef unless defined($tmp = getline($socketRef)); + return("getResponse() socket is not open") unless ($$socketRef->opened); + ## Keep reading lines if it's a multi-line response + while ($tmp =~ /^\d{3}-/o) { + $reply .= $tmp; + return undef unless defined($tmp = getline($socketRef)); + } + $reply .= $tmp; + $reply =~ s/\r?\n$//o; + return $reply; +} + + + + +############################################################################################### +## Function: SMTPchat ( [string $command] ) +## +## Description: Sends $command to the SMTP server (on SERVER) and awaits a successful +## reply form the server. If the server returns an error, or does not reply +## within $conf{'alarm'} seconds an error is generated. +## NOTE: $command is optional, if no command is specified then nothing will +## be sent to the server, but a valid response is still required from the server. +## +## Input: [$command] A (optional) valid SMTP command (ex. "HELO") +## +## +## Output: Returns zero on success, or non-zero on error. +## Error messages will be stored in $conf{'error'} +## A copy of the last SMTP response is stored in the global variable +## $conf{'SMTPchat_response'} +## +## +## Example: SMTPchat ("HELO mail.isp.net"); +############################################################################################### +sub SMTPchat { + my ($command) = @_; + + printmsg("INFO => Sending: \t$command", 1) if ($command); + + ## Send our command + print $SERVER "$command$CRLF" if ($command); + + ## Read a response from the server + $SIG{'ALRM'} = sub { $conf{'error'} = "alarm"; $SERVER->close(); }; + alarm($conf{'alarm'}) if ($^O !~ /win/i); ## alarm() doesn't work in win32; + my $result = $conf{'SMTPchat_response'} = getResponse(\$SERVER); + alarm(0) if ($^O !~ /win/i); ## alarm() doesn't work in win32; + + ## Generate an alert if we timed out + if ($conf{'error'} eq "alarm") { + $conf{'error'} = "ERROR => Timeout while reading from $conf{'server'}:$conf{'port'} There was no response after $conf{'alarm'} seconds."; + return(1); + } + + ## Make sure the server actually responded + if (!$result) { + $conf{'error'} = "ERROR => $conf{'server'}:$conf{'port'} returned a zero byte response to our query."; + return(2); + } + + ## Validate the response + if (evalSMTPresponse($result)) { + ## conf{'error'} will already be set here + return(2); + } + + ## Print the success messsage + printmsg($conf{'error'}, 1); + + ## Return Success + return(0); +} + + + + + + + + + + + + +############################################################################################### +## Function: evalSMTPresponse (string $message ) +## +## Description: Searches $message for either an SMTP success or error code, and returns +## 0 on success, and the actual error code on error. +## +## +## Input: $message Data received from a SMTP server (ex. "220 +## +## +## Output: Returns zero on success, or non-zero on error. +## Error messages will be stored in $conf{'error'} +## +## +## Example: SMTPchat ("HELO mail.isp.net"); +############################################################################################### +sub evalSMTPresponse { + my ($message) = @_; + + ## Validate input + if (!$message) { + $conf{'error'} = "ERROR => No message was passed to evalSMTPresponse(). What happened?"; + return(1) + } + + printmsg("DEBUG => evalSMTPresponse() - Checking for SMTP success or error status in the message: $message ", 3); + + ## Look for a SMTP success code + if ($message =~ /^([23]\d\d)/) { + printmsg("DEBUG => evalSMTPresponse() - Found SMTP success code: $1", 2); + $conf{'error'} = "SUCCESS => Received: \t$message"; + return(0); + } + + ## Look for a SMTP error code + if ($message =~ /^([45]\d\d)/) { + printmsg("DEBUG => evalSMTPresponse() - Found SMTP error code: $1", 2); + $conf{'error'} = "ERROR => Received: \t$message"; + return($1); + } + + ## If no SMTP codes were found return an error of 1 + $conf{'error'} = "ERROR => Received a message with no success or error code. The message received was: $message"; + return(2); + +} + + + + + + + + + + +######################################################### +# SUB: &return_month(0,1,etc) +# returns the name of the month that corrosponds +# with the number. returns 0 on error. +######################################################### +sub return_month { + my $x = $_[0]; + if ($x == 0) { return 'Jan'; } + if ($x == 1) { return 'Feb'; } + if ($x == 2) { return 'Mar'; } + if ($x == 3) { return 'Apr'; } + if ($x == 4) { return 'May'; } + if ($x == 5) { return 'Jun'; } + if ($x == 6) { return 'Jul'; } + if ($x == 7) { return 'Aug'; } + if ($x == 8) { return 'Sep'; } + if ($x == 9) { return 'Oct'; } + if ($x == 10) { return 'Nov'; } + if ($x == 11) { return 'Dec'; } + return (0); +} + + + + + + + + + + + + + + + + +######################################################### +# SUB: &return_day(0,1,etc) +# returns the name of the day that corrosponds +# with the number. returns 0 on error. +######################################################### +sub return_day { + my $x = $_[0]; + if ($x == 0) { return 'Sun'; } + if ($x == 1) { return 'Mon'; } + if ($x == 2) { return 'Tue'; } + if ($x == 3) { return 'Wed'; } + if ($x == 4) { return 'Thu'; } + if ($x == 5) { return 'Fri'; } + if ($x == 6) { return 'Sat'; } + return (0); +} + + + + + + + + + + + + + + + + +############################################################################################### +## Function: returnAddressParts(string $address) +## +## Description: Returns a two element array containing the "Name" and "Address" parts of +## an email address. +## +## Example: "Brandon Zehm " +## would return: ("Brandon Zehm", "caspian@dotconf.net"); +## +## "caspian@dotconf.net" +## would return: ("caspian@dotconf.net", "caspian@dotconf.net") +############################################################################################### +sub returnAddressParts { + my $input = $_[0]; + my $name = ""; + my $address = ""; + + ## Make sure to fail if it looks totally invalid + if ($input !~ /(\S+\@\S+)/) { + $conf{'error'} = "ERROR => The address [$input] doesn't look like a valid email address, ignoring it"; + return(undef()); + } + + ## Check 1, should find addresses like: "Brandon Zehm " + elsif ($input =~ /^\s*(\S(.*\S)?)\s*<(\S+\@\S+)>/o) { + ($name, $address) = ($1, $3); + } + + ## Otherwise if that failed, just get the address: + elsif ($input =~ /<(\S+\@\S+)>/o) { + $name = $address = $1; + } + + ## Or maybe it was formatted this way: caspian@dotconf.net + elsif ($input =~ /(\S+\@\S+)/o) { + $name = $address = $1; + } + + ## Something stupid happened, just return an error. + unless ($name and $address) { + printmsg("ERROR => Couldn't parse the address: $input", 0); + printmsg("HINT => If you think this should work, consider reporting this as a bug to $conf{'authorEmail'}", 1); + return(undef()); + } + + ## Make sure there aren't invalid characters in the address, and return it. + my $ctrl = '\000-\037'; + my $nonASCII = '\x80-\xff'; + if ($address =~ /[<> ,;:"'\[\]\\$ctrl$nonASCII]/) { + printmsg("WARNING => The address [$address] seems to contain invalid characters: continuing anyway", 0); + } + return($name, $address); +} + + + + + + + + + + + + + + + + +############################################################################################### +## Function: base64_encode(string $data, bool $chunk) +## +## Description: Returns $data as a base64 encoded string. +## If $chunk is true, the encoded data is returned in 76 character long lines +## with the final \CR\LF removed. +## +## Note: This is only used from the smtp auth section of code. +## At some point it would be nice to merge the code that encodes attachments and this. +############################################################################################### +sub base64_encode { + my $data = $_[0]; + my $chunk = $_[1]; + my $tmp = ''; + my $base64 = ''; + my $CRLF = "\r\n"; + + ################################### + ## Convert binary data to base64 ## + ################################### + while ($data =~ s/(.{45})//s) { ## Get 45 bytes from the binary string + $tmp = substr(pack('u', $&), 1); ## Convert the binary to uuencoded text + chop($tmp); + $tmp =~ tr|` -_|AA-Za-z0-9+/|; ## Translate from uuencode to base64 + $base64 .= $tmp; + } + + ########################## + ## Encode the leftovers ## + ########################## + my $padding = ""; + if ( ($data) and (length($data) > 0) ) { + $padding = (3 - length($data) % 3) % 3; ## Set flag if binary data isn't divisible by 3 + $tmp = substr(pack('u', $data), 1); ## Convert the binary to uuencoded text + chop($tmp); + $tmp =~ tr|` -_|AA-Za-z0-9+/|; ## Translate from uuencode to base64 + $base64 .= $tmp; + } + + ############################ + ## Fix padding at the end ## + ############################ + $data = ''; + $base64 =~ s/.{$padding}$/'=' x $padding/e if $padding; ## Fix the end padding if flag (from above) is set + if ($chunk) { + while ($base64 =~ s/(.{1,76})//s) { ## Put $CRLF after each 76 characters + $data .= "$1$CRLF"; + } + } + else { + $data = $base64; + } + + ## Remove any trailing CRLF's + $data =~ s/(\r|\n)*$//s; + return($data); +} + + + + + + + + + +######################################################### +# SUB: send_attachment("/path/filename") +# Sends the mime headers and base64 encoded file +# to the email server. +######################################################### +sub send_attachment { + my ($filename) = @_; ## Get filename passed + my (@fields, $y, $filename_name, $encoding, ## Local variables + @attachlines, $content_type); + my $bin = 1; + + @fields = split(/\/|\\/, $filename); ## Get the actual filename without the path + $filename_name = pop(@fields); + push @attachments_names, $filename_name; ## FIXME: This is only used later for putting in the log file + + ########################## + ## Autodetect Mime Type ## + ########################## + + @fields = split(/\./, $filename_name); + $encoding = $fields[$#fields]; + + if ($encoding =~ /txt|text|log|conf|^c$|cpp|^h$|inc|m3u/i) { $content_type = 'text/plain'; } + elsif ($encoding =~ /html|htm|shtml|shtm|asp|php|cfm/i) { $content_type = 'text/html'; } + elsif ($encoding =~ /sh$/i) { $content_type = 'application/x-sh'; } + elsif ($encoding =~ /tcl/i) { $content_type = 'application/x-tcl'; } + elsif ($encoding =~ /pl$/i) { $content_type = 'application/x-perl'; } + elsif ($encoding =~ /js$/i) { $content_type = 'application/x-javascript'; } + elsif ($encoding =~ /man/i) { $content_type = 'application/x-troff-man'; } + elsif ($encoding =~ /gif/i) { $content_type = 'image/gif'; } + elsif ($encoding =~ /jpg|jpeg|jpe|jfif|pjpeg|pjp/i) { $content_type = 'image/jpeg'; } + elsif ($encoding =~ /tif|tiff/i) { $content_type = 'image/tiff'; } + elsif ($encoding =~ /xpm/i) { $content_type = 'image/x-xpixmap'; } + elsif ($encoding =~ /bmp/i) { $content_type = 'image/x-MS-bmp'; } + elsif ($encoding =~ /pcd/i) { $content_type = 'image/x-photo-cd'; } + elsif ($encoding =~ /png/i) { $content_type = 'image/png'; } + elsif ($encoding =~ /aif|aiff/i) { $content_type = 'audio/x-aiff'; } + elsif ($encoding =~ /wav/i) { $content_type = 'audio/x-wav'; } + elsif ($encoding =~ /mp2|mp3|mpa/i) { $content_type = 'audio/x-mpeg'; } + elsif ($encoding =~ /ra$|ram/i) { $content_type = 'audio/x-pn-realaudio'; } + elsif ($encoding =~ /mpeg|mpg/i) { $content_type = 'video/mpeg'; } + elsif ($encoding =~ /mov|qt$/i) { $content_type = 'video/quicktime'; } + elsif ($encoding =~ /avi/i) { $content_type = 'video/x-msvideo'; } + elsif ($encoding =~ /zip/i) { $content_type = 'application/x-zip-compressed'; } + elsif ($encoding =~ /tar/i) { $content_type = 'application/x-tar'; } + elsif ($encoding =~ /jar/i) { $content_type = 'application/java-archive'; } + elsif ($encoding =~ /exe|bin/i) { $content_type = 'application/octet-stream'; } + elsif ($encoding =~ /ppt|pot|ppa|pps|pwz/i) { $content_type = 'application/vnd.ms-powerpoint'; } + elsif ($encoding =~ /mdb|mda|mde/i) { $content_type = 'application/vnd.ms-access'; } + elsif ($encoding =~ /xls|xlt|xlm|xld|xla|xlc|xlw|xll/i) { $content_type = 'application/vnd.ms-excel'; } + elsif ($encoding =~ /doc|dot/i) { $content_type = 'application/msword'; } + elsif ($encoding =~ /rtf/i) { $content_type = 'application/rtf'; } + elsif ($encoding =~ /pdf/i) { $content_type = 'application/pdf'; } + elsif ($encoding =~ /tex/i) { $content_type = 'application/x-tex'; } + elsif ($encoding =~ /latex/i) { $content_type = 'application/x-latex'; } + elsif ($encoding =~ /vcf/i) { $content_type = 'application/x-vcard'; } + else { $content_type = 'application/octet-stream'; } + + + ############################ + ## Process the attachment ## + ############################ + + ##################################### + ## Generate and print MIME headers ## + ##################################### + + $y = "$CRLF--$conf{'delimiter'}$CRLF"; + $y .= "Content-Type: $content_type;$CRLF"; + $y .= " name=\"$filename_name\"$CRLF"; + $y .= "Content-Transfer-Encoding: base64$CRLF"; + $y .= "Content-Disposition: attachment; filename=\"$filename_name\"$CRLF"; + $y .= "$CRLF"; + print $SERVER $y; + + + ########################################################### + ## Convert the file to base64 and print it to the server ## + ########################################################### + + open (FILETOATTACH, $filename) || do { + printmsg("ERROR => Opening the file [$filename] for attachment failed with the error: $!", 0); + return(1); + }; + binmode(FILETOATTACH); ## Hack to make Win32 work + + my $res = ""; + my $tmp = ""; + my $base64 = ""; + while () { ## Read a line from the (binary) file + $res .= $_; + + ################################### + ## Convert binary data to base64 ## + ################################### + while ($res =~ s/(.{45})//s) { ## Get 45 bytes from the binary string + $tmp = substr(pack('u', $&), 1); ## Convert the binary to uuencoded text + chop($tmp); + $tmp =~ tr|` -_|AA-Za-z0-9+/|; ## Translate from uuencode to base64 + $base64 .= $tmp; + } + + ################################ + ## Print chunks to the server ## + ################################ + while ($base64 =~ s/(.{76})//s) { + print $SERVER "$1$CRLF"; + } + + } + + ################################### + ## Encode and send the leftovers ## + ################################### + my $padding = ""; + if ( ($res) and (length($res) >= 1) ) { + $padding = (3 - length($res) % 3) % 3; ## Set flag if binary data isn't divisible by 3 + $res = substr(pack('u', $res), 1); ## Convert the binary to uuencoded text + chop($res); + $res =~ tr|` -_|AA-Za-z0-9+/|; ## Translate from uuencode to base64 + } + + ############################ + ## Fix padding at the end ## + ############################ + $res = $base64 . $res; ## Get left overs from above + $res =~ s/.{$padding}$/'=' x $padding/e if $padding; ## Fix the end padding if flag (from above) is set + if ($res) { + while ($res =~ s/(.{1,76})//s) { ## Send it to the email server. + print $SERVER "$1$CRLF"; + } + } + + close (FILETOATTACH) || do { + printmsg("ERROR - Closing the filehandle for file [$filename] failed with the error: $!", 0); + return(2); + }; + + ## Return 0 errors + return(0); + +} + + + + + + + + + +############################################################################################### +## Function: $string = get_hostname (boot $fqdn) +## +## Description: Tries really hard to returns the short (or FQDN) hostname of the current +## system. Uses techniques and code from the Sys-Hostname module. +## +## Input: $fqdn A true value (1) will cause this function to return a FQDN hostname +## rather than a short hostname. +## +## Output: Returns a string +############################################################################################### +sub get_hostname { + ## Assign incoming parameters to variables + my ( $fqdn ) = @_; + my $hostname = ""; + + ## STEP 1: Get short hostname + + ## Load Sys::Hostname if it's available + eval { require Sys::Hostname; }; + unless ($@) { + $hostname = Sys::Hostname::hostname(); + } + + ## If that didn't get us a hostname, try a few other things + else { + ## Windows systems + if ($^O !~ /win/i) { + if ($ENV{'COMPUTERNAME'}) { $hostname = $ENV{'COMPUTERNAME'}; } + if (!$hostname) { $hostname = gethostbyname('localhost'); } + if (!$hostname) { chomp($hostname = `hostname 2> NUL`) }; + } + + ## Unix systems + else { + local $ENV{PATH} = '/usr/bin:/bin:/usr/sbin:/sbin'; ## Paranoia + + ## Try the environment first (Help! What other variables could/should I be checking here?) + if ($ENV{'HOSTNAME'}) { $hostname = $ENV{'HOSTNAME'}; } + + ## Try the hostname command + eval { local $SIG{__DIE__}; local $SIG{CHLD}; $hostname = `hostname 2>/dev/null`; chomp($hostname); } || + + ## Try POSIX::uname(), which strictly can't be expected to be correct + eval { local $SIG{__DIE__}; require POSIX; $hostname = (POSIX::uname())[1]; } || + + ## Try the uname command + eval { local $SIG{__DIE__}; $hostname = `uname -n 2>/dev/null`; chomp($hostname); }; + + } + + ## If we can't find anything else, return "" + if (!$hostname) { + print "WARNING => No hostname could be determined, please specify one with -o fqdn=FQDN option!\n"; + return("unknown"); + } + } + + ## Return the short hostname + unless ($fqdn) { + $hostname =~ s/\..*//; + return(lc($hostname)); + } + + ## STEP 2: Determine the FQDN + + ## First, if we already have one return it. + if ($hostname =~ /\w\.\w/) { return(lc($hostname)); } + + ## Next try using + eval { $fqdn = (gethostbyname($hostname))[0]; }; + if ($fqdn) { return(lc($fqdn)); } + return(lc($hostname)); +} + + + + + + + + +############################################################################################### +## Function: printmsg (string $message, int $level) +## +## Description: Handles all messages - printing them to the screen only if the messages +## $level is >= the global debug level. If $conf{'logFile'} is defined it +## will also log the message to that file. +## +## Input: $message A message to be printed, logged, etc. +## $level The debug level of the message. If +## not defined 0 will be assumed. 0 is +## considered a normal message, 1 and +## higher is considered a debug message. +## +## Output: Prints to STDOUT +## +## Assumptions: $conf{'hostname'} should be the name of the computer we're running on. +## $conf{'stdout'} should be set to 1 if you want to print to stdout +## $conf{'logFile'} should be a full path to a log file if you want that +## $conf{'debug'} should be an integer between 0 and 10. +## +## Example: printmsg("WARNING: We believe in generic error messages... NOT!", 0); +############################################################################################### +sub printmsg { + ## Assign incoming parameters to variables + my ( $message, $level ) = @_; + + ## Make sure input is sane + $level = 0 if (!defined($level)); + $message =~ s/\s+$//sgo; + $message =~ s/\r?\n/, /sgo; + + ## Continue only if the debug level of the program is >= message debug level. + if ($conf{'debug'} >= $level) { + + ## Get the date in the format: Dec 3 11:14:04 + my ($sec, $min, $hour, $mday, $mon) = localtime(); + $mon = ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec')[$mon]; + my $date = sprintf("%s %02d %02d:%02d:%02d", $mon, $mday, $hour, $min, $sec); + + ## Print to STDOUT always if debugging is enabled, or if conf{stdout} is true. + if ( ($conf{'debug'} >= 1) or ($conf{'stdout'} == 1) ) { + print "$date $conf{'hostname'} $conf{'programName'}\[$$\]: $message\n"; + } + + ## Print to the log file if $conf{'logging'} is true + if ($conf{'logFile'}) { + if (openLogFile($conf{'logFile'})) { $conf{'logFile'} = ""; printmsg("ERROR => Opening the file [$conf{'logFile'}] for appending returned the error: $!", 1); } + print LOGFILE "$date $conf{'hostname'} $conf{'programName'}\[$$\]: $message\n"; + } + + } + + ## Return 0 errors + return(0); +} + + + + + + + + + + + + +############################################################################################### +## FUNCTION: +## openLogFile ( $filename ) +## +## +## DESCRIPTION: +## Opens the file $filename and attaches it to the filehandle "LOGFILE". Returns 0 on success +## and non-zero on failure. Error codes are listed below, and the error message gets set in +## global variable $!. +## +## +## Example: +## openFile ("/var/log/sendEmail.log"); +## +############################################################################################### +sub openLogFile { + ## Get the incoming filename + my $filename = $_[0]; + + ## Make sure our file exists, and if the file doesn't exist then create it + if ( ! -f $filename ) { + print STDERR "NOTICE: The log file [$filename] does not exist. Creating it now with mode [0600].\n" if ($conf{'stdout'}); + open (LOGFILE, ">>$filename"); + close LOGFILE; + chmod (0600, $filename); + } + + ## Now open the file and attach it to a filehandle + open (LOGFILE,">>$filename") or return (1); + + ## Put the file into non-buffering mode + select LOGFILE; + $| = 1; + select STDOUT; + + ## Return success + return(0); +} + + + + + + + + +############################################################################################### +## Function: read_file (string $filename) +## +## Description: Reads the contents of a file and returns a two part array: +## ($status, $file-contents) +## $status is 0 on success, non-zero on error. +## +## Example: ($status, $file) = read_file("/etc/passwd"); +############################################################################################### +sub read_file { + my ( $filename ) = @_; + + ## If the value specified is a file, load the file's contents + if ( (-e $filename and -r $filename) ) { + my $FILE; + if(!open($FILE, ' ' . $filename)) { + return((1, "")); + } + my $file = ''; + while (<$FILE>) { + $file .= $_; + } + ## Strip an ending \r\n + $file =~ s/\r?\n$//os; + } + return((1, "")); +} + + + + + + + + + +############################################################################################### +## Function: quit (string $message, int $errorLevel) +## +## Description: Exits the program, optionally printing $message. It +## returns an exit error level of $errorLevel to the +## system (0 means no errors, and is assumed if empty.) +## +## Example: quit("Exiting program normally", 0); +############################################################################################### +sub quit { + my ( $message, $errorLevel ) = @_; + $errorLevel = 0 if (!defined($errorLevel)); + + ## Print exit message + if ($message) { + printmsg($message, 0); + } + + ## Exit + exit($errorLevel); +} + + + + + + + + + + + + +############################################################################################### +## Function: help () +## +## Description: For all those newbies ;) +## Prints a help message and exits the program. +## +############################################################################################### +sub help { +exit(1) if (!$conf{'stdout'}); +print <${colorNoBold} + +Synopsis: $conf{'programName'} -f ADDRESS [options] + + ${colorRed}Required:${colorNormal} + -f ADDRESS from (sender) email address + * At least one recipient required via -t, -cc, or -bcc + * Message body required via -m, STDIN, or -o message-file=FILE + + ${colorGreen}Common:${colorNormal} + -t ADDRESS [ADDR ...] to email address(es) + -u SUBJECT message subject + -m MESSAGE message body + -s SERVER[:PORT] smtp mail relay, default is $conf{'server'}:$conf{'port'} + + ${colorGreen}Optional:${colorNormal} + -a FILE [FILE ...] file attachment(s) + -cc ADDRESS [ADDR ...] cc email address(es) + -bcc ADDRESS [ADDR ...] bcc email address(es) + -xu USERNAME username for SMTP authentication + -xp PASSWORD password for SMTP authentication + + ${colorGreen}Paranormal:${colorNormal} + -b BINDADDR[:PORT] local host bind address + -l LOGFILE log to the specified file + -v verbosity, use multiple times for greater effect + -q be quiet (i.e. no STDOUT output) + -o NAME=VALUE advanced options, for details try: --help misc + -o message-content-type= + -o message-file=FILE -o message-format=raw + -o message-header=HEADER -o message-charset=CHARSET + -o reply-to=ADDRESS -o timeout=SECONDS + -o username=USERNAME -o password=PASSWORD + -o tls= -o fqdn=FQDN + + + ${colorGreen}Help:${colorNormal} + --help the helpful overview you're reading now + --help addressing explain addressing and related options + --help message explain message body input and related options + --help networking explain -s, -b, etc + --help output explain logging and other output options + --help misc explain -o options, TLS, SMTP auth, and more + +EOM +exit(1); +} + + + + + + + + + +############################################################################################### +## Function: helpTopic ($topic) +## +## Description: For all those newbies ;) +## Prints a help message and exits the program. +## +############################################################################################### +sub helpTopic { + exit(1) if (!$conf{'stdout'}); + my ($topic) = @_; + + CASE: { + + + + +## ADDRESSING + ($topic eq 'addressing') && do { + print <" + Just Address: "john.doe\@gmail.com" + +The "Full Name" method is useful if you want a name, rather than a plain +email address, to be displayed in the recipient's From, To, or Cc fields +when they view the message. + + +${colorGreen}Multiple Recipients${colorNormal} +The -t, -cc, and -bcc options each accept multiple addresses. They may be +specified by separating them by either a white space, comma, or semi-colon +separated list. You may also specify the -t, -cc, and -bcc options multiple +times, each occurance will append the new recipients to the respective list. + +Examples: +(I used "-t" in these examples, but it can be "-cc" or "-bcc" as well) + + * Space separated list: + -t jane.doe\@yahoo.com "John Doe " + + * Semi-colon separated list: + -t "jane.doe\@yahoo.com; John Doe " + + * Comma separated list: + -t "jane.doe\@yahoo.com, John Doe " + + * Multiple -t, -cc, or -bcc options: + -t "jane.doe\@yahoo.com" -t "John Doe " + + +EOM + last CASE; + }; + + + + + + +## MESSAGE + ($topic eq 'message') && do { + print < + -o message-header=EMAIL HEADER + -o message-charset=CHARSET + -o message-format=raw + +-u SUBJECT + This option allows you to specify the subject for your email message. + It is not required (anymore) that the subject be quoted, although it + is recommended. The subject will be read until an argument starting + with a hyphen (-) is found. + Examples: + -u "Contact information while on vacation" + -u New Microsoft vulnerability discovered + +-m MESSAGE + This option is one of three methods that allow you to specify the message + body for your email. The message may be specified on the command line + with this -m option, read from a file with the -o message-file=FILE + option, or read from STDIN if neither of these options are present. + + It is not required (anymore) that the message be quoted, although it is + recommended. The message will be read until an argument starting with a + hyphen (-) is found. + Examples: + -m "See you in South Beach, Hawaii. -Todd" + -m Please ensure that you upgrade your systems right away + + Multi-line message bodies may be specified with the -m option by putting + a "\\n" into the message. Example: + -m "This is line 1.\\nAnd this is line 2." + + HTML messages are supported, simply begin your message with "" and + sendEmail will properly label the mime header so MUAs properly render + the message. It is currently not possible without "-o message-format=raw" + to send a message with both text and html parts with sendEmail. + +-o message-file=FILE + This option is one of three methods that allow you to specify the message + body for your email. To use this option simply specify a text file + containing the body of your email message. Examples: + -o message-file=/root/message.txt + -o message-file="C:\\Program Files\\output.txt" + +-o message-content-type= + This option allows you to specify the content-type of the email. If your + email message is an html message but is being displayed as a text message + just add "-o message-content-type=html" to the command line to force it + to display as an html message. This actually just changes the Content-Type: + header. Advanced users will be happy to know that if you specify anything + other than the three options listed above it will use that as the vaule + for the Content-Type header. + +-o message-header=EMAIL HEADER + This option allows you to specify additional email headers to be included. + To add more than one message header simply use this option on the command + line more than once. If you specify a message header that sendEmail would + normally generate the one you specified will be used in it's place. + Do not use this unless you know what you are doing! + Example: + To scare a Microsoft Outlook user you may want to try this: + -o message-header="X-Message-Flag: Message contains illegal content" + Example: + To request a read-receipt try this: + -o message-header="Disposition-Notification-To: " + Example: + To set the message priority try this: + -o message-header="X-Priority: 1" + Priority reference: 1=highest, 2=high, 3=normal, 4=low, 5=lowest + +-o message-charset=CHARSET + This option allows you to specify the character-set for the message body. + The default is iso-8859-1. + +-o message-format=raw + This option instructs sendEmail to assume the message (specified with -m, + read from STDIN, or read from the file specified in -o message-file=FILE) + is already a *complete* email message. SendEmail will not generate any + headers and will transmit the message as-is to the remote SMTP server. + Due to the nature of this option the following command line options will + be ignored when this one is used: + -u SUBJECT + -o message-header=EMAIL HEADER + -o message-charset=CHARSET + -a ATTACHMENT + + +${colorGreen}The Message Body${colorNormal} +The email message body may be specified in one of three ways: + 1) Via the -m MESSAGE command line option. + Example: + -m "This is the message body" + + 2) By putting the message body in a file and using the -o message-file=FILE + command line option. + Example: + -o message-file=/root/message.txt + + 3) By piping the message body to sendEmail when nither of the above command + line options were specified. + Example: + grep "ERROR" /var/log/messages | sendEmail -t you\@domain.com ... + +If the message body begins with "" then the message will be treated as +an HTML message and the MIME headers will be written so that a HTML capable +email client will display the message in it's HTML form. +Any of the above methods may be used with the -o message-format=raw option +to deliver an already complete email message. + + +EOM + last CASE; + }; + + + + + + +## MISC + ($topic eq 'misc') && do { + print < + -o timeout=SECONDS + -o fqdn=FQDN + +-a ATTACHMENT [ATTACHMENT ...] + This option allows you to attach any number of files to your email message. + To specify more than one attachment, simply separate each filename with a + space. Example: -a file1.txt file2.txt file3.txt + +-xu USERNAME + Alias for -o username=USERNAME + +-xp PASSWORD + Alias for -o password=PASSWORD + +-o username=USERNAME (synonym for -xu) + These options allow specification of a username to be used with SMTP + servers that require authentication. If a username is specified but a + password is not, you will be prompted to enter one at runtime. + +-o password=PASSWORD (synonym for -xp) + These options allow specification of a password to be used with SMTP + servers that require authentication. If a username is specified but a + password is not, you will be prompted to enter one at runtime. + +-o tls= + This option allows you to specify if TLS (SSL for SMTP) should be enabled + or disabled. The default, auto, will use TLS automatically if your perl + installation has the IO::Socket::SSL and Net::SSLeay modules available, + and if the remote SMTP server supports TLS. To require TLS for message + delivery set this to yes. To disable TLS support set this to no. A debug + level of one or higher will reveal details about the status of TLS. + +-o timeout=SECONDS + This option sets the timeout value in seconds used for all network reads, + writes, and a few other things. + +-o fqdn=FQDN + This option sets the Fully Qualified Domain Name used during the initial + SMTP greeting. Normally this is automatically detected, but in case you + need to manually set it for some reason or get a warning about detection + failing, you can use this to override the default. + + +EOM + last CASE; + }; + + + + + + +## NETWORKING + ($topic eq 'networking') && do { + print < + -o timeout=SECONDS + +-s SERVER[:PORT] + This option allows you to specify the SMTP server sendEmail should + connect to to deliver your email message to. If this option is not + specified sendEmail will try to connect to localhost:25 to deliver + the message. THIS IS MOST LIKELY NOT WHAT YOU WANT, AND WILL LIKELY + FAIL unless you have a email server (commonly known as an MTA) running + on your computer! + Typically you will need to specify your company or ISP's email server. + For example, if you use CableOne you will need to specify: + -s mail.cableone.net + If you have your own email server running on port 300 you would + probably use an option like this: + -s myserver.mydomain.com:300 + If you're a GMail user try: + -s smtp.gmail.com:587 -xu me\@gmail.com -xp PASSWD + +-b BINDADDR[:PORT] + This option allows you to specify the local IP address (and optional + tcp port number) for sendEmail to bind to when connecting to the remote + SMTP server. This useful for people who need to send an email from a + specific network interface or source address and are running sendEmail on + a firewall or other host with several network interfaces. + +-o tls= + This option allows you to specify if TLS (SSL for SMTP) should be enabled + or disabled. The default, auto, will use TLS automatically if your perl + installation has the IO::Socket::SSL and Net::SSLeay modules available, + and if the remote SMTP server supports TLS. To require TLS for message + delivery set this to yes. To disable TLS support set this to no. A debug + level of one or higher will reveal details about the status of TLS. + +-o timeout=SECONDS + This option sets the timeout value in seconds used for all network reads, + writes, and a few other things. + + +EOM + last CASE; + }; + + + + + + +## OUTPUT + ($topic eq 'output') && do { + print < The help topic specified is not valid!", 1); + }; + +exit(1); +} + + + + + + + + + + + + + + + + + + + + + + +############################# +## ## +## MAIN PROGRAM ## +## ## +############################# + + +## Initialize +initialize(); + +## Process Command Line +processCommandLine(); +$conf{'alarm'} = $opt{'timeout'}; + +## Abort program after $conf{'alarm'} seconds to avoid infinite hangs +alarm($conf{'alarm'}) if ($^O !~ /win/i); ## alarm() doesn't work in win32 + + + + +################################################### +## Read $message from STDIN if -m was not used ## +################################################### + +if (!($message)) { + ## Read message body from a file specified with -o message-file= + if ($opt{'message-file'}) { + if (! -e $opt{'message-file'}) { + printmsg("ERROR => Message body file specified [$opt{'message-file'}] does not exist!", 0); + printmsg("HINT => 1) check spelling of your file; 2) fully qualify the path; 3) doubble quote it", 1); + quit("", 1); + } + if (! -r $opt{'message-file'}) { + printmsg("ERROR => Message body file specified can not be read due to restricted permissions!", 0); + printmsg("HINT => Check permissions on file specified to ensure it can be read", 1); + quit("", 1); + } + if (!open(MFILE, "< " . $opt{'message-file'})) { + printmsg("ERROR => Error opening message body file [$opt{'message-file'}]: $!", 0); + quit("", 1); + } + while () { + $message .= $_; + } + close(MFILE); + } + + ## Read message body from STDIN + else { + alarm($conf{'alarm'}) if ($^O !~ /win/i); ## alarm() doesn't work in win32 + if ($conf{'stdout'}) { + print "Reading message body from STDIN because the '-m' option was not used.\n"; + print "If you are manually typing in a message:\n"; + print " - First line must be received within $conf{'alarm'} seconds.\n" if ($^O !~ /win/i); + print " - End manual input with a CTRL-D on its own line.\n\n" if ($^O !~ /win/i); + print " - End manual input with a CTRL-Z on its own line.\n\n" if ($^O =~ /win/i); + } + while () { ## Read STDIN into $message + $message .= $_; + alarm(0) if ($^O !~ /win/i); ## Disable the alarm since at least one line was received + } + printmsg("Message input complete.", 0); + } +} + +## Replace bare LF's with CRLF's (\012 should always have \015 with it) +$message =~ s/(\015)?(\012|$)/\015\012/g; + +## Replace bare CR's with CRLF's (\015 should always have \012 with it) +$message =~ s/(\015)(\012|$)?/\015\012/g; + +## Check message for bare periods and encode them +$message =~ s/(^|$CRLF)(\.{1})($CRLF|$)/$1.$2$3/g; + +## Get the current date for the email header +my ($sec,$min,$hour,$mday,$mon,$year,$day) = gmtime(); +$year += 1900; $mon = return_month($mon); $day = return_day($day); +my $date = sprintf("%s, %s %s %d %.2d:%.2d:%.2d %s",$day, $mday, $mon, $year, $hour, $min, $sec, $conf{'timezone'}); + + + + +################################## +## Connect to the SMTP server ## +################################## +printmsg("DEBUG => Connecting to $conf{'server'}:$conf{'port'}", 1); +$SIG{'ALRM'} = sub { + printmsg("ERROR => Timeout while connecting to $conf{'server'}:$conf{'port'} There was no response after $conf{'alarm'} seconds.", 0); + printmsg("HINT => Try specifying a different mail relay with the -s option.", 1); + quit("", 1); +}; +alarm($conf{'alarm'}) if ($^O !~ /win/i); ## alarm() doesn't work in win32; +$SERVER = IO::Socket::INET->new( PeerAddr => $conf{'server'}, + PeerPort => $conf{'port'}, + LocalAddr => $conf{'bindaddr'}, + Proto => 'tcp', + Autoflush => 1, + timeout => $conf{'alarm'}, +); +alarm(0) if ($^O !~ /win/i); ## alarm() doesn't work in win32; + +## Make sure we got connected +if ( (!$SERVER) or (!$SERVER->opened()) ) { + printmsg("ERROR => Connection attempt to $conf{'server'}:$conf{'port'} failed: $@", 0); + printmsg("HINT => Try specifying a different mail relay with the -s option.", 1); + quit("", 1); +} + +## Save our IP address for later +$conf{'ip'} = $SERVER->sockhost(); +printmsg("DEBUG => My IP address is: $conf{'ip'}", 1); + + + + + + + +######################### +## Do the SMTP Dance ## +######################### + +## Read initial greeting to make sure we're talking to a live SMTP server +if (SMTPchat()) { quit($conf{'error'}, 1); } + +## We're about to use $opt{'fqdn'}, make sure it isn't empty +if (!$opt{'fqdn'}) { + ## Ok, that means we couldn't get a hostname, how about using the IP address for the HELO instead + $opt{'fqdn'} = "[" . $conf{'ip'} . "]"; +} + +## EHLO +if (SMTPchat('EHLO ' . $opt{'fqdn'})) { + printmsg($conf{'error'}, 0); + printmsg("NOTICE => EHLO command failed, attempting HELO instead"); + if (SMTPchat('HELO ' . $opt{'fqdn'})) { quit($conf{'error'}, 1); } + if ( $opt{'username'} and $opt{'password'} ) { + printmsg("WARNING => The mail server does not support SMTP authentication!", 0); + } +} +else { + + ## Determin if the server supports TLS + if ($conf{'SMTPchat_response'} =~ /STARTTLS/) { + $conf{'tls_server'} = 1; + printmsg("DEBUG => The remote SMTP server supports TLS :)", 2); + } + else { + $conf{'tls_server'} = 0; + printmsg("DEBUG => The remote SMTP server does NOT support TLS :(", 2); + } + + ## Start TLS if possible + if ($conf{'tls_server'} == 1 and $conf{'tls_client'} == 1 and $opt{'tls'} =~ /^(yes|auto)$/) { + printmsg("DEBUG => Starting TLS", 2); + if (SMTPchat('STARTTLS')) { quit($conf{'error'}, 1); } + if (! IO::Socket::SSL->start_SSL($SERVER, SSL_version => 'SSLv3 TLSv1')) { + quit("ERROR => TLS setup failed: " . IO::Socket::SSL::errstr(), 1); + } + printmsg("DEBUG => TLS: Using cipher: ". $SERVER->get_cipher(), 3); + printmsg("DEBUG => TLS session initialized :)", 1); + + ## Restart our SMTP session + if (SMTPchat('EHLO ' . $opt{'fqdn'})) { quit($conf{'error'}, 1); } + } + elsif ($opt{'tls'} eq 'yes' and $conf{'tls_server'} == 0) { + quit("ERROR => TLS not possible! Remote SMTP server, $conf{'server'}, does not support it.", 1); + } + + + ## Do SMTP Auth if required + if ( $opt{'username'} and $opt{'password'} ) { + if ($conf{'SMTPchat_response'} !~ /AUTH\s/) { + printmsg("NOTICE => Authentication not supported by the remote SMTP server!", 0); + } + else { + my $auth_succeeded = 0; + my $mutual_method = 0; + + # ## SASL CRAM-MD5 authentication method + # if ($conf{'SMTPchat_response'} =~ /\bCRAM-MD5\b/i) { + # printmsg("DEBUG => SMTP-AUTH: Using CRAM-MD5 authentication method", 1); + # if (SMTPchat('AUTH CRAM-MD5')) { quit($conf{'error'}, 1); } + # + # ## FIXME!! + # + # printmsg("DEBUG => User authentication was successful", 1); + # } + + ## SASL LOGIN authentication method + if ($auth_succeeded == 0 and $conf{'SMTPchat_response'} =~ /\bLOGIN\b/i) { + $mutual_method = 1; + printmsg("DEBUG => SMTP-AUTH: Using LOGIN authentication method", 1); + if (!SMTPchat('AUTH LOGIN')) { + if (!SMTPchat(base64_encode($opt{'username'}))) { + if (!SMTPchat(base64_encode($opt{'password'}))) { + $auth_succeeded = 1; + printmsg("DEBUG => User authentication was successful (Method: LOGIN)", 1); + } + } + } + if ($auth_succeeded == 0) { + printmsg("DEBUG => SMTP-AUTH: LOGIN authenticaion failed.", 1); + } + } + + ## SASL PLAIN authentication method + if ($auth_succeeded == 0 and $conf{'SMTPchat_response'} =~ /\bPLAIN\b/i) { + $mutual_method = 1; + printmsg("DEBUG => SMTP-AUTH: Using PLAIN authentication method", 1); + if (SMTPchat('AUTH PLAIN ' . base64_encode("$opt{'username'}\0$opt{'username'}\0$opt{'password'}"))) { + printmsg("DEBUG => SMTP-AUTH: PLAIN authenticaion failed.", 1); + } + else { + $auth_succeeded = 1; + printmsg("DEBUG => User authentication was successful (Method: PLAIN)", 1); + } + } + + ## If none of the authentication methods supported by sendEmail were supported by the server, let the user know + if ($mutual_method == 0) { + printmsg("WARNING => SMTP-AUTH: No mutually supported authentication methods available", 0); + } + + ## If we didn't get authenticated, log an error message and exit + if ($auth_succeeded == 0) { + quit("ERROR => ERROR => SMTP-AUTH: Authentication to $conf{'server'}:$conf{'port'} failed.", 1); + } + } + } +} + +## MAIL FROM +if (SMTPchat('MAIL FROM:<' .(returnAddressParts($from))[1]. '>')) { quit($conf{'error'}, 1); } + +## RCPT TO +my $oneRcptAccepted = 0; +foreach my $rcpt (@to, @cc, @bcc) { + my ($name, $address) = returnAddressParts($rcpt); + if (SMTPchat('RCPT TO:<' . $address . '>')) { + printmsg("WARNING => The recipient <$address> was rejected by the mail server, error follows:", 0); + $conf{'error'} =~ s/^ERROR/WARNING/o; + printmsg($conf{'error'}, 0); + } + elsif ($oneRcptAccepted == 0) { + $oneRcptAccepted = 1; + } +} +## If no recipients were accepted we need to exit with an error. +if ($oneRcptAccepted == 0) { + quit("ERROR => Exiting. No recipients were accepted for delivery by the mail server.", 1); +} + +## DATA +if (SMTPchat('DATA')) { quit($conf{'error'}, 1); } + + +############################### +## Build and send the body ## +############################### +printmsg("INFO => Sending message body",1); + +## If the message-format is raw just send the message as-is. +if ($opt{'message-format'} =~ /^raw$/i) { + print $SERVER $message; +} + +## If the message-format isn't raw, then build and send the message, +else { + + ## Message-ID: + if ($opt{'message-header'} !~ /^Message-ID:/iom) { + $header .= 'Message-ID: <' . $conf{'Message-ID'} . '@' . $conf{'hostname'} . '>' . $CRLF; + } + + ## From: "Name" (the pointless test below is just to keep scoping correct) + if ($from and $opt{'message-header'} !~ /^From:/iom) { + my ($name, $address) = returnAddressParts($from); + $header .= 'From: "' . $name . '" <' . $address . '>' . $CRLF; + } + + ## Reply-To: + if ($opt{'reply-to'} and $opt{'message-header'} !~ /^Reply-To:/iom) { + my ($name, $address) = returnAddressParts($opt{'reply-to'}); + $header .= 'Reply-To: "' . $name . '" <' . $address . '>' . $CRLF; + } + + ## To: "Name" + if ($opt{'message-header'} =~ /^To:/iom) { + ## The user put the To: header in via -o message-header - dont do anything + } + elsif (scalar(@to) > 0) { + $header .= "To:"; + for (my $a = 0; $a < scalar(@to); $a++) { + my $msg = ""; + + my ($name, $address) = returnAddressParts($to[$a]); + $msg = " \"$name\" <$address>"; + + ## If we're not on the last address add a comma to the end of the line. + if (($a + 1) != scalar(@to)) { + $msg .= ","; + } + + $header .= $msg . $CRLF; + } + } + ## We always want a To: line so if the only recipients were bcc'd they don't see who it was sent to + else { + $header .= "To: \"Undisclosed Recipients\" <>$CRLF"; + } + + if (scalar(@cc) > 0 and $opt{'message-header'} !~ /^Cc:/iom) { + $header .= "Cc:"; + for (my $a = 0; $a < scalar(@cc); $a++) { + my $msg = ""; + + my ($name, $address) = returnAddressParts($cc[$a]); + $msg = " \"$name\" <$address>"; + + ## If we're not on the last address add a comma to the end of the line. + if (($a + 1) != scalar(@cc)) { + $msg .= ","; + } + + $header .= $msg . $CRLF; + } + } + + if ($opt{'message-header'} !~ /^Subject:/iom) { + $header .= 'Subject: ' . $subject . $CRLF; ## Subject + } + if ($opt{'message-header'} !~ /^Date:/iom) { + $header .= 'Date: ' . $date . $CRLF; ## Date + } + if ($opt{'message-header'} !~ /^X-Mailer:/iom) { + $header .= 'X-Mailer: sendEmail-'.$conf{'version'}.$CRLF; ## X-Mailer + } + ## I wonder if I should put this in by default? + # if ($opt{'message-header'} !~ /^X-Originating-IP:/iom) { + # $header .= 'X-Originating-IP: ['.$conf{'ip'}.']'.$CRLF; ## X-Originating-IP + # } + + ## Encode all messages with MIME. + if ($opt{'message-header'} !~ /^MIME-Version:/iom) { + $header .= "MIME-Version: 1.0$CRLF"; + } + if ($opt{'message-header'} !~ /^Content-Type:/iom) { + my $content_type = 'multipart/mixed'; + if (scalar(@attachments) == 0) { $content_type = 'multipart/related'; } + $header .= "Content-Type: $content_type; boundary=\"$conf{'delimiter'}\"$CRLF"; + } + + ## Send additional message header line(s) if specified + if ($opt{'message-header'}) { + $header .= $opt{'message-header'}; + } + + ## Send the message header to the server + print $SERVER $header . $CRLF; + + ## Start sending the message body to the server + print $SERVER "This is a multi-part message in MIME format. To properly display this message you need a MIME-Version 1.0 compliant Email program.$CRLF"; + print $SERVER "$CRLF"; + + + ## Send message body + print $SERVER "--$conf{'delimiter'}$CRLF"; + ## Send a message content-type header: + ## If the message contains HTML... + if ($opt{'message-content-type'} eq 'html' or ($opt{'message-content-type'} eq 'auto' and $message =~ /^\s*( 0) { + ## Disable the alarm so people on modems can send big attachments + alarm(0) if ($^O !~ /win/i); ## alarm() doesn't work in win32 + + ## Send the attachments + foreach my $filename (@attachments) { + ## This is check 2, we already checked this above, but just in case... + if ( ! -f $filename ) { + printmsg("ERROR => The file [$filename] doesn't exist! Email will be sent, but without that attachment.", 0); + } + elsif ( ! -r $filename ) { + printmsg("ERROR => Couldn't open the file [$filename] for reading: $! Email will be sent, but without that attachment.", 0); + } + else { + printmsg("DEBUG => Sending the attachment [$filename]", 1); + send_attachment($filename); + } + } + } + + + ## End the mime encoded message + print $SERVER "$CRLF--$conf{'delimiter'}--$CRLF"; +} + + +## Tell the server we are done sending the email +print $SERVER "$CRLF.$CRLF"; +if (SMTPchat()) { quit($conf{'error'}, 1); } + + + +#################### +# We are done!!! # +#################### + +## Disconnect from the server (don't SMTPchat(), it breaks when using TLS) +print $SERVER "QUIT$CRLF"; +close $SERVER; + + + + + + +####################################### +## Generate exit message/log entry ## +####################################### + +if ($conf{'debug'} or $conf{'logging'}) { + printmsg("Generating a detailed exit message", 3); + + ## Put the message together + my $output = "Email was sent successfully! From: <" . (returnAddressParts($from))[1] . "> "; + + if (scalar(@to) > 0) { + $output .= "To: "; + for ($a = 0; $a < scalar(@to); $a++) { + $output .= "<" . (returnAddressParts($to[$a]))[1] . "> "; + } + } + if (scalar(@cc) > 0) { + $output .= "Cc: "; + for ($a = 0; $a < scalar(@cc); $a++) { + $output .= "<" . (returnAddressParts($cc[$a]))[1] . "> "; + } + } + if (scalar(@bcc) > 0) { + $output .= "Bcc: "; + for ($a = 0; $a < scalar(@bcc); $a++) { + $output .= "<" . (returnAddressParts($bcc[$a]))[1] . "> "; + } + } + $output .= "Subject: [$subject] " if ($subject); + if (scalar(@attachments_names) > 0) { + $output .= "Attachment(s): "; + foreach(@attachments_names) { + $output .= "[$_] "; + } + } + $output .= "Server: [$conf{'server'}:$conf{'port'}]"; + + +###################### +# Exit the program # +###################### + + ## Print / Log the detailed message + quit($output, 0); +} +else { + ## Or the standard message + quit("Email was sent successfully!", 0); +} +