From 1e2387474a449452b78520b9ad96a8b4b5e99722 Mon Sep 17 00:00:00 2001 From: Harald Pfeiffer Date: Wed, 17 Apr 2019 19:07:19 +0200 Subject: initial commit of source fetch --- .../check_email_delivery/Makefile | 14 + .../check_email_delivery-0.7.1b/CHANGES.txt | 15 + .../check_email_delivery-0.7.1b/LICENSE.txt | 674 ++++++++++++++ .../check_email_delivery-0.7.1b/README.txt | 77 ++ .../check_email_delivery | 970 ++++++++++++++++++++ .../check_email_delivery_epn | 498 ++++++++++ .../check_email_delivery-0.7.1b/check_imap_quota | 431 +++++++++ .../check_imap_quota_epn | 235 +++++ .../check_email_delivery-0.7.1b/check_imap_receive | 999 +++++++++++++++++++++ .../check_imap_receive_epn | 492 ++++++++++ .../check_email_delivery-0.7.1b/check_smtp_send | 782 ++++++++++++++++ .../check_smtp_send_epn | 458 ++++++++++ .../How to connect to IMAP server manually.txt | 69 ++ .../docs/How to test plugin.txt | 15 + .../docs/check_email_delivery.html | 522 +++++++++++ .../docs/check_email_delivery.pod | 472 ++++++++++ .../docs/check_imap_quota.html | 258 ++++++ .../docs/check_imap_quota.pod | 196 ++++ .../docs/check_imap_receive.html | 551 ++++++++++++ .../docs/check_imap_receive.pod | 507 +++++++++++ .../docs/check_smtp_send.html | 375 ++++++++ .../docs/check_smtp_send.pod | 324 +++++++ .../docs/imap_ssl_cert.html | 178 ++++ .../docs/imap_ssl_cert.pod | 122 +++ .../check_email_delivery-0.7.1b/imap_ssl_cert | 236 +++++ .../check_email_delivery-0.7.1b/imap_ssl_cert_epn | 114 +++ .../nagios-plugins-check_email_delivery.spec | 63 ++ .../check_email_delivery/control | 15 + .../check_email_delivery/copyright | 15 + .../check_email_delivery/email_delivery.cfg | 4 + .../check_email_delivery/src | 1 + 31 files changed, 9682 insertions(+) create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/Makefile create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/CHANGES.txt create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/LICENSE.txt create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/README.txt create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_email_delivery create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_email_delivery_epn create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_quota create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_quota_epn create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_receive create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_receive_epn create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_smtp_send create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_smtp_send_epn create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to connect to IMAP server manually.txt create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to test plugin.txt create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.html create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.pod create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.html create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.pod create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.html create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.pod create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.html create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.pod create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.html create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.pod create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/imap_ssl_cert create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/imap_ssl_cert_epn create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/nagios-plugins-check_email_delivery.spec create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/control create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/copyright create mode 100644 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/email_delivery.cfg create mode 120000 nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/src (limited to 'nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery') diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/Makefile b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/Makefile new file mode 100644 index 0000000..54fe593 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/Makefile @@ -0,0 +1,14 @@ +#/usr/bin/make -f + +PLUGIN = $(wildcard src/check_*) $(wildcard src/imap_ssl_*) +MANPAGES = $(shell find src/docs -regex '[^ ]*.pod' -printf '%f\n' | sed 's,pod$$,7,') +DOCFILES = src/docs/*.html src/docs/*.txt src/README.txt +CLEANFILES = $(MANPAGES) + +include ../common.mk + + +%.7: src/docs/%.pod + pod2man -s 7 $< > $@ + + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/CHANGES.txt b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/CHANGES.txt new file mode 100644 index 0000000..05626d6 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/CHANGES.txt @@ -0,0 +1,15 @@ +2005-11-10 +* published +2005-05-10 +* received patches from Johan Nilsson +2006-07-20 +* received patches from Geoff Crompton +2007-04-24 +* packaged ePN version of the plugins -- the __END__ block for embedded documentation was causing an error because of the way ePN wraps the perl scripts. see http://nagios.sourceforge.net/docs/2_0/embeddedperl.html +* added SSL support using patch from Benjamin Ritcey +2007-10-21 +* added TLS support for SMTP using Net::SMTP::TLS +* added SSL support for SMTP using Net::SMTP::SSL, but NOTE that I don't have access to an SMTPS server so I cannot test this. +2007-12-04 +* small fix with SSL support for IMAP related to bugfix in Mail::IMAPClient 3.00 over 2.2.9 thanks to Seth P. Low +* added --usage option to all three plugins for familiarity with the official nagios plugins diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/LICENSE.txt b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/LICENSE.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/LICENSE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/README.txt b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/README.txt new file mode 100644 index 0000000..6367b93 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/README.txt @@ -0,0 +1,77 @@ +This file was updated on Sun Oct 21 21:32:12 PDT 2007. + +Developer guidelines: +http://nagiosplug.sourceforge.net/developer-guidelines.html + +Nagios Plugins: +http://nagiosplugins.org/ + Nagios: http://nagios.org and http://nagiosplug.sourceforge.net + +Perl library: http://search.cpan.org/dist/Nagios-Plugin/lib/Nagios/Plugin.pm + +The email delivery plugin I wrote uses two other plugins +(smtp send and imap receive), also included, to send a message +to an email account and then check that account for the message +and delete it. The plugin times how long it takes for the +message to be delivered and the warning and critical thresholds +are for this elapsed time. + +A few notes: + +1. I tried to use the check_smtp plugin for sending mail. I +can do it on the command line but I can't get the newlines to +happen from the nagios config file (\n doesn't seem to work so smtp +server waits for the '.' but doesn't get it like it does when I +use single quote and newlines from the command line). So if +you know how to get the check_smtp plugin to send a message from +the nagios config, that one could be used instead of the +check_smtp_send plugin included here (and please let me know) + + +2. I looked at check_mail.pl by bledi51 and its pretty good, +and also conforms better to nagios perl plugin guidelnes than +mine does. So I'm going to be revising my plugins to conform +more. + + + + + + +Finally, usage example from my own nagios config: + +define command{ + command_name check_email_delivery + command_line $USER1$/check_email_delivery -H $HOSTADDRESS$ --mailfrom $ARG3$ --mailto $ARG4$ --username $ARG5$ --password $ARG6$ --libexec $USER1$ -w $ARG1$ -c $ARG2$ + } + +define service{ + use generic-service + host_name mail.your.net + service_description EMAIL DELIVERY + check_command check_email_delivery!5!120!sender@your.net!recipient@your.net!recipient@your.net!password + } + + +A new usage example equivalent to the old one but using the new --plugins and --token options: + +define command{ + command_name check_email_delivery + command_line $USER1$/check_email_delivery -p '$USER1$/check_smtp_send -H $HOSTADDRESS$ --mailfrom $ARG3$ --mailto $ARG4$ -U $ARG5$ -P $ARG6$ --subject "Nagios %TOKEN1%" -w $ARG1$ -c $ARG2$' -p '$USER1$/check_imap_receive -H $HOSTADDRESS$ -U $ARG5$ -P $ARG6$ -s SUBJECT -s "Nagios %TOKEN1%" -w $ARG1$ -c $ARG2$' -w $ARG1$,$ARG1$ -c $ARG2$,$ARG2$ + } + +define service{ + use generic-service + host_name mail.your.net + service_description EMAIL DELIVERY + check_command check_email_delivery!5!120!sender@your.net!recipient@your.net!recipient@your.net!password + } + + +References to similar plugins: + +pop3(s) email matching plugin by kkvenkit +check_mail.pl by bledi51 +check_email_loop.pl by ryanwilliams +check_pop.pl and check_imap.pl by http://www.jhweiss.de/software/nagios.html + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_email_delivery b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_email_delivery new file mode 100644 index 0000000..689d619 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_email_delivery @@ -0,0 +1,970 @@ +#!/usr/bin/perl +use strict; +my $VERSION = '0.7.1'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +# look for required modules +exit $status{UNKNOWN} unless load_modules(qw/Getopt::Long/); + +BEGIN { + if( grep { /^--hires$/ } @ARGV ) { + eval "use Time::HiRes qw(time);"; + warn "Time::HiRes not installed\n" if $@; + } +} + +# get options from command line +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $host = ""; +my $smtp_server = ""; +my $smtp_port = ""; +my $imap_server = ""; +my $smtp_username = ""; +my $smtp_password = ""; +my $smtp_tls = ""; +my $imap_port = ""; +my $imap_username = ""; +my $imap_password = ""; +my $imap_mailbox = ""; +my $username = ""; +my $password = ""; +my $ssl = ""; +my $imap_ssl = ""; +my $mailto = ""; +my $mailfrom = ""; +my @header = (); +my $body = ""; +my $warnstr = ""; +my $critstr = ""; +my $waitstr = ""; +my $delay_warn = 95; +my $delay_crit = 300; +my $smtp_warn = 15; +my $smtp_crit = 30; +my $imap_warn = 15; +my $imap_crit = 30; +my $timeout = ""; +my @alert_plugins = (); +my $imap_interval = 5; +my $imap_retries = 5; +my @plugins = (); +my @token_formats = (); +my $tokenfile = ""; +my $default_crit = 30; +my $default_warn = 15; +my $default_wait = 5; +my $default_timeout = 60; +my $time_hires = ""; +my $libexec = "/usr/local/nagios/libexec"; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + "w|warning=s"=>\$warnstr,"c|critical=s"=>\$critstr, "t|timeout=s"=>\$timeout, + "libexec=s"=>\$libexec, + # plugin settings + "p|plugin=s"=>\@plugins, "T|token=s"=>\@token_formats, + "A|alert=i"=>\@alert_plugins, + "F|file=s"=>\$tokenfile, + # common settings + "H|hostname=s"=>\$host, + "U|username=s"=>\$username,"P|password=s"=>\$password, + "ssl!"=>\$ssl, + # smtp settings + "smtp-server=s"=>\$smtp_server,"smtp-port=i"=>\$smtp_port, + "mailto=s"=>\$mailto, "mailfrom=s",\$mailfrom, + "header=s"=>\@header, "body=s"=>\$body, + # smtp-tls settings + "smtptls!"=>\$smtp_tls, + "smtp-username=s"=>\$smtp_username,"smtp-password=s"=>\$smtp_password, + # delay settings + "wait=s"=>\$waitstr, + # imap settings + "imap-server=s"=>\$imap_server,"imap-port=i"=>\$imap_port, + "imap-username=s"=>\$imap_username,"imap-password=s"=>\$imap_password, + "imap-mailbox=s"=>\$imap_mailbox, + "imap-check-interval=i"=>\$imap_interval,"imap-retries=i"=>\$imap_retries, + "imapssl!"=>\$imap_ssl, + # Time + "hires"=>\$time_hires, + ); + +if( $show_version ) { + print "$VERSION\n"; + if( $verbose ) { + print "Warning threshold: $delay_warn seconds\n"; + print "Critical threshold: $delay_crit seconds\n"; + print "Default wait: $default_wait seconds\n"; + print "Default timeout: $default_timeout seconds\n"; + } + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +if( $host ) { + $smtp_server = $host if $smtp_server eq ""; + $imap_server = $host if $imap_server eq ""; +} + +if( $username ) { + $smtp_username = $username if $smtp_username eq ""; + $imap_username = $username if $imap_username eq ""; +} + +if( $password ) { + $smtp_password = $password if $smtp_password eq ""; + $imap_password = $password if $imap_password eq ""; +} + +if( $ssl ) { + $imap_ssl = $ssl if $imap_ssl eq ""; + $smtp_tls = $ssl if $smtp_tls eq ""; +} + +if( $help_usage + || + ( + scalar(@plugins) == 0 + && + ( + $smtp_server eq "" || $mailto eq "" || $mailfrom eq "" + || $imap_server eq "" || $username eq "" || $password eq "" + ) + ) + ) { + print "Usage 1: $0 -H host \n\t". + "--mailto recipient\@your.net --mailfrom sender\@your.net --body 'message' \n\t". + "--username username --password password \n\t". + "[-w ] [-c ]\n\t" . + "[--imap-check-interval ] [--imap-retries ]\n"; + print "Usage 2: $0 \n\t". + "-p 'first plugin command with %TOKEN1% embedded' \n\t". + "-p 'second plugin command with %TOKEN1% embedded' \n\t". + "[-w ,] [-c ,] \n"; + exit $status{UNKNOWN}; +} + +# determine thresholds +my @warning_times = split(",", $warnstr); +my @critical_times = split(",", $critstr); +my @alarm_times = split(",", $timeout); +my @wait_times = split(",", $waitstr); +my ($dw,$sw,$rw) = split(",", $warnstr); +my ($dc,$sc,$rc) = split(",", $critstr); +my ($wait) = split(",", $waitstr); +$delay_warn = $dw if defined $dw and $dw ne ""; +$smtp_warn = $sw if defined $sw and $sw ne ""; +$imap_warn = $rw if defined $rw and $rw ne ""; +$delay_crit = $dc if defined $dc and $dc ne ""; +$smtp_crit = $sc if defined $sc and $sc ne ""; +$imap_crit = $rc if defined $rc and $rc ne ""; +my $smtp_thresholds = ""; +$smtp_thresholds .= "-w $smtp_warn " if defined $smtp_warn and $smtp_warn ne ""; +$smtp_thresholds .= "-c $smtp_crit " if defined $smtp_crit and $smtp_crit ne ""; +my $imap_thresholds = ""; +$imap_thresholds .= "-w $imap_warn " if defined $imap_warn and $imap_warn ne ""; +$imap_thresholds .= "-c $imap_crit " if defined $imap_crit and $imap_crit ne ""; +$imap_thresholds .= "--imap-check-interval $imap_interval " if defined $imap_interval and $imap_interval ne ""; +$imap_thresholds .= "--imap-retries $imap_retries " if defined $imap_retries and $imap_retries ne ""; +if( scalar(@alarm_times) == 1 ) { + $default_timeout = shift(@alarm_times); +} + +# determine which other options to include +my $smtp_options = ""; +$smtp_options .= "-H $smtp_server " if defined $smtp_server and $smtp_server ne ""; +$smtp_options .= "-p $smtp_port " if defined $smtp_port and $smtp_port ne ""; +$smtp_options .= "--tls " if defined $smtp_tls and $smtp_tls; +$smtp_options .= "-U ".shellquote($smtp_username)." " if defined $smtp_username and $smtp_username ne ""; +$smtp_options .= "-P ".shellquote($smtp_password)." " if defined $smtp_password and $smtp_password ne ""; +$smtp_options .= "--mailto ".shellquote($mailto)." " if defined $mailto and $mailto ne ""; +$smtp_options .= "--mailfrom ".shellquote($mailfrom)." " if defined $mailfrom and $mailfrom ne ""; +foreach my $h( @header ) { + $smtp_options .= "--header ".shellquote($h)." "; +} +my $imap_options = ""; +$imap_options .= "-H $imap_server " if defined $imap_server and $imap_server ne ""; +$imap_options .= "-p $imap_port " if defined $imap_port and $imap_port ne ""; +$imap_options .= "-U ".shellquote($imap_username)." " if defined $imap_username and $imap_username ne ""; +$imap_options .= "-P ".shellquote($imap_password)." " if defined $imap_password and $imap_password ne ""; +$imap_options .= "--mailbox ".shellquote($imap_mailbox)." " if defined $imap_mailbox and $imap_mailbox ne ""; +$imap_options .= "--ssl " if defined $imap_ssl and $imap_ssl; + + +# create the report object +my $report = new PluginReport; +my @report_plugins = (); # populated later with either (smtp,imap) or (plugin1,plugin2,...) +my $time_start; # initialized later with time the work actually starts + +# create token formats for use with the plugins +my @alpha = qw/a b c d e f g h i j k l m n o p q r s t u v w x y z/; +my @numeric = qw/0 1 2 3 4 5 6 7 8 9/; +my @hex = qw/0 1 2 3 4 5 6 7 8 9 a b c d e f/; +my @pgp_even = qw/aardvark absurd accrue acme adrift adult afflict ahead aimless Algol allow alone ammo ancient apple artist assume Athens atlas Aztec baboon backfield backward banjo beaming bedlamp beehive beeswax befriend Belfast berserk billiard bison blackjack blockade blowtorch bluebird bombast bookshelf brackish breadline breakup brickyard briefcase Burbank button buzzard cement chairlift chatter checkup chisel choking chopper Christmas clamshell classic classroom cleanup clockwork cobra commence concert cowbell crackdown cranky crowfoot crucial crumpled crusade cubic dashboard deadbolt deckhand dogsled dragnet drainage dreadful drifter dropper drumbeat drunken Dupont dwelling eating edict egghead eightball endorse endow enlist erase escape exceed eyeglass eyetooth facial fallout flagpole flatfoot flytrap fracture framework freedom frighten gazelle Geiger glitter glucose goggles goldfish gremlin guidance hamlet highchair hockey indoors indulge inverse involve island jawbone keyboard kickoff kiwi klaxon locale lockup merit minnow miser Mohawk mural music necklace Neptune newborn nightbird Oakland obtuse offload optic orca payday peachy pheasant physique playhouse Pluto preclude prefer preshrunk printer prowler pupil puppy python quadrant quiver quota ragtime ratchet rebirth reform regain reindeer rematch repay retouch revenge reward rhythm ribcage ringbolt robust rocker ruffled sailboat sawdust scallion scenic scorecard Scotland seabird select sentence shadow shamrock showgirl skullcap skydive slingshot slowdown snapline snapshot snowcap snowslide solo southward soybean spaniel spearhead spellbind spheroid spigot spindle spyglass stagehand stagnate stairway standard stapler steamship sterling stockman stopwatch stormy sugar surmount suspense sweatband swelter tactics talon tapeworm tempest tiger tissue tonic topmost tracker transit trauma treadmill Trojan trouble tumor tunnel tycoon uncut unearth unwind uproot upset upshot vapor village virus Vulcan waffle wallet watchword wayside willow woodlark Zulu/; +my @pgp_odd = qw/adroitness adviser aftermath aggregate alkali almighty amulet amusement antenna applicant Apollo armistice article asteroid Atlantic atmosphere autopsy Babylon backwater barbecue belowground bifocals bodyguard bookseller borderline bottomless Bradbury bravado Brazilian breakaway Burlington businessman butterfat Camelot candidate cannonball Capricorn caravan caretaker celebrate cellulose certify chambermaid Cherokee Chicago clergyman coherence combustion commando company component concurrent confidence conformist congregate consensus consulting corporate corrosion councilman crossover crucifix cumbersome customer Dakota decadence December decimal designing detector detergent determine dictator dinosaur direction disable disbelief disruptive distortion document embezzle enchanting enrollment enterprise equation equipment escapade Eskimo everyday examine existence exodus fascinate filament finicky forever fortitude frequency gadgetry Galveston getaway glossary gossamer graduate gravity guitarist hamburger Hamilton handiwork hazardous headwaters hemisphere hesitate hideaway holiness hurricane hydraulic impartial impetus inception indigo inertia infancy inferno informant insincere insurgent integrate intention inventive Istanbul Jamaica Jupiter leprosy letterhead liberty maritime matchmaker maverick Medusa megaton microscope microwave midsummer millionaire miracle misnomer molasses molecule Montana monument mosquito narrative nebula newsletter Norwegian October Ohio onlooker opulent Orlando outfielder Pacific pandemic Pandora paperweight paragon paragraph paramount passenger pedigree Pegasus penetrate perceptive performance pharmacy phonetic photograph pioneer pocketful politeness positive potato processor provincial proximate puberty publisher pyramid quantity racketeer rebellion recipe recover repellent replica reproduce resistor responsive retraction retrieval retrospect revenue revival revolver sandalwood sardonic Saturday savagery scavenger sensation sociable souvenir specialist speculate stethoscope stupendous supportive surrender suspicious sympathy tambourine telephone therapist tobacco tolerance tomorrow torpedo tradition travesty trombonist truncated typewriter ultimate undaunted underfoot unicorn unify universe unravel upcoming vacancy vagabond vertigo Virginia visitor vocalist voyager warranty Waterloo whimsical Wichita Wilmington Wyoming yesteryear Yucatan/; +my %formats = ( + 'a' => sub { pick_random(@alpha) }, + 'n' => sub { pick_random(@numeric) }, + 'c' => sub { pick_random(@alpha,@numeric) }, + 'h' => sub { pick_random(@hex) }, + 'U' => sub { time }, + 'X' => sub { pick_random(@pgp_even) }, + 'Y' => sub { pick_random(@pgp_odd) }, +); +if( scalar(@plugins) ) { + # scan the plugin commands for use of tokens to count how many we need + my $token_count = 0; + foreach my $p (@plugins) { + my @matches = sort ($p =~ m/%TOKEN(\d+)%/g); + my $max = pop @matches; + $token_count = $max if defined($max) && $max > $token_count; + } + # create the tokens + my @tokens = (); + foreach my $t (1..$token_count) { + my $format = shift @token_formats; + $format = "U-X-Y" unless $format; + my @format_characters = split(//, $format); + my $token = ""; + foreach my $c (@format_characters) { + if( defined $formats{$c} ) { + $token .= &{$formats{$c}}; + } + else { + $token .= $c; + } + } + push @tokens, $token; + } + # substitute the tokens into each plugin command + foreach my $p (@plugins) { + foreach my $t (1..$token_count) { + my $token = $tokens[$t-1]; + $p =~ s/%TOKEN$t%/$token/g; + } + } + # mark plugins that are allowed to generate alerts. default behavior is to alert for all plugins. + my %alert_plugins = (); + if( scalar(@alert_plugins) > 0 ) { + %alert_plugins = map { $_ => 1 } @alert_plugins; + } + else { + %alert_plugins = map { $_ => 1 } (1..scalar(@plugins)); + } + # run each plugin and store its output in a report + $time_start = time; + my $i = 0; + foreach my $p( @plugins ) { + $i++; + my $plugin_timeout = shift(@alarm_times) || $default_timeout; + # run the plugin + eval { + local $SIG{ALRM} = sub { die "exceeded timeout $plugin_timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $plugin_timeout; + my $output = `$p`; + chomp $output; + if( $output !~ m/OK|WARNING|CRITICAL/ ) { + print "EMAIL DELIVERY UNKNOWN - plugin $i error: $output\n"; + print "Plugin $i: $p\n" if $verbose; + # record tokens in a file if option is enabled + record_tokens($tokenfile,\@tokens,$time_start,undef,'UNKNOWN',$i,$output) if $tokenfile; + exit $status{UNKNOWN}; + } + if( $output =~ m/CRITICAL/ && $alert_plugins{$i} ) { + print "EMAIL DELIVERY CRITICAL - plugin $i failed: $output\n"; + print "Plugin $i: $p" if $verbose; + # record tokens in a file if option is enabled + record_tokens($tokenfile,\@tokens,$time_start,undef,'CRITICAL',$i,$output) if $tokenfile; + exit $status{CRITICAL}; + } + if( $output =~ m/WARNING/ && $alert_plugins{$i} ) { + print "EMAIL DELIVERY WARNING - plugin $i warning: $output\n"; + print "Plugin $i: $p\n" if $verbose; + # record tokens in a file if option is enabled + record_tokens($tokenfile,\@tokens,$time_start,undef,'WARNING',$i,$output) if $tokenfile; + exit $status{WARNING}; + } + $report->{"plugin".$i} = $output; + alarm 0; + }; + if( $@ && $alert_plugins{$i} ) { + print "EMAIL DELIVERY CRITICAL - Could not run plugin $i: $@\n"; + print "Plugin $i: $p\n" if $verbose; + exit $status{CRITICAL}; + } + # if this wasn't the last plugin, wait before continuing + if( $i < scalar(@plugins) ) { + my $wait = shift(@wait_times) || $default_wait; + sleep $wait; + } + # compatibility with the "not using plugins" method... pretend to calculate the total round trip time (the delay) using data from the plugins ... + $report->{max} = 0; + $report->{delay} = 0; + } + # register the list of reports + foreach my $r ( 1..scalar(@plugins)) { + push @report_plugins, "plugin".$r; + } + # record tokens in a file if option is enabled + my $tmp_long_report = join(", ", map { "$_: $report->{$_}" } @report_plugins ) if $tokenfile; + record_tokens($tokenfile,\@tokens,$time_start,time,'OK',scalar(@plugins),$tmp_long_report) if $tokenfile; +} +else { + # not using plugins. + $time_start = time; + + # send email via SMTP + my $id = $time_start; # XXX should include localhost name maybe or some random number in case the same mailbox is used for multiple delivery tests + + my $smtp_plugin = "$libexec/check_smtp_send"; + $smtp_plugin = "$libexec/check_smtp_send.pl" unless -e $smtp_plugin; + my $smtp_timeout = shift(@alarm_times) || $default_timeout; + eval { + local $SIG{ALRM} = sub { die "exceeded timeout $smtp_timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $smtp_timeout; + my $smtp = `$smtp_plugin $smtp_options --header 'Subject: Nagios Message SMTP $smtp_server ID $id.' --body 'Nagios Email Delivery Plugin\n$body' $smtp_thresholds`; + if( $smtp !~ m/OK|WARNING|CRITICAL/ ) { + print "EMAIL DELIVERY UNKNOWN - smtp unknown: $smtp\n"; + exit $status{UNKNOWN}; + } + if( $smtp =~ m/CRITICAL/ ) { + print "EMAIL DELIVERY CRITICAL - smtp failed: $smtp\n"; + exit $status{CRITICAL}; + } + chomp $smtp; + $report->{smtp} = $smtp; + alarm 0; + }; + if( $@ ) { + print "EMAIL DELIVERY CRITICAL - Could not connect to SMTP server $smtp_server: $@\n"; + exit $status{CRITICAL}; + } + + # wait before checking the delivery + $wait = shift(@wait_times) || $default_wait; + sleep $wait; + + # check email via IMAP + my $imap_plugin = "$libexec/check_imap_receive"; + $imap_plugin = "$libexec/check_imap_receive.pl" unless -e $imap_plugin; + my $imap_timeout = shift(@alarm_times) || $default_timeout; + eval { + local $SIG{ALRM} = sub { die "exceeded timeout $imap_timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $imap_timeout; + my $imap = `$imap_plugin $imap_options -s SUBJECT -s 'Nagios Message SMTP $smtp_server ID' --capture-max 'Nagios Message SMTP $smtp_server ID (\\d+)' --nodelete-captured $imap_thresholds`; + if( $imap !~ m/OK|WARNING|CRITICAL/ ) { + print "EMAIL DELIVERY UNKNOWN - imap unknown: $imap\n"; + exit $status{UNKNOWN}; + } + if( $imap =~ m/CRITICAL/ ) { + print "EMAIL DELIVERY CRITICAL - imap failed: $imap\n"; + exit $status{CRITICAL}; + } + if( $imap =~ m/ (\d+) max/ ) { + my $last_received = $1; + $report->{max} = $1; + my $delay = time - $last_received; + $report->{delay} = $delay; + } + chomp $imap; + $report->{imap} = $imap; + alarm 0; + }; + if( $@ ) { + print "EMAIL DELIVERY CRITICAL - Could not connect to IMAP server $imap_server: $@\n"; + exit $status{CRITICAL}; + } + # register the list of reports + push @report_plugins, ("smtp","imap"); +} + + +# calculate elapsed time and issue warnings +my $time_end = time; +my $elapsedtime = $time_end - $time_start; +$report->{seconds} = $elapsedtime; + +my @warning = (); +my @critical = (); + +push @warning, "most recent received $report->{delay} seconds ago" if( defined($report->{delay}) && $report->{delay} > $delay_warn ); +push @critical, "most recent received $report->{delay} seconds ago" if( defined($report->{delay}) && $report->{delay} > $delay_crit ); +push @warning, "no emails found" if( !defined($report->{delay}) ); + +# print report and exit with known status +my $perf_data = "delay=".$report->{delay}."s;$delay_warn;$delay_crit;0 elapsed=".$report->{seconds}."s"; # TODO: need a component for safely generating valid perf data format. for notes on the format, see http://www.perfparse.de/tiki-view_faq.php?faqId=6 +my $short_report = $report->text(qw/seconds delay/) . " | $perf_data"; +my $long_report = join("", map { "$_: $report->{$_}\n" } @report_plugins ); +if( scalar @critical ) { + my $alerts = join(", ", @critical); + print "EMAIL DELIVERY CRITICAL - $alerts; $short_report\n"; + print $long_report if $verbose; + exit $status{CRITICAL}; +} +if( scalar @warning ) { + my $alerts = join(", ", @warning); + print "EMAIL DELIVERY WARNING - $alerts; $short_report\n"; + print $long_report if $verbose; + exit $status{WARNING}; +} +print "EMAIL DELIVERY OK - $short_report\n"; +print $long_report if $verbose; +exit $status{OK}; + +# utility to load required modules. exits if unable to load one or more of the modules. +sub load_modules { + my @missing_modules = (); + foreach( @_ ) { + eval "require $_"; + push @missing_modules, $_ if $@; + } + if( @missing_modules ) { + print "Missing perl modules: @missing_modules\n"; + return 0; + } + return 1; +} + +# returns one random character from a set of characters +sub pick_random { + my @set = @_; + my $size = scalar @set; + my $string = $set[int(rand($size))]; + return $string; +} + +# appens tokens and times to a tab-separated value file +sub record_tokens { + my ($tokenfile,$tokens,$time_start,$time_end,$status,$plugin_num,$output) = @_; + if( $tokenfile ) { + my @tokens = @$tokens; + $time_end = "" unless defined $time_end; + $status = "" unless defined $status; + $plugin_num = "" unless defined $plugin_num; + $output = "" unless defined $output; + print "saving ".scalar(@tokens)." tokens into $tokenfile\n" if $verbose; + open(TOKENFILE,">>$tokenfile"); + foreach(@tokens) { + print TOKENFILE "$_\t$time_start\t$time_end\t$status\t$plugin_num\t$output\n"; + } + close(TOKENFILE); + } +} + +# wraps argument in single-quotes and escapes any single-quotes in the argument +sub shellquote { + my $str = shift || ""; + $str =~ s/\'/\'\\\'\'/g; + return "'$str'"; +} + + +# NAME +# PluginReport +# SYNOPSIS +# $report = new PluginReport; +# $report->{label1} = "value1"; +# $report->{label2} = "value2"; +# print $report->text(qw/label1 label2/); +package PluginReport; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub text { + my ($self,@labels) = @_; + my @report = map { "$self->{$_} $_" } grep { defined $self->{$_} } @labels; + my $text = join(", ", @report); + return $text; +} + +package main; +1; + +__END__ + +=pod + +=head1 NAME + +check_email_delivery - sends email and verifies delivery + +=head1 SYNOPSIS + + check_email_delivery -vV + check_email_delivery --usage + check_email_delivery --help + +=head1 OPTIONS + +=over + +=item --warning [,,] + +Exit with WARNING if the most recent email found is older than . The +optional and parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -w [,[,]] + +When using the --plugin option, only one parameter is supported (-w ) and it will apply +to the entire process. You can specify a warning threshold specific to each plugin in the +plugin command line. + +When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions. + +=item --critical [,,] + +Exit with CRITICAL if the most recent email found is older than . The +optional and parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -c [,[,]] + +When using the --plugin option, only one parameter is supported (-c ) and it will apply +to the entire process. You can specify a critical threshold specific to each plugin in the +plugin command line. + +When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions. + +=item --timeout + +=item --timeout , + +=item --timeout ,,... + +Exit with CRITICAL if the plugins do not return a status within the specified number of seconds. +When only one parameter is used, it applies to each plugin. When multiple parameters are used +(separated by commas) they apply to plugins in the same order the plugins were specified on the +command line. When using --timeout but not the --plugin option, the first parameter is for +check_smtp_send and the second is for check_imap_receive. + +=item --alert + +Exit with WARNING or CRITICAL only if a warning or error (--warning, --critical, or --timeout) +occurs for specified plugins. If a warning or error occurs for non-specified plugins that run +BEFORE the specified plugins, the exit status will be UNKNOWN. If a warning of error occurs +for non-specified plugins that run AFTER the specified plugins, the exit status will not be +affected. + +You would use this option if you are using check_email_delivery with the --plugin option and +the plugins you configure each use different servers, for example different SMTP and IMAP servers. +By default, if you do not use the --alert option, if anything goes wrong during the email delivery +check, a WARNING or CRITICAL alert will be issued. This means that if you define check_email_delivery +for the SMTP server only and the IMAP server fails, Nagios will alert you for the SMTP server which +would be misleading. If you define it for both the SMTP server and IMAP server and just one of them +fails, Nagios will alert you for both servers, which would still be misleading. If you have this +situation, you may want to use the --alert option. You define the check_email_delivery check for +both servers: for the SMTP server (first plugin) you use --alert 1, and for for the IMAP server +(second plugin) you use --alert 2. When check_email_delivery runs with --alert 1 and the SMTP +server fails, you will get the appropriate alert. If the IMAP server fails it will not affect the +status. When check_email_delivery runs with --alert 2 and the SMTP server fails, you will get the +UNKNOWN return code. If the IMAP server generates an alert you will get a WARNING or CRITICAL as +appropriate. + +You can repeat this option to specify multiple plugins that should cause an alert. +Do this if you have multiple plugins on the command line but some of them involve the same server. + +See also: --plugin. +Also known as: -A + + +=item --wait [,,...] + +How long to wait between sending the message and checking that it was received. View default with +the -vV option. + +When using the --plugin option, you can specify as many wait-between times as you have plugins +(minus the last plugin, because it makes no sense to wait after running the last one). For +example, if you use the --plugin option twice to specify an SMTP plugin and an IMAP plugin, and +you want to wait 5 seconds between sending and receiving, then you would specify --wait 5. A second +example, if you are using the --plugin option three times, then specifying -w 5 will wait 5 seconds +between the second and third plugins also. You can specify a different wait time +of 10 seconds between the second and third plugins, like this: -w 5,10. + +=item --hostname + +Address or name of the SMTP and IMAP server. Examples: mail.server.com, localhost, 192.168.1.100. +Also known as: -H + +=item --smtp-server + +Address or name of the SMTP server. Examples: smtp.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option. + +=item --smtp-port + +Service port on the SMTP server. Default is 25. + +=item --smtp-username + +=item --smtp-password + +Username and password to use when connecting to the SMTP server with the TLS option. +Use these options if the SMTP account has a different username/password than the +IMAP account you are testing. These options take precendence over the --username and +the --password options. + +These are shell-escaped; special characters are ok. + +=item --imap-server + +Address or name of the IMAP server. Examples: imap.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option. + +=item --imap-port + +Service port on the IMAP server. Default is 143. If you use SSL the default is 993. + +=item --imap-username + +=item --imap-password + +Username and password to use when connecting to the IMAP server. +Use these options if the IMAP account has a different username/password than the +SMTP account you are testing. These options take precendence over the --username and +the --password options. + +These are shell-escaped; special characters are ok. + +=item --username + +=item --password + +Username and password to use when connecting to IMAP server. +Also known as: -U -P + +Also used as the username and password for SMTP when the TLS option is enabled. +To specify a separate set of credentials for SMTP authentication, see the +options --smtp-username and --smtp-password. + +=item --imap-check-interval + +How long to wait between polls of the imap-server for the specified mail. Default is 5 seconds. + +=item --imap-retries + +How many times to poll the imap-server for the mail, before we give up. Default is 10. + +=item --body + +Use this option to specify the body of the email message. + +=item --header
+ +Use this option to set an arbitrary header in the message. You can use it multiple times. + +=item --mailto recipient@your.net + +You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed): + +$ check_email_delivery ... --mailto recipient@your.net,recipient2@your.net --mailfrom sender@your.net + +This argument is shell-escaped; special characters or angle brackets around the address are ok. + +=item --mailfrom sender@your.net + +Use this option to set the "from" address in the email. + +=item --imapssl +=item --noimapssl + +Use this to enable or disable SSL for the IMAP plugin. + +This argument is shell-escaped; special characters or angle brackets around the address are ok. + +=item --smtptls +=item --nosmtptls + +Use this to enable or disable TLS/AUTH for the SMTP plugin. + +=item --libexec + +Use this option to set the path of the Nagios libexec directory. The default is +/usr/local/nagios/libexec. This is where this plugin looks for the SMTP and IMAP +plugins that it depends on. + +=item --plugin + +This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It frees the plugin from depending on specific external plugins and generalizes the +work done to determine that the email loop is operational. When using the --plugin +option, the following options are ignored: libexec, imapssl, smtptls, hostname, +username, password, smtp*, imap*, mailto, mailfrom, body, header, search. + +Use this option multiple times to specify the complete trip. Typically, you would use +this twice to specify plugins for SMTP and IMAP, or SMTP and POP3. + +The output will be success if all the plugins return success. Each plugin should be a +standard Nagios plugin. + +A random token will be automatically generated and passed to each plugin specified on +the command line by substituting the string %TOKEN1%. + +Example usage: + + command_name check_email_delivery + command_line check_email_delivery + --plugin "$USER1$/check_smtp_send -H $ARG1$ --mailto recipient@your.net --mailfrom sender@your.net --header 'Subject: Nagios Test %TOKEN1%.'" + --plugin "$USER1$/check_imap_receive -H $ARG1$ -U $ARG1$ -P $ARG2$ -s SUBJECT -s 'Nagios Test %TOKEN1%.'" + +This technique allows for a lot of flexibility in configuring the plugins that test +each part of your email delivery loop. + +See also: --token. +Also known as: -p + +=item --token + +This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It can be used in conjunction with --plugin to control the tokens that are generated +and passed to the plugins, like %TOKEN1%. + +Use this option multiple times to specify formats for different tokens. For example, +if you want %TOKEN1% to consist of only alphabetical characters but want %TOKEN2% to +consist of only digits, then you might use these options: --token aaaaaa --token nnnnn + +Any tokens used in your plugin commands that have not been specified by --token +will default to --token U-X-Y + +Token formats: +a - alpha character (a-z) +n - numeric character (0-9) +c - alphanumeric character (a-z0-9) +h - hexadecimal character (0-9a-f) +U - unix time, seconds from epoch. eg 1193012441 +X - a word from the pgp even list. eg aardvark +Y - a word from the pgp odd list. eg adroitness + +Caution: It has been observed that some IMAP servers do not handle underscores well in the +search criteria. For best results, avoid using underscores in your tokens. Use hyphens or commas instead. + +See also: --plugin. +Also known as: -T + +The PGP word list was obtained from http://en.wikipedia.org/wiki/PGP_word_list + +=item --file + +Save (append) status information into the given tab-delimited file. Format used: + + token start-time end-time status plugin-num output + +Note: format may change in future versions and may become configurable. + +This option available as of version 0.6.2. + +Also known as: -F + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Send a message with custom headers + +$ check_email_delivery -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--username recipient --password secret + +EMAIL DELIVERY OK - 1 seconds + +=head2 Set warning and critical timeouts for receive plugin only: + +$ check_email_delivery -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--username recipient --password secret -w ,,5 -c ,,15 + +EMAIL DELIVERY OK - 1 seconds + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 CHANGES + + Wed Oct 29 13:08:00 PST 2005 + + version 0.1 + + Wed Nov 9 17:16:09 PST 2005 + + updated arguments to check_smtp_send and check_imap_receive + + added eval/alarm block to implement -c option + + added wait option to adjust sleep time between smtp and imap calls + + added delay-warn and delay-crit options to adjust email delivery warning thresholds + + now using an inline PluginReport package to generate the report + + copyright notice and GNU GPL + + version 0.2 + + Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson ) + + version 0.2.1 + + corrected bug in getoptions ($imap_server would never ever be set from command-line...) + + will not make $smtp_server and $imap_server == $host if they're defined on commandline + + added support for multiple polls of imap-server, with specified intervals + + changed default behaviour in check_imap_server (searches for the specific id in subject and deletes mails found) + + increased default delay_warn from 65 seconds to 95 seconds + + Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton ) + + fixed a bug in getoptions + + version 0.2.2 + + Tue Apr 24 21:17:53 PDT 2007 + + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature + + version 0.2.3 + + Fri Apr 27 20:32:53 PDT 2007 + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + changed connection error to display timeout only if timeout was the error + + default IMAP plugin is libexec/check_imap_receive (also checking for same but with .pl extension) + + default SMTP plugin is libexec/check_smtp_send (also checking for same but with .pl extension) + + removed default values for SMTP port and IMAP port to allow those plugins to set the defaults; so current behavior stays the same and will continue to make sense with SSL + + version 0.3 + + Thu Oct 11 10:00:00 EET 2007 (by Timo Virtaneva + + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers + + version 0.3.1 + + Sun Oct 21 11:01:03 PDT 2007 + + added support for TLS options to the SMTP plugin + + version 0.4 + + Sun Oct 21 16:17:14 PDT 2007 + + added support for arbitrary plugins to send and receive mail (or anthing else!). see the --plugin option. + + version 0.5 + + Tue Dec 4 07:36:20 PST 2007 + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + shortcut option for --token is now -T to avoid clash with standard shortcut -t for --timeout + + fixed some minor pod formatting issues for perldoc + + version 0.5.1 + + Sat Dec 15 07:39:59 PST 2007 + + improved compatibility with Nagios embedded perl (ePN) + + version 0.5.2 + + Thu Jan 17 20:27:36 PST 2008 (by Timo Virtaneva on Thu Oct 11 10:00:00 EET 2007) + + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers + + version 0.5.3 + + Mon Jan 28 22:11:02 PST 2008 + + fixed a bug, smtp-password and imap-password are now string parameters + + added --alert option to allow selection of which plugin(s) should cause a WARNING or CRITICAL alert + + version 0.6 + + Mon Feb 11 19:09:37 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.6.1 + + Mon May 26 10:39:19 PDT 2008 + + added --file option to allow plugin to record status information into a tab-delimited file + + changed default token from U_X_Y to U-X-Y + + version 0.6.2 + + Wed Jan 14 08:29:35 PST 2009 + + fixed a bug that the --header parameter was not being passed to the smtp plugin. + + version 0.6.3 + + Mon Jun 8 15:43:48 PDT 2009 + + added performance data for use with PNP4Nagios! (thanks to Ben Ritcey for the patch) + + version 0.6.4 + + Wed Sep 16 07:10:10 PDT 2009 + + added elapsed time in seconds to performance data + + version 0.6.5 + + Fri Oct 8 19:48:44 PDT 2010 + + fixed uniform IMAP and SMTP username and password bug (thanks to Micle Moerenhout for pointing it out) + + version 0.6.6 + + Mon Jan 3 08:24:23 PST 2011 + + added shell escaping for smtp-username, smtp-password, mailto, mailfrom, imap-username, and imap-password arguments + + version 0.7.0 + + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.1 + + Sun Jun 12 17:17:06 AST 2011 + + added --imap-mailbox option to pass through to check_imap_receive --mailbox option + + added --ssl option to conveniently enable both --smtp-tls and --imap-ssl + + version 0.7.2 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2005-2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_email_delivery_epn b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_email_delivery_epn new file mode 100644 index 0000000..b0cc304 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_email_delivery_epn @@ -0,0 +1,498 @@ +#!/usr/bin/perl +use strict; +my $VERSION = '0.7.1'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +# look for required modules +exit $status{UNKNOWN} unless load_modules(qw/Getopt::Long/); + +BEGIN { + if( grep { /^--hires$/ } @ARGV ) { + eval "use Time::HiRes qw(time);"; + warn "Time::HiRes not installed\n" if $@; + } +} + +# get options from command line +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $host = ""; +my $smtp_server = ""; +my $smtp_port = ""; +my $imap_server = ""; +my $smtp_username = ""; +my $smtp_password = ""; +my $smtp_tls = ""; +my $imap_port = ""; +my $imap_username = ""; +my $imap_password = ""; +my $imap_mailbox = ""; +my $username = ""; +my $password = ""; +my $ssl = ""; +my $imap_ssl = ""; +my $mailto = ""; +my $mailfrom = ""; +my @header = (); +my $body = ""; +my $warnstr = ""; +my $critstr = ""; +my $waitstr = ""; +my $delay_warn = 95; +my $delay_crit = 300; +my $smtp_warn = 15; +my $smtp_crit = 30; +my $imap_warn = 15; +my $imap_crit = 30; +my $timeout = ""; +my @alert_plugins = (); +my $imap_interval = 5; +my $imap_retries = 5; +my @plugins = (); +my @token_formats = (); +my $tokenfile = ""; +my $default_crit = 30; +my $default_warn = 15; +my $default_wait = 5; +my $default_timeout = 60; +my $time_hires = ""; +my $libexec = "/usr/local/nagios/libexec"; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + "w|warning=s"=>\$warnstr,"c|critical=s"=>\$critstr, "t|timeout=s"=>\$timeout, + "libexec=s"=>\$libexec, + # plugin settings + "p|plugin=s"=>\@plugins, "T|token=s"=>\@token_formats, + "A|alert=i"=>\@alert_plugins, + "F|file=s"=>\$tokenfile, + # common settings + "H|hostname=s"=>\$host, + "U|username=s"=>\$username,"P|password=s"=>\$password, + "ssl!"=>\$ssl, + # smtp settings + "smtp-server=s"=>\$smtp_server,"smtp-port=i"=>\$smtp_port, + "mailto=s"=>\$mailto, "mailfrom=s",\$mailfrom, + "header=s"=>\@header, "body=s"=>\$body, + # smtp-tls settings + "smtptls!"=>\$smtp_tls, + "smtp-username=s"=>\$smtp_username,"smtp-password=s"=>\$smtp_password, + # delay settings + "wait=s"=>\$waitstr, + # imap settings + "imap-server=s"=>\$imap_server,"imap-port=i"=>\$imap_port, + "imap-username=s"=>\$imap_username,"imap-password=s"=>\$imap_password, + "imap-mailbox=s"=>\$imap_mailbox, + "imap-check-interval=i"=>\$imap_interval,"imap-retries=i"=>\$imap_retries, + "imapssl!"=>\$imap_ssl, + # Time + "hires"=>\$time_hires, + ); + +if( $show_version ) { + print "$VERSION\n"; + if( $verbose ) { + print "Warning threshold: $delay_warn seconds\n"; + print "Critical threshold: $delay_crit seconds\n"; + print "Default wait: $default_wait seconds\n"; + print "Default timeout: $default_timeout seconds\n"; + } + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +if( $host ) { + $smtp_server = $host if $smtp_server eq ""; + $imap_server = $host if $imap_server eq ""; +} + +if( $username ) { + $smtp_username = $username if $smtp_username eq ""; + $imap_username = $username if $imap_username eq ""; +} + +if( $password ) { + $smtp_password = $password if $smtp_password eq ""; + $imap_password = $password if $imap_password eq ""; +} + +if( $ssl ) { + $imap_ssl = $ssl if $imap_ssl eq ""; + $smtp_tls = $ssl if $smtp_tls eq ""; +} + +if( $help_usage + || + ( + scalar(@plugins) == 0 + && + ( + $smtp_server eq "" || $mailto eq "" || $mailfrom eq "" + || $imap_server eq "" || $username eq "" || $password eq "" + ) + ) + ) { + print "Usage 1: $0 -H host \n\t". + "--mailto recipient\@your.net --mailfrom sender\@your.net --body 'message' \n\t". + "--username username --password password \n\t". + "[-w ] [-c ]\n\t" . + "[--imap-check-interval ] [--imap-retries ]\n"; + print "Usage 2: $0 \n\t". + "-p 'first plugin command with %TOKEN1% embedded' \n\t". + "-p 'second plugin command with %TOKEN1% embedded' \n\t". + "[-w ,] [-c ,] \n"; + exit $status{UNKNOWN}; +} + +# determine thresholds +my @warning_times = split(",", $warnstr); +my @critical_times = split(",", $critstr); +my @alarm_times = split(",", $timeout); +my @wait_times = split(",", $waitstr); +my ($dw,$sw,$rw) = split(",", $warnstr); +my ($dc,$sc,$rc) = split(",", $critstr); +my ($wait) = split(",", $waitstr); +$delay_warn = $dw if defined $dw and $dw ne ""; +$smtp_warn = $sw if defined $sw and $sw ne ""; +$imap_warn = $rw if defined $rw and $rw ne ""; +$delay_crit = $dc if defined $dc and $dc ne ""; +$smtp_crit = $sc if defined $sc and $sc ne ""; +$imap_crit = $rc if defined $rc and $rc ne ""; +my $smtp_thresholds = ""; +$smtp_thresholds .= "-w $smtp_warn " if defined $smtp_warn and $smtp_warn ne ""; +$smtp_thresholds .= "-c $smtp_crit " if defined $smtp_crit and $smtp_crit ne ""; +my $imap_thresholds = ""; +$imap_thresholds .= "-w $imap_warn " if defined $imap_warn and $imap_warn ne ""; +$imap_thresholds .= "-c $imap_crit " if defined $imap_crit and $imap_crit ne ""; +$imap_thresholds .= "--imap-check-interval $imap_interval " if defined $imap_interval and $imap_interval ne ""; +$imap_thresholds .= "--imap-retries $imap_retries " if defined $imap_retries and $imap_retries ne ""; +if( scalar(@alarm_times) == 1 ) { + $default_timeout = shift(@alarm_times); +} + +# determine which other options to include +my $smtp_options = ""; +$smtp_options .= "-H $smtp_server " if defined $smtp_server and $smtp_server ne ""; +$smtp_options .= "-p $smtp_port " if defined $smtp_port and $smtp_port ne ""; +$smtp_options .= "--tls " if defined $smtp_tls and $smtp_tls; +$smtp_options .= "-U ".shellquote($smtp_username)." " if defined $smtp_username and $smtp_username ne ""; +$smtp_options .= "-P ".shellquote($smtp_password)." " if defined $smtp_password and $smtp_password ne ""; +$smtp_options .= "--mailto ".shellquote($mailto)." " if defined $mailto and $mailto ne ""; +$smtp_options .= "--mailfrom ".shellquote($mailfrom)." " if defined $mailfrom and $mailfrom ne ""; +foreach my $h( @header ) { + $smtp_options .= "--header ".shellquote($h)." "; +} +my $imap_options = ""; +$imap_options .= "-H $imap_server " if defined $imap_server and $imap_server ne ""; +$imap_options .= "-p $imap_port " if defined $imap_port and $imap_port ne ""; +$imap_options .= "-U ".shellquote($imap_username)." " if defined $imap_username and $imap_username ne ""; +$imap_options .= "-P ".shellquote($imap_password)." " if defined $imap_password and $imap_password ne ""; +$imap_options .= "--mailbox ".shellquote($imap_mailbox)." " if defined $imap_mailbox and $imap_mailbox ne ""; +$imap_options .= "--ssl " if defined $imap_ssl and $imap_ssl; + + +# create the report object +my $report = new PluginReport; +my @report_plugins = (); # populated later with either (smtp,imap) or (plugin1,plugin2,...) +my $time_start; # initialized later with time the work actually starts + +# create token formats for use with the plugins +my @alpha = qw/a b c d e f g h i j k l m n o p q r s t u v w x y z/; +my @numeric = qw/0 1 2 3 4 5 6 7 8 9/; +my @hex = qw/0 1 2 3 4 5 6 7 8 9 a b c d e f/; +my @pgp_even = qw/aardvark absurd accrue acme adrift adult afflict ahead aimless Algol allow alone ammo ancient apple artist assume Athens atlas Aztec baboon backfield backward banjo beaming bedlamp beehive beeswax befriend Belfast berserk billiard bison blackjack blockade blowtorch bluebird bombast bookshelf brackish breadline breakup brickyard briefcase Burbank button buzzard cement chairlift chatter checkup chisel choking chopper Christmas clamshell classic classroom cleanup clockwork cobra commence concert cowbell crackdown cranky crowfoot crucial crumpled crusade cubic dashboard deadbolt deckhand dogsled dragnet drainage dreadful drifter dropper drumbeat drunken Dupont dwelling eating edict egghead eightball endorse endow enlist erase escape exceed eyeglass eyetooth facial fallout flagpole flatfoot flytrap fracture framework freedom frighten gazelle Geiger glitter glucose goggles goldfish gremlin guidance hamlet highchair hockey indoors indulge inverse involve island jawbone keyboard kickoff kiwi klaxon locale lockup merit minnow miser Mohawk mural music necklace Neptune newborn nightbird Oakland obtuse offload optic orca payday peachy pheasant physique playhouse Pluto preclude prefer preshrunk printer prowler pupil puppy python quadrant quiver quota ragtime ratchet rebirth reform regain reindeer rematch repay retouch revenge reward rhythm ribcage ringbolt robust rocker ruffled sailboat sawdust scallion scenic scorecard Scotland seabird select sentence shadow shamrock showgirl skullcap skydive slingshot slowdown snapline snapshot snowcap snowslide solo southward soybean spaniel spearhead spellbind spheroid spigot spindle spyglass stagehand stagnate stairway standard stapler steamship sterling stockman stopwatch stormy sugar surmount suspense sweatband swelter tactics talon tapeworm tempest tiger tissue tonic topmost tracker transit trauma treadmill Trojan trouble tumor tunnel tycoon uncut unearth unwind uproot upset upshot vapor village virus Vulcan waffle wallet watchword wayside willow woodlark Zulu/; +my @pgp_odd = qw/adroitness adviser aftermath aggregate alkali almighty amulet amusement antenna applicant Apollo armistice article asteroid Atlantic atmosphere autopsy Babylon backwater barbecue belowground bifocals bodyguard bookseller borderline bottomless Bradbury bravado Brazilian breakaway Burlington businessman butterfat Camelot candidate cannonball Capricorn caravan caretaker celebrate cellulose certify chambermaid Cherokee Chicago clergyman coherence combustion commando company component concurrent confidence conformist congregate consensus consulting corporate corrosion councilman crossover crucifix cumbersome customer Dakota decadence December decimal designing detector detergent determine dictator dinosaur direction disable disbelief disruptive distortion document embezzle enchanting enrollment enterprise equation equipment escapade Eskimo everyday examine existence exodus fascinate filament finicky forever fortitude frequency gadgetry Galveston getaway glossary gossamer graduate gravity guitarist hamburger Hamilton handiwork hazardous headwaters hemisphere hesitate hideaway holiness hurricane hydraulic impartial impetus inception indigo inertia infancy inferno informant insincere insurgent integrate intention inventive Istanbul Jamaica Jupiter leprosy letterhead liberty maritime matchmaker maverick Medusa megaton microscope microwave midsummer millionaire miracle misnomer molasses molecule Montana monument mosquito narrative nebula newsletter Norwegian October Ohio onlooker opulent Orlando outfielder Pacific pandemic Pandora paperweight paragon paragraph paramount passenger pedigree Pegasus penetrate perceptive performance pharmacy phonetic photograph pioneer pocketful politeness positive potato processor provincial proximate puberty publisher pyramid quantity racketeer rebellion recipe recover repellent replica reproduce resistor responsive retraction retrieval retrospect revenue revival revolver sandalwood sardonic Saturday savagery scavenger sensation sociable souvenir specialist speculate stethoscope stupendous supportive surrender suspicious sympathy tambourine telephone therapist tobacco tolerance tomorrow torpedo tradition travesty trombonist truncated typewriter ultimate undaunted underfoot unicorn unify universe unravel upcoming vacancy vagabond vertigo Virginia visitor vocalist voyager warranty Waterloo whimsical Wichita Wilmington Wyoming yesteryear Yucatan/; +my %formats = ( + 'a' => sub { pick_random(@alpha) }, + 'n' => sub { pick_random(@numeric) }, + 'c' => sub { pick_random(@alpha,@numeric) }, + 'h' => sub { pick_random(@hex) }, + 'U' => sub { time }, + 'X' => sub { pick_random(@pgp_even) }, + 'Y' => sub { pick_random(@pgp_odd) }, +); +if( scalar(@plugins) ) { + # scan the plugin commands for use of tokens to count how many we need + my $token_count = 0; + foreach my $p (@plugins) { + my @matches = sort ($p =~ m/%TOKEN(\d+)%/g); + my $max = pop @matches; + $token_count = $max if defined($max) && $max > $token_count; + } + # create the tokens + my @tokens = (); + foreach my $t (1..$token_count) { + my $format = shift @token_formats; + $format = "U-X-Y" unless $format; + my @format_characters = split(//, $format); + my $token = ""; + foreach my $c (@format_characters) { + if( defined $formats{$c} ) { + $token .= &{$formats{$c}}; + } + else { + $token .= $c; + } + } + push @tokens, $token; + } + # substitute the tokens into each plugin command + foreach my $p (@plugins) { + foreach my $t (1..$token_count) { + my $token = $tokens[$t-1]; + $p =~ s/%TOKEN$t%/$token/g; + } + } + # mark plugins that are allowed to generate alerts. default behavior is to alert for all plugins. + my %alert_plugins = (); + if( scalar(@alert_plugins) > 0 ) { + %alert_plugins = map { $_ => 1 } @alert_plugins; + } + else { + %alert_plugins = map { $_ => 1 } (1..scalar(@plugins)); + } + # run each plugin and store its output in a report + $time_start = time; + my $i = 0; + foreach my $p( @plugins ) { + $i++; + my $plugin_timeout = shift(@alarm_times) || $default_timeout; + # run the plugin + eval { + local $SIG{ALRM} = sub { die "exceeded timeout $plugin_timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $plugin_timeout; + my $output = `$p`; + chomp $output; + if( $output !~ m/OK|WARNING|CRITICAL/ ) { + print "EMAIL DELIVERY UNKNOWN - plugin $i error: $output\n"; + print "Plugin $i: $p\n" if $verbose; + # record tokens in a file if option is enabled + record_tokens($tokenfile,\@tokens,$time_start,undef,'UNKNOWN',$i,$output) if $tokenfile; + exit $status{UNKNOWN}; + } + if( $output =~ m/CRITICAL/ && $alert_plugins{$i} ) { + print "EMAIL DELIVERY CRITICAL - plugin $i failed: $output\n"; + print "Plugin $i: $p" if $verbose; + # record tokens in a file if option is enabled + record_tokens($tokenfile,\@tokens,$time_start,undef,'CRITICAL',$i,$output) if $tokenfile; + exit $status{CRITICAL}; + } + if( $output =~ m/WARNING/ && $alert_plugins{$i} ) { + print "EMAIL DELIVERY WARNING - plugin $i warning: $output\n"; + print "Plugin $i: $p\n" if $verbose; + # record tokens in a file if option is enabled + record_tokens($tokenfile,\@tokens,$time_start,undef,'WARNING',$i,$output) if $tokenfile; + exit $status{WARNING}; + } + $report->{"plugin".$i} = $output; + alarm 0; + }; + if( $@ && $alert_plugins{$i} ) { + print "EMAIL DELIVERY CRITICAL - Could not run plugin $i: $@\n"; + print "Plugin $i: $p\n" if $verbose; + exit $status{CRITICAL}; + } + # if this wasn't the last plugin, wait before continuing + if( $i < scalar(@plugins) ) { + my $wait = shift(@wait_times) || $default_wait; + sleep $wait; + } + # compatibility with the "not using plugins" method... pretend to calculate the total round trip time (the delay) using data from the plugins ... + $report->{max} = 0; + $report->{delay} = 0; + } + # register the list of reports + foreach my $r ( 1..scalar(@plugins)) { + push @report_plugins, "plugin".$r; + } + # record tokens in a file if option is enabled + my $tmp_long_report = join(", ", map { "$_: $report->{$_}" } @report_plugins ) if $tokenfile; + record_tokens($tokenfile,\@tokens,$time_start,time,'OK',scalar(@plugins),$tmp_long_report) if $tokenfile; +} +else { + # not using plugins. + $time_start = time; + + # send email via SMTP + my $id = $time_start; # XXX should include localhost name maybe or some random number in case the same mailbox is used for multiple delivery tests + + my $smtp_plugin = "$libexec/check_smtp_send"; + $smtp_plugin = "$libexec/check_smtp_send.pl" unless -e $smtp_plugin; + my $smtp_timeout = shift(@alarm_times) || $default_timeout; + eval { + local $SIG{ALRM} = sub { die "exceeded timeout $smtp_timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $smtp_timeout; + my $smtp = `$smtp_plugin $smtp_options --header 'Subject: Nagios Message SMTP $smtp_server ID $id.' --body 'Nagios Email Delivery Plugin\n$body' $smtp_thresholds`; + if( $smtp !~ m/OK|WARNING|CRITICAL/ ) { + print "EMAIL DELIVERY UNKNOWN - smtp unknown: $smtp\n"; + exit $status{UNKNOWN}; + } + if( $smtp =~ m/CRITICAL/ ) { + print "EMAIL DELIVERY CRITICAL - smtp failed: $smtp\n"; + exit $status{CRITICAL}; + } + chomp $smtp; + $report->{smtp} = $smtp; + alarm 0; + }; + if( $@ ) { + print "EMAIL DELIVERY CRITICAL - Could not connect to SMTP server $smtp_server: $@\n"; + exit $status{CRITICAL}; + } + + # wait before checking the delivery + $wait = shift(@wait_times) || $default_wait; + sleep $wait; + + # check email via IMAP + my $imap_plugin = "$libexec/check_imap_receive"; + $imap_plugin = "$libexec/check_imap_receive.pl" unless -e $imap_plugin; + my $imap_timeout = shift(@alarm_times) || $default_timeout; + eval { + local $SIG{ALRM} = sub { die "exceeded timeout $imap_timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $imap_timeout; + my $imap = `$imap_plugin $imap_options -s SUBJECT -s 'Nagios Message SMTP $smtp_server ID' --capture-max 'Nagios Message SMTP $smtp_server ID (\\d+)' --nodelete-captured $imap_thresholds`; + if( $imap !~ m/OK|WARNING|CRITICAL/ ) { + print "EMAIL DELIVERY UNKNOWN - imap unknown: $imap\n"; + exit $status{UNKNOWN}; + } + if( $imap =~ m/CRITICAL/ ) { + print "EMAIL DELIVERY CRITICAL - imap failed: $imap\n"; + exit $status{CRITICAL}; + } + if( $imap =~ m/ (\d+) max/ ) { + my $last_received = $1; + $report->{max} = $1; + my $delay = time - $last_received; + $report->{delay} = $delay; + } + chomp $imap; + $report->{imap} = $imap; + alarm 0; + }; + if( $@ ) { + print "EMAIL DELIVERY CRITICAL - Could not connect to IMAP server $imap_server: $@\n"; + exit $status{CRITICAL}; + } + # register the list of reports + push @report_plugins, ("smtp","imap"); +} + + +# calculate elapsed time and issue warnings +my $time_end = time; +my $elapsedtime = $time_end - $time_start; +$report->{seconds} = $elapsedtime; + +my @warning = (); +my @critical = (); + +push @warning, "most recent received $report->{delay} seconds ago" if( defined($report->{delay}) && $report->{delay} > $delay_warn ); +push @critical, "most recent received $report->{delay} seconds ago" if( defined($report->{delay}) && $report->{delay} > $delay_crit ); +push @warning, "no emails found" if( !defined($report->{delay}) ); + +# print report and exit with known status +my $perf_data = "delay=".$report->{delay}."s;$delay_warn;$delay_crit;0 elapsed=".$report->{seconds}."s"; # TODO: need a component for safely generating valid perf data format. for notes on the format, see http://www.perfparse.de/tiki-view_faq.php?faqId=6 +my $short_report = $report->text(qw/seconds delay/) . " | $perf_data"; +my $long_report = join("", map { "$_: $report->{$_}\n" } @report_plugins ); +if( scalar @critical ) { + my $alerts = join(", ", @critical); + print "EMAIL DELIVERY CRITICAL - $alerts; $short_report\n"; + print $long_report if $verbose; + exit $status{CRITICAL}; +} +if( scalar @warning ) { + my $alerts = join(", ", @warning); + print "EMAIL DELIVERY WARNING - $alerts; $short_report\n"; + print $long_report if $verbose; + exit $status{WARNING}; +} +print "EMAIL DELIVERY OK - $short_report\n"; +print $long_report if $verbose; +exit $status{OK}; + +# utility to load required modules. exits if unable to load one or more of the modules. +sub load_modules { + my @missing_modules = (); + foreach( @_ ) { + eval "require $_"; + push @missing_modules, $_ if $@; + } + if( @missing_modules ) { + print "Missing perl modules: @missing_modules\n"; + return 0; + } + return 1; +} + +# returns one random character from a set of characters +sub pick_random { + my @set = @_; + my $size = scalar @set; + my $string = $set[int(rand($size))]; + return $string; +} + +# appens tokens and times to a tab-separated value file +sub record_tokens { + my ($tokenfile,$tokens,$time_start,$time_end,$status,$plugin_num,$output) = @_; + if( $tokenfile ) { + my @tokens = @$tokens; + $time_end = "" unless defined $time_end; + $status = "" unless defined $status; + $plugin_num = "" unless defined $plugin_num; + $output = "" unless defined $output; + print "saving ".scalar(@tokens)." tokens into $tokenfile\n" if $verbose; + open(TOKENFILE,">>$tokenfile"); + foreach(@tokens) { + print TOKENFILE "$_\t$time_start\t$time_end\t$status\t$plugin_num\t$output\n"; + } + close(TOKENFILE); + } +} + +# wraps argument in single-quotes and escapes any single-quotes in the argument +sub shellquote { + my $str = shift || ""; + $str =~ s/\'/\'\\\'\'/g; + return "'$str'"; +} + + +# NAME +# PluginReport +# SYNOPSIS +# $report = new PluginReport; +# $report->{label1} = "value1"; +# $report->{label2} = "value2"; +# print $report->text(qw/label1 label2/); +package PluginReport; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub text { + my ($self,@labels) = @_; + my @report = map { "$self->{$_} $_" } grep { defined $self->{$_} } @labels; + my $text = join(", ", @report); + return $text; +} + +package main; +1; + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_quota b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_quota new file mode 100644 index 0000000..13f3504 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_quota @@ -0,0 +1,431 @@ +#!/usr/bin/perl +use strict; +my $VERSION = '0.2'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +#### IDEA AND INITIAL IMPLEMENTATION BASED ON CHECK_IMAP_RECEIVE WAS CONTRIBUTED BY JOHAN ROMME from THE NETHERLANDS 14 Oct 2011 + +# look for required modules +exit $status{UNKNOWN} unless load_modules(qw/Getopt::Long Mail::IMAPClient/); + +BEGIN { + if( grep { /^--hires$/ } @ARGV ) { + eval "use Time::HiRes qw(time);"; + warn "Time::HiRes not installed\n" if $@; + } +} + +# get options from command line +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $imap_server = ""; +my $default_imap_port = "143"; +my $default_imap_ssl_port = "993"; +my $imap_port = ""; +my $username = ""; +my $password = ""; +my $mailbox = "INBOX"; +my $warntime = 15; +my $criticaltime = 30; +my $timeout = 60; +my $peek = ""; +my $ssl = 0; +my $tls = 0; +my $time_hires = ""; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + "w|warning=i"=>\$warntime,"c|critical=i"=>\$criticaltime,"t|timeout=i"=>\$timeout, + # imap settings + "H|hostname=s"=>\$imap_server,"p|port=i"=>\$imap_port, + "U|username=s"=>\$username,"P|password=s"=>\$password, "m|mailbox=s"=>\$mailbox, + "ssl!"=>\$ssl, "tls!"=>\$tls, + # search settings + "peek!"=>\$peek, + # Time + "hires"=>\$time_hires, + ); + +if( $show_version ) { + print "$VERSION\n"; + if( $verbose ) { + print "Default warning threshold: $warntime seconds\n"; + print "Default critical threshold: $criticaltime seconds\n"; + print "Default timeout: $timeout seconds\n"; + } + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +my @required_module = (); +push @required_module, 'IO::Socket::SSL' if $ssl || $tls; +exit $status{UNKNOWN} unless load_modules(@required_module); + +if( $help_usage + || + ( $imap_server eq "" || $username eq "" || $password eq "" ) + ) { + print "Usage: $0 -H host [-p port] -U username -P password [--imap-retries ]\n"; + exit $status{UNKNOWN}; +} + + +# initialize +my $report = new PluginReport; +my $time_start = time; + +# connect to IMAP server +print "connecting to server $imap_server\n" if $verbose > 2; +my $imap; +eval { + local $SIG{ALRM} = sub { die "exceeded timeout $timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $timeout; + + if( $ssl || $tls ) { + $imap_port = $default_imap_ssl_port unless $imap_port; + my $socket = IO::Socket::SSL->new("$imap_server:$imap_port"); + die IO::Socket::SSL::errstr() unless $socket; + $socket->autoflush(1); + $imap = Mail::IMAPClient->new(Socket=>$socket, Debug => 0 ); + $imap->State(Mail::IMAPClient->Connected); + $imap->_read_line() if "$Mail::IMAPClient::VERSION" le "2.2.9"; # necessary to remove the server's "ready" line from the input buffer for old versions of Mail::IMAPClient. Using string comparison for the version check because the numeric didn't work on Darwin and for Mail::IMAPClient the next version is 2.3.0 and then 3.00 so string comparison works + $imap->User($username); + $imap->Password($password); + $imap->login() or die "$@"; + } + else { + $imap_port = $default_imap_port unless $imap_port; + $imap = Mail::IMAPClient->new(Debug => 0 ); + $imap->Server("$imap_server:$imap_port"); + $imap->User($username); + $imap->Password($password); + $imap->connect() or die "$@"; + } + + $imap->Peek(1) if $peek; + $imap->Ignoresizeerrors(1); + + alarm 0; +}; +if( $@ ) { + chomp $@; + print "IMAP QUOTA CRITICAL - Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +unless( $imap ) { + print "IMAP QUOTA CRITICAL - Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +my $time_connected = time; + +my $quotaUsed; +my $quotaLimit; +my $quotaPercentage; +my $quotaPercentageWarning = 80; +my $quotaPercentageCritical = 90; +my $quotaMessage; + +# look for the quota limits +my $tries = 0; +my @msgs; + +eval { + my $k; + my @l = $imap->getquotaroot(); + foreach $k (@l) { + print "$k\n" if $verbose > 2; + if ($k =~ /STORAGE +(\d+) +(\d+)/) { + $quotaUsed = $1; + $quotaLimit = $2; + } + } + if (!length($quotaUsed) && !length($quotaLimit)) { + print "no answer from imap host\n" if $verbose > 2; + } elsif (!length($quotaUsed) || !length($quotaLimit) { + print "incorrect answer from imap host\n"; + $imap->close(); + exit $status{UNKNOWN}; + } else { + $quotaPercentage = sprintf("%.1f", (100 * $quotaUsed) / $quotaLimit); + $quotaMessage = "$quotaUsed $quotaLimit - $quotaPercentage%"; + } +}; +if( $@ ) { + chomp $@; + print "IMAP QUOTA CRITICAL - Could not check quota at $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} + + +# disconnect from IMAP server +print "disconnecting from server\n" if $verbose > 2; +$imap->logout(); + +# calculate elapsed time and issue warnings +my $time_end = time; +my $elapsedtime = $time_end - $time_start; +$report->{seconds} = $elapsedtime; + +# print report and exit with known status + +if($quotaPercentage >= $quotaPercentageCritical) { + print "IMAP QUOTA CRITICAL - $quotaMessage\n"; + exit $status{CRITICAL}; +} +if($quotaPercentage >= $quotaPercentageWarning) { + print "IMAP QUOTA WARNING - $quotaMessage\n"; + exit $status{WARNING}; +} +print "IMAP QUOTA OK - $quotaMessage\n"; +exit $status{OK}; + + +# utility to load required modules. exits if unable to load one or more of the modules. +sub load_modules { + my @missing_modules = (); + foreach( @_ ) { + eval "require $_"; + push @missing_modules, $_ if $@; + } + if( @missing_modules ) { + print "Missing perl modules: @missing_modules\n"; + return 0; + } + return 1; +} + + +# NAME +# PluginReport +# SYNOPSIS +# $report = new PluginReport; +# $report->{label1} = "value1"; +# $report->{label2} = "value2"; +# print $report->text(qw/label1 label2/); +package PluginReport; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub text { + my ($self,@labels) = @_; + my @report = map { "$self->{$_} $_" } grep { defined $self->{$_} } @labels; + my $text = join(", ", @report); + return $text; +} + + +package main; +1; + +__END__ + + +=pod + +=head1 NAME + +check_imap_quota - connects to an IMAP account and checks the quota + +=head1 SYNOPSIS + + check_imap_quota -vV + check_imap_quota -? + check_imap_quota --help + +=head1 OPTIONS + +=over + +=item --warning + +Warn if it takes longer than to connect to the IMAP server. Default is 15 seconds. +Also known as: -w + +=item --critical + +Return a critical status if it takes longer than to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical +Also known as: -c + +=item --timeout + +Abort with critical status if it takes longer than to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t + +=item --hostname + +Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H + +=item --port + +Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p + +=item --username + +=item --password + +Username and password to use when connecting to IMAP server. +Also known as: -U -P + +=item --mailbox + +Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m + +=item --ssl + +=item --nossl + +Enable SSL protocol. Requires IO::Socket::SSL. + +Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option. + +Use the nossl option to turn off the ssl option. + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. + +If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Report how many emails are in the mailbox + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s ALL --nodelete + + IMAP RECEIVE OK - 1 seconds, 7 found + +=head2 Report the email with the highest value + +Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated): + + To: mailuser@server.net + From: autoscript@server.net + Subject: Results of Autoscript + Date: Wed, 09 Nov 2005 08:30:40 -0800 + Message-ID: + + Homeruns 5 + +And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values: + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)" --nodelete-captured + + IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted + +=head2 Troubleshoot your search parameters + +Add the --nodelete and --imap-retries=1 parameters to your command line. + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 SEE ALSO + +http://nagios.org/ +http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod +http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod + +=head1 CHANGES + + Fri Nov 11 04:53:09 AST 2011 + + version 0.1 created with quota code contributed by Johan Romme + + Tue Dec 20 17:38:04 PST 2011 + + fixed bug where a quota of 0 was reported as an incorrect response from the server, thanks to Eike Arndt + + version 0.2 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_quota_epn b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_quota_epn new file mode 100644 index 0000000..d43877f --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_quota_epn @@ -0,0 +1,235 @@ +#!/usr/bin/perl +use strict; +my $VERSION = '0.2'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +#### IDEA AND INITIAL IMPLEMENTATION BASED ON CHECK_IMAP_RECEIVE WAS CONTRIBUTED BY JOHAN ROMME from THE NETHERLANDS 14 Oct 2011 + +# look for required modules +exit $status{UNKNOWN} unless load_modules(qw/Getopt::Long Mail::IMAPClient/); + +BEGIN { + if( grep { /^--hires$/ } @ARGV ) { + eval "use Time::HiRes qw(time);"; + warn "Time::HiRes not installed\n" if $@; + } +} + +# get options from command line +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $imap_server = ""; +my $default_imap_port = "143"; +my $default_imap_ssl_port = "993"; +my $imap_port = ""; +my $username = ""; +my $password = ""; +my $mailbox = "INBOX"; +my $warntime = 15; +my $criticaltime = 30; +my $timeout = 60; +my $peek = ""; +my $ssl = 0; +my $tls = 0; +my $time_hires = ""; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + "w|warning=i"=>\$warntime,"c|critical=i"=>\$criticaltime,"t|timeout=i"=>\$timeout, + # imap settings + "H|hostname=s"=>\$imap_server,"p|port=i"=>\$imap_port, + "U|username=s"=>\$username,"P|password=s"=>\$password, "m|mailbox=s"=>\$mailbox, + "ssl!"=>\$ssl, "tls!"=>\$tls, + # search settings + "peek!"=>\$peek, + # Time + "hires"=>\$time_hires, + ); + +if( $show_version ) { + print "$VERSION\n"; + if( $verbose ) { + print "Default warning threshold: $warntime seconds\n"; + print "Default critical threshold: $criticaltime seconds\n"; + print "Default timeout: $timeout seconds\n"; + } + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +my @required_module = (); +push @required_module, 'IO::Socket::SSL' if $ssl || $tls; +exit $status{UNKNOWN} unless load_modules(@required_module); + +if( $help_usage + || + ( $imap_server eq "" || $username eq "" || $password eq "" ) + ) { + print "Usage: $0 -H host [-p port] -U username -P password [--imap-retries ]\n"; + exit $status{UNKNOWN}; +} + + +# initialize +my $report = new PluginReport; +my $time_start = time; + +# connect to IMAP server +print "connecting to server $imap_server\n" if $verbose > 2; +my $imap; +eval { + local $SIG{ALRM} = sub { die "exceeded timeout $timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $timeout; + + if( $ssl || $tls ) { + $imap_port = $default_imap_ssl_port unless $imap_port; + my $socket = IO::Socket::SSL->new("$imap_server:$imap_port"); + die IO::Socket::SSL::errstr() unless $socket; + $socket->autoflush(1); + $imap = Mail::IMAPClient->new(Socket=>$socket, Debug => 0 ); + $imap->State(Mail::IMAPClient->Connected); + $imap->_read_line() if "$Mail::IMAPClient::VERSION" le "2.2.9"; # necessary to remove the server's "ready" line from the input buffer for old versions of Mail::IMAPClient. Using string comparison for the version check because the numeric didn't work on Darwin and for Mail::IMAPClient the next version is 2.3.0 and then 3.00 so string comparison works + $imap->User($username); + $imap->Password($password); + $imap->login() or die "$@"; + } + else { + $imap_port = $default_imap_port unless $imap_port; + $imap = Mail::IMAPClient->new(Debug => 0 ); + $imap->Server("$imap_server:$imap_port"); + $imap->User($username); + $imap->Password($password); + $imap->connect() or die "$@"; + } + + $imap->Peek(1) if $peek; + $imap->Ignoresizeerrors(1); + + alarm 0; +}; +if( $@ ) { + chomp $@; + print "IMAP QUOTA CRITICAL - Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +unless( $imap ) { + print "IMAP QUOTA CRITICAL - Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +my $time_connected = time; + +my $quotaUsed; +my $quotaLimit; +my $quotaPercentage; +my $quotaPercentageWarning = 80; +my $quotaPercentageCritical = 90; +my $quotaMessage; + +# look for the quota limits +my $tries = 0; +my @msgs; + +eval { + my $k; + my @l = $imap->getquotaroot(); + foreach $k (@l) { + print "$k\n" if $verbose > 2; + if ($k =~ /STORAGE +(\d+) +(\d+)/) { + $quotaUsed = $1; + $quotaLimit = $2; + } + } + if (!length($quotaUsed) && !length($quotaLimit)) { + print "no answer from imap host\n" if $verbose > 2; + } elsif (!length($quotaUsed) || !length($quotaLimit) { + print "incorrect answer from imap host\n"; + $imap->close(); + exit $status{UNKNOWN}; + } else { + $quotaPercentage = sprintf("%.1f", (100 * $quotaUsed) / $quotaLimit); + $quotaMessage = "$quotaUsed $quotaLimit - $quotaPercentage%"; + } +}; +if( $@ ) { + chomp $@; + print "IMAP QUOTA CRITICAL - Could not check quota at $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} + + +# disconnect from IMAP server +print "disconnecting from server\n" if $verbose > 2; +$imap->logout(); + +# calculate elapsed time and issue warnings +my $time_end = time; +my $elapsedtime = $time_end - $time_start; +$report->{seconds} = $elapsedtime; + +# print report and exit with known status + +if($quotaPercentage >= $quotaPercentageCritical) { + print "IMAP QUOTA CRITICAL - $quotaMessage\n"; + exit $status{CRITICAL}; +} +if($quotaPercentage >= $quotaPercentageWarning) { + print "IMAP QUOTA WARNING - $quotaMessage\n"; + exit $status{WARNING}; +} +print "IMAP QUOTA OK - $quotaMessage\n"; +exit $status{OK}; + + +# utility to load required modules. exits if unable to load one or more of the modules. +sub load_modules { + my @missing_modules = (); + foreach( @_ ) { + eval "require $_"; + push @missing_modules, $_ if $@; + } + if( @missing_modules ) { + print "Missing perl modules: @missing_modules\n"; + return 0; + } + return 1; +} + + +# NAME +# PluginReport +# SYNOPSIS +# $report = new PluginReport; +# $report->{label1} = "value1"; +# $report->{label2} = "value2"; +# print $report->text(qw/label1 label2/); +package PluginReport; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub text { + my ($self,@labels) = @_; + my @report = map { "$self->{$_} $_" } grep { defined $self->{$_} } @labels; + my $text = join(", ", @report); + return $text; +} + + +package main; +1; + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_receive b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_receive new file mode 100644 index 0000000..6b4fd86 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_receive @@ -0,0 +1,999 @@ +#!/usr/bin/perl +use strict; +my $VERSION = '0.7.5'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +# look for required modules +exit $status{UNKNOWN} unless load_modules(qw/Getopt::Long Mail::IMAPClient/); + +BEGIN { + if( grep { /^--hires$/ } @ARGV ) { + eval "use Time::HiRes qw(time);"; + warn "Time::HiRes not installed\n" if $@; + } +} + +# get options from command line +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $imap_server = ""; +my $default_imap_port = "143"; +my $default_imap_ssl_port = "993"; +my $imap_port = ""; +my $username = ""; +my $password = ""; +my $mailbox = "INBOX"; +my @search = (); +my $search_critical_min = 1; +my $search_critical_max = -1; # -1 means disabled for this option +my $search_warning_min = 1; +my $search_warning_max = -1; # -1 means disabled for this option +my $capture_max = ""; +my $capture_min = ""; +my $delete = 1; +my $no_delete_captured = ""; +my $warntime = 15; +my $criticaltime = 30; +my $timeout = 60; +my $interval = 5; +my $max_retries = 10; +my $download = ""; +my $download_max = ""; +my $peek = ""; +my $template = ""; +my $ssl = 0; +my $ssl_ca_file = ""; +my $tls = 0; +my $time_hires = ""; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + "w|warning=i"=>\$warntime,"c|critical=i"=>\$criticaltime,"t|timeout=i"=>\$timeout, + # imap settings + "H|hostname=s"=>\$imap_server,"p|port=i"=>\$imap_port, + "U|username=s"=>\$username,"P|password=s"=>\$password, "m|mailbox=s"=>\$mailbox, + "imap-check-interval=i"=>\$interval,"imap-retries=i"=>\$max_retries, + "ssl!"=>\$ssl, "ssl-ca-file=s"=>\$ssl_ca_file, "tls!"=>\$tls, + # search settings + "s|search=s"=>\@search, + "search-critical-min=i"=>\$search_critical_min, "search-critical-max=i"=>\$search_critical_max, + "search-warning-min=i"=>\$search_warning_min, "search-warning-max=i"=>\$search_warning_max, + "capture-max=s"=>\$capture_max, "capture-min=s"=>\$capture_min, + "delete!"=>\$delete, "nodelete-captured"=>\$no_delete_captured, + "download!"=>\$download, "download_max=i"=>\$download_max, "download-max=i"=>\$download_max, + "peek!"=>\$peek, + "template!"=>\$template, + # Time + "hires"=>\$time_hires, + ); + +if( $show_version ) { + print "$VERSION\n"; + if( $verbose ) { + print "Default warning threshold: $warntime seconds\n"; + print "Default critical threshold: $criticaltime seconds\n"; + print "Default timeout: $timeout seconds\n"; + } + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +my @required_module = (); +push @required_module, 'IO::Socket::SSL' if $ssl || $tls; +push @required_module, 'Email::Simple' if $download; +push @required_module, ('Text::Template','Date::Manip') if $template; +exit $status{UNKNOWN} unless load_modules(@required_module); + +if( $help_usage + || + ( $imap_server eq "" || $username eq "" || $password eq "" || scalar(@search)==0 ) + ) { + print "Usage: $0 -H host [-p port] -U username -P password -s HEADER -s X-Nagios -s 'ID: 1234.' [-w ] [-c ] [--imap-check-interval ] [--imap-retries ]\n"; + exit $status{UNKNOWN}; +} + +# before attempting to connect to the server, check if any of the search parameters +# use substitution functions and make sure we can parse them first. if we can't we +# need to abort since the search will be meaningless. +if( $template ) { + foreach my $token (@search) { + my $t = Text::Template->new(TYPE=>'STRING',SOURCE=>$token,PACKAGE=>'ImapSearchTemplate'); + $token = $t->fill_in(PREPEND=>q{package ImapSearchTemplate;}); + #print "token: $token\n"; + } +} + + +# initialize +my $report = new PluginReport; +my $time_start = time; + +# connect to IMAP server +print "connecting to server $imap_server\n" if $verbose > 2; +my $imap; +eval { + local $SIG{ALRM} = sub { die "exceeded timeout $timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $timeout; + + if( $ssl || $tls ) { + $imap_port = $default_imap_ssl_port unless $imap_port; + my %ssl_args = (); + if( length($ssl_ca_file) > 0 ) { + $ssl_args{SSL_verify_mode} = 1; + $ssl_args{SSL_ca_file} = $ssl_ca_file; + $ssl_args{SSL_verifycn_scheme} = 'imap'; + $ssl_args{SSL_verifycn_name} = $imap_server; + } + my $socket = IO::Socket::SSL->new(PeerAddr=>"$imap_server:$imap_port", %ssl_args); + die IO::Socket::SSL::errstr() . " (if you get this only when using both --ssl and --ssl-ca-file, but not when using just --ssl, the server SSL certificate failed validation)" unless $socket; + $socket->autoflush(1); + $imap = Mail::IMAPClient->new(Socket=>$socket, Debug => 0 ); + $imap->State(Mail::IMAPClient->Connected); + $imap->_read_line() if "$Mail::IMAPClient::VERSION" le "2.2.9"; # necessary to remove the server's "ready" line from the input buffer for old versions of Mail::IMAPClient. Using string comparison for the version check because the numeric didn't work on Darwin and for Mail::IMAPClient the next version is 2.3.0 and then 3.00 so string comparison works + $imap->User($username); + $imap->Password($password); + $imap->login() or die "Cannot login: $@"; + } + else { + $imap_port = $default_imap_port unless $imap_port; + $imap = Mail::IMAPClient->new(Debug => 0 ); + $imap->Server("$imap_server:$imap_port"); + $imap->User($username); + $imap->Password($password); + $imap->connect() or die "$@"; + } + + $imap->Peek(1) if $peek; + $imap->Ignoresizeerrors(1); + + alarm 0; +}; +if( $@ ) { + chomp $@; + print "IMAP RECEIVE CRITICAL - Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +unless( $imap ) { + print "IMAP RECEIVE CRITICAL - Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +my $time_connected = time; + +# select a mailbox +print "selecting mailbox $mailbox\n" if $verbose > 2; +unless( $imap->select($mailbox) ) { + print "IMAP RECEIVE CRITICAL - Could not select $mailbox: $@ $!\n"; + if( $verbose > 2 ) { + print "Mailbox list:\n" . join("\n", $imap->folders) . "\n"; + print "Mailbox separator: " . $imap->separator . "\n"; + ##print "Special mailboxes:\n" . join("\n", map { "$_ => ". + } + $imap->logout(); + exit $status{CRITICAL}; +} + + +# search for messages +my $tries = 0; +my @msgs; +until( scalar(@msgs) != 0 || $tries >= $max_retries ) { + eval { + $imap->select( $mailbox ); + # if download flag is on, we download recent messages and search ourselves + if( $download ) { + print "downloading messages to search\n" if $verbose > 2; + @msgs = download_and_search($imap,@search); + } + else { + print "searching on server\n" if $verbose > 2; + @msgs = $imap->search(@search); + die "Invalid search parameters: $@" if $@; + } + }; + if( $@ ) { + chomp $@; + print "Cannot search messages: $@\n"; + $imap->close(); + $imap->logout(); + exit $status{UNKNOWN}; + } + $report->{found} = scalar(@msgs); + $tries++; + sleep $interval unless (scalar(@msgs) != 0 || $tries >= $max_retries); +} + +sub download_and_search { + my ($imap,@search) = @_; + my $ims = new ImapMessageSearch; + $ims->querytokens(@search); + my @found = (); + @msgs = reverse $imap->messages or (); # die "Cannot list messages: $@\n"; # reversing to get descending order, which is most recent messages first! (at least on my mail servers) + @msgs = @msgs[0..$download_max-1] if $download_max && scalar(@msgs) > $download_max; + foreach my $m (@msgs) { + my $message = $imap->message_string($m); + push @found, $m if $ims->match($message); + } + return @found; +} + + + +# capture data in messages +my $captured_max_id = ""; +my $captured_min_id = ""; +if( $capture_max || $capture_min ) { + my $max = undef; + my $min = undef; + my %captured = (); + for (my $i=0;$i < scalar(@msgs); $i++) { + my $message = $imap->message_string($msgs[$i]); + if( $message =~ m/$capture_max/ ) { + if( !defined($max) || $1 > $max ) { + $captured{ $i } = 1; + $max = $1; + $captured_max_id = $msgs[$i]; + } + } + if( $message =~ m/$capture_min/ ) { + if( !defined($min) || $1 < $min ) { + $captured{ $i } = 1; + $min = $1; + $captured_min_id = $msgs[$i]; + } + } + print $message if $verbose > 1; + } + $report->{captured} = scalar keys %captured; + $report->{max} = $max if defined $max; + $report->{min} = $min if defined $min; +} + +# delete messages +if( $delete ) { + print "deleting matching messages\n" if $verbose > 2; + my $deleted = 0; + for (my $i=0;$i < scalar(@msgs); $i++) { + next if ($no_delete_captured && ($captured_max_id eq $msgs[$i])); + next if ($no_delete_captured && ($captured_min_id eq $msgs[$i])); + $imap->delete_message($msgs[$i]); + $deleted++; + } + $report->{deleted} = $deleted; + $imap->expunge() if $deleted; +} + +# deselect the mailbox +$imap->close(); + +# disconnect from IMAP server +print "disconnecting from server\n" if $verbose > 2; +$imap->logout(); + +# calculate elapsed time and issue warnings +my $time_end = time; +my $elapsedtime = $time_end - $time_start; +$report->{seconds} = $elapsedtime; +$report->{found} = 0 unless defined $report->{found}; +$report->{captured} = 0 unless defined $report->{captured}; + +my @warning = (); +my @critical = (); + +push @warning, "found less than $search_warning_min" if( scalar(@msgs) < $search_warning_min ); +push @warning, "found more than $search_warning_max" if ( $search_warning_max > -1 && scalar(@msgs) > $search_warning_max ); +push @critical, "found less than $search_critical_min" if ( scalar(@msgs) < $search_critical_min ); +push @critical, "found more than $search_critical_max" if ( $search_critical_max > -1 && scalar(@msgs) > $search_critical_max ); +push @warning, "connection time more than $warntime" if( $time_connected - $time_start > $warntime ); +push @critical, "connection time more than $criticaltime" if( $time_connected - $time_start > $criticaltime ); + +# print report and exit with known status +my $perf_data = "elapsed=".$report->{seconds}."s found=".$report->{found}."messages captured=".$report->{captured}."messages"; # TODO: need a component for safely generating valid perf data format. for notes on the format, see http://www.perfparse.de/tiki-view_faq.php?faqId=6 and http://nagiosplug.sourceforge.net/developer-guidelines.html#AEN185 +my $short_report = $report->text(qw/seconds found captured max min deleted/) . " | $perf_data"; +if( scalar @critical ) { + my $crit_alerts = join(", ", @critical); + print "IMAP RECEIVE CRITICAL - $crit_alerts; $short_report\n"; + exit $status{CRITICAL}; +} +if( scalar @warning ) { + my $warn_alerts = join(", ", @warning); + print "IMAP RECEIVE WARNING - $warn_alerts; $short_report\n"; + exit $status{WARNING}; +} +print "IMAP RECEIVE OK - $short_report\n"; +exit $status{OK}; + + +# utility to load required modules. exits if unable to load one or more of the modules. +sub load_modules { + my @missing_modules = (); + foreach( @_ ) { + eval "require $_"; + push @missing_modules, $_ if $@; + } + if( @missing_modules ) { + print "Missing perl modules: @missing_modules\n"; + return 0; + } + return 1; +} + + +# NAME +# PluginReport +# SYNOPSIS +# $report = new PluginReport; +# $report->{label1} = "value1"; +# $report->{label2} = "value2"; +# print $report->text(qw/label1 label2/); +package PluginReport; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub text { + my ($self,@labels) = @_; + my @report = map { "$self->{$_} $_" } grep { defined $self->{$_} } @labels; + my $text = join(", ", @report); + return $text; +} + +package ImapMessageSearch; + +require Email::Simple; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{querystring} = []; + $self->{querytokens} = []; + $self->{queryfnlist} = []; + $self->{mimemessage} = undef; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub querystring { + my ($self,$string) = @_; + $self->{querystring} = $string; + return $self->querytokens( parseimapsearch($string) ); +} + +sub querytokens { + my ($self,@tokens) = @_; + $self->{querytokens} = [@tokens]; + $self->{queryfnlist} = [create_search_expressions(@tokens)]; + return $self; +} + +sub match { + my ($self,$message_string) = @_; + return 0 unless defined $message_string; + my $message_mime = Email::Simple->new($message_string); + return $self->matchmime($message_mime); +} + +sub matchmime { + my ($self,$message_mime) = @_; + my $match = 1; + foreach my $x (@{$self->{queryfnlist}}) { + $match = $match && $x->($message_mime); + } + return $match; +} + +# this should probably become its own Perl module... see also Net::IMAP::Server::Command::Search +sub create_search_expressions { + my (@search) = @_; + return () unless scalar(@search); + my $token = shift @search; + if( $token eq 'TEXT' ) { + my $value = shift @search; + return (sub {shift->as_string =~ /\Q$value\E/i},create_search_expressions(@search)); + } + if( $token eq 'BODY' ) { + my $value = shift @search; + return (sub {shift->body =~ /\Q$value\E/i},create_search_expressions(@search)); + } + if( $token eq 'SUBJECT' ) { + my $value = shift @search; + return (sub {shift->header('Subject') =~ /\Q$value\E/i},create_search_expressions(@search)); + } + if( $token eq 'HEADER' ) { + my $name = shift @search; + my $value = shift @search; + return (sub {shift->header($name) =~ /\Q$value\E/i},create_search_expressions(@search)); + } + if( $token eq 'NOT' ) { + my @exp = create_search_expressions(@search); + my $next = shift @exp; + return (sub { ! $next->(@_) }, @exp); + } + if( $token eq 'OR' ) { + my @exp = create_search_expressions(@search); + my $next1 = shift @exp; + my $next2 = shift @exp; + return (sub { $next1->(@_) or $next2->(@_) }, @exp); + } + if( $token eq 'SENTBEFORE' ) { + my $value = shift @search; + return (sub {datecmp(shift->header('Date'),$value) < 0},create_search_expressions(@search)); + } + if( $token eq 'SENTON' ) { + my $value = shift @search; + return (sub {datecmp(shift->header('Date'),$value) == 0},create_search_expressions(@search)); + } + if( $token eq 'SENTSINCE' ) { + my $value = shift @search; + return (sub {datecmp(shift->header('Date'),$value) > 0},create_search_expressions(@search)); + } + return sub { die "invalid search parameter: $token" }; +} + +sub datecmp { + my ($date1,$date2) = @_; + my $parsed1 = Date::Manip::ParseDate($date1); + my $parsed2 = Date::Manip::ParseDate($date2); + my $cmp = Date::Manip::Date_Cmp($parsed1,$parsed2); + print " $date1 <=> $date2 -> $cmp\n"; + return $cmp <=> 0; +} + +package ImapSearchTemplate; + +# Takes an English date specification ("now", etc) and an optional offset ("-4 hours") +# and returns an RFC 2822 formatted date string. +# see http://search.cpan.org/dist/Date-Manip/lib/Date/Manip.pod +sub rfc2822dateHeader { + my ($when,$delta) = @_; + $when = Date::Manip::ParseDate($when); + $delta = Date::Manip::ParseDateDelta($delta) if $delta; + my $d = $delta ? Date::Manip::DateCalc($when,$delta) : $when; + return Date::Manip::UnixDate($d, "%a, %d %b %Y %H:%M:%S %z"); +} + +sub rfc2822date { + my ($when,$delta) = @_; + $when = Date::Manip::ParseDate($when); + $delta = Date::Manip::ParseDateDelta($delta) if $delta; + my $d = $delta ? Date::Manip::DateCalc($when,$delta) : $when; + return Date::Manip::UnixDate($d, "%d-%b-%Y"); +} + +# alias for 2822 ... RFC 822 is an older version and specifies 2-digit years, but we ignore that for now. +sub rfc822dateHeader { return rfc2822dateHeader(@_); } +sub rfc822date { return rfc2822date(@_); } + +sub date { + my ($format,$when,$delta) = @_; + $when = Date::Manip::ParseDate($when); + $delta = Date::Manip::ParseDateDelta($delta) if $delta; + my $d = $delta ? Date::Manip::DateCalc($when,$delta) : $when; + return Date::Manip::UnixDate($d, $format); +} + +package main; +1; + +__END__ + + +=pod + +=head1 NAME + +check_imap_receive - connects to and searches an IMAP account for messages + +=head1 SYNOPSIS + + check_imap_receive -vV + check_imap_receive -? + check_imap_receive --help + +=head1 OPTIONS + +=over + +=item --warning + +Warn if it takes longer than to connect to the IMAP server. Default is 15 seconds. +Also known as: -w + +=item --critical + +Return a critical status if it takes longer than to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical +Also known as: -c + +=item --timeout + +Abort with critical status if it takes longer than to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t + +=item --imap-check-interval + +How long to wait after searching for a matching message before searching again. Only takes effect +if no messages were found. Default is 5 seconds. + +=item --imap-retries + +How many times to try searching for a matching message before giving up. If you set this to 0 then +messages will not be searched at all. Setting this to 1 means the plugin only tries once. Etc. +Default is 10 times. + +=item --hostname + +Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H + +=item --port + +Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p + +=item --username + +=item --password + +Username and password to use when connecting to IMAP server. +Also known as: -U -P + +=item --mailbox + +Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m + +=item --search + +Use this option to filter the messages. Default is not to filter. You may (must) use this option +multiple times in order to create any valid IMAP search criteria. See the examples and see also +http://www.ietf.org/rfc/rfc2060.txt (look for section 6.4.4, the SEARCH command) + +This is the way to find messages matching a given subject: + -s SUBJECT -s "a given subject" + +You can use the following technique for any header, including Subject. To find "Header-Name: some value": + -s HEADER -s Header-Name -s "some value" + +Modern IMAP servers that support rfc5032 extensions allow you to search for messages +older or younger than a number of seconds. So to find messages received in the past hour, +you can do: + + -s YOUNGER -s 3600 + +Or to find messages received more than 5 minutes ago, you can do: + + -s OLDER -s 300 + +Also known as: -s + +=item --download + +=item --nodownload + +This option causes all messages in the specified mailbox to be downloaded from the server +and searched locally. See --download-max if you only want to download a few messages. +Currently only the following RFC 2060 search criteria are supported: +TEXT, BODY, SUBJECT, HEADER, NOT, OR, SENTBEFORE, SENTON, SENTSINCE. + +Requires Email::Simple to be installed. It is available on CPAN. + +This option may be particularly useful to you if your mail server is slow to index +messages (like Exchange 2003), causing the plugin not to find them with IMAP SEARCH +even though they are in the inbox. + +It's also useful if you're searching for messages that have been on the server for a +specified amount of time, like some minutes or hours, because the standard IMAP search +function only allows whole dates. For this, use the standard search keywords but you +can specify either just a date like in RFC 2060 or a date and a time. + +If you use SENTBEFORE, SENTON, or SENTSINCE, you must have Date::Manip installed +on your system. + + +=item --download-max + +Limits the number of messages downloaded from the server when the --download option is used. +Default is to download and search all messages. + +=item --search-critical-min + +This option will trigger a CRITICAL status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search. + +This parameter defaults to 1 so that if no messages are found, the plugin will exit with a CRITICAL status. + +If you want the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0. + +=item --search-critical-max + +This option will trigger a CRITICAL status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search. + +This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +CRITICAL if it finds 11 messages. If you set it to 1, the plugin will exit with CRITICAL if it finds +any more than 1 message. If you set it to 0, the plugin will exit with CRITICAL if it finds any messages +at all. If you set it to -1 it will be disabled. + +=item --search-warning-min + +This option will trigger a WARNING status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search. + +This parameter defaults to 1 so that if no messages are found, the plugin will exit with a WARNING status. + +If you want to suppress the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0. When this parameter is 0, it means that you expect the mailbox not to have any messages. + +=item --search-warning-max + +This option will trigger a WARNING status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search. + +This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +WARNING if it finds 11 messages. If you set it to 1, the plugin will exit with WARNING if it finds +any more than 1 message. If you set it to 0, the plugin will exit with WARNING if it finds any messages +at all. If you set it to -1 it will be disabled. + +=item --capture-max + +In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-max" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the highest captured value. + +The regexp is expected to capture a numeric value. + +=item --capture-min + +In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-min" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the lowest captured value. + +The regexp is expected to capture a numeric value. + +=item --delete + +=item --nodelete + +Use the delete option to delete messages that matched the search criteria. This is useful for +preventing the mailbox from filling up with automated messages (from the check_smtp_send plugin, for example). +THE DELETE OPTION IS TURNED *ON* BY DEFAULT, in order to preserve compatibility with an earlier version. + +Use the nodelete option to turn off the delete option. + +=item --nodelete-captured + +If you use both the capture-max and delete arguments, you can also use the nodelete-captured argument to specify that the email +with the highest captured value should not be deleted. This leaves it available for comparison the next time this plugin runs. + +If you do not use the delete option, this option has no effect. + +=item --ssl + +=item --nossl + +Enable SSL protocol. Requires IO::Socket::SSL. + +Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option. + +Use the nossl option to turn off the ssl option. + +=item --ssl-ca-file + +Use this to verify the server SSL certificate against a local .pem file. You'll need to +specify the path to the .pem file as the parameter. + +You can use the imap_ssl_cert utility included in this distribution to connect to your IMAP +server and save its SSL certificates into your .pem file. Usage is like this: + + imap_ssl_cert -H imap.server.com > ca_file.pem + +Only applicable when --ssl option is enabled. + +=item --template + +=item --notemplate + +Enable (or disable) processing of IMAP search parameters. Requires Text::Template and Date::Manip. + +Use this option to apply special processing to IMAP search parameters that allows you to use the +results of arbitrary computations as the parameter values. For example, you can use this feature +to search for message received up to 4 hours ago. + +Modern IMAP servers that support rfc5032 extensions allow searching with the YOUNGER and OLDER +criteria so a message received up to 4 hours ago is -s YOUNGER -s 14400. But if your mail server +doesn't support that, you could use the --template option to get similar functionality. + +When you enable the --template option, each parameter you pass to the -s option is parsed by +Text::Template. See the Text::Template manual for more information, but in general any expression +written in Perl will work. + +A convenience function called rfc2822dateHeader is provided to you so you can easily compute properly +formatted dates for use as search parameters. The rfc2822date function can take one or two +parameters itself: the date to format and an optional offset. To use the current time as a +search parameter, you can write this: + + $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{rfc2822dateHeader("now")}' + +The output of {rfc2822dateHeader("now")} looks like this: Wed, 30 Sep 2009 22:44:03 -0700 and +is suitable for use with a date header, like HEADER Delivery-Date. + +To use a time in the past relative to the current time or day, you can use a second convenience function +called rfc2822date and write this: + + $ check_imap_receive ... --template -s SENTSINCE -s '{rfc2822date("now","-1 day")}' + +The output of {rfc2822date("now","-1 day")} looks like this: 29-Sep-2009 and is suitable for use +with BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, and SINCE. + +I have seen some email clients use a different format in the Date field, +like September 17, 2009 9:46:51 AM PDT. To specify an arbitrary format like this one, write this: + + $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{date("%B %e, %Y %i:%M:%S %p %Z","now","-4 hours")}' + +You can use BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, or SINCE to search for messages that arrived +on, before, or after a given day but not on, before, or after a specific time on that day. + +To search for messages that arrived on, before, or after a specific time you have to use the +Delivery-Date or another date field, like with -s HEADER -s Delivery-Date in the example above. + +See the Date::Manip manual for more information on the allowed expressions for date and delta strings. + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. + +If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Report how many emails are in the mailbox + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s ALL --nodelete + + IMAP RECEIVE OK - 1 seconds, 7 found + +=head2 Report the email with the highest value + +Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated): + + To: mailuser@server.net + From: autoscript@server.net + Subject: Results of Autoscript + Date: Wed, 09 Nov 2005 08:30:40 -0800 + Message-ID: + + Homeruns 5 + +And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values: + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)" --nodelete-captured + + IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted + +=head2 Troubleshoot your search parameters + +Add the --nodelete and --imap-retries=1 parameters to your command line. + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 SEE ALSO + +http://nagios.org/ +http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod +http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod + +=head1 CHANGES + + Wed Oct 29 11:00:00 PST 2005 + + version 0.1 + + Wed Nov 9 09:53:32 PST 2005 + + added delete/nodelete option. deleting found messages is still default behavior. + + added capture-max option + + added nodelete-captured option + + added mailbox option + + added eval/alarm block to implement -c option + + now using an inline PluginReport package to generate the report + + copyright notice and GNU GPL + + version 0.2 + + Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson ) + + version 0.2.1 + + added support for multiple polls of imap-server, with specified intervals + + Tue Apr 24 21:17:53 PDT 2007 + + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature + + added patch from Benjamin Ritcey for SSL support on machines that have an SSL-enabled + + version 0.2.3 + + Fri Apr 27 18:56:50 PDT 2007 + + fixed problem that "Invalid search parameters" was not printed because of missing newline to flush it + + warnings and critical errors now try to append error messages received from the IMAP client + + changed connection error to display timeout only if timeout was the error + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + added abbreviations U for username, P for password, m for mailbox + + fixed bug that imap-check-interval applied even after the last try (imap-retries) when it was not necessary + + the IMAP expunge command is not sent unless at least one message is deleted + + fixed bug that the "no messages" warning was printed even if some messages were found + + version 0.3 + + Sun Oct 21 14:08:07 PDT 2007 + + added port info to the "could not connect" error message + + fixed bug that occurred when using --ssl --port 143 which caused port to remain at the default 993 imap/ssl port + + added clarity shortcuts --search-subject and --search-header + + port is no longer a required option. defaults to 143 for regular IMAP and 993 for IMAP/SSL + + version 0.3.1 + + Sun Oct 21 20:41:56 PDT 2007 + + reworked ssl support to use IO::Socket::SSL instead of the convenience method Mail::IMAPClient->Ssl (which is not included in the standard Mail::IMAPClient package) + + removed clarity shortcuts (bad idea, code bloat) + + version 0.4 + + Tue Dec 4 07:05:27 PST 2007 + + added version check to _read_line workaround for SSL-related bug in Mail::IMAPClient version 2.2.9 ; newer versions fixed the bug + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + fixed some minor pod formatting issues for perldoc + + version 0.4.1 + + Sat Dec 15 07:39:59 PST 2007 + + improved compatibility with Nagios embedded perl (ePN) + + version 0.4.2 + + Mon Jan 7 21:35:23 PST 2008 + + changed version check for Mail::IMAPClient version 2.2.9 to use string comparison le "2.2.9" + + fixed bug where script was dying on socket->autoflush when socket does not exist because autoflush was being called before checking the socket object + + version 0.4.3 + + Mon Feb 11 19:13:38 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.4.4 + + Mon May 26 08:33:27 PDT 2008 + + fixed a bug for number captured, it now reflects number of messages captured instead of always returning "1" + + added --capture-min option to complement --capture-max + + added --search-critical-min to trigger a CRITICAL alert if number of messages found is less than argument, with default 1. + + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly + + version 0.5 + + Wed Jul 2 14:59:05 PDT 2008 + + fixed a bug for not finding a message after the first try, by reselecting the mailbox before each search + + version 0.5.1 + + Sat Dec 13 08:57:29 PST 2008 + + added --download option to allow local searching of messages (useful if your server has an index that handles searching but it takes a while before new emails show up and you want immediate results), supports only the TEXT, BODY, SUBJECT, and HEADER search keys + + added --download-max option to set a limit on number of messages downloaded with --download + + version 0.6.0 + + Wed Sep 30 23:25:33 PDT 2009 + + fixed --download-max option (was incorrectly looking for --download_max). currently both will work, in the future only --download-max will work + + added --template option to allow arbitrary substitutions for search parameters, and provided three convenience functions for working with dates + + added date search criteria to the --download option: SENTBEFORE, SENTON, and SENTSINCE which check the Date header and allow hours and minutes in addition to dates (whereas the IMAP standard only allows dates) + + added --search-critical-max to trigger a CRITICAL alert if number of messages found is more than argument, disabled by default. + + fixed a bug in --download --search where messages would match even though they failed the search criteria + + changed behavior of --download-max to look at the most recent messages first (hopefully); the IMAP protocol doesn't guarantee the order that the messages are returned but I observed that many mail servers return them in chronological order; so now --download-max reverses the order to look at the newer messages first + + added performance data for use with PNP4Nagios! + + version 0.7.0 + + Fri Oct 2 15:22:00 PDT 2009 + + added --search-warning-max and --search-warning-min to trigger a WARNING alert if number of messages is more than or less than the specified number. + + fixed --download option not to fail with CRITICAL if mailbox is empty; now this can be configured with --search-warning-min or --search-critical-min + + version 0.7.1 + + Sat Nov 21 18:27:17 PST 2009 + + fixed problem with using --download option on certain mail servers by turning on the IgnoreSizeErrors feature in IMAPClient + + added --peek option to prevent marking messages as seen + + version 0.7.2 + + Tue Jan 5 12:13:53 PST 2010 + + added error message and exit with unknown status when an unrecognized IMAP search criteria is encountered by the --download --search option + + Wed May 5 11:14:51 PDT 2010 + + added mailbox list when mailbox is not found and verbose level 3 is on (-vvv) + + version 0.7.3 + + Tue Mar 8 18:58:14 AST 2011 + + updated documentation for --search and --template to mention rfc5032 extensions (thanks to Stuart Henderson) + + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.4 + + Fri Nov 11 01:51:40 AST 2011 + + added --ssl-ca-file option to allow verifying the server certificate against a local .pem file (thanks to Alexandre Bezroutchko) + + added imap_ssl_cert.pl utility (not in this file) to conveniently save the server's SSL certificates into a local .pem file + + version 0.7.5 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2005-2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_receive_epn b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_receive_epn new file mode 100644 index 0000000..f1c0fc4 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_imap_receive_epn @@ -0,0 +1,492 @@ +#!/usr/bin/perl +use strict; +my $VERSION = '0.7.5'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +# look for required modules +exit $status{UNKNOWN} unless load_modules(qw/Getopt::Long Mail::IMAPClient/); + +BEGIN { + if( grep { /^--hires$/ } @ARGV ) { + eval "use Time::HiRes qw(time);"; + warn "Time::HiRes not installed\n" if $@; + } +} + +# get options from command line +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $imap_server = ""; +my $default_imap_port = "143"; +my $default_imap_ssl_port = "993"; +my $imap_port = ""; +my $username = ""; +my $password = ""; +my $mailbox = "INBOX"; +my @search = (); +my $search_critical_min = 1; +my $search_critical_max = -1; # -1 means disabled for this option +my $search_warning_min = 1; +my $search_warning_max = -1; # -1 means disabled for this option +my $capture_max = ""; +my $capture_min = ""; +my $delete = 1; +my $no_delete_captured = ""; +my $warntime = 15; +my $criticaltime = 30; +my $timeout = 60; +my $interval = 5; +my $max_retries = 10; +my $download = ""; +my $download_max = ""; +my $peek = ""; +my $template = ""; +my $ssl = 0; +my $ssl_ca_file = ""; +my $tls = 0; +my $time_hires = ""; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + "w|warning=i"=>\$warntime,"c|critical=i"=>\$criticaltime,"t|timeout=i"=>\$timeout, + # imap settings + "H|hostname=s"=>\$imap_server,"p|port=i"=>\$imap_port, + "U|username=s"=>\$username,"P|password=s"=>\$password, "m|mailbox=s"=>\$mailbox, + "imap-check-interval=i"=>\$interval,"imap-retries=i"=>\$max_retries, + "ssl!"=>\$ssl, "ssl-ca-file=s"=>\$ssl_ca_file, "tls!"=>\$tls, + # search settings + "s|search=s"=>\@search, + "search-critical-min=i"=>\$search_critical_min, "search-critical-max=i"=>\$search_critical_max, + "search-warning-min=i"=>\$search_warning_min, "search-warning-max=i"=>\$search_warning_max, + "capture-max=s"=>\$capture_max, "capture-min=s"=>\$capture_min, + "delete!"=>\$delete, "nodelete-captured"=>\$no_delete_captured, + "download!"=>\$download, "download_max=i"=>\$download_max, "download-max=i"=>\$download_max, + "peek!"=>\$peek, + "template!"=>\$template, + # Time + "hires"=>\$time_hires, + ); + +if( $show_version ) { + print "$VERSION\n"; + if( $verbose ) { + print "Default warning threshold: $warntime seconds\n"; + print "Default critical threshold: $criticaltime seconds\n"; + print "Default timeout: $timeout seconds\n"; + } + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +my @required_module = (); +push @required_module, 'IO::Socket::SSL' if $ssl || $tls; +push @required_module, 'Email::Simple' if $download; +push @required_module, ('Text::Template','Date::Manip') if $template; +exit $status{UNKNOWN} unless load_modules(@required_module); + +if( $help_usage + || + ( $imap_server eq "" || $username eq "" || $password eq "" || scalar(@search)==0 ) + ) { + print "Usage: $0 -H host [-p port] -U username -P password -s HEADER -s X-Nagios -s 'ID: 1234.' [-w ] [-c ] [--imap-check-interval ] [--imap-retries ]\n"; + exit $status{UNKNOWN}; +} + +# before attempting to connect to the server, check if any of the search parameters +# use substitution functions and make sure we can parse them first. if we can't we +# need to abort since the search will be meaningless. +if( $template ) { + foreach my $token (@search) { + my $t = Text::Template->new(TYPE=>'STRING',SOURCE=>$token,PACKAGE=>'ImapSearchTemplate'); + $token = $t->fill_in(PREPEND=>q{package ImapSearchTemplate;}); + #print "token: $token\n"; + } +} + + +# initialize +my $report = new PluginReport; +my $time_start = time; + +# connect to IMAP server +print "connecting to server $imap_server\n" if $verbose > 2; +my $imap; +eval { + local $SIG{ALRM} = sub { die "exceeded timeout $timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $timeout; + + if( $ssl || $tls ) { + $imap_port = $default_imap_ssl_port unless $imap_port; + my %ssl_args = (); + if( length($ssl_ca_file) > 0 ) { + $ssl_args{SSL_verify_mode} = 1; + $ssl_args{SSL_ca_file} = $ssl_ca_file; + $ssl_args{SSL_verifycn_scheme} = 'imap'; + $ssl_args{SSL_verifycn_name} = $imap_server; + } + my $socket = IO::Socket::SSL->new(PeerAddr=>"$imap_server:$imap_port", %ssl_args); + die IO::Socket::SSL::errstr() . " (if you get this only when using both --ssl and --ssl-ca-file, but not when using just --ssl, the server SSL certificate failed validation)" unless $socket; + $socket->autoflush(1); + $imap = Mail::IMAPClient->new(Socket=>$socket, Debug => 0 ); + $imap->State(Mail::IMAPClient->Connected); + $imap->_read_line() if "$Mail::IMAPClient::VERSION" le "2.2.9"; # necessary to remove the server's "ready" line from the input buffer for old versions of Mail::IMAPClient. Using string comparison for the version check because the numeric didn't work on Darwin and for Mail::IMAPClient the next version is 2.3.0 and then 3.00 so string comparison works + $imap->User($username); + $imap->Password($password); + $imap->login() or die "Cannot login: $@"; + } + else { + $imap_port = $default_imap_port unless $imap_port; + $imap = Mail::IMAPClient->new(Debug => 0 ); + $imap->Server("$imap_server:$imap_port"); + $imap->User($username); + $imap->Password($password); + $imap->connect() or die "$@"; + } + + $imap->Peek(1) if $peek; + $imap->Ignoresizeerrors(1); + + alarm 0; +}; +if( $@ ) { + chomp $@; + print "IMAP RECEIVE CRITICAL - Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +unless( $imap ) { + print "IMAP RECEIVE CRITICAL - Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +my $time_connected = time; + +# select a mailbox +print "selecting mailbox $mailbox\n" if $verbose > 2; +unless( $imap->select($mailbox) ) { + print "IMAP RECEIVE CRITICAL - Could not select $mailbox: $@ $!\n"; + if( $verbose > 2 ) { + print "Mailbox list:\n" . join("\n", $imap->folders) . "\n"; + print "Mailbox separator: " . $imap->separator . "\n"; + ##print "Special mailboxes:\n" . join("\n", map { "$_ => ". + } + $imap->logout(); + exit $status{CRITICAL}; +} + + +# search for messages +my $tries = 0; +my @msgs; +until( scalar(@msgs) != 0 || $tries >= $max_retries ) { + eval { + $imap->select( $mailbox ); + # if download flag is on, we download recent messages and search ourselves + if( $download ) { + print "downloading messages to search\n" if $verbose > 2; + @msgs = download_and_search($imap,@search); + } + else { + print "searching on server\n" if $verbose > 2; + @msgs = $imap->search(@search); + die "Invalid search parameters: $@" if $@; + } + }; + if( $@ ) { + chomp $@; + print "Cannot search messages: $@\n"; + $imap->close(); + $imap->logout(); + exit $status{UNKNOWN}; + } + $report->{found} = scalar(@msgs); + $tries++; + sleep $interval unless (scalar(@msgs) != 0 || $tries >= $max_retries); +} + +sub download_and_search { + my ($imap,@search) = @_; + my $ims = new ImapMessageSearch; + $ims->querytokens(@search); + my @found = (); + @msgs = reverse $imap->messages or (); # die "Cannot list messages: $@\n"; # reversing to get descending order, which is most recent messages first! (at least on my mail servers) + @msgs = @msgs[0..$download_max-1] if $download_max && scalar(@msgs) > $download_max; + foreach my $m (@msgs) { + my $message = $imap->message_string($m); + push @found, $m if $ims->match($message); + } + return @found; +} + + + +# capture data in messages +my $captured_max_id = ""; +my $captured_min_id = ""; +if( $capture_max || $capture_min ) { + my $max = undef; + my $min = undef; + my %captured = (); + for (my $i=0;$i < scalar(@msgs); $i++) { + my $message = $imap->message_string($msgs[$i]); + if( $message =~ m/$capture_max/ ) { + if( !defined($max) || $1 > $max ) { + $captured{ $i } = 1; + $max = $1; + $captured_max_id = $msgs[$i]; + } + } + if( $message =~ m/$capture_min/ ) { + if( !defined($min) || $1 < $min ) { + $captured{ $i } = 1; + $min = $1; + $captured_min_id = $msgs[$i]; + } + } + print $message if $verbose > 1; + } + $report->{captured} = scalar keys %captured; + $report->{max} = $max if defined $max; + $report->{min} = $min if defined $min; +} + +# delete messages +if( $delete ) { + print "deleting matching messages\n" if $verbose > 2; + my $deleted = 0; + for (my $i=0;$i < scalar(@msgs); $i++) { + next if ($no_delete_captured && ($captured_max_id eq $msgs[$i])); + next if ($no_delete_captured && ($captured_min_id eq $msgs[$i])); + $imap->delete_message($msgs[$i]); + $deleted++; + } + $report->{deleted} = $deleted; + $imap->expunge() if $deleted; +} + +# deselect the mailbox +$imap->close(); + +# disconnect from IMAP server +print "disconnecting from server\n" if $verbose > 2; +$imap->logout(); + +# calculate elapsed time and issue warnings +my $time_end = time; +my $elapsedtime = $time_end - $time_start; +$report->{seconds} = $elapsedtime; +$report->{found} = 0 unless defined $report->{found}; +$report->{captured} = 0 unless defined $report->{captured}; + +my @warning = (); +my @critical = (); + +push @warning, "found less than $search_warning_min" if( scalar(@msgs) < $search_warning_min ); +push @warning, "found more than $search_warning_max" if ( $search_warning_max > -1 && scalar(@msgs) > $search_warning_max ); +push @critical, "found less than $search_critical_min" if ( scalar(@msgs) < $search_critical_min ); +push @critical, "found more than $search_critical_max" if ( $search_critical_max > -1 && scalar(@msgs) > $search_critical_max ); +push @warning, "connection time more than $warntime" if( $time_connected - $time_start > $warntime ); +push @critical, "connection time more than $criticaltime" if( $time_connected - $time_start > $criticaltime ); + +# print report and exit with known status +my $perf_data = "elapsed=".$report->{seconds}."s found=".$report->{found}."messages captured=".$report->{captured}."messages"; # TODO: need a component for safely generating valid perf data format. for notes on the format, see http://www.perfparse.de/tiki-view_faq.php?faqId=6 and http://nagiosplug.sourceforge.net/developer-guidelines.html#AEN185 +my $short_report = $report->text(qw/seconds found captured max min deleted/) . " | $perf_data"; +if( scalar @critical ) { + my $crit_alerts = join(", ", @critical); + print "IMAP RECEIVE CRITICAL - $crit_alerts; $short_report\n"; + exit $status{CRITICAL}; +} +if( scalar @warning ) { + my $warn_alerts = join(", ", @warning); + print "IMAP RECEIVE WARNING - $warn_alerts; $short_report\n"; + exit $status{WARNING}; +} +print "IMAP RECEIVE OK - $short_report\n"; +exit $status{OK}; + + +# utility to load required modules. exits if unable to load one or more of the modules. +sub load_modules { + my @missing_modules = (); + foreach( @_ ) { + eval "require $_"; + push @missing_modules, $_ if $@; + } + if( @missing_modules ) { + print "Missing perl modules: @missing_modules\n"; + return 0; + } + return 1; +} + + +# NAME +# PluginReport +# SYNOPSIS +# $report = new PluginReport; +# $report->{label1} = "value1"; +# $report->{label2} = "value2"; +# print $report->text(qw/label1 label2/); +package PluginReport; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub text { + my ($self,@labels) = @_; + my @report = map { "$self->{$_} $_" } grep { defined $self->{$_} } @labels; + my $text = join(", ", @report); + return $text; +} + +package ImapMessageSearch; + +require Email::Simple; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{querystring} = []; + $self->{querytokens} = []; + $self->{queryfnlist} = []; + $self->{mimemessage} = undef; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub querystring { + my ($self,$string) = @_; + $self->{querystring} = $string; + return $self->querytokens( parseimapsearch($string) ); +} + +sub querytokens { + my ($self,@tokens) = @_; + $self->{querytokens} = [@tokens]; + $self->{queryfnlist} = [create_search_expressions(@tokens)]; + return $self; +} + +sub match { + my ($self,$message_string) = @_; + return 0 unless defined $message_string; + my $message_mime = Email::Simple->new($message_string); + return $self->matchmime($message_mime); +} + +sub matchmime { + my ($self,$message_mime) = @_; + my $match = 1; + foreach my $x (@{$self->{queryfnlist}}) { + $match = $match && $x->($message_mime); + } + return $match; +} + +# this should probably become its own Perl module... see also Net::IMAP::Server::Command::Search +sub create_search_expressions { + my (@search) = @_; + return () unless scalar(@search); + my $token = shift @search; + if( $token eq 'TEXT' ) { + my $value = shift @search; + return (sub {shift->as_string =~ /\Q$value\E/i},create_search_expressions(@search)); + } + if( $token eq 'BODY' ) { + my $value = shift @search; + return (sub {shift->body =~ /\Q$value\E/i},create_search_expressions(@search)); + } + if( $token eq 'SUBJECT' ) { + my $value = shift @search; + return (sub {shift->header('Subject') =~ /\Q$value\E/i},create_search_expressions(@search)); + } + if( $token eq 'HEADER' ) { + my $name = shift @search; + my $value = shift @search; + return (sub {shift->header($name) =~ /\Q$value\E/i},create_search_expressions(@search)); + } + if( $token eq 'NOT' ) { + my @exp = create_search_expressions(@search); + my $next = shift @exp; + return (sub { ! $next->(@_) }, @exp); + } + if( $token eq 'OR' ) { + my @exp = create_search_expressions(@search); + my $next1 = shift @exp; + my $next2 = shift @exp; + return (sub { $next1->(@_) or $next2->(@_) }, @exp); + } + if( $token eq 'SENTBEFORE' ) { + my $value = shift @search; + return (sub {datecmp(shift->header('Date'),$value) < 0},create_search_expressions(@search)); + } + if( $token eq 'SENTON' ) { + my $value = shift @search; + return (sub {datecmp(shift->header('Date'),$value) == 0},create_search_expressions(@search)); + } + if( $token eq 'SENTSINCE' ) { + my $value = shift @search; + return (sub {datecmp(shift->header('Date'),$value) > 0},create_search_expressions(@search)); + } + return sub { die "invalid search parameter: $token" }; +} + +sub datecmp { + my ($date1,$date2) = @_; + my $parsed1 = Date::Manip::ParseDate($date1); + my $parsed2 = Date::Manip::ParseDate($date2); + my $cmp = Date::Manip::Date_Cmp($parsed1,$parsed2); + print " $date1 <=> $date2 -> $cmp\n"; + return $cmp <=> 0; +} + +package ImapSearchTemplate; + +# Takes an English date specification ("now", etc) and an optional offset ("-4 hours") +# and returns an RFC 2822 formatted date string. +# see http://search.cpan.org/dist/Date-Manip/lib/Date/Manip.pod +sub rfc2822dateHeader { + my ($when,$delta) = @_; + $when = Date::Manip::ParseDate($when); + $delta = Date::Manip::ParseDateDelta($delta) if $delta; + my $d = $delta ? Date::Manip::DateCalc($when,$delta) : $when; + return Date::Manip::UnixDate($d, "%a, %d %b %Y %H:%M:%S %z"); +} + +sub rfc2822date { + my ($when,$delta) = @_; + $when = Date::Manip::ParseDate($when); + $delta = Date::Manip::ParseDateDelta($delta) if $delta; + my $d = $delta ? Date::Manip::DateCalc($when,$delta) : $when; + return Date::Manip::UnixDate($d, "%d-%b-%Y"); +} + +# alias for 2822 ... RFC 822 is an older version and specifies 2-digit years, but we ignore that for now. +sub rfc822dateHeader { return rfc2822dateHeader(@_); } +sub rfc822date { return rfc2822date(@_); } + +sub date { + my ($format,$when,$delta) = @_; + $when = Date::Manip::ParseDate($when); + $delta = Date::Manip::ParseDateDelta($delta) if $delta; + my $d = $delta ? Date::Manip::DateCalc($when,$delta) : $when; + return Date::Manip::UnixDate($d, $format); +} + +package main; +1; + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_smtp_send b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_smtp_send new file mode 100644 index 0000000..ade0fe3 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_smtp_send @@ -0,0 +1,782 @@ +#!/usr/bin/perl +use strict; +use POSIX qw(strftime); +my $VERSION = '0.7.3'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +# look for required modules +exit $status{UNKNOWN} unless load_modules(qw/Getopt::Long Net::SMTP/); + +BEGIN { + if( grep { /^--hires$/ } @ARGV ) { + eval "use Time::HiRes qw(time);"; + warn "Time::HiRes not installed\n" if $@; + } +} + +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $smtp_server = ""; +my $default_smtp_port = "25"; +my $default_smtp_ssl_port = "465"; +my $default_smtp_tls_port = "587"; +my $smtp_port = ""; +my @mailto = (); +my $mailfrom = ""; +my @header = (); +my $body = ""; +my $stdin = ""; +my $template = ""; +my $expect_response = "250"; +my $warntime = 15; +my $criticaltime = 30; +my $timeout = 60; +my $tls = 0; +my $ssl = 0; +my $auth_method = undef; +my $username = ""; +my $password = ""; +my $time_hires = ""; +my $mx_lookup = 0; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + "w|warning=i"=>\$warntime,"c|critical=i"=>\$criticaltime,"t|timeout=i"=>\$timeout, + # smtp settings + "H|hostname=s"=>\$smtp_server,"p|port=i"=>\$smtp_port, + "mailto=s"=>\@mailto, "mailfrom=s",\$mailfrom, + "header=s"=>\@header, "body=s"=>\$body, "stdin"=>\$stdin, + "template!"=>\$template, + # SSL/TLS/auth options + "tls!"=>\$tls, "ssl!"=>\$ssl, "auth=s"=>\$auth_method, + "U|username=s"=>\$username,"P|password=s"=>\$password, + # Server response + "E|expect-response=s"=>\$expect_response, + # Time + "hires"=>\$time_hires, + ); + +if( $show_version ) { + print "$VERSION\n"; + if( $verbose ) { + print "Default warning threshold: $warntime seconds\n"; + print "Default critical threshold: $criticaltime seconds\n"; + print "Default timeout: $timeout seconds\n"; + } + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +if( $smtp_server eq "" && scalar(@mailto) == 1 ) { + # no SMTP server specified but one mailto address given means we can look up the MX record + $mx_lookup = 1; +} + +my @required_module = (); +push @required_module, 'Net::SMTP::SSL' if $ssl; +push @required_module, ('MIME::Base64','Authen::SASL') if $ssl && $username; +push @required_module, 'Net::SMTP::TLS' if $tls; +push @required_module, 'Net::SMTP_auth' if $auth_method and not $tls; # whereas if auth_method and tls we use TLS_auth, which is included in this script! +push @required_module, 'Text::Template' if $template; +push @required_module, 'Net::DNS' if $mx_lookup; +push @required_module, 'Email::Address' if $mx_lookup; +exit $status{UNKNOWN} unless load_modules(@required_module); + + +# split up @mailto if commas were used instead of multiple options +@mailto = split(/,/,join(',',@mailto)); + +if( $help_usage || + ( + ($smtp_server eq "" && !$mx_lookup) || scalar(@mailto)==0 || $mailfrom eq "" + ) + ) { + print "Usage: $0 [-H host [-p port]] --mailto recipient\@your.net [--mailto recipient2\@your.net ...] --mailfrom sender\@your.net --body 'some text' [-w ] [-c ]\n"; + exit $status{UNKNOWN}; +} + +# initialize +my $report = new PluginReport; +my $time_start = time; +my $actual_response = undef; +my @warning = (); +my @critical = (); + +my $smtp_debug = 0; +$smtp_debug = 1 if $verbose >= 3; + +# default date and message id headers +push @header, default_date_header() unless find_header("Date",@header); +push @header, default_messageid_header() unless find_header("Message-ID",@header); + +# look up MX server if necessary +if( $mx_lookup ) { + my $addr = Email::Address->new( undef, $mailto[0] ); + my $mx_domain = $addr->host; + print "MX lookup " . $mx_domain . "\n" if $verbose > 1; + my $res = Net::DNS::Resolver->new; + my @mx = Net::DNS::mx($res, $mx_domain); + if( @mx ) { + # use the first server + foreach my $rr (@mx) { + print "pref : " . $rr->preference . " exchange: " . $rr->exchange . "\n" if $verbose > 2; + } + $smtp_server = $mx[0]->exchange; + print "smtp server: $smtp_server\n" if $verbose; + } + else { + print "SMTP SEND CRITICAL - Cannot find MX records for $mx_domain\n"; + exit $status{CRITICAL}; + } +} + +# connect to SMTP server +# create the smtp handle using Net::SMTP, Net::SMTP::SSL, Net::SMTP::TLS, or an authentication variant +my $smtp; +eval { + if( $tls and $auth_method ) { + $smtp_port = $default_smtp_tls_port unless $smtp_port; + $smtp = TLS_auth->new($smtp_server, Timeout=>$timeout, Port=>$smtp_port, User=>$username, Password=>$password, Auth_Method=>$auth_method); + if( $smtp ) { + my $message = oneline($smtp->message()); + die "cannot connect with TLS/$auth_method: $message" if $smtp->code() =~ m/53\d/; + } + } + elsif( $tls ) { + $smtp_port = $default_smtp_tls_port unless $smtp_port; + $smtp = Net::SMTP::TLS->new($smtp_server, Timeout=>$timeout, Port=>$smtp_port, User=>$username, Password=>$password); + if( $smtp ) { + my $message = oneline($smtp->message()); + die "cannot connect with TLS: $message" if $smtp->code() =~ m/53\d/; + } + } + elsif( $ssl ) { + $smtp_port = $default_smtp_ssl_port unless $smtp_port; + $smtp = Net::SMTP::SSL->new($smtp_server, Port => $smtp_port, Timeout=>$timeout,Debug=>$smtp_debug); + if( $smtp && $username ) { + $smtp->auth($username, $password); + my $message = oneline($smtp->message()); + die "cannot connect with SSL/password: $message" if $smtp->code() =~ m/53\d/; + } + } + elsif( $auth_method ) { + $smtp_port = $default_smtp_port unless $smtp_port; + $smtp = Net::SMTP_auth->new($smtp_server, Port=>$smtp_port, Timeout=>$timeout,Debug=>$smtp_debug); + if( $smtp ) { + $smtp->auth($auth_method, $username, $password); + my $message = oneline($smtp->message()); + die "cannot connect with SSL/$auth_method: $message" if $smtp->code() =~ m/53\d/; + } + } + else { + $smtp_port = $default_smtp_port unless $smtp_port; + $smtp = Net::SMTP->new($smtp_server, Port=>$smtp_port, Timeout=>$timeout,Debug=>$smtp_debug); + if( $smtp && $username ) { + $smtp->auth($username, $password); + my $message = oneline($smtp->message()); + die "cannot connect with password: $message" if $smtp->code() =~ m/53\d/; + } + } +}; +if( $@ ) { + $@ =~ s/\n/ /g; # the error message can be multiline but we want our output to be just one line + print "SMTP SEND CRITICAL - $@\n"; + exit $status{CRITICAL}; +} +unless( $smtp ) { + print "SMTP SEND CRITICAL - Could not connect to $smtp_server port $smtp_port\n"; + exit $status{CRITICAL}; +} +my $time_connected = time; + +# add the monitored server's banner to the report +if( $tls ) { + $report->{banner} = ""; +} +elsif( $ssl ) { + $report->{banner} = $smtp->banner || ""; + chomp $report->{banner}; +} +else { + $report->{banner} = $smtp->banner || ""; + chomp $report->{banner}; +} + + +# send email +if( $stdin ) { + $body = ""; + while() { + $body .= $_; + } +} + +# if user wants to use template substitutions, this is the place to process body and headers +if( $template ) { + foreach my $item (@header,$body) { + my $t = Text::Template->new(TYPE=>'STRING',SOURCE=>$item,PACKAGE=>'SmtpMessageTemplate'); + $item = $t->fill_in(PREPEND=>q{package SmtpMessageTemplate;}); +# print "item: $item\n"; + } +} + + +$smtp->mail($mailfrom); +foreach( @mailto ) { + # the two SMTP modules have different error reporting mechanisms: + if( $tls ) { + # Net::SMTP::TLS croaks when the recipient is rejected + eval { + $smtp->to($_); + }; + if( $@ ) { + print "SMTP SEND CRITICAL - Could not send to $_\n"; + print "Reason: $@\n" if $verbose; + exit $status{CRITICAL}; + } + } + else { + # Net::SMTP returns false when the recipient is rejected + my $to_returned = $smtp->to($_); + if( !$to_returned ) { + print "SMTP SEND CRITICAL - Could not send to $_\n"; + print "Reason: Recipient rejected or authentication failed\n" if $verbose; + exit $status{CRITICAL}; + } + } +} + +# Net::SMTP::TLS doesn't implement code() so we need to wrap calls in eval to get our error messages + + # start data transfer (expect response 354) + $smtp->data(); + + # send data + $smtp->datasend("To: ".join(", ",@mailto)."\n"); + $smtp->datasend("From: $mailfrom\n"); + foreach( @header ) { + $smtp->datasend("$_\n"); + } + $smtp->datasend("\n"); + $smtp->datasend($body); + $smtp->datasend("\n"); + +eval { + # end data transfer (expect response 250) + $smtp->dataend(); +}; +if( $@ ) { + $actual_response = $tls ? get_tls_error($@) : $smtp->code(); +} +else { + $actual_response = $tls ? "250" : $smtp->code(); # no error means we got 250 +} + +eval { + # disconnect from SMTP server (expect response 221) + $smtp->quit(); +}; +if( $@ ) { + push @warning, "Error while disconnecting from $smtp_server"; +} + +# calculate elapsed time and issue warnings +my $time_end = time; +my $elapsedtime = $time_end - $time_start; +$report->{seconds} = $elapsedtime; + +push @warning, "connection time more than $warntime" if( $time_connected - $time_start > $warntime ); +push @critical, "connection time more than $criticaltime" if( $time_connected - $time_start > $criticaltime ); +push @critical, "response was $actual_response but expected $expect_response" if ( $actual_response ne $expect_response ); + +# print report and exit with known status +my $perf_data = "elapsed=".$report->{seconds}."s;$warntime;$criticaltime"; # TODO: need a component for safely generating valid perf data format. for notes on the format, see http://www.perfparse.de/tiki-view_faq.php?faqId=6 and http://nagiosplug.sourceforge.net/developer-guidelines.html#AEN185 +my $short_report = $report->text(qw/seconds/) . " | $perf_data"; +my $long_report = join("", map { "$_: $report->{$_}\n" } qw/banner/ ); +if( scalar @critical ) { + my $crit_alerts = join(", ", @critical); + print "SMTP SEND CRITICAL - $crit_alerts; $short_report\n"; + print $long_report if $verbose; + exit $status{CRITICAL}; +} +if( scalar @warning ) { + my $warn_alerts = join(", ", @warning); + print "SMTP SEND WARNING - $warn_alerts; $short_report\n"; + print $long_report if $verbose; + exit $status{WARNING}; +} +print "SMTP SEND OK - $short_report\n"; +print $long_report if $verbose; +exit $status{OK}; + + +# utility to load required modules. exits if unable to load one or more of the modules. +sub load_modules { + my @missing_modules = (); + foreach( @_ ) { + eval "require $_"; + push @missing_modules, $_ if $@; + } + if( @missing_modules ) { + print "Missing perl modules: @missing_modules\n"; + return 0; + } + return 1; +} + +# utility to extract error codes out of Net::SMTP::TLS croak messages +sub get_tls_error { + my ($errormsg) = @_; + $errormsg =~ m/: (\d+) (.+)/; + my $code = $1; + return $code; +} + +# looks for a specific header in a list of headers; returns true if found +sub find_header { + my ($name, @list) = @_; + return scalar grep { m/^$name: /i } @list; +} + +# RFC 2822 date header +sub default_date_header { + return strftime "Date: %a, %e %b %Y %H:%M:%S %z (%Z)", gmtime; +} + +# RFC 2822 message id header +sub default_messageid_header { + my $random = randomstring(16,qw/0 1 2 3 4 5 6 7 8 9 a b c d e f g h i j k l m n o p q r s t u v w x y z/); + my $hostname = `hostname`; + chomp $hostname; + return "Message-ID: <".time.".".$random.".checksmtpsend@".$hostname.">"; +} + +# returns a random string of specified length using characters from specified set +sub randomstring { + my ($length,@set) = @_; + my $size = scalar @set; + my $string = ""; + while($length--) { + $string .= $set[int(rand($size))]; + } + return $string; +} + +# replaces all newlines in the input string with spaces +sub oneline { + my ($input) = @_; + $input =~ s/[\r\n]+/ /g; + return $input; +} + +# NAME +# PluginReport +# SYNOPSIS +# $report = new PluginReport; +# $report->{label1} = "value1"; +# $report->{label2} = "value2"; +# print $report->text(qw/label1 label2/); +package PluginReport; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub text { + my ($self,@labels) = @_; + my @report = map { "$self->{$_} $_" } grep { defined $self->{$_} } @labels; + my $text = join(", ", @report); + return $text; +} + +package SmtpMessageTemplate; + +sub trim { + my ($text) = @_; + $text =~ s/^\s*//; + $text =~ s/\s*$//; + return $text; +} + +# NAME +# TLS_auth +# SYNOPSYS +# +# Based on contribution by Brad Guillory +package TLS_auth; +#use Net::SMTP::TLS; +our @ISA = qw(Net::SMTP::TLS); +use Carp; +sub new { + my ($proto,$server,%p) = @_; + my $class = ref($proto) || $proto; + #my $self = bless {}, $class; + no strict 'refs'; + no warnings 'once'; + *Net::SMTP::TLS::login = *TLS_auth::login; # override parent's login with ours so when it's called in the constructor, our overriden version will be used + my $self = Net::SMTP::TLS->new($server,%p); + return $self; +} + + +sub login { + my ($self) = @_; + my $type = $self->{features}->{AUTH}; + if(not $type){ + die "Server did not return AUTH in capabilities\n"; # croak + } +# print "Feature: $type\nAuth Method: $self->{Auth_Method}\n"; + if($type =~ /CRAM\-MD5/ and $self->{Auth_Method} =~ /CRAM\-MD5/i){ + $self->auth_MD5(); + }elsif($type =~ /LOGIN/ and $self->{Auth_Method} =~ /LOGIN/i){ + $self->auth_LOGIN(); + }elsif($type =~ /PLAIN/ and $self->{Auth_Method} =~ /PLAIN/i){ + #print "Calling auth_PLAIN\n"; + $self->auth_PLAIN(); + }else{ + die "Unsupported Authentication mechanism: $self->{Auth_Method}\n"; # croak + } +} + + +package main; +1; + +__END__ + +=pod + +=head1 NAME + +check_smtp_send - connects to an SMTP server and sends a message + +=head1 SYNOPSIS + + check_smtp_send -vV + check_smtp_send -? + check_smtp_send --help + +=head1 OPTIONS + +=over + +=item --warning + +Warn if it takes longer than to connect to the SMTP server. Default is 15 seconds. +Also known as: -w + +=item --critical + +Return a critical status if it takes longer than to connect to the SMTP server. Default is 30 seconds. +Also known as: -c + +=item --timeout + +Abort with critical status if it takes longer than to connect to the SMTP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t + +=item --hostname + +Address or name of the SMTP server. Examples: mail.server.com, localhost, 192.168.1.100 + +If not provided, and if there is only one --mailto address, the script will automatically look up the MX record +for the --mailto address and use that as the hostname. You can use this to check that your MX records are correct. +When omitting the --hostname option, it doesn't really make sense to specify --port, --username, or --password +but you can still do so and they will have their normal effect. To look up the MX records you need to have the +module Net::DNS and Email::Address installed. + +Also known as: -H + +=item --port + +Service port on the SMTP server. Default is 25 for regular SMTP, 465 for SSL, and 587 for TLS. +Also known as: -p + +=item --tls + +=item --notls + +Enable TLS/AUTH protocol. Requires Net::SMTP::TLS, availble on CPAN. + +When using this option, the default port is 587. +You can specify a port from the command line using the --port option. + +Use the notls option to turn off the tls option. + +Also, you may need to fix your copy of Net::SMTP::TLS. Here is the diff against version 0.12: + + 254c254 + < $me->_command(sprintf("AUTH PLAIN %S", + --- + > $me->_command(sprintf("AUTH PLAIN %s", + + +=item --ssl + +=item --nossl + +Enable SSL protocol. Requires Net::SMTP::SSL and Authen::SASL, availble on CPAN. + +When using this option, the default port is 465. You can override with the --port option. + +Use the nossl option to turn off the ssl option. + +=item --auth + +Enable authentication with Net::SMTP_auth (sold separately). +For example, try using --auth PLAIN or --auth CRAM-MD5. + +=item --username + +=item --password + +Username and password to use when connecting to SMTP server. +Also known as: -U -P + +=item --body + +Use this option to specify the body of the email message. If you need newlines in your message, +you might need to use the --stdin option instead. + +=item --header
+ +Use this option to set an arbitrary header in the message. You can use it multiple times. + +=item --stdin + +Grab the body of the email message from stdin. + +=item --mailto recipient@your.net + +You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed): + +$ check_smtp_send -H mail.server.net --mailto recipient@your.net,recipient2@your.net --mailfrom sender@your.net + +SMTP SEND OK - 1 seconds + +=item --mailfrom sender@your.net + +Use this option to set the "from" address in the email. + +=item --template + +=item --notemplate + +Enable (or disable) processing of message body and headers. Requires Text::Template. + +Use this option to apply special processing to your message body and headers that allows you to use the +results of arbitrary computations in the text. For example, you can use this feature to send a message +containing the hostname of the machine that sent the message without customizing the plugin configuration +on each machine. + +When you enable the --template option, the message body and headers are parsed by +Text::Template. Even a message body provided using the --stdin option will be parsed. +See the Text::Template manual for more information, but in general any expression +written in Perl will work. + +There is one convenience function provided to you, trim, which will remove leading and trailing whitespace +from its parameter. Here's an example: + + check_smtp_send -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net + --template --body 'hello, this message is from {use Sys::Hostname; hostname}' + --header 'Subject: test message from {trim(`whoami`)}' + + +=item --expect-response + +Use this option to specify which SMTP response code should be expected from the server +after the SMTP dialog is complete. The default is 250 (message accepted). + +Also known as: -E + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. + +One --verbose will show extra information for OK, WARNING, and CRITICAL status. + +Use one --verbose together with --version to see the default warning and critical timeout values. + +Three --verbose (or -vvv) will show debug information, unless you're using --tls because Net::SMTP::TLS +does not have a Debug feature. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Send a message with custom headers + +$ check_smtp_send -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--body 'Homeruns 5' --header 'Subject: Hello, world!' --header 'X-Your-Header: Yes' + +SMTP SEND OK - 1 seconds + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 CHANGES + + Wed Oct 29 14:05:00 PST 2005 + + version 0.1 + + Wed Nov 9 15:01:48 PST 2005 + + now using an inline PluginReport package to generate the report + + added stdin option + + copyright notice and GNU GPL + + version 0.2 + + Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton ) + + added bailing if the $smtp->to() call fails + + added support for mailto recipients separated by commas + + version 0.2.1 + + Tue Apr 24 21:17:53 PDT 2007 + + moved POD text to separate file in order to accomodate the new embedded-perl Nagios feature + + version 0.2.3 + + Fri Apr 27 20:26:42 PDT 2007 + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + version 0.3 + + Sun Oct 21 10:34:14 PDT 2007 + + added support for TLS and authentication via the Net::SMTP::TLS module. see --tls option. + + version 0.4 + + Sun Oct 21 13:54:26 PDT 2007 + + added support for SSL via the Net::SMTP::SSL module. see --ssl option. + + port is no longer a required option. defaults to 25 for regular smtp, 465 for ssl, and 587 for tls. + + added port info to the "could not connect" error message + + version 0.4.1 + + Tue Dec 4 07:42:32 PST 2007 + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + fixed some minor pod formatting issues for perldoc + + version 0.4.2 + + Mon Feb 11 19:09:37 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.4.3 + + Mon May 26 09:12:14 PDT 2008 + + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly + + version 0.4.4 + + Wed Jul 2 07:12:35 PDT 2008 + + added --expect-response option submitted by Christian Kauhaus + + added support for authentication via Net::SMTP_auth. see --auth option. + + version 0.4.5 + + Sun Oct 5 15:18:23 PDT 2008 + + added error handling for smtp server disconnects ungracefully during QUIT (gmail.com does) + + version 0.4.6 + + Thu Oct 1 12:09:35 PDT 2009 + + added --template option to allow arbitrary substitutions for body and headers, and provided one convenience function for trimming strings + + added performance data for use with PNP4Nagios! + + version 0.5.0 + + Thu Oct 8 11:17:04 PDT 2009 + + added more detailed error messages when using --verbose + + version 0.5.1 + + Tue Feb 9 12:14:49 PST 2010 + + added support for combining --auth with --tls using a subclass of Net::SMTP::TLS submitted by Brad Guillory; please note that to use the "PLAIN" authentication type you need to patch your Net::SMTP:TLS because it has a bug in sub auth_PLAIN (sprintf %S instead of %s) + + version 0.5.2 + + Mon Jan 3 10:39:42 PST 2011 + + added default Date and Message-ID headers; Date header uses POSIX strftime and Message-ID header uses hostname command to get localhost name + + version 0.7.0 + + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.1 + + Wed Jul 6 19:18:26 AST 2011 + + the --hostname is now optional; if not provided the plugin will lookup the MX record for the --mailto address (requires Net::DNS) + + version 0.7.2 + + Tue Dec 13 09:24:04 PST 2011 + + separated authentication errors from connection errors + + version 0.7.3 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2005-2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_smtp_send_epn b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_smtp_send_epn new file mode 100644 index 0000000..9648ec8 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/check_smtp_send_epn @@ -0,0 +1,458 @@ +#!/usr/bin/perl +use strict; +use POSIX qw(strftime); +my $VERSION = '0.7.3'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +# look for required modules +exit $status{UNKNOWN} unless load_modules(qw/Getopt::Long Net::SMTP/); + +BEGIN { + if( grep { /^--hires$/ } @ARGV ) { + eval "use Time::HiRes qw(time);"; + warn "Time::HiRes not installed\n" if $@; + } +} + +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $smtp_server = ""; +my $default_smtp_port = "25"; +my $default_smtp_ssl_port = "465"; +my $default_smtp_tls_port = "587"; +my $smtp_port = ""; +my @mailto = (); +my $mailfrom = ""; +my @header = (); +my $body = ""; +my $stdin = ""; +my $template = ""; +my $expect_response = "250"; +my $warntime = 15; +my $criticaltime = 30; +my $timeout = 60; +my $tls = 0; +my $ssl = 0; +my $auth_method = undef; +my $username = ""; +my $password = ""; +my $time_hires = ""; +my $mx_lookup = 0; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + "w|warning=i"=>\$warntime,"c|critical=i"=>\$criticaltime,"t|timeout=i"=>\$timeout, + # smtp settings + "H|hostname=s"=>\$smtp_server,"p|port=i"=>\$smtp_port, + "mailto=s"=>\@mailto, "mailfrom=s",\$mailfrom, + "header=s"=>\@header, "body=s"=>\$body, "stdin"=>\$stdin, + "template!"=>\$template, + # SSL/TLS/auth options + "tls!"=>\$tls, "ssl!"=>\$ssl, "auth=s"=>\$auth_method, + "U|username=s"=>\$username,"P|password=s"=>\$password, + # Server response + "E|expect-response=s"=>\$expect_response, + # Time + "hires"=>\$time_hires, + ); + +if( $show_version ) { + print "$VERSION\n"; + if( $verbose ) { + print "Default warning threshold: $warntime seconds\n"; + print "Default critical threshold: $criticaltime seconds\n"; + print "Default timeout: $timeout seconds\n"; + } + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +if( $smtp_server eq "" && scalar(@mailto) == 1 ) { + # no SMTP server specified but one mailto address given means we can look up the MX record + $mx_lookup = 1; +} + +my @required_module = (); +push @required_module, 'Net::SMTP::SSL' if $ssl; +push @required_module, ('MIME::Base64','Authen::SASL') if $ssl && $username; +push @required_module, 'Net::SMTP::TLS' if $tls; +push @required_module, 'Net::SMTP_auth' if $auth_method and not $tls; # whereas if auth_method and tls we use TLS_auth, which is included in this script! +push @required_module, 'Text::Template' if $template; +push @required_module, 'Net::DNS' if $mx_lookup; +push @required_module, 'Email::Address' if $mx_lookup; +exit $status{UNKNOWN} unless load_modules(@required_module); + + +# split up @mailto if commas were used instead of multiple options +@mailto = split(/,/,join(',',@mailto)); + +if( $help_usage || + ( + ($smtp_server eq "" && !$mx_lookup) || scalar(@mailto)==0 || $mailfrom eq "" + ) + ) { + print "Usage: $0 [-H host [-p port]] --mailto recipient\@your.net [--mailto recipient2\@your.net ...] --mailfrom sender\@your.net --body 'some text' [-w ] [-c ]\n"; + exit $status{UNKNOWN}; +} + +# initialize +my $report = new PluginReport; +my $time_start = time; +my $actual_response = undef; +my @warning = (); +my @critical = (); + +my $smtp_debug = 0; +$smtp_debug = 1 if $verbose >= 3; + +# default date and message id headers +push @header, default_date_header() unless find_header("Date",@header); +push @header, default_messageid_header() unless find_header("Message-ID",@header); + +# look up MX server if necessary +if( $mx_lookup ) { + my $addr = Email::Address->new( undef, $mailto[0] ); + my $mx_domain = $addr->host; + print "MX lookup " . $mx_domain . "\n" if $verbose > 1; + my $res = Net::DNS::Resolver->new; + my @mx = Net::DNS::mx($res, $mx_domain); + if( @mx ) { + # use the first server + foreach my $rr (@mx) { + print "pref : " . $rr->preference . " exchange: " . $rr->exchange . "\n" if $verbose > 2; + } + $smtp_server = $mx[0]->exchange; + print "smtp server: $smtp_server\n" if $verbose; + } + else { + print "SMTP SEND CRITICAL - Cannot find MX records for $mx_domain\n"; + exit $status{CRITICAL}; + } +} + +# connect to SMTP server +# create the smtp handle using Net::SMTP, Net::SMTP::SSL, Net::SMTP::TLS, or an authentication variant +my $smtp; +eval { + if( $tls and $auth_method ) { + $smtp_port = $default_smtp_tls_port unless $smtp_port; + $smtp = TLS_auth->new($smtp_server, Timeout=>$timeout, Port=>$smtp_port, User=>$username, Password=>$password, Auth_Method=>$auth_method); + if( $smtp ) { + my $message = oneline($smtp->message()); + die "cannot connect with TLS/$auth_method: $message" if $smtp->code() =~ m/53\d/; + } + } + elsif( $tls ) { + $smtp_port = $default_smtp_tls_port unless $smtp_port; + $smtp = Net::SMTP::TLS->new($smtp_server, Timeout=>$timeout, Port=>$smtp_port, User=>$username, Password=>$password); + if( $smtp ) { + my $message = oneline($smtp->message()); + die "cannot connect with TLS: $message" if $smtp->code() =~ m/53\d/; + } + } + elsif( $ssl ) { + $smtp_port = $default_smtp_ssl_port unless $smtp_port; + $smtp = Net::SMTP::SSL->new($smtp_server, Port => $smtp_port, Timeout=>$timeout,Debug=>$smtp_debug); + if( $smtp && $username ) { + $smtp->auth($username, $password); + my $message = oneline($smtp->message()); + die "cannot connect with SSL/password: $message" if $smtp->code() =~ m/53\d/; + } + } + elsif( $auth_method ) { + $smtp_port = $default_smtp_port unless $smtp_port; + $smtp = Net::SMTP_auth->new($smtp_server, Port=>$smtp_port, Timeout=>$timeout,Debug=>$smtp_debug); + if( $smtp ) { + $smtp->auth($auth_method, $username, $password); + my $message = oneline($smtp->message()); + die "cannot connect with SSL/$auth_method: $message" if $smtp->code() =~ m/53\d/; + } + } + else { + $smtp_port = $default_smtp_port unless $smtp_port; + $smtp = Net::SMTP->new($smtp_server, Port=>$smtp_port, Timeout=>$timeout,Debug=>$smtp_debug); + if( $smtp && $username ) { + $smtp->auth($username, $password); + my $message = oneline($smtp->message()); + die "cannot connect with password: $message" if $smtp->code() =~ m/53\d/; + } + } +}; +if( $@ ) { + $@ =~ s/\n/ /g; # the error message can be multiline but we want our output to be just one line + print "SMTP SEND CRITICAL - $@\n"; + exit $status{CRITICAL}; +} +unless( $smtp ) { + print "SMTP SEND CRITICAL - Could not connect to $smtp_server port $smtp_port\n"; + exit $status{CRITICAL}; +} +my $time_connected = time; + +# add the monitored server's banner to the report +if( $tls ) { + $report->{banner} = ""; +} +elsif( $ssl ) { + $report->{banner} = $smtp->banner || ""; + chomp $report->{banner}; +} +else { + $report->{banner} = $smtp->banner || ""; + chomp $report->{banner}; +} + + +# send email +if( $stdin ) { + $body = ""; + while() { + $body .= $_; + } +} + +# if user wants to use template substitutions, this is the place to process body and headers +if( $template ) { + foreach my $item (@header,$body) { + my $t = Text::Template->new(TYPE=>'STRING',SOURCE=>$item,PACKAGE=>'SmtpMessageTemplate'); + $item = $t->fill_in(PREPEND=>q{package SmtpMessageTemplate;}); +# print "item: $item\n"; + } +} + + +$smtp->mail($mailfrom); +foreach( @mailto ) { + # the two SMTP modules have different error reporting mechanisms: + if( $tls ) { + # Net::SMTP::TLS croaks when the recipient is rejected + eval { + $smtp->to($_); + }; + if( $@ ) { + print "SMTP SEND CRITICAL - Could not send to $_\n"; + print "Reason: $@\n" if $verbose; + exit $status{CRITICAL}; + } + } + else { + # Net::SMTP returns false when the recipient is rejected + my $to_returned = $smtp->to($_); + if( !$to_returned ) { + print "SMTP SEND CRITICAL - Could not send to $_\n"; + print "Reason: Recipient rejected or authentication failed\n" if $verbose; + exit $status{CRITICAL}; + } + } +} + +# Net::SMTP::TLS doesn't implement code() so we need to wrap calls in eval to get our error messages + + # start data transfer (expect response 354) + $smtp->data(); + + # send data + $smtp->datasend("To: ".join(", ",@mailto)."\n"); + $smtp->datasend("From: $mailfrom\n"); + foreach( @header ) { + $smtp->datasend("$_\n"); + } + $smtp->datasend("\n"); + $smtp->datasend($body); + $smtp->datasend("\n"); + +eval { + # end data transfer (expect response 250) + $smtp->dataend(); +}; +if( $@ ) { + $actual_response = $tls ? get_tls_error($@) : $smtp->code(); +} +else { + $actual_response = $tls ? "250" : $smtp->code(); # no error means we got 250 +} + +eval { + # disconnect from SMTP server (expect response 221) + $smtp->quit(); +}; +if( $@ ) { + push @warning, "Error while disconnecting from $smtp_server"; +} + +# calculate elapsed time and issue warnings +my $time_end = time; +my $elapsedtime = $time_end - $time_start; +$report->{seconds} = $elapsedtime; + +push @warning, "connection time more than $warntime" if( $time_connected - $time_start > $warntime ); +push @critical, "connection time more than $criticaltime" if( $time_connected - $time_start > $criticaltime ); +push @critical, "response was $actual_response but expected $expect_response" if ( $actual_response ne $expect_response ); + +# print report and exit with known status +my $perf_data = "elapsed=".$report->{seconds}."s;$warntime;$criticaltime"; # TODO: need a component for safely generating valid perf data format. for notes on the format, see http://www.perfparse.de/tiki-view_faq.php?faqId=6 and http://nagiosplug.sourceforge.net/developer-guidelines.html#AEN185 +my $short_report = $report->text(qw/seconds/) . " | $perf_data"; +my $long_report = join("", map { "$_: $report->{$_}\n" } qw/banner/ ); +if( scalar @critical ) { + my $crit_alerts = join(", ", @critical); + print "SMTP SEND CRITICAL - $crit_alerts; $short_report\n"; + print $long_report if $verbose; + exit $status{CRITICAL}; +} +if( scalar @warning ) { + my $warn_alerts = join(", ", @warning); + print "SMTP SEND WARNING - $warn_alerts; $short_report\n"; + print $long_report if $verbose; + exit $status{WARNING}; +} +print "SMTP SEND OK - $short_report\n"; +print $long_report if $verbose; +exit $status{OK}; + + +# utility to load required modules. exits if unable to load one or more of the modules. +sub load_modules { + my @missing_modules = (); + foreach( @_ ) { + eval "require $_"; + push @missing_modules, $_ if $@; + } + if( @missing_modules ) { + print "Missing perl modules: @missing_modules\n"; + return 0; + } + return 1; +} + +# utility to extract error codes out of Net::SMTP::TLS croak messages +sub get_tls_error { + my ($errormsg) = @_; + $errormsg =~ m/: (\d+) (.+)/; + my $code = $1; + return $code; +} + +# looks for a specific header in a list of headers; returns true if found +sub find_header { + my ($name, @list) = @_; + return scalar grep { m/^$name: /i } @list; +} + +# RFC 2822 date header +sub default_date_header { + return strftime "Date: %a, %e %b %Y %H:%M:%S %z (%Z)", gmtime; +} + +# RFC 2822 message id header +sub default_messageid_header { + my $random = randomstring(16,qw/0 1 2 3 4 5 6 7 8 9 a b c d e f g h i j k l m n o p q r s t u v w x y z/); + my $hostname = `hostname`; + chomp $hostname; + return "Message-ID: <".time.".".$random.".checksmtpsend@".$hostname.">"; +} + +# returns a random string of specified length using characters from specified set +sub randomstring { + my ($length,@set) = @_; + my $size = scalar @set; + my $string = ""; + while($length--) { + $string .= $set[int(rand($size))]; + } + return $string; +} + +# replaces all newlines in the input string with spaces +sub oneline { + my ($input) = @_; + $input =~ s/[\r\n]+/ /g; + return $input; +} + +# NAME +# PluginReport +# SYNOPSIS +# $report = new PluginReport; +# $report->{label1} = "value1"; +# $report->{label2} = "value2"; +# print $report->text(qw/label1 label2/); +package PluginReport; + +sub new { + my ($proto,%p) = @_; + my $class = ref($proto) || $proto; + my $self = bless {}, $class; + $self->{$_} = $p{$_} foreach keys %p; + return $self; +} + +sub text { + my ($self,@labels) = @_; + my @report = map { "$self->{$_} $_" } grep { defined $self->{$_} } @labels; + my $text = join(", ", @report); + return $text; +} + +package SmtpMessageTemplate; + +sub trim { + my ($text) = @_; + $text =~ s/^\s*//; + $text =~ s/\s*$//; + return $text; +} + +# NAME +# TLS_auth +# SYNOPSYS +# +# Based on contribution by Brad Guillory +package TLS_auth; +#use Net::SMTP::TLS; +our @ISA = qw(Net::SMTP::TLS); +use Carp; +sub new { + my ($proto,$server,%p) = @_; + my $class = ref($proto) || $proto; + #my $self = bless {}, $class; + no strict 'refs'; + no warnings 'once'; + *Net::SMTP::TLS::login = *TLS_auth::login; # override parent's login with ours so when it's called in the constructor, our overriden version will be used + my $self = Net::SMTP::TLS->new($server,%p); + return $self; +} + + +sub login { + my ($self) = @_; + my $type = $self->{features}->{AUTH}; + if(not $type){ + die "Server did not return AUTH in capabilities\n"; # croak + } +# print "Feature: $type\nAuth Method: $self->{Auth_Method}\n"; + if($type =~ /CRAM\-MD5/ and $self->{Auth_Method} =~ /CRAM\-MD5/i){ + $self->auth_MD5(); + }elsif($type =~ /LOGIN/ and $self->{Auth_Method} =~ /LOGIN/i){ + $self->auth_LOGIN(); + }elsif($type =~ /PLAIN/ and $self->{Auth_Method} =~ /PLAIN/i){ + #print "Calling auth_PLAIN\n"; + $self->auth_PLAIN(); + }else{ + die "Unsupported Authentication mechanism: $self->{Auth_Method}\n"; # croak + } +} + + +package main; +1; + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to connect to IMAP server manually.txt b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to connect to IMAP server manually.txt new file mode 100644 index 0000000..ce52655 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to connect to IMAP server manually.txt @@ -0,0 +1,69 @@ +HOW TO CONNECT TO IMAP SERVER MANUALLY + +This how-to borrowed from: http://www.bincimap.org/bincimap-faq.html + + +1) Connection +Using telnet, connect to your service on port 143. Replace "server" with your server's name. If the server is set up correctly, you will see this greeting: + # telnet server 143 + * OK IMAP Server ready + +If you have SSL enabled (most likely you do), connect to port 993 with the openssl tool. If the server is set up correctly, you will see this greeting: + # openssl s_client -connect server:993 -crlf + * OK IMAP Server ready + +2) Logging in / authenticating +Firstly, check your bincimap.conf file, in the "Authentication" section, for this setting: +allow plain auth in non ssl = "no" + +If you want users to be able to connect without using SSL, set this to "yes". +Using either the telnet (in case of "yes" in the above example) or openssl tool, try the LOGIN command, replacing "username" with one username on your server, and "password" with that user's password. You should get the reply on the second line. +1 LOGIN username password +1 LOGIN completed + +Note that you should try logging in with at least two users to check that this feature is working properly. +3) Listing, creating, renaming and deleting mailboxes +Enter the following command to list the user's first level mailboxes. You should get at least one line of response (starting with "* LIST") before you get the "2 OK LIST" reponse. +2 LIST "" "%" +* LIST (\UnMarked) "/" "INBOX" +2 OK LIST completed + +Check your bincimap.conf file, under the Mailbox section, and check the "depot" setting. Try creating a mailbox with the following command, replacing mailbox with a name of your choice. Note that if you are using the Maildir++ depot setting, you must use "INBOX/mailbox" instead: +3 CREATE mailbox +3 OK CREATE completed + +Rename the mailbox with this command. Note the "INBOX/" prefix when using a Maildir++ depot. (After that, rerunning the LIST command from above will give you a slightly different result than before): +4 RENAME mailbox newmailbox +4 OK RENAME completed + +Now delete the mailbox with this command: +5 DELETE newmailbox +5 OK DELETE completed + +4) Selecting a mailbox and looking inside +Select your INBOX with this command. Note that the response may be slightly different from in this example: +6 SELECT INBOX +* 146 EXISTS +* OK [UIDVALIDITY 1047992537] +* OK [UIDNEXT 2683] 2683 is the next UID +* FLAGS (\Answered \Flagged \Deleted \Recent \Seen \Draft) +* OK [PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft)] Limited +6 OK [READ-WRITE] + +Fetch the flags of all your messages with this command. Note that the "..." is for editorial clarity, many lines of output have been omitted in this example: +7 FETCH 1:* FLAGS +* 1 FETCH (FLAGS (\Seen \Answered)) +* 2 FETCH (FLAGS (\Seen \Answered)) +... +* 146 FETCH (FLAGS (\Seen \Answered)) +7 OK FETCH completed + +Set a flag with this command: +8 STORE 1 +FLAGS \Flagged +* FETCH (FLAGS (\Seen \Flagged)) +8 OK STORE completed + +5) Logging out +9 LOGOUT +* BYE Server logging out +9 OK LOGOUT finished. diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to test plugin.txt b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to test plugin.txt new file mode 100644 index 0000000..369baf4 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/How to test plugin.txt @@ -0,0 +1,15 @@ +HOW TO TEST THE PLUGIN + +Run the shell script tests which start the test server automatically: + +./test/3_email_delivery.sh + + + + + + +If you want to start up the test server yourself: + +sudo perl test/dummy_smtp_server.pl + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.html new file mode 100644 index 0000000..31422bc --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.html @@ -0,0 +1,522 @@ + + + + +check_email_delivery - sends email and verifies delivery + + + + + + + + + +
+

+ + + +
+ + +

+

+
+

NAME

+

check_email_delivery - sends email and verifies delivery

+

+

+
+

SYNOPSIS

+
+ check_email_delivery -vV
+ check_email_delivery --usage
+ check_email_delivery --help
+

+

+
+

OPTIONS

+
+
--warning <seconds>[,<smtp_seconds>,<imap_seconds>]
+ +
+

Exit with WARNING if the most recent email found is older than <seconds>. The +optional <smtp_seconds> and <imap_seconds> parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -w <seconds>[,<send>[,<recv>]]

+

When using the --plugin option, only one parameter is supported (-w <seconds>) and it will apply +to the entire process. You can specify a warning threshold specific to each plugin in the +plugin command line.

+

When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions.

+
+
--critical <seconds>[,<smtp_seconds>,<imap_seconds>]
+ +
+

Exit with CRITICAL if the most recent email found is older than <seconds>. The +optional <smtp_seconds> and <imap_seconds> parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -c <seconds>[,<send>[,<recv>]]

+

When using the --plugin option, only one parameter is supported (-c <seconds>) and it will apply +to the entire process. You can specify a critical threshold specific to each plugin in the +plugin command line.

+

When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions.

+
+
--timeout <seconds>
+ +
--timeout <smtp_seconds>,<imap_seconds>
+ +
--timeout <plugin1_seconds>,<plugin2_seconds>,...
+ +
+

Exit with CRITICAL if the plugins do not return a status within the specified number of seconds. +When only one parameter is used, it applies to each plugin. When multiple parameters are used +(separated by commas) they apply to plugins in the same order the plugins were specified on the +command line. When using --timeout but not the --plugin option, the first parameter is for +check_smtp_send and the second is for check_imap_receive.

+
+
--alert <pluginN>
+ +
+

Exit with WARNING or CRITICAL only if a warning or error (--warning, --critical, or --timeout) +occurs for specified plugins. If a warning or error occurs for non-specified plugins that run +BEFORE the specified plugins, the exit status will be UNKNOWN. If a warning of error occurs +for non-specified plugins that run AFTER the specified plugins, the exit status will not be +affected.

+

You would use this option if you are using check_email_delivery with the --plugin option and +the plugins you configure each use different servers, for example different SMTP and IMAP servers. +By default, if you do not use the --alert option, if anything goes wrong during the email delivery +check, a WARNING or CRITICAL alert will be issued. This means that if you define check_email_delivery +for the SMTP server only and the IMAP server fails, Nagios will alert you for the SMTP server which +would be misleading. If you define it for both the SMTP server and IMAP server and just one of them +fails, Nagios will alert you for both servers, which would still be misleading. If you have this +situation, you may want to use the --alert option. You define the check_email_delivery check for +both servers: for the SMTP server (first plugin) you use --alert 1, and for for the IMAP server +(second plugin) you use --alert 2. When check_email_delivery runs with --alert 1 and the SMTP +server fails, you will get the appropriate alert. If the IMAP server fails it will not affect the +status. When check_email_delivery runs with --alert 2 and the SMTP server fails, you will get the +UNKNOWN return code. If the IMAP server generates an alert you will get a WARNING or CRITICAL as +appropriate.

+

You can repeat this option to specify multiple plugins that should cause an alert. +Do this if you have multiple plugins on the command line but some of them involve the same server.

+

See also: --plugin. +Also known as: -A <pluginN>

+
+
--wait <seconds>[,<seconds>,...]
+ +
+

How long to wait between sending the message and checking that it was received. View default with +the -vV option.

+

When using the --plugin option, you can specify as many wait-between times as you have plugins +(minus the last plugin, because it makes no sense to wait after running the last one). For +example, if you use the --plugin option twice to specify an SMTP plugin and an IMAP plugin, and +you want to wait 5 seconds between sending and receiving, then you would specify --wait 5. A second +example, if you are using the --plugin option three times, then specifying -w 5 will wait 5 seconds +between the second and third plugins also. You can specify a different wait time +of 10 seconds between the second and third plugins, like this: -w 5,10.

+
+
--hostname <server>
+ +
+

Address or name of the SMTP and IMAP server. Examples: mail.server.com, localhost, 192.168.1.100. +Also known as: -H <server>

+
+
--smtp-server <server>
+ +
+

Address or name of the SMTP server. Examples: smtp.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option.

+
+
--smtp-port <number>
+ +
+

Service port on the SMTP server. Default is 25.

+
+
--smtp-username <username>
+ +
--smtp-password <password>
+ +
+

Username and password to use when connecting to the SMTP server with the TLS option. +Use these options if the SMTP account has a different username/password than the +IMAP account you are testing. These options take precendence over the --username and +the --password options.

+

These are shell-escaped; special characters are ok.

+
+
--imap-server <server>
+ +
+

Address or name of the IMAP server. Examples: imap.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option.

+
+
--imap-port <number>
+ +
+

Service port on the IMAP server. Default is 143. If you use SSL the default is 993.

+
+
--imap-username <username>
+ +
--imap-password <password>
+ +
+

Username and password to use when connecting to the IMAP server. +Use these options if the IMAP account has a different username/password than the +SMTP account you are testing. These options take precendence over the --username and +the --password options.

+

These are shell-escaped; special characters are ok.

+
+
--username <username>
+ +
--password <password>
+ +
+

Username and password to use when connecting to IMAP server. +Also known as: -U <username> -P <password>

+

Also used as the username and password for SMTP when the TLS option is enabled. +To specify a separate set of credentials for SMTP authentication, see the +options --smtp-username and --smtp-password.

+
+
--imap-check-interval <seconds>
+ +
+

How long to wait between polls of the imap-server for the specified mail. Default is 5 seconds.

+
+
--imap-retries <times>
+ +
+

How many times to poll the imap-server for the mail, before we give up. Default is 10.

+
+
--body <message>
+ +
+

Use this option to specify the body of the email message.

+
+
--header <header>
+ +
+

Use this option to set an arbitrary header in the message. You can use it multiple times.

+
+
--mailto recipient@your.net
+ +
+

You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed):

+

$ check_email_delivery ... --mailto recipient@your.net,recipient2@your.net --mailfrom sender@your.net

+

This argument is shell-escaped; special characters or angle brackets around the address are ok.

+
+
--mailfrom sender@your.net
+ +
+

Use this option to set the "from" address in the email.

+
+
--imapssl +=item --noimapssl
+ +
+

Use this to enable or disable SSL for the IMAP plugin.

+

This argument is shell-escaped; special characters or angle brackets around the address are ok.

+
+
--smtptls +=item --nosmtptls
+ +
+

Use this to enable or disable TLS/AUTH for the SMTP plugin.

+
+
--libexec
+ +
+

Use this option to set the path of the Nagios libexec directory. The default is +/usr/local/nagios/libexec. This is where this plugin looks for the SMTP and IMAP +plugins that it depends on.

+
+
--plugin <command>
+ +
+

This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It frees the plugin from depending on specific external plugins and generalizes the +work done to determine that the email loop is operational. When using the --plugin +option, the following options are ignored: libexec, imapssl, smtptls, hostname, +username, password, smtp*, imap*, mailto, mailfrom, body, header, search.

+

Use this option multiple times to specify the complete trip. Typically, you would use +this twice to specify plugins for SMTP and IMAP, or SMTP and POP3.

+

The output will be success if all the plugins return success. Each plugin should be a +standard Nagios plugin.

+

A random token will be automatically generated and passed to each plugin specified on +the command line by substituting the string %TOKEN1%.

+

Example usage:

+
+ command_name check_email_delivery
+ command_line check_email_delivery
+ --plugin "$USER1$/check_smtp_send -H $ARG1$ --mailto recipient@your.net --mailfrom sender@your.net --header 'Subject: Nagios Test %TOKEN1%.'"
+ --plugin "$USER1$/check_imap_receive -H $ARG1$ -U $ARG1$ -P $ARG2$ -s SUBJECT -s 'Nagios Test %TOKEN1%.'"
+

This technique allows for a lot of flexibility in configuring the plugins that test +each part of your email delivery loop.

+

See also: --token. +Also known as: -p <command>

+
+
--token <format>
+ +
+

This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It can be used in conjunction with --plugin to control the tokens that are generated +and passed to the plugins, like %TOKEN1%.

+

Use this option multiple times to specify formats for different tokens. For example, +if you want %TOKEN1% to consist of only alphabetical characters but want %TOKEN2% to +consist of only digits, then you might use these options: --token aaaaaa --token nnnnn

+

Any tokens used in your plugin commands that have not been specified by --token <format> +will default to --token U-X-Y

+

Token formats: +a - alpha character (a-z) +n - numeric character (0-9) +c - alphanumeric character (a-z0-9) +h - hexadecimal character (0-9a-f) +U - unix time, seconds from epoch. eg 1193012441 +X - a word from the pgp even list. eg aardvark +Y - a word from the pgp odd list. eg adroitness

+

Caution: It has been observed that some IMAP servers do not handle underscores well in the +search criteria. For best results, avoid using underscores in your tokens. Use hyphens or commas instead.

+

See also: --plugin. +Also known as: -T <format>

+

The PGP word list was obtained from http://en.wikipedia.org/wiki/PGP_word_list

+
+
--file <file>
+ +
+

Save (append) status information into the given tab-delimited file. Format used:

+
+ token  start-time      end-time        status  plugin-num      output
+

Note: format may change in future versions and may become configurable.

+

This option available as of version 0.6.2.

+

Also known as: -F <file>

+
+
--hires
+ +
+

Use the Time::HiRes module to measure time, if available.

+
+
--verbose
+ +
+

Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. +Also known as: -v

+
+
--version
+ +
+

Display plugin version and exit. +Also known as: -V

+
+
--help
+ +
+

Display this documentation and exit. Does not work in the ePN version. +Also known as: -h

+
+
--usage
+ +
+

Display a short usage instruction and exit.

+
+
+

+

+
+

EXAMPLES

+

+

+

Send a message with custom headers

+

$ check_email_delivery -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--username recipient --password secret

+

EMAIL DELIVERY OK - 1 seconds

+

+

+

Set warning and critical timeouts for receive plugin only:

+

$ check_email_delivery -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--username recipient --password secret -w ,,5 -c ,,15

+

EMAIL DELIVERY OK - 1 seconds

+

+

+
+

EXIT CODES

+

Complies with the Nagios plug-in specification: +
0OKThe plugin was able to check the service and it appeared to be functioning properly +
1WarningThe plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly +
2CriticalThe plugin detected that either the service was not running or it was above some "critical" threshold +
3UnknownInvalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service

+

+

+
+

NAGIOS PLUGIN NOTES

+

Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html

+

This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV.

+

Other than that, it attempts to follow published guidelines for Nagios plugins.

+

+

+
+

CHANGES

+
+ Wed Oct 29 13:08:00 PST 2005
+ + version 0.1
+
+ Wed Nov  9 17:16:09 PST 2005
+ + updated arguments to check_smtp_send and check_imap_receive
+ + added eval/alarm block to implement -c option
+ + added wait option to adjust sleep time between smtp and imap calls
+ + added delay-warn and delay-crit options to adjust email delivery warning thresholds
+ + now using an inline PluginReport package to generate the report
+ + copyright notice and GNU GPL
+ + version 0.2
+
+ Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson <johann (at) axis.com>)
+ + version 0.2.1
+ + corrected bug in getoptions ($imap_server would never ever be set from command-line...)
+ + will not make $smtp_server and $imap_server == $host if they're defined on commandline 
+ + added support for multiple polls of imap-server, with specified intervals
+ + changed default behaviour in check_imap_server (searches for the specific id in subject and deletes mails found)
+ + increased default delay_warn from 65 seconds to 95 seconds
+
+ Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton <geoff.crompton@strategicdata.com.au>)
+ + fixed a bug in getoptions
+ + version 0.2.2
+
+ Tue Apr 24 21:17:53 PDT 2007
+ + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature
+ + version 0.2.3
+
+ Fri Apr 27 20:32:53 PDT 2007 
+ + documentation now mentions every command-line option accepted by the plugin, including abbreviations
+ + changed connection error to display timeout only if timeout was the error
+ + default IMAP plugin is libexec/check_imap_receive (also checking for same but with .pl extension)
+ + default SMTP plugin is libexec/check_smtp_send (also checking for same but with .pl extension)
+ + removed default values for SMTP port and IMAP port to allow those plugins to set the defaults; so current behavior stays the same and will continue to make sense with SSL
+ + version 0.3
+
+ Thu Oct 11 10:00:00 EET 2007 (by Timo Virtaneva <timo (at) virtaneva dot com>
+ + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers
+ + version 0.3.1
+
+ Sun Oct 21 11:01:03 PDT 2007
+ + added support for TLS options to the SMTP plugin
+ + version 0.4
+
+ Sun Oct 21 16:17:14 PDT 2007
+ + added support for arbitrary plugins to send and receive mail (or anthing else!). see the --plugin option.
+ + version 0.5
+
+ Tue Dec  4 07:36:20 PST 2007
+ + added --usage option because the official nagios plugins have both --help and --usage
+ + added --timeout option to match the official nagios plugins
+ + shortcut option for --token is now -T to avoid clash with standard shortcut -t for --timeout
+ + fixed some minor pod formatting issues for perldoc
+ + version 0.5.1
+
+ Sat Dec 15 07:39:59 PST 2007
+ + improved compatibility with Nagios embedded perl (ePN)
+ + version 0.5.2
+
+ Thu Jan 17 20:27:36 PST 2008 (by Timo Virtaneva <timo (at) virtaneva dot com> on Thu Oct 11 10:00:00 EET 2007)
+ + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers
+ + version 0.5.3
+
+ Mon Jan 28 22:11:02 PST 2008
+ + fixed a bug, smtp-password and imap-password are now string parameters
+ + added --alert option to allow selection of which plugin(s) should cause a WARNING or CRITICAL alert
+ + version 0.6
+
+ Mon Feb 11 19:09:37 PST 2008
+ + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules
+ + version 0.6.1
+
+ Mon May 26 10:39:19 PDT 2008
+ + added --file option to allow plugin to record status information into a tab-delimited file
+ + changed default token from U_X_Y to U-X-Y 
+ + version 0.6.2
+
+ Wed Jan 14 08:29:35 PST 2009
+ + fixed a bug that the --header parameter was not being passed to the smtp plugin.
+ + version 0.6.3
+
+ Mon Jun  8 15:43:48 PDT 2009
+ + added performance data for use with PNP4Nagios! (thanks to Ben Ritcey for the patch)
+ + version 0.6.4
+
+ Wed Sep 16 07:10:10 PDT 2009
+ + added elapsed time in seconds to performance data
+ + version 0.6.5
+
+ Fri Oct  8 19:48:44 PDT 2010
+ + fixed uniform IMAP and SMTP username and password bug (thanks to Micle Moerenhout for pointing it out)
+ + version 0.6.6
+
+ Mon Jan  3 08:24:23 PST 2011
+ + added shell escaping for smtp-username, smtp-password, mailto, mailfrom, imap-username, and imap-password arguments
+ + version 0.7.0
+
+ Fri May  6 08:35:09 AST 2011
+ + added --hires option to enable use of Time::Hires if available
+ + version 0.7.1
+
+ Sun Jun 12 17:17:06 AST 2011
+ + added --imap-mailbox option to pass through to check_imap_receive --mailbox option
+ + added --ssl option to conveniently enable both --smtp-tls and --imap-ssl 
+ + version 0.7.2
+

+

+
+

AUTHOR

+

Jonathan Buhacoff <jonathan@buhacoff.net>

+

+

+
+

COPYRIGHT AND LICENSE

+
+ Copyright (C) 2005-2011 Jonathan Buhacoff
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>;.
+
+ http://www.gnu.org/licenses/gpl.txt
+ + + + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.pod new file mode 100644 index 0000000..8e8c9dc --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_email_delivery.pod @@ -0,0 +1,472 @@ + + +=pod + +=head1 NAME + +check_email_delivery - sends email and verifies delivery + +=head1 SYNOPSIS + + check_email_delivery -vV + check_email_delivery --usage + check_email_delivery --help + +=head1 OPTIONS + +=over + +=item --warning [,,] + +Exit with WARNING if the most recent email found is older than . The +optional and parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -w [,[,]] + +When using the --plugin option, only one parameter is supported (-w ) and it will apply +to the entire process. You can specify a warning threshold specific to each plugin in the +plugin command line. + +When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions. + +=item --critical [,,] + +Exit with CRITICAL if the most recent email found is older than . The +optional and parameters will be passed on to the +included plugins that are used for those tasks. If they are not +given then they will not be passed on and the default for that plugin will apply. +Also known as: -c [,[,]] + +When using the --plugin option, only one parameter is supported (-c ) and it will apply +to the entire process. You can specify a critical threshold specific to each plugin in the +plugin command line. + +When using the --plugin option, no measuring of "most recent email" is done because we would +not know how to read this information from receive plugins. This may be addressed in future versions. + +=item --timeout + +=item --timeout , + +=item --timeout ,,... + +Exit with CRITICAL if the plugins do not return a status within the specified number of seconds. +When only one parameter is used, it applies to each plugin. When multiple parameters are used +(separated by commas) they apply to plugins in the same order the plugins were specified on the +command line. When using --timeout but not the --plugin option, the first parameter is for +check_smtp_send and the second is for check_imap_receive. + +=item --alert + +Exit with WARNING or CRITICAL only if a warning or error (--warning, --critical, or --timeout) +occurs for specified plugins. If a warning or error occurs for non-specified plugins that run +BEFORE the specified plugins, the exit status will be UNKNOWN. If a warning of error occurs +for non-specified plugins that run AFTER the specified plugins, the exit status will not be +affected. + +You would use this option if you are using check_email_delivery with the --plugin option and +the plugins you configure each use different servers, for example different SMTP and IMAP servers. +By default, if you do not use the --alert option, if anything goes wrong during the email delivery +check, a WARNING or CRITICAL alert will be issued. This means that if you define check_email_delivery +for the SMTP server only and the IMAP server fails, Nagios will alert you for the SMTP server which +would be misleading. If you define it for both the SMTP server and IMAP server and just one of them +fails, Nagios will alert you for both servers, which would still be misleading. If you have this +situation, you may want to use the --alert option. You define the check_email_delivery check for +both servers: for the SMTP server (first plugin) you use --alert 1, and for for the IMAP server +(second plugin) you use --alert 2. When check_email_delivery runs with --alert 1 and the SMTP +server fails, you will get the appropriate alert. If the IMAP server fails it will not affect the +status. When check_email_delivery runs with --alert 2 and the SMTP server fails, you will get the +UNKNOWN return code. If the IMAP server generates an alert you will get a WARNING or CRITICAL as +appropriate. + +You can repeat this option to specify multiple plugins that should cause an alert. +Do this if you have multiple plugins on the command line but some of them involve the same server. + +See also: --plugin. +Also known as: -A + + +=item --wait [,,...] + +How long to wait between sending the message and checking that it was received. View default with +the -vV option. + +When using the --plugin option, you can specify as many wait-between times as you have plugins +(minus the last plugin, because it makes no sense to wait after running the last one). For +example, if you use the --plugin option twice to specify an SMTP plugin and an IMAP plugin, and +you want to wait 5 seconds between sending and receiving, then you would specify --wait 5. A second +example, if you are using the --plugin option three times, then specifying -w 5 will wait 5 seconds +between the second and third plugins also. You can specify a different wait time +of 10 seconds between the second and third plugins, like this: -w 5,10. + +=item --hostname + +Address or name of the SMTP and IMAP server. Examples: mail.server.com, localhost, 192.168.1.100. +Also known as: -H + +=item --smtp-server + +Address or name of the SMTP server. Examples: smtp.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option. + +=item --smtp-port + +Service port on the SMTP server. Default is 25. + +=item --smtp-username + +=item --smtp-password + +Username and password to use when connecting to the SMTP server with the TLS option. +Use these options if the SMTP account has a different username/password than the +IMAP account you are testing. These options take precendence over the --username and +the --password options. + +These are shell-escaped; special characters are ok. + +=item --imap-server + +Address or name of the IMAP server. Examples: imap.server.com, localhost, 192.168.1.100. +Using this option overrides the hostname option. + +=item --imap-port + +Service port on the IMAP server. Default is 143. If you use SSL the default is 993. + +=item --imap-username + +=item --imap-password + +Username and password to use when connecting to the IMAP server. +Use these options if the IMAP account has a different username/password than the +SMTP account you are testing. These options take precendence over the --username and +the --password options. + +These are shell-escaped; special characters are ok. + +=item --username + +=item --password + +Username and password to use when connecting to IMAP server. +Also known as: -U -P + +Also used as the username and password for SMTP when the TLS option is enabled. +To specify a separate set of credentials for SMTP authentication, see the +options --smtp-username and --smtp-password. + +=item --imap-check-interval + +How long to wait between polls of the imap-server for the specified mail. Default is 5 seconds. + +=item --imap-retries + +How many times to poll the imap-server for the mail, before we give up. Default is 10. + +=item --body + +Use this option to specify the body of the email message. + +=item --header
+ +Use this option to set an arbitrary header in the message. You can use it multiple times. + +=item --mailto recipient@your.net + +You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed): + +$ check_email_delivery ... --mailto recipient@your.net,recipient2@your.net --mailfrom sender@your.net + +This argument is shell-escaped; special characters or angle brackets around the address are ok. + +=item --mailfrom sender@your.net + +Use this option to set the "from" address in the email. + +=item --imapssl +=item --noimapssl + +Use this to enable or disable SSL for the IMAP plugin. + +This argument is shell-escaped; special characters or angle brackets around the address are ok. + +=item --smtptls +=item --nosmtptls + +Use this to enable or disable TLS/AUTH for the SMTP plugin. + +=item --libexec + +Use this option to set the path of the Nagios libexec directory. The default is +/usr/local/nagios/libexec. This is where this plugin looks for the SMTP and IMAP +plugins that it depends on. + +=item --plugin + +This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It frees the plugin from depending on specific external plugins and generalizes the +work done to determine that the email loop is operational. When using the --plugin +option, the following options are ignored: libexec, imapssl, smtptls, hostname, +username, password, smtp*, imap*, mailto, mailfrom, body, header, search. + +Use this option multiple times to specify the complete trip. Typically, you would use +this twice to specify plugins for SMTP and IMAP, or SMTP and POP3. + +The output will be success if all the plugins return success. Each plugin should be a +standard Nagios plugin. + +A random token will be automatically generated and passed to each plugin specified on +the command line by substituting the string %TOKEN1%. + +Example usage: + + command_name check_email_delivery + command_line check_email_delivery + --plugin "$USER1$/check_smtp_send -H $ARG1$ --mailto recipient@your.net --mailfrom sender@your.net --header 'Subject: Nagios Test %TOKEN1%.'" + --plugin "$USER1$/check_imap_receive -H $ARG1$ -U $ARG1$ -P $ARG2$ -s SUBJECT -s 'Nagios Test %TOKEN1%.'" + +This technique allows for a lot of flexibility in configuring the plugins that test +each part of your email delivery loop. + +See also: --token. +Also known as: -p + +=item --token + +This is a new option introduced in version 0.5 of the check_email_delivery plugin. +It can be used in conjunction with --plugin to control the tokens that are generated +and passed to the plugins, like %TOKEN1%. + +Use this option multiple times to specify formats for different tokens. For example, +if you want %TOKEN1% to consist of only alphabetical characters but want %TOKEN2% to +consist of only digits, then you might use these options: --token aaaaaa --token nnnnn + +Any tokens used in your plugin commands that have not been specified by --token +will default to --token U-X-Y + +Token formats: +a - alpha character (a-z) +n - numeric character (0-9) +c - alphanumeric character (a-z0-9) +h - hexadecimal character (0-9a-f) +U - unix time, seconds from epoch. eg 1193012441 +X - a word from the pgp even list. eg aardvark +Y - a word from the pgp odd list. eg adroitness + +Caution: It has been observed that some IMAP servers do not handle underscores well in the +search criteria. For best results, avoid using underscores in your tokens. Use hyphens or commas instead. + +See also: --plugin. +Also known as: -T + +The PGP word list was obtained from http://en.wikipedia.org/wiki/PGP_word_list + +=item --file + +Save (append) status information into the given tab-delimited file. Format used: + + token start-time end-time status plugin-num output + +Note: format may change in future versions and may become configurable. + +This option available as of version 0.6.2. + +Also known as: -F + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Send a message with custom headers + +$ check_email_delivery -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--username recipient --password secret + +EMAIL DELIVERY OK - 1 seconds + +=head2 Set warning and critical timeouts for receive plugin only: + +$ check_email_delivery -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--username recipient --password secret -w ,,5 -c ,,15 + +EMAIL DELIVERY OK - 1 seconds + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 CHANGES + + Wed Oct 29 13:08:00 PST 2005 + + version 0.1 + + Wed Nov 9 17:16:09 PST 2005 + + updated arguments to check_smtp_send and check_imap_receive + + added eval/alarm block to implement -c option + + added wait option to adjust sleep time between smtp and imap calls + + added delay-warn and delay-crit options to adjust email delivery warning thresholds + + now using an inline PluginReport package to generate the report + + copyright notice and GNU GPL + + version 0.2 + + Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson ) + + version 0.2.1 + + corrected bug in getoptions ($imap_server would never ever be set from command-line...) + + will not make $smtp_server and $imap_server == $host if they're defined on commandline + + added support for multiple polls of imap-server, with specified intervals + + changed default behaviour in check_imap_server (searches for the specific id in subject and deletes mails found) + + increased default delay_warn from 65 seconds to 95 seconds + + Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton ) + + fixed a bug in getoptions + + version 0.2.2 + + Tue Apr 24 21:17:53 PDT 2007 + + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature + + version 0.2.3 + + Fri Apr 27 20:32:53 PDT 2007 + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + changed connection error to display timeout only if timeout was the error + + default IMAP plugin is libexec/check_imap_receive (also checking for same but with .pl extension) + + default SMTP plugin is libexec/check_smtp_send (also checking for same but with .pl extension) + + removed default values for SMTP port and IMAP port to allow those plugins to set the defaults; so current behavior stays the same and will continue to make sense with SSL + + version 0.3 + + Thu Oct 11 10:00:00 EET 2007 (by Timo Virtaneva + + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers + + version 0.3.1 + + Sun Oct 21 11:01:03 PDT 2007 + + added support for TLS options to the SMTP plugin + + version 0.4 + + Sun Oct 21 16:17:14 PDT 2007 + + added support for arbitrary plugins to send and receive mail (or anthing else!). see the --plugin option. + + version 0.5 + + Tue Dec 4 07:36:20 PST 2007 + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + shortcut option for --token is now -T to avoid clash with standard shortcut -t for --timeout + + fixed some minor pod formatting issues for perldoc + + version 0.5.1 + + Sat Dec 15 07:39:59 PST 2007 + + improved compatibility with Nagios embedded perl (ePN) + + version 0.5.2 + + Thu Jan 17 20:27:36 PST 2008 (by Timo Virtaneva on Thu Oct 11 10:00:00 EET 2007) + + Changed the header and the search criteria so that the same email-box can be used for all smtp-servers + + version 0.5.3 + + Mon Jan 28 22:11:02 PST 2008 + + fixed a bug, smtp-password and imap-password are now string parameters + + added --alert option to allow selection of which plugin(s) should cause a WARNING or CRITICAL alert + + version 0.6 + + Mon Feb 11 19:09:37 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.6.1 + + Mon May 26 10:39:19 PDT 2008 + + added --file option to allow plugin to record status information into a tab-delimited file + + changed default token from U_X_Y to U-X-Y + + version 0.6.2 + + Wed Jan 14 08:29:35 PST 2009 + + fixed a bug that the --header parameter was not being passed to the smtp plugin. + + version 0.6.3 + + Mon Jun 8 15:43:48 PDT 2009 + + added performance data for use with PNP4Nagios! (thanks to Ben Ritcey for the patch) + + version 0.6.4 + + Wed Sep 16 07:10:10 PDT 2009 + + added elapsed time in seconds to performance data + + version 0.6.5 + + Fri Oct 8 19:48:44 PDT 2010 + + fixed uniform IMAP and SMTP username and password bug (thanks to Micle Moerenhout for pointing it out) + + version 0.6.6 + + Mon Jan 3 08:24:23 PST 2011 + + added shell escaping for smtp-username, smtp-password, mailto, mailfrom, imap-username, and imap-password arguments + + version 0.7.0 + + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.1 + + Sun Jun 12 17:17:06 AST 2011 + + added --imap-mailbox option to pass through to check_imap_receive --mailbox option + + added --ssl option to conveniently enable both --smtp-tls and --imap-ssl + + version 0.7.2 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2005-2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.html new file mode 100644 index 0000000..8548ca0 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.html @@ -0,0 +1,258 @@ + + + + +check_imap_quota - connects to an IMAP account and checks the quota + + + + + + + + + +
+

+ + + +
+ + +

+

+
+

NAME

+

check_imap_quota - connects to an IMAP account and checks the quota

+

+

+
+

SYNOPSIS

+
+ check_imap_quota -vV
+ check_imap_quota -?
+ check_imap_quota --help
+

+

+
+

OPTIONS

+
+
--warning <seconds>
+ +
+

Warn if it takes longer than <seconds> to connect to the IMAP server. Default is 15 seconds. +Also known as: -w <seconds>

+
+
--critical <seconds>
+ +
+

Return a critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical <messages> +Also known as: -c <seconds>

+
+
--timeout <seconds>
+ +
+

Abort with critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds>

+
+
--hostname <server>
+ +
+

Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H <server>

+
+
--port <number>
+ +
+

Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p <number>

+
+
--username <username>
+ +
--password <password>
+ +
+

Username and password to use when connecting to IMAP server. +Also known as: -U <username> -P <password>

+
+
--mailbox <mailbox>
+ +
+

Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m <mailbox>

+
+
--ssl
+ +
--nossl
+ +
+

Enable SSL protocol. Requires IO::Socket::SSL.

+

Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option.

+

Use the nossl option to turn off the ssl option.

+
+
--hires
+ +
+

Use the Time::HiRes module to measure time, if available.

+
+
--verbose
+ +
+

Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values.

+

If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server.

+

Also known as: -v

+
+
--version
+ +
+

Display plugin version and exit. +Also known as: -V

+
+
--help
+ +
+

Display this documentation and exit. Does not work in the ePN version. +Also known as: -h

+
+
--usage
+ +
+

Display a short usage instruction and exit.

+
+
+

+

+
+

EXAMPLES

+

+

+

Report how many emails are in the mailbox

+
+ $ check_imap_receive -H mail.server.net --username mailuser --password mailpass
+ -s ALL --nodelete
+
+ IMAP RECEIVE OK - 1 seconds, 7 found
+

+

+

Report the email with the highest value

+

Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated):

+
+ To: mailuser@server.net
+ From: autoscript@server.net
+ Subject: Results of Autoscript
+ Date: Wed, 09 Nov 2005 08:30:40 -0800
+ Message-ID: <auto-000000992528@server.net>
+
+ Homeruns 5
+

And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values:

+
+ $ check_imap_receive -H mail.server.net --username mailuser --password mailpass
+ -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)"  --nodelete-captured
+
+ IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted
+

+

+

Troubleshoot your search parameters

+

Add the --nodelete and --imap-retries=1 parameters to your command line.

+

+

+
+

EXIT CODES

+

Complies with the Nagios plug-in specification: +
0OKThe plugin was able to check the service and it appeared to be functioning properly +
1WarningThe plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly +
2CriticalThe plugin detected that either the service was not running or it was above some "critical" threshold +
3UnknownInvalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service

+

+

+
+

NAGIOS PLUGIN NOTES

+

Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html

+

This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV.

+

Other than that, it attempts to follow published guidelines for Nagios plugins.

+

+

+
+

SEE ALSO

+

http://nagios.org/ +http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod +http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod

+

+

+
+

CHANGES

+
+ Fri Nov 11 04:53:09 AST 2011
+ + version 0.1 created with quota code contributed by Johan Romme
+
+ Tue Dec 20 17:38:04 PST 2011
+ + fixed bug where a quota of 0 was reported as an incorrect response from the server, thanks to Eike Arndt
+ + version 0.2
+

+

+
+

AUTHOR

+

Jonathan Buhacoff <jonathan@buhacoff.net>

+

+

+
+

COPYRIGHT AND LICENSE

+
+ Copyright (C) 2011 Jonathan Buhacoff
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>;.
+
+ http://www.gnu.org/licenses/gpl.txt
+ + + + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.pod new file mode 100644 index 0000000..03a02c2 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_quota.pod @@ -0,0 +1,196 @@ + + + +=pod + +=head1 NAME + +check_imap_quota - connects to an IMAP account and checks the quota + +=head1 SYNOPSIS + + check_imap_quota -vV + check_imap_quota -? + check_imap_quota --help + +=head1 OPTIONS + +=over + +=item --warning + +Warn if it takes longer than to connect to the IMAP server. Default is 15 seconds. +Also known as: -w + +=item --critical + +Return a critical status if it takes longer than to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical +Also known as: -c + +=item --timeout + +Abort with critical status if it takes longer than to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t + +=item --hostname + +Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H + +=item --port + +Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p + +=item --username + +=item --password + +Username and password to use when connecting to IMAP server. +Also known as: -U -P + +=item --mailbox + +Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m + +=item --ssl + +=item --nossl + +Enable SSL protocol. Requires IO::Socket::SSL. + +Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option. + +Use the nossl option to turn off the ssl option. + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. + +If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Report how many emails are in the mailbox + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s ALL --nodelete + + IMAP RECEIVE OK - 1 seconds, 7 found + +=head2 Report the email with the highest value + +Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated): + + To: mailuser@server.net + From: autoscript@server.net + Subject: Results of Autoscript + Date: Wed, 09 Nov 2005 08:30:40 -0800 + Message-ID: + + Homeruns 5 + +And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values: + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)" --nodelete-captured + + IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted + +=head2 Troubleshoot your search parameters + +Add the --nodelete and --imap-retries=1 parameters to your command line. + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 SEE ALSO + +http://nagios.org/ +http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod +http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod + +=head1 CHANGES + + Fri Nov 11 04:53:09 AST 2011 + + version 0.1 created with quota code contributed by Johan Romme + + Tue Dec 20 17:38:04 PST 2011 + + fixed bug where a quota of 0 was reported as an incorrect response from the server, thanks to Eike Arndt + + version 0.2 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.html new file mode 100644 index 0000000..fee7c08 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.html @@ -0,0 +1,551 @@ + + + + +check_imap_receive - connects to and searches an IMAP account for messages + + + + + + + + + +
+

+ + + +
+ + +

+

+
+

NAME

+

check_imap_receive - connects to and searches an IMAP account for messages

+

+

+
+

SYNOPSIS

+
+ check_imap_receive -vV
+ check_imap_receive -?
+ check_imap_receive --help
+

+

+
+

OPTIONS

+
+
--warning <seconds>
+ +
+

Warn if it takes longer than <seconds> to connect to the IMAP server. Default is 15 seconds. +Also known as: -w <seconds>

+
+
--critical <seconds>
+ +
+

Return a critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical <messages> +Also known as: -c <seconds>

+
+
--timeout <seconds>
+ +
+

Abort with critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds>

+
+
--imap-check-interval <seconds>
+ +
+

How long to wait after searching for a matching message before searching again. Only takes effect +if no messages were found. Default is 5 seconds.

+
+
--imap-retries <number>
+ +
+

How many times to try searching for a matching message before giving up. If you set this to 0 then +messages will not be searched at all. Setting this to 1 means the plugin only tries once. Etc. +Default is 10 times.

+
+
--hostname <server>
+ +
+

Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H <server>

+
+
--port <number>
+ +
+

Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p <number>

+
+
--username <username>
+ +
--password <password>
+ +
+

Username and password to use when connecting to IMAP server. +Also known as: -U <username> -P <password>

+
+
--mailbox <mailbox>
+ +
+

Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m <mailbox>

+
+
--search <string>
+ +
+

Use this option to filter the messages. Default is not to filter. You may (must) use this option +multiple times in order to create any valid IMAP search criteria. See the examples and see also +http://www.ietf.org/rfc/rfc2060.txt (look for section 6.4.4, the SEARCH command)

+

This is the way to find messages matching a given subject: + -s SUBJECT -s "a given subject"

+

You can use the following technique for any header, including Subject. To find "Header-Name: some value": + -s HEADER -s Header-Name -s "some value"

+

Modern IMAP servers that support rfc5032 extensions allow you to search for messages +older or younger than a number of seconds. So to find messages received in the past hour, +you can do:

+
+ -s YOUNGER -s 3600
+

Or to find messages received more than 5 minutes ago, you can do:

+
+ -s OLDER -s 300
+

Also known as: -s <string>

+
+
--download
+ +
--nodownload
+ +
+

This option causes all messages in the specified mailbox to be downloaded from the server +and searched locally. See --download-max if you only want to download a few messages. +Currently only the following RFC 2060 search criteria are supported: +TEXT, BODY, SUBJECT, HEADER, NOT, OR, SENTBEFORE, SENTON, SENTSINCE.

+

Requires Email::Simple to be installed. It is available on CPAN.

+

This option may be particularly useful to you if your mail server is slow to index +messages (like Exchange 2003), causing the plugin not to find them with IMAP SEARCH +even though they are in the inbox.

+

It's also useful if you're searching for messages that have been on the server for a +specified amount of time, like some minutes or hours, because the standard IMAP search +function only allows whole dates. For this, use the standard search keywords but you +can specify either just a date like in RFC 2060 or a date and a time.

+

If you use SENTBEFORE, SENTON, or SENTSINCE, you must have Date::Manip installed +on your system.

+
+
--download-max
+ +
+

Limits the number of messages downloaded from the server when the --download option is used. +Default is to download and search all messages.

+
+
--search-critical-min <messages>
+ +
+

This option will trigger a CRITICAL status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search.

+

This parameter defaults to 1 so that if no messages are found, the plugin will exit with a CRITICAL status.

+

If you want the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0.

+
+
--search-critical-max <messages>
+ +
+

This option will trigger a CRITICAL status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search.

+

This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +CRITICAL if it finds 11 messages. If you set it to 1, the plugin will exit with CRITICAL if it finds +any more than 1 message. If you set it to 0, the plugin will exit with CRITICAL if it finds any messages +at all. If you set it to -1 it will be disabled.

+
+
--search-warning-min <messages>
+ +
+

This option will trigger a WARNING status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search.

+

This parameter defaults to 1 so that if no messages are found, the plugin will exit with a WARNING status.

+

If you want to suppress the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0. When this parameter is 0, it means that you expect the mailbox not to have any messages.

+
+
--search-warning-max <messages>
+ +
+

This option will trigger a WARNING status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search.

+

This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +WARNING if it finds 11 messages. If you set it to 1, the plugin will exit with WARNING if it finds +any more than 1 message. If you set it to 0, the plugin will exit with WARNING if it finds any messages +at all. If you set it to -1 it will be disabled.

+
+
--capture-max <regexp>
+ +
+

In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-max" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the highest captured value.

+

The regexp is expected to capture a numeric value.

+
+
--capture-min <regexp>
+ +
+

In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-min" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the lowest captured value.

+

The regexp is expected to capture a numeric value.

+
+
--delete
+ +
--nodelete
+ +
+

Use the delete option to delete messages that matched the search criteria. This is useful for +preventing the mailbox from filling up with automated messages (from the check_smtp_send plugin, for example). +THE DELETE OPTION IS TURNED *ON* BY DEFAULT, in order to preserve compatibility with an earlier version.

+

Use the nodelete option to turn off the delete option.

+
+
--nodelete-captured
+ +
+

If you use both the capture-max and delete arguments, you can also use the nodelete-captured argument to specify that the email +with the highest captured value should not be deleted. This leaves it available for comparison the next time this plugin runs.

+

If you do not use the delete option, this option has no effect.

+
+
--ssl
+ +
--nossl
+ +
+

Enable SSL protocol. Requires IO::Socket::SSL.

+

Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option.

+

Use the nossl option to turn off the ssl option.

+
+
--ssl-ca-file
+ +
+

Use this to verify the server SSL certificate against a local .pem file. You'll need to +specify the path to the .pem file as the parameter.

+

You can use the imap_ssl_cert utility included in this distribution to connect to your IMAP +server and save its SSL certificates into your .pem file. Usage is like this:

+
+ imap_ssl_cert -H imap.server.com > ca_file.pem
+

Only applicable when --ssl option is enabled.

+
+
--template
+ +
--notemplate
+ +
+

Enable (or disable) processing of IMAP search parameters. Requires Text::Template and Date::Manip.

+

Use this option to apply special processing to IMAP search parameters that allows you to use the +results of arbitrary computations as the parameter values. For example, you can use this feature +to search for message received up to 4 hours ago.

+

Modern IMAP servers that support rfc5032 extensions allow searching with the YOUNGER and OLDER +criteria so a message received up to 4 hours ago is -s YOUNGER -s 14400. But if your mail server +doesn't support that, you could use the --template option to get similar functionality.

+

When you enable the --template option, each parameter you pass to the -s option is parsed by +Text::Template. See the Text::Template manual for more information, but in general any expression +written in Perl will work.

+

A convenience function called rfc2822dateHeader is provided to you so you can easily compute properly +formatted dates for use as search parameters. The rfc2822date function can take one or two +parameters itself: the date to format and an optional offset. To use the current time as a +search parameter, you can write this:

+
+ $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{rfc2822dateHeader("now")}'
+

The output of {rfc2822dateHeader("now")} looks like this: Wed, 30 Sep 2009 22:44:03 -0700 and +is suitable for use with a date header, like HEADER Delivery-Date.

+

To use a time in the past relative to the current time or day, you can use a second convenience function +called rfc2822date and write this:

+
+ $ check_imap_receive ... --template -s SENTSINCE -s '{rfc2822date("now","-1 day")}'
+

The output of {rfc2822date("now","-1 day")} looks like this: 29-Sep-2009 and is suitable for use +with BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, and SINCE.

+

I have seen some email clients use a different format in the Date field, +like September 17, 2009 9:46:51 AM PDT. To specify an arbitrary format like this one, write this:

+
+ $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{date("%B %e, %Y %i:%M:%S %p %Z","now","-4 hours")}'
+

You can use BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, or SINCE to search for messages that arrived +on, before, or after a given day but not on, before, or after a specific time on that day.

+

To search for messages that arrived on, before, or after a specific time you have to use the +Delivery-Date or another date field, like with -s HEADER -s Delivery-Date in the example above.

+

See the Date::Manip manual for more information on the allowed expressions for date and delta strings.

+
+
--hires
+ +
+

Use the Time::HiRes module to measure time, if available.

+
+
--verbose
+ +
+

Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values.

+

If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server.

+

Also known as: -v

+
+
--version
+ +
+

Display plugin version and exit. +Also known as: -V

+
+
--help
+ +
+

Display this documentation and exit. Does not work in the ePN version. +Also known as: -h

+
+
--usage
+ +
+

Display a short usage instruction and exit.

+
+
+

+

+
+

EXAMPLES

+

+

+

Report how many emails are in the mailbox

+
+ $ check_imap_receive -H mail.server.net --username mailuser --password mailpass
+ -s ALL --nodelete
+
+ IMAP RECEIVE OK - 1 seconds, 7 found
+

+

+

Report the email with the highest value

+

Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated):

+
+ To: mailuser@server.net
+ From: autoscript@server.net
+ Subject: Results of Autoscript
+ Date: Wed, 09 Nov 2005 08:30:40 -0800
+ Message-ID: <auto-000000992528@server.net>
+
+ Homeruns 5
+

And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values:

+
+ $ check_imap_receive -H mail.server.net --username mailuser --password mailpass
+ -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)"  --nodelete-captured
+
+ IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted
+

+

+

Troubleshoot your search parameters

+

Add the --nodelete and --imap-retries=1 parameters to your command line.

+

+

+
+

EXIT CODES

+

Complies with the Nagios plug-in specification: +
0OKThe plugin was able to check the service and it appeared to be functioning properly +
1WarningThe plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly +
2CriticalThe plugin detected that either the service was not running or it was above some "critical" threshold +
3UnknownInvalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service

+

+

+
+

NAGIOS PLUGIN NOTES

+

Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html

+

This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV.

+

Other than that, it attempts to follow published guidelines for Nagios plugins.

+

+

+
+

SEE ALSO

+

http://nagios.org/ +http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod +http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod

+

+

+
+

CHANGES

+
+ Wed Oct 29 11:00:00 PST 2005
+ + version 0.1
+
+ Wed Nov  9 09:53:32 PST 2005
+ + added delete/nodelete option.  deleting found messages is still default behavior.
+ + added capture-max option
+ + added nodelete-captured option
+ + added mailbox option
+ + added eval/alarm block to implement -c option
+ + now using an inline PluginReport package to generate the report
+ + copyright notice and GNU GPL
+ + version 0.2
+
+ Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson <johann (at) axis.com>)
+ + version 0.2.1
+ + added support for multiple polls of imap-server, with specified intervals
+
+ Tue Apr 24 21:17:53 PDT 2007
+ + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature
+ + added patch from Benjamin Ritcey <ben@ritcey.com> for SSL support on machines that have an SSL-enabled
+ + version 0.2.3
+
+ Fri Apr 27 18:56:50 PDT 2007 
+ + fixed problem that "Invalid search parameters" was not printed because of missing newline to flush it
+ + warnings and critical errors now try to append error messages received from the IMAP client
+ + changed connection error to display timeout only if timeout was the error
+ + documentation now mentions every command-line option accepted by the plugin, including abbreviations
+ + added abbreviations U for username, P for password, m for mailbox
+ + fixed bug that imap-check-interval applied even after the last try (imap-retries) when it was not necessary
+ + the IMAP expunge command is not sent unless at least one message is deleted
+ + fixed bug that the "no messages" warning was printed even if some messages were found
+ + version 0.3
+
+ Sun Oct 21 14:08:07 PDT 2007
+ + added port info to the "could not connect" error message
+ + fixed bug that occurred when using --ssl --port 143 which caused port to remain at the default 993 imap/ssl port
+ + added clarity shortcuts --search-subject and --search-header
+ + port is no longer a required option. defaults to 143 for regular IMAP and 993 for IMAP/SSL
+ + version 0.3.1
+
+ Sun Oct 21 20:41:56 PDT 2007
+ + reworked ssl support to use IO::Socket::SSL instead of the convenience method Mail::IMAPClient->Ssl (which is not included in the standard Mail::IMAPClient package)
+ + removed clarity shortcuts (bad idea, code bloat) 
+ + version 0.4
+
+ Tue Dec  4 07:05:27 PST 2007
+ + added version check to _read_line workaround for SSL-related bug in Mail::IMAPClient version 2.2.9 ; newer versions fixed the bug 
+ + added --usage option because the official nagios plugins have both --help and --usage
+ + added --timeout option to match the official nagios plugins
+ + fixed some minor pod formatting issues for perldoc
+ + version 0.4.1
+
+ Sat Dec 15 07:39:59 PST 2007
+ + improved compatibility with Nagios embedded perl (ePN)
+ + version 0.4.2
+
+ Mon Jan  7 21:35:23 PST 2008
+ + changed version check for Mail::IMAPClient version 2.2.9 to use string comparison le "2.2.9"
+ + fixed bug where script was dying on socket->autoflush when socket does not exist because autoflush was being called before checking the socket object 
+ + version 0.4.3
+
+ Mon Feb 11 19:13:38 PST 2008
+ + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules
+ + version 0.4.4
+
+ Mon May 26 08:33:27 PDT 2008
+ + fixed a bug for number captured, it now reflects number of messages captured instead of always returning "1"
+ + added --capture-min option to complement --capture-max
+ + added --search-critical-min to trigger a CRITICAL alert if number of messages found is less than argument, with default 1.
+ + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly
+ + version 0.5
+
+ Wed Jul  2 14:59:05 PDT 2008
+ + fixed a bug for not finding a message after the first try, by reselecting the mailbox before each search
+ + version 0.5.1
+
+ Sat Dec 13 08:57:29 PST 2008
+ + added --download option to allow local searching of messages (useful if your server has an index that handles searching but it takes a while before new emails show up and you want immediate results), supports only the TEXT, BODY, SUBJECT, and HEADER search keys 
+ + added --download-max option to set a limit on number of messages downloaded with --download
+ + version 0.6.0
+
+ Wed Sep 30 23:25:33 PDT 2009
+ + fixed --download-max option (was incorrectly looking for --download_max). currently both will work, in the future only --download-max will work
+ + added --template option to allow arbitrary substitutions for search parameters, and provided three convenience functions for working with dates
+ + added date search criteria to the --download option: SENTBEFORE, SENTON, and SENTSINCE which check the Date header and allow hours and minutes in addition to dates (whereas the IMAP standard only allows dates)
+ + added --search-critical-max to trigger a CRITICAL alert if number of messages found is more than argument, disabled by default.
+ + fixed a bug in --download --search where messages would match even though they failed the search criteria
+ + changed behavior of --download-max to look at the most recent messages first (hopefully); the IMAP protocol doesn't guarantee the order that the messages are returned but I observed that many mail servers return them in chronological order; so now --download-max reverses the order to look at the newer messages first
+ + added performance data for use with PNP4Nagios!
+ + version 0.7.0
+
+ Fri Oct  2 15:22:00 PDT 2009
+ + added --search-warning-max and --search-warning-min to trigger a WARNING alert if number of messages is more than or less than the specified number. 
+ + fixed --download option not to fail with CRITICAL if mailbox is empty; now this can be configured with --search-warning-min or --search-critical-min
+ + version 0.7.1
+
+ Sat Nov 21 18:27:17 PST 2009
+ + fixed problem with using --download option on certain mail servers by turning on the IgnoreSizeErrors feature in IMAPClient
+ + added --peek option to prevent marking messages as seen 
+ + version 0.7.2
+
+ Tue Jan  5 12:13:53 PST 2010
+ + added error message and exit with unknown status when an unrecognized IMAP search criteria is encountered by the --download --search option
+
+ Wed May  5 11:14:51 PDT 2010
+ + added mailbox list when mailbox is not found and verbose level 3 is on (-vvv)
+ + version 0.7.3
+
+ Tue Mar  8 18:58:14 AST 2011
+ + updated documentation for --search and --template to mention rfc5032 extensions (thanks to Stuart Henderson)
+
+ Fri May  6 08:35:09 AST 2011
+ + added --hires option to enable use of Time::Hires if available
+ + version 0.7.4
+
+ Fri Nov 11 01:51:40 AST 2011
+ + added --ssl-ca-file option to allow verifying the server certificate against a local .pem file (thanks to Alexandre Bezroutchko)
+ + added imap_ssl_cert.pl utility (not in this file) to conveniently save the server's SSL certificates into a local .pem file
+ + version 0.7.5
+

+

+
+

AUTHOR

+

Jonathan Buhacoff <jonathan@buhacoff.net>

+

+

+
+

COPYRIGHT AND LICENSE

+
+ Copyright (C) 2005-2011 Jonathan Buhacoff
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>;.
+
+ http://www.gnu.org/licenses/gpl.txt
+ + + + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.pod new file mode 100644 index 0000000..9e9faf9 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_imap_receive.pod @@ -0,0 +1,507 @@ + + + +=pod + +=head1 NAME + +check_imap_receive - connects to and searches an IMAP account for messages + +=head1 SYNOPSIS + + check_imap_receive -vV + check_imap_receive -? + check_imap_receive --help + +=head1 OPTIONS + +=over + +=item --warning + +Warn if it takes longer than to connect to the IMAP server. Default is 15 seconds. +Also known as: -w + +=item --critical + +Return a critical status if it takes longer than to connect to the IMAP server. Default is 30 seconds. +See also: --capture-critical +Also known as: -c + +=item --timeout + +Abort with critical status if it takes longer than to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t + +=item --imap-check-interval + +How long to wait after searching for a matching message before searching again. Only takes effect +if no messages were found. Default is 5 seconds. + +=item --imap-retries + +How many times to try searching for a matching message before giving up. If you set this to 0 then +messages will not be searched at all. Setting this to 1 means the plugin only tries once. Etc. +Default is 10 times. + +=item --hostname + +Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H + +=item --port + +Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p + +=item --username + +=item --password + +Username and password to use when connecting to IMAP server. +Also known as: -U -P + +=item --mailbox + +Use this option to specify the mailbox to search for messages. Default is INBOX. +Also known as: -m + +=item --search + +Use this option to filter the messages. Default is not to filter. You may (must) use this option +multiple times in order to create any valid IMAP search criteria. See the examples and see also +http://www.ietf.org/rfc/rfc2060.txt (look for section 6.4.4, the SEARCH command) + +This is the way to find messages matching a given subject: + -s SUBJECT -s "a given subject" + +You can use the following technique for any header, including Subject. To find "Header-Name: some value": + -s HEADER -s Header-Name -s "some value" + +Modern IMAP servers that support rfc5032 extensions allow you to search for messages +older or younger than a number of seconds. So to find messages received in the past hour, +you can do: + + -s YOUNGER -s 3600 + +Or to find messages received more than 5 minutes ago, you can do: + + -s OLDER -s 300 + +Also known as: -s + +=item --download + +=item --nodownload + +This option causes all messages in the specified mailbox to be downloaded from the server +and searched locally. See --download-max if you only want to download a few messages. +Currently only the following RFC 2060 search criteria are supported: +TEXT, BODY, SUBJECT, HEADER, NOT, OR, SENTBEFORE, SENTON, SENTSINCE. + +Requires Email::Simple to be installed. It is available on CPAN. + +This option may be particularly useful to you if your mail server is slow to index +messages (like Exchange 2003), causing the plugin not to find them with IMAP SEARCH +even though they are in the inbox. + +It's also useful if you're searching for messages that have been on the server for a +specified amount of time, like some minutes or hours, because the standard IMAP search +function only allows whole dates. For this, use the standard search keywords but you +can specify either just a date like in RFC 2060 or a date and a time. + +If you use SENTBEFORE, SENTON, or SENTSINCE, you must have Date::Manip installed +on your system. + + +=item --download-max + +Limits the number of messages downloaded from the server when the --download option is used. +Default is to download and search all messages. + +=item --search-critical-min + +This option will trigger a CRITICAL status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search. + +This parameter defaults to 1 so that if no messages are found, the plugin will exit with a CRITICAL status. + +If you want the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0. + +=item --search-critical-max + +This option will trigger a CRITICAL status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search. + +This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +CRITICAL if it finds 11 messages. If you set it to 1, the plugin will exit with CRITICAL if it finds +any more than 1 message. If you set it to 0, the plugin will exit with CRITICAL if it finds any messages +at all. If you set it to -1 it will be disabled. + +=item --search-warning-min + +This option will trigger a WARNING status if the number of messages found by the search criteria +is below the given number. Use in conjunction with --search. + +This parameter defaults to 1 so that if no messages are found, the plugin will exit with a WARNING status. + +If you want to suppress the original behavior where the plugin exits with a WARNING status when no messages are found, +set this parameter to 0. When this parameter is 0, it means that you expect the mailbox not to have any messages. + +=item --search-warning-max + +This option will trigger a WARNING status if the number of messages found by the search criteria +is above the given number. Use in conjunction with --search. + +This parameter defaults to -1 meaning it's disabled. If you set it to 10, the plugin will exit with +WARNING if it finds 11 messages. If you set it to 1, the plugin will exit with WARNING if it finds +any more than 1 message. If you set it to 0, the plugin will exit with WARNING if it finds any messages +at all. If you set it to -1 it will be disabled. + +=item --capture-max + +In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-max" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the highest captured value. + +The regexp is expected to capture a numeric value. + +=item --capture-min + +In addition to specifying search arguments to filter the emails in the IMAP account, you can specify +a "capture-min" regexp argument and the eligible emails (found with search arguments) +will be compared to each other and the OK line will have the lowest captured value. + +The regexp is expected to capture a numeric value. + +=item --delete + +=item --nodelete + +Use the delete option to delete messages that matched the search criteria. This is useful for +preventing the mailbox from filling up with automated messages (from the check_smtp_send plugin, for example). +THE DELETE OPTION IS TURNED *ON* BY DEFAULT, in order to preserve compatibility with an earlier version. + +Use the nodelete option to turn off the delete option. + +=item --nodelete-captured + +If you use both the capture-max and delete arguments, you can also use the nodelete-captured argument to specify that the email +with the highest captured value should not be deleted. This leaves it available for comparison the next time this plugin runs. + +If you do not use the delete option, this option has no effect. + +=item --ssl + +=item --nossl + +Enable SSL protocol. Requires IO::Socket::SSL. + +Using this option automatically changes the default port from 143 to 993. You can still +override this from the command line using the --port option. + +Use the nossl option to turn off the ssl option. + +=item --ssl-ca-file + +Use this to verify the server SSL certificate against a local .pem file. You'll need to +specify the path to the .pem file as the parameter. + +You can use the imap_ssl_cert utility included in this distribution to connect to your IMAP +server and save its SSL certificates into your .pem file. Usage is like this: + + imap_ssl_cert -H imap.server.com > ca_file.pem + +Only applicable when --ssl option is enabled. + +=item --template + +=item --notemplate + +Enable (or disable) processing of IMAP search parameters. Requires Text::Template and Date::Manip. + +Use this option to apply special processing to IMAP search parameters that allows you to use the +results of arbitrary computations as the parameter values. For example, you can use this feature +to search for message received up to 4 hours ago. + +Modern IMAP servers that support rfc5032 extensions allow searching with the YOUNGER and OLDER +criteria so a message received up to 4 hours ago is -s YOUNGER -s 14400. But if your mail server +doesn't support that, you could use the --template option to get similar functionality. + +When you enable the --template option, each parameter you pass to the -s option is parsed by +Text::Template. See the Text::Template manual for more information, but in general any expression +written in Perl will work. + +A convenience function called rfc2822dateHeader is provided to you so you can easily compute properly +formatted dates for use as search parameters. The rfc2822date function can take one or two +parameters itself: the date to format and an optional offset. To use the current time as a +search parameter, you can write this: + + $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{rfc2822dateHeader("now")}' + +The output of {rfc2822dateHeader("now")} looks like this: Wed, 30 Sep 2009 22:44:03 -0700 and +is suitable for use with a date header, like HEADER Delivery-Date. + +To use a time in the past relative to the current time or day, you can use a second convenience function +called rfc2822date and write this: + + $ check_imap_receive ... --template -s SENTSINCE -s '{rfc2822date("now","-1 day")}' + +The output of {rfc2822date("now","-1 day")} looks like this: 29-Sep-2009 and is suitable for use +with BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, and SINCE. + +I have seen some email clients use a different format in the Date field, +like September 17, 2009 9:46:51 AM PDT. To specify an arbitrary format like this one, write this: + + $ check_imap_receive ... --template -s HEADER -s Delivery-Date -s '{date("%B %e, %Y %i:%M:%S %p %Z","now","-4 hours")}' + +You can use BEFORE, ON, SENTBEFORE, SENTON, SENTSINCE, or SINCE to search for messages that arrived +on, before, or after a given day but not on, before, or after a specific time on that day. + +To search for messages that arrived on, before, or after a specific time you have to use the +Delivery-Date or another date field, like with -s HEADER -s Delivery-Date in the example above. + +See the Date::Manip manual for more information on the allowed expressions for date and delta strings. + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. Use together with --version to see the default +warning and critical timeout values. + +If the selected mailbox was not found, you can use verbosity level 3 (-vvv) to display a list of all +available mailboxes on the server. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Report how many emails are in the mailbox + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s ALL --nodelete + + IMAP RECEIVE OK - 1 seconds, 7 found + +=head2 Report the email with the highest value + +Suppose your mailbox has some emails from an automated script and that a message +from this script typically looks like this (abbreviated): + + To: mailuser@server.net + From: autoscript@server.net + Subject: Results of Autoscript + Date: Wed, 09 Nov 2005 08:30:40 -0800 + Message-ID: + + Homeruns 5 + +And further suppose that you are interested in reporting the message that has the +highest number of home runs, and also to leave this message in the mailbox for future +checks, but remove the other matching messages with lesser values: + + $ check_imap_receive -H mail.server.net --username mailuser --password mailpass + -s SUBJECT -s "Results of Autoscript" --capture-max "Homeruns (\d+)" --nodelete-captured + + IMAP RECEIVE OK - 1 seconds, 3 found, 1 captured, 5 max, 2 deleted + +=head2 Troubleshoot your search parameters + +Add the --nodelete and --imap-retries=1 parameters to your command line. + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 SEE ALSO + +http://nagios.org/ +http://search.cpan.org/~djkernen/Mail-IMAPClient-2.2.9/IMAPClient.pod +http://search.cpan.org/~markov/Mail-IMAPClient-3.00/lib/Mail/IMAPClient.pod + +=head1 CHANGES + + Wed Oct 29 11:00:00 PST 2005 + + version 0.1 + + Wed Nov 9 09:53:32 PST 2005 + + added delete/nodelete option. deleting found messages is still default behavior. + + added capture-max option + + added nodelete-captured option + + added mailbox option + + added eval/alarm block to implement -c option + + now using an inline PluginReport package to generate the report + + copyright notice and GNU GPL + + version 0.2 + + Thu Apr 20 14:00:00 CET 2006 (by Johan Nilsson ) + + version 0.2.1 + + added support for multiple polls of imap-server, with specified intervals + + Tue Apr 24 21:17:53 PDT 2007 + + now there is an alternate version (same but without embedded perl POD) that is compatible with the new new embedded-perl Nagios feature + + added patch from Benjamin Ritcey for SSL support on machines that have an SSL-enabled + + version 0.2.3 + + Fri Apr 27 18:56:50 PDT 2007 + + fixed problem that "Invalid search parameters" was not printed because of missing newline to flush it + + warnings and critical errors now try to append error messages received from the IMAP client + + changed connection error to display timeout only if timeout was the error + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + added abbreviations U for username, P for password, m for mailbox + + fixed bug that imap-check-interval applied even after the last try (imap-retries) when it was not necessary + + the IMAP expunge command is not sent unless at least one message is deleted + + fixed bug that the "no messages" warning was printed even if some messages were found + + version 0.3 + + Sun Oct 21 14:08:07 PDT 2007 + + added port info to the "could not connect" error message + + fixed bug that occurred when using --ssl --port 143 which caused port to remain at the default 993 imap/ssl port + + added clarity shortcuts --search-subject and --search-header + + port is no longer a required option. defaults to 143 for regular IMAP and 993 for IMAP/SSL + + version 0.3.1 + + Sun Oct 21 20:41:56 PDT 2007 + + reworked ssl support to use IO::Socket::SSL instead of the convenience method Mail::IMAPClient->Ssl (which is not included in the standard Mail::IMAPClient package) + + removed clarity shortcuts (bad idea, code bloat) + + version 0.4 + + Tue Dec 4 07:05:27 PST 2007 + + added version check to _read_line workaround for SSL-related bug in Mail::IMAPClient version 2.2.9 ; newer versions fixed the bug + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + fixed some minor pod formatting issues for perldoc + + version 0.4.1 + + Sat Dec 15 07:39:59 PST 2007 + + improved compatibility with Nagios embedded perl (ePN) + + version 0.4.2 + + Mon Jan 7 21:35:23 PST 2008 + + changed version check for Mail::IMAPClient version 2.2.9 to use string comparison le "2.2.9" + + fixed bug where script was dying on socket->autoflush when socket does not exist because autoflush was being called before checking the socket object + + version 0.4.3 + + Mon Feb 11 19:13:38 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.4.4 + + Mon May 26 08:33:27 PDT 2008 + + fixed a bug for number captured, it now reflects number of messages captured instead of always returning "1" + + added --capture-min option to complement --capture-max + + added --search-critical-min to trigger a CRITICAL alert if number of messages found is less than argument, with default 1. + + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly + + version 0.5 + + Wed Jul 2 14:59:05 PDT 2008 + + fixed a bug for not finding a message after the first try, by reselecting the mailbox before each search + + version 0.5.1 + + Sat Dec 13 08:57:29 PST 2008 + + added --download option to allow local searching of messages (useful if your server has an index that handles searching but it takes a while before new emails show up and you want immediate results), supports only the TEXT, BODY, SUBJECT, and HEADER search keys + + added --download-max option to set a limit on number of messages downloaded with --download + + version 0.6.0 + + Wed Sep 30 23:25:33 PDT 2009 + + fixed --download-max option (was incorrectly looking for --download_max). currently both will work, in the future only --download-max will work + + added --template option to allow arbitrary substitutions for search parameters, and provided three convenience functions for working with dates + + added date search criteria to the --download option: SENTBEFORE, SENTON, and SENTSINCE which check the Date header and allow hours and minutes in addition to dates (whereas the IMAP standard only allows dates) + + added --search-critical-max to trigger a CRITICAL alert if number of messages found is more than argument, disabled by default. + + fixed a bug in --download --search where messages would match even though they failed the search criteria + + changed behavior of --download-max to look at the most recent messages first (hopefully); the IMAP protocol doesn't guarantee the order that the messages are returned but I observed that many mail servers return them in chronological order; so now --download-max reverses the order to look at the newer messages first + + added performance data for use with PNP4Nagios! + + version 0.7.0 + + Fri Oct 2 15:22:00 PDT 2009 + + added --search-warning-max and --search-warning-min to trigger a WARNING alert if number of messages is more than or less than the specified number. + + fixed --download option not to fail with CRITICAL if mailbox is empty; now this can be configured with --search-warning-min or --search-critical-min + + version 0.7.1 + + Sat Nov 21 18:27:17 PST 2009 + + fixed problem with using --download option on certain mail servers by turning on the IgnoreSizeErrors feature in IMAPClient + + added --peek option to prevent marking messages as seen + + version 0.7.2 + + Tue Jan 5 12:13:53 PST 2010 + + added error message and exit with unknown status when an unrecognized IMAP search criteria is encountered by the --download --search option + + Wed May 5 11:14:51 PDT 2010 + + added mailbox list when mailbox is not found and verbose level 3 is on (-vvv) + + version 0.7.3 + + Tue Mar 8 18:58:14 AST 2011 + + updated documentation for --search and --template to mention rfc5032 extensions (thanks to Stuart Henderson) + + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.4 + + Fri Nov 11 01:51:40 AST 2011 + + added --ssl-ca-file option to allow verifying the server certificate against a local .pem file (thanks to Alexandre Bezroutchko) + + added imap_ssl_cert.pl utility (not in this file) to conveniently save the server's SSL certificates into a local .pem file + + version 0.7.5 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2005-2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.html new file mode 100644 index 0000000..0afa438 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.html @@ -0,0 +1,375 @@ + + + + +check_smtp_send - connects to an SMTP server and sends a message + + + + + + + + + +
+

+ + + +
+ + +

+

+
+

NAME

+

check_smtp_send - connects to an SMTP server and sends a message

+

+

+
+

SYNOPSIS

+
+ check_smtp_send -vV
+ check_smtp_send -?
+ check_smtp_send --help
+

+

+
+

OPTIONS

+
+
--warning <seconds>
+ +
+

Warn if it takes longer than <seconds> to connect to the SMTP server. Default is 15 seconds. +Also known as: -w <seconds>

+
+
--critical <seconds>
+ +
+

Return a critical status if it takes longer than <seconds> to connect to the SMTP server. Default is 30 seconds. +Also known as: -c <seconds>

+
+
--timeout <seconds>
+ +
+

Abort with critical status if it takes longer than <seconds> to connect to the SMTP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds>

+
+
--hostname <server>
+ +
+

Address or name of the SMTP server. Examples: mail.server.com, localhost, 192.168.1.100

+

If not provided, and if there is only one --mailto address, the script will automatically look up the MX record +for the --mailto address and use that as the hostname. You can use this to check that your MX records are correct. +When omitting the --hostname option, it doesn't really make sense to specify --port, --username, or --password +but you can still do so and they will have their normal effect. To look up the MX records you need to have the +module Net::DNS and Email::Address installed.

+

Also known as: -H <server>

+
+
--port <number>
+ +
+

Service port on the SMTP server. Default is 25 for regular SMTP, 465 for SSL, and 587 for TLS. +Also known as: -p <number>

+
+
--tls
+ +
--notls
+ +
+

Enable TLS/AUTH protocol. Requires Net::SMTP::TLS, availble on CPAN.

+

When using this option, the default port is 587. +You can specify a port from the command line using the --port option.

+

Use the notls option to turn off the tls option.

+

Also, you may need to fix your copy of Net::SMTP::TLS. Here is the diff against version 0.12:

+
+ 254c254
+ <      $me->_command(sprintf("AUTH PLAIN %S",
+ ---
+ >      $me->_command(sprintf("AUTH PLAIN %s",
+
+
--ssl
+ +
--nossl
+ +
+

Enable SSL protocol. Requires Net::SMTP::SSL and Authen::SASL, availble on CPAN.

+

When using this option, the default port is 465. You can override with the --port option.

+

Use the nossl option to turn off the ssl option.

+
+
--auth <method>
+ +
+

Enable authentication with Net::SMTP_auth (sold separately). +For example, try using --auth PLAIN or --auth CRAM-MD5.

+
+
--username <username>
+ +
--password <password>
+ +
+

Username and password to use when connecting to SMTP server. +Also known as: -U <username> -P <password>

+
+
--body <message>
+ +
+

Use this option to specify the body of the email message. If you need newlines in your message, +you might need to use the --stdin option instead.

+
+
--header <header>
+ +
+

Use this option to set an arbitrary header in the message. You can use it multiple times.

+
+
--stdin
+ +
+

Grab the body of the email message from stdin.

+
+
--mailto recipient@your.net
+ +
+

You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed):

+

$ check_smtp_send -H mail.server.net --mailto recipient@your.net,recipient2@your.net --mailfrom sender@your.net

+

SMTP SEND OK - 1 seconds

+
+
--mailfrom sender@your.net
+ +
+

Use this option to set the "from" address in the email.

+
+
--template
+ +
--notemplate
+ +
+

Enable (or disable) processing of message body and headers. Requires Text::Template.

+

Use this option to apply special processing to your message body and headers that allows you to use the +results of arbitrary computations in the text. For example, you can use this feature to send a message +containing the hostname of the machine that sent the message without customizing the plugin configuration +on each machine.

+

When you enable the --template option, the message body and headers are parsed by +Text::Template. Even a message body provided using the --stdin option will be parsed. +See the Text::Template manual for more information, but in general any expression +written in Perl will work.

+

There is one convenience function provided to you, trim, which will remove leading and trailing whitespace +from its parameter. Here's an example:

+
+ check_smtp_send -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net 
+ --template --body 'hello, this message is from {use Sys::Hostname; hostname}' 
+ --header 'Subject: test message from {trim(`whoami`)}'
+
+
--expect-response <code>
+ +
+

Use this option to specify which SMTP response code should be expected from the server +after the SMTP dialog is complete. The default is 250 (message accepted).

+

Also known as: -E <code>

+
+
--hires
+ +
+

Use the Time::HiRes module to measure time, if available.

+
+
--verbose
+ +
+

Display additional information. Useful for troubleshooting.

+

One --verbose will show extra information for OK, WARNING, and CRITICAL status.

+

Use one --verbose together with --version to see the default warning and critical timeout values.

+

Three --verbose (or -vvv) will show debug information, unless you're using --tls because Net::SMTP::TLS +does not have a Debug feature.

+

Also known as: -v

+
+
--version
+ +
+

Display plugin version and exit. +Also known as: -V

+
+
--help
+ +
+

Display this documentation and exit. Does not work in the ePN version. +Also known as: -h

+
+
--usage
+ +
+

Display a short usage instruction and exit.

+
+
+

+

+
+

EXAMPLES

+

+

+

Send a message with custom headers

+

$ check_smtp_send -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--body 'Homeruns 5' --header 'Subject: Hello, world!' --header 'X-Your-Header: Yes'

+

SMTP SEND OK - 1 seconds

+

+

+
+

EXIT CODES

+

Complies with the Nagios plug-in specification: +
0OKThe plugin was able to check the service and it appeared to be functioning properly +
1WarningThe plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly +
2CriticalThe plugin detected that either the service was not running or it was above some "critical" threshold +
3UnknownInvalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service

+

+

+
+

NAGIOS PLUGIN NOTES

+

Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html

+

This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV.

+

Other than that, it attempts to follow published guidelines for Nagios plugins.

+

+

+
+

CHANGES

+
+ Wed Oct 29 14:05:00 PST 2005
+ + version 0.1
+
+ Wed Nov  9 15:01:48 PST 2005
+ + now using an inline PluginReport package to generate the report
+ + added stdin option
+ + copyright notice and GNU GPL
+ + version 0.2
+
+ Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton <geoff.crompton@strategicdata.com.au>)
+ + added bailing if the $smtp->to() call fails
+ + added support for mailto recipients separated by commas
+ + version 0.2.1
+
+ Tue Apr 24 21:17:53 PDT 2007
+ + moved POD text to separate file in order to accomodate the new embedded-perl Nagios feature
+ + version 0.2.3
+
+ Fri Apr 27 20:26:42 PDT 2007
+ + documentation now mentions every command-line option accepted by the plugin, including abbreviations
+ + version 0.3
+ 
+ Sun Oct 21 10:34:14 PDT 2007
+ + added support for TLS and authentication via the Net::SMTP::TLS module. see --tls option.
+ + version 0.4
+
+ Sun Oct 21 13:54:26 PDT 2007
+ + added support for SSL via the Net::SMTP::SSL module. see --ssl option.
+ + port is no longer a required option. defaults to 25 for regular smtp, 465 for ssl, and 587 for tls.
+ + added port info to the "could not connect" error message
+ + version 0.4.1
+
+ Tue Dec  4 07:42:32 PST 2007
+ + added --usage option because the official nagios plugins have both --help and --usage
+ + added --timeout option to match the official nagios plugins
+ + fixed some minor pod formatting issues for perldoc
+ + version 0.4.2
+
+ Mon Feb 11 19:09:37 PST 2008
+ + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules
+ + version 0.4.3
+
+ Mon May 26 09:12:14 PDT 2008
+ + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly
+ + version 0.4.4
+ 
+ Wed Jul  2 07:12:35 PDT 2008
+ + added --expect-response option submitted by Christian Kauhaus <kc@gocept.com>
+ + added support for authentication via Net::SMTP_auth. see --auth option.
+ + version 0.4.5
+
+ Sun Oct  5 15:18:23 PDT 2008
+ + added error handling for smtp server disconnects ungracefully during QUIT (gmail.com does)
+ + version 0.4.6
+
+ Thu Oct  1 12:09:35 PDT 2009
+ + added --template option to allow arbitrary substitutions for body and headers, and provided one convenience function for trimming strings
+ + added performance data for use with PNP4Nagios!
+ + version 0.5.0
+
+ Thu Oct  8 11:17:04 PDT 2009
+ + added more detailed error messages when using --verbose
+ + version 0.5.1
+
+ Tue Feb  9 12:14:49 PST 2010
+ + added support for combining --auth with --tls using a subclass of Net::SMTP::TLS submitted by Brad Guillory; please note that to use the "PLAIN" authentication type you need to patch your Net::SMTP:TLS because it has a bug in sub auth_PLAIN (sprintf %S instead of %s)
+ + version 0.5.2
+
+ Mon Jan  3 10:39:42 PST 2011
+ + added default Date and Message-ID headers; Date header uses POSIX strftime and Message-ID header uses hostname command to get localhost name
+ + version 0.7.0
+
+ Fri May  6 08:35:09 AST 2011
+ + added --hires option to enable use of Time::Hires if available
+ + version 0.7.1
+
+ Wed Jul  6 19:18:26 AST 2011
+ + the --hostname is now optional; if not provided the plugin will lookup the MX record for the --mailto address (requires Net::DNS)
+ + version 0.7.2
+
+ Tue Dec 13 09:24:04 PST 2011
+ + separated authentication errors from connection errors
+ + version 0.7.3
+

+

+
+

AUTHOR

+

Jonathan Buhacoff <jonathan@buhacoff.net>

+

+

+
+

COPYRIGHT AND LICENSE

+
+ Copyright (C) 2005-2011 Jonathan Buhacoff
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>;.
+
+ http://www.gnu.org/licenses/gpl.txt
+ + + + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.pod new file mode 100644 index 0000000..db33549 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/check_smtp_send.pod @@ -0,0 +1,324 @@ + + +=pod + +=head1 NAME + +check_smtp_send - connects to an SMTP server and sends a message + +=head1 SYNOPSIS + + check_smtp_send -vV + check_smtp_send -? + check_smtp_send --help + +=head1 OPTIONS + +=over + +=item --warning + +Warn if it takes longer than to connect to the SMTP server. Default is 15 seconds. +Also known as: -w + +=item --critical + +Return a critical status if it takes longer than to connect to the SMTP server. Default is 30 seconds. +Also known as: -c + +=item --timeout + +Abort with critical status if it takes longer than to connect to the SMTP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t + +=item --hostname + +Address or name of the SMTP server. Examples: mail.server.com, localhost, 192.168.1.100 + +If not provided, and if there is only one --mailto address, the script will automatically look up the MX record +for the --mailto address and use that as the hostname. You can use this to check that your MX records are correct. +When omitting the --hostname option, it doesn't really make sense to specify --port, --username, or --password +but you can still do so and they will have their normal effect. To look up the MX records you need to have the +module Net::DNS and Email::Address installed. + +Also known as: -H + +=item --port + +Service port on the SMTP server. Default is 25 for regular SMTP, 465 for SSL, and 587 for TLS. +Also known as: -p + +=item --tls + +=item --notls + +Enable TLS/AUTH protocol. Requires Net::SMTP::TLS, availble on CPAN. + +When using this option, the default port is 587. +You can specify a port from the command line using the --port option. + +Use the notls option to turn off the tls option. + +Also, you may need to fix your copy of Net::SMTP::TLS. Here is the diff against version 0.12: + + 254c254 + < $me->_command(sprintf("AUTH PLAIN %S", + --- + > $me->_command(sprintf("AUTH PLAIN %s", + + +=item --ssl + +=item --nossl + +Enable SSL protocol. Requires Net::SMTP::SSL and Authen::SASL, availble on CPAN. + +When using this option, the default port is 465. You can override with the --port option. + +Use the nossl option to turn off the ssl option. + +=item --auth + +Enable authentication with Net::SMTP_auth (sold separately). +For example, try using --auth PLAIN or --auth CRAM-MD5. + +=item --username + +=item --password + +Username and password to use when connecting to SMTP server. +Also known as: -U -P + +=item --body + +Use this option to specify the body of the email message. If you need newlines in your message, +you might need to use the --stdin option instead. + +=item --header
+ +Use this option to set an arbitrary header in the message. You can use it multiple times. + +=item --stdin + +Grab the body of the email message from stdin. + +=item --mailto recipient@your.net + +You can send a message to multiple recipients by repeating this option or by separating +the email addresses with commas (no whitespace allowed): + +$ check_smtp_send -H mail.server.net --mailto recipient@your.net,recipient2@your.net --mailfrom sender@your.net + +SMTP SEND OK - 1 seconds + +=item --mailfrom sender@your.net + +Use this option to set the "from" address in the email. + +=item --template + +=item --notemplate + +Enable (or disable) processing of message body and headers. Requires Text::Template. + +Use this option to apply special processing to your message body and headers that allows you to use the +results of arbitrary computations in the text. For example, you can use this feature to send a message +containing the hostname of the machine that sent the message without customizing the plugin configuration +on each machine. + +When you enable the --template option, the message body and headers are parsed by +Text::Template. Even a message body provided using the --stdin option will be parsed. +See the Text::Template manual for more information, but in general any expression +written in Perl will work. + +There is one convenience function provided to you, trim, which will remove leading and trailing whitespace +from its parameter. Here's an example: + + check_smtp_send -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net + --template --body 'hello, this message is from {use Sys::Hostname; hostname}' + --header 'Subject: test message from {trim(`whoami`)}' + + +=item --expect-response + +Use this option to specify which SMTP response code should be expected from the server +after the SMTP dialog is complete. The default is 250 (message accepted). + +Also known as: -E + +=item --hires + +Use the Time::HiRes module to measure time, if available. + +=item --verbose + +Display additional information. Useful for troubleshooting. + +One --verbose will show extra information for OK, WARNING, and CRITICAL status. + +Use one --verbose together with --version to see the default warning and critical timeout values. + +Three --verbose (or -vvv) will show debug information, unless you're using --tls because Net::SMTP::TLS +does not have a Debug feature. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. Does not work in the ePN version. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Send a message with custom headers + +$ check_smtp_send -H mail.server.net --mailto recipient@your.net --mailfrom sender@your.net +--body 'Homeruns 5' --header 'Subject: Hello, world!' --header 'X-Your-Header: Yes' + +SMTP SEND OK - 1 seconds + +=head1 EXIT CODES + +Complies with the Nagios plug-in specification: + 0 OK The plugin was able to check the service and it appeared to be functioning properly + 1 Warning The plugin was able to check the service, but it appeared to be above some "warning" threshold or did not appear to be working properly + 2 Critical The plugin detected that either the service was not running or it was above some "critical" threshold + 3 Unknown Invalid command line arguments were supplied to the plugin or the plugin was unable to check the status of the given hosts/service + +=head1 NAGIOS PLUGIN NOTES + +Nagios plugin reference: http://nagiosplug.sourceforge.net/developer-guidelines.html + +This plugin does NOT use Nagios DEFAULT_SOCKET_TIMEOUT (provided by utils.pm as $TIMEOUT) because +the path to utils.pm must be specified completely in this program and forces users to edit the source +code if their install location is different (if they realize this is the problem). You can view +the default timeout for this module by using the --verbose and --version options together. The +short form is -vV. + +Other than that, it attempts to follow published guidelines for Nagios plugins. + +=head1 CHANGES + + Wed Oct 29 14:05:00 PST 2005 + + version 0.1 + + Wed Nov 9 15:01:48 PST 2005 + + now using an inline PluginReport package to generate the report + + added stdin option + + copyright notice and GNU GPL + + version 0.2 + + Thu Apr 20 16:00:00 PST 2006 (by Geoff Crompton ) + + added bailing if the $smtp->to() call fails + + added support for mailto recipients separated by commas + + version 0.2.1 + + Tue Apr 24 21:17:53 PDT 2007 + + moved POD text to separate file in order to accomodate the new embedded-perl Nagios feature + + version 0.2.3 + + Fri Apr 27 20:26:42 PDT 2007 + + documentation now mentions every command-line option accepted by the plugin, including abbreviations + + version 0.3 + + Sun Oct 21 10:34:14 PDT 2007 + + added support for TLS and authentication via the Net::SMTP::TLS module. see --tls option. + + version 0.4 + + Sun Oct 21 13:54:26 PDT 2007 + + added support for SSL via the Net::SMTP::SSL module. see --ssl option. + + port is no longer a required option. defaults to 25 for regular smtp, 465 for ssl, and 587 for tls. + + added port info to the "could not connect" error message + + version 0.4.1 + + Tue Dec 4 07:42:32 PST 2007 + + added --usage option because the official nagios plugins have both --help and --usage + + added --timeout option to match the official nagios plugins + + fixed some minor pod formatting issues for perldoc + + version 0.4.2 + + Mon Feb 11 19:09:37 PST 2008 + + fixed a bug for embedded perl version, variable "%status" will not stay shared in load_modules + + version 0.4.3 + + Mon May 26 09:12:14 PDT 2008 + + fixed warning and critical messages to use "more than" or "less than" instead of the angle brackets, to make them more web friendly + + version 0.4.4 + + Wed Jul 2 07:12:35 PDT 2008 + + added --expect-response option submitted by Christian Kauhaus + + added support for authentication via Net::SMTP_auth. see --auth option. + + version 0.4.5 + + Sun Oct 5 15:18:23 PDT 2008 + + added error handling for smtp server disconnects ungracefully during QUIT (gmail.com does) + + version 0.4.6 + + Thu Oct 1 12:09:35 PDT 2009 + + added --template option to allow arbitrary substitutions for body and headers, and provided one convenience function for trimming strings + + added performance data for use with PNP4Nagios! + + version 0.5.0 + + Thu Oct 8 11:17:04 PDT 2009 + + added more detailed error messages when using --verbose + + version 0.5.1 + + Tue Feb 9 12:14:49 PST 2010 + + added support for combining --auth with --tls using a subclass of Net::SMTP::TLS submitted by Brad Guillory; please note that to use the "PLAIN" authentication type you need to patch your Net::SMTP:TLS because it has a bug in sub auth_PLAIN (sprintf %S instead of %s) + + version 0.5.2 + + Mon Jan 3 10:39:42 PST 2011 + + added default Date and Message-ID headers; Date header uses POSIX strftime and Message-ID header uses hostname command to get localhost name + + version 0.7.0 + + Fri May 6 08:35:09 AST 2011 + + added --hires option to enable use of Time::Hires if available + + version 0.7.1 + + Wed Jul 6 19:18:26 AST 2011 + + the --hostname is now optional; if not provided the plugin will lookup the MX record for the --mailto address (requires Net::DNS) + + version 0.7.2 + + Tue Dec 13 09:24:04 PST 2011 + + separated authentication errors from connection errors + + version 0.7.3 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2005-2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.html b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.html new file mode 100644 index 0000000..cff7a09 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.html @@ -0,0 +1,178 @@ + + + + +imap_ssl_cert - connects to an IMAP server using SSL and saves the server certificate into a .pem file + + + + + + + + + +
+

+ + + +
+ + +

+

+
+

NAME

+

imap_ssl_cert - connects to an IMAP server using SSL and saves the server certificate into a .pem file

+

+

+
+

SYNOPSIS

+
+ imap_ssl_cert -H imap.server.com > server_ca_file.pem
+ imap_ssl_cert -?
+ imap_ssl_cert --help
+

+

+
+

DEPENDENCIES

+

This utility requires the following perl modules to be installed:

+

Getopt::Long +Mail::IMAPClient +IO::Socket::SSL +Net::SSLeay

+

+

+
+

OPTIONS

+
+
--timeout <seconds>
+ +
+

Abort with critical status if it takes longer than <seconds> to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t <seconds>

+
+
--hostname <server>
+ +
+

Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H <server>

+
+
--port <number>
+ +
+

Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p <number>

+
+
--verbose
+ +
+

Display additional information. Useful for troubleshooting.

+

Also known as: -v

+
+
--version
+ +
+

Display plugin version and exit. +Also known as: -V

+
+
--help
+ +
+

Display this documentation and exit. +Also known as: -h

+
+
--usage
+ +
+

Display a short usage instruction and exit.

+
+
+

+

+
+

EXAMPLES

+

+

+

Print the server's SSL certificate chain

+
+ $ perl imap_ssl_cert.pl -H imap.server.com > ca_file.pem
+ $ cat ca_file.pem
+
+ -----BEGIN CERTIFICATE-----
+ MIID1zCCAr+gAwIBAgIQPr3bVk0SkuXygjxgA7EVGDANBgkqhkiG9w0BAQUFADA8
+ [...snip...]
+ 0FF4warjskrfqaVtWeIV58LJheaM4cPJkc2M
+ -----END CERTIFICATE-----
+
+ $ openssl x509 -in ca_file.pem -text
+

+

+
+

SEE ALSO

+

http://en.wikipedia.org/wiki/X.509 +http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail +http://tools.ietf.org/html/rfc1422 +http://search.cpan.org/~mikem/Net-SSLeay-1.42/lib/Net/SSLeay.pm +http://search.cpan.org/~plobbes/Mail-IMAPClient-3.29/lib/Mail/IMAPClient.pod

+

+

+
+

CHANGES

+
+ Fri Nov 11 03:38:13 AST 2011
+ + version 0.1
+

+

+
+

AUTHOR

+

Jonathan Buhacoff <jonathan@buhacoff.net>

+

+

+
+

COPYRIGHT AND LICENSE

+
+ Copyright (C) 2011 Jonathan Buhacoff
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>;.
+
+ http://www.gnu.org/licenses/gpl.txt
+ + + + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.pod b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.pod new file mode 100644 index 0000000..dc42d5c --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/docs/imap_ssl_cert.pod @@ -0,0 +1,122 @@ + + + +=pod + +=head1 NAME + +imap_ssl_cert - connects to an IMAP server using SSL and saves the server certificate into a .pem file + +=head1 SYNOPSIS + + imap_ssl_cert -H imap.server.com > server_ca_file.pem + imap_ssl_cert -? + imap_ssl_cert --help + +=head1 DEPENDENCIES + +This utility requires the following perl modules to be installed: + +Getopt::Long +Mail::IMAPClient +IO::Socket::SSL +Net::SSLeay + +=head1 OPTIONS + +=over + +=item --timeout + +Abort with critical status if it takes longer than to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t + +=item --hostname + +Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H + +=item --port + +Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p + +=item --verbose + +Display additional information. Useful for troubleshooting. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Print the server's SSL certificate chain + + $ perl imap_ssl_cert.pl -H imap.server.com > ca_file.pem + $ cat ca_file.pem + + -----BEGIN CERTIFICATE----- + MIID1zCCAr+gAwIBAgIQPr3bVk0SkuXygjxgA7EVGDANBgkqhkiG9w0BAQUFADA8 + [...snip...] + 0FF4warjskrfqaVtWeIV58LJheaM4cPJkc2M + -----END CERTIFICATE----- + + $ openssl x509 -in ca_file.pem -text + + +=head1 SEE ALSO + +http://en.wikipedia.org/wiki/X.509 +http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail +http://tools.ietf.org/html/rfc1422 +http://search.cpan.org/~mikem/Net-SSLeay-1.42/lib/Net/SSLeay.pm +http://search.cpan.org/~plobbes/Mail-IMAPClient-3.29/lib/Mail/IMAPClient.pod + +=head1 CHANGES + + Fri Nov 11 03:38:13 AST 2011 + + version 0.1 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/imap_ssl_cert b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/imap_ssl_cert new file mode 100644 index 0000000..a79c56e --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/imap_ssl_cert @@ -0,0 +1,236 @@ +#!/usr/bin/perl +use strict; +my $VERSION = '0.1'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +use Getopt::Long; +use Mail::IMAPClient; +use IO::Socket::SSL; +use Net::SSLeay; + +# get options from command line +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $imap_server = ""; +my $default_imap_port = "143"; +my $default_imap_ssl_port = "993"; +my $imap_port = ""; +my $timeout = 60; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + # imap settings + "H|hostname=s"=>\$imap_server,"p|port=i"=>\$imap_port, + # time + "t|timeout=i"=>\$timeout + ); + +if( $show_version ) { + print "$VERSION\n"; + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +if( $help_usage + || + ( $imap_server eq "" ) + ) { + print "Usage: $0 -H host [-p port]\n"; + exit $status{UNKNOWN}; +} + +my @certs = (); # we have to store the certs we get Net::SSLeay here so that we can output them in REVERSE order (server cert first, root cert last) + +# connect to IMAP server +print "connecting to server $imap_server\n" if $verbose > 2; +my $imap; +eval { + local $SIG{ALRM} = sub { die "exceeded timeout $timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $timeout; + + $imap_port = $default_imap_ssl_port unless $imap_port; + my $socket = IO::Socket::SSL->new( + PeerAddr => "$imap_server:$imap_port", + SSL_verify_mode => 1, + SSL_ca_file => undef, + SSL_verifycn_scheme => 'imap', + SSL_verifycn_name => $imap_server, + SSL_verify_callback => \&ssl_printer + ); + die IO::Socket::SSL::errstr() unless $socket; + $socket->autoflush(1); + $imap = Mail::IMAPClient->new(Socket=>$socket, Debug => 0 ); + $imap->State(Mail::IMAPClient->Connected); + $imap->_read_line() if "$Mail::IMAPClient::VERSION" le "2.2.9"; # necessary to remove the server's "ready" line from the input buffer for old versions of Mail::IMAPClient. Using string comparison for the version check because the numeric didn't work on Darwin and for Mail::IMAPClient the next version is 2.3.0 and then 3.00 so string comparison works +# $imap->User($username); +# $imap->Password($password); +# $imap->login() or die "Cannot login: $@"; + + print join("\n",reverse(@certs)); + alarm 0; +}; +if( $@ ) { + chomp $@; + print "Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +unless( $imap ) { + print "Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} + +# deselect the mailbox +$imap->close(); + +# disconnect from IMAP server +print "disconnecting from server\n" if $verbose > 2; +$imap->logout(); + + +exit $status{OK}; + +# see IO::Socket::SSL documentation for SSL_verify_callback: +sub ssl_printer { + my ($boolOpenSSLResult, $cmemCertificateStore, $strCertIssuerOwnerAttr, $strError, $cmemPeerCertificate) = @_; + warn "OpenSSL says certificate is " . ( $boolOpenSSLResult ? "valid" : "invalid" ) if $verbose > 0; + warn "Peer certificate: $strCertIssuerOwnerAttr" if $verbose > 0; + warn "Errors: $strError" if $verbose > 0; + #print Net::SSLeay::PEM_get_string_X509($cmemPeerCertificate); + push @certs, $strCertIssuerOwnerAttr . "\n" . Net::SSLeay::PEM_get_string_X509($cmemPeerCertificate); +} + +package main; +1; + +__END__ + + +=pod + +=head1 NAME + +imap_ssl_cert - connects to an IMAP server using SSL and saves the server certificate into a .pem file + +=head1 SYNOPSIS + + imap_ssl_cert -H imap.server.com > server_ca_file.pem + imap_ssl_cert -? + imap_ssl_cert --help + +=head1 DEPENDENCIES + +This utility requires the following perl modules to be installed: + +Getopt::Long +Mail::IMAPClient +IO::Socket::SSL +Net::SSLeay + +=head1 OPTIONS + +=over + +=item --timeout + +Abort with critical status if it takes longer than to connect to the IMAP server. Default is 60 seconds. +The difference between timeout and critical is that, with the default settings, if it takes 45 seconds to +connect to the server then the connection will succeed but the plugin will return CRITICAL because it took longer +than 30 seconds. +Also known as: -t + +=item --hostname + +Address or name of the IMAP server. Examples: mail.server.com, localhost, 192.168.1.100 +Also known as: -H + +=item --port + +Service port on the IMAP server. Default is 143. If you use SSL, default is 993. +Also known as: -p + +=item --verbose + +Display additional information. Useful for troubleshooting. + +Also known as: -v + +=item --version + +Display plugin version and exit. +Also known as: -V + +=item --help + +Display this documentation and exit. +Also known as: -h + +=item --usage + +Display a short usage instruction and exit. + +=back + +=head1 EXAMPLES + +=head2 Print the server's SSL certificate chain + + $ perl imap_ssl_cert.pl -H imap.server.com > ca_file.pem + $ cat ca_file.pem + + -----BEGIN CERTIFICATE----- + MIID1zCCAr+gAwIBAgIQPr3bVk0SkuXygjxgA7EVGDANBgkqhkiG9w0BAQUFADA8 + [...snip...] + 0FF4warjskrfqaVtWeIV58LJheaM4cPJkc2M + -----END CERTIFICATE----- + + $ openssl x509 -in ca_file.pem -text + + +=head1 SEE ALSO + +http://en.wikipedia.org/wiki/X.509 +http://en.wikipedia.org/wiki/Privacy_Enhanced_Mail +http://tools.ietf.org/html/rfc1422 +http://search.cpan.org/~mikem/Net-SSLeay-1.42/lib/Net/SSLeay.pm +http://search.cpan.org/~plobbes/Mail-IMAPClient-3.29/lib/Mail/IMAPClient.pod + +=head1 CHANGES + + Fri Nov 11 03:38:13 AST 2011 + + version 0.1 + +=head1 AUTHOR + +Jonathan Buhacoff + +=head1 COPYRIGHT AND LICENSE + + Copyright (C) 2011 Jonathan Buhacoff + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + http://www.gnu.org/licenses/gpl.txt + +=cut + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/imap_ssl_cert_epn b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/imap_ssl_cert_epn new file mode 100644 index 0000000..dce2f32 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/imap_ssl_cert_epn @@ -0,0 +1,114 @@ +#!/usr/bin/perl +use strict; +my $VERSION = '0.1'; +my $COPYRIGHT = 'Copyright (C) 2005-2011 Jonathan Buhacoff '; +my $LICENSE = 'http://www.gnu.org/licenses/gpl.txt'; +my %status = ( 'OK' => 0, 'WARNING' => 1, 'CRITICAL' => 2, 'UNKNOWN' => 3 ); + +use Getopt::Long; +use Mail::IMAPClient; +use IO::Socket::SSL; +use Net::SSLeay; + +# get options from command line +Getopt::Long::Configure("bundling"); +my $verbose = 0; +my $help = ""; +my $help_usage = ""; +my $show_version = ""; +my $imap_server = ""; +my $default_imap_port = "143"; +my $default_imap_ssl_port = "993"; +my $imap_port = ""; +my $timeout = 60; +my $ok; +$ok = Getopt::Long::GetOptions( + "V|version"=>\$show_version, + "v|verbose+"=>\$verbose,"h|help"=>\$help,"usage"=>\$help_usage, + # imap settings + "H|hostname=s"=>\$imap_server,"p|port=i"=>\$imap_port, + # time + "t|timeout=i"=>\$timeout + ); + +if( $show_version ) { + print "$VERSION\n"; + exit $status{UNKNOWN}; +} + +if( $help ) { + exec "perldoc", $0 or print "Try `perldoc $0`\n"; + exit $status{UNKNOWN}; +} + +if( $help_usage + || + ( $imap_server eq "" ) + ) { + print "Usage: $0 -H host [-p port]\n"; + exit $status{UNKNOWN}; +} + +my @certs = (); # we have to store the certs we get Net::SSLeay here so that we can output them in REVERSE order (server cert first, root cert last) + +# connect to IMAP server +print "connecting to server $imap_server\n" if $verbose > 2; +my $imap; +eval { + local $SIG{ALRM} = sub { die "exceeded timeout $timeout seconds\n" }; # NB: \n required, see `perldoc -f alarm` + alarm $timeout; + + $imap_port = $default_imap_ssl_port unless $imap_port; + my $socket = IO::Socket::SSL->new( + PeerAddr => "$imap_server:$imap_port", + SSL_verify_mode => 1, + SSL_ca_file => undef, + SSL_verifycn_scheme => 'imap', + SSL_verifycn_name => $imap_server, + SSL_verify_callback => \&ssl_printer + ); + die IO::Socket::SSL::errstr() unless $socket; + $socket->autoflush(1); + $imap = Mail::IMAPClient->new(Socket=>$socket, Debug => 0 ); + $imap->State(Mail::IMAPClient->Connected); + $imap->_read_line() if "$Mail::IMAPClient::VERSION" le "2.2.9"; # necessary to remove the server's "ready" line from the input buffer for old versions of Mail::IMAPClient. Using string comparison for the version check because the numeric didn't work on Darwin and for Mail::IMAPClient the next version is 2.3.0 and then 3.00 so string comparison works +# $imap->User($username); +# $imap->Password($password); +# $imap->login() or die "Cannot login: $@"; + + print join("\n",reverse(@certs)); + alarm 0; +}; +if( $@ ) { + chomp $@; + print "Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} +unless( $imap ) { + print "Could not connect to $imap_server port $imap_port: $@\n"; + exit $status{CRITICAL}; +} + +# deselect the mailbox +$imap->close(); + +# disconnect from IMAP server +print "disconnecting from server\n" if $verbose > 2; +$imap->logout(); + + +exit $status{OK}; + +# see IO::Socket::SSL documentation for SSL_verify_callback: +sub ssl_printer { + my ($boolOpenSSLResult, $cmemCertificateStore, $strCertIssuerOwnerAttr, $strError, $cmemPeerCertificate) = @_; + warn "OpenSSL says certificate is " . ( $boolOpenSSLResult ? "valid" : "invalid" ) if $verbose > 0; + warn "Peer certificate: $strCertIssuerOwnerAttr" if $verbose > 0; + warn "Errors: $strError" if $verbose > 0; + #print Net::SSLeay::PEM_get_string_X509($cmemPeerCertificate); + push @certs, $strCertIssuerOwnerAttr . "\n" . Net::SSLeay::PEM_get_string_X509($cmemPeerCertificate); +} + +package main; +1; + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/nagios-plugins-check_email_delivery.spec b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/nagios-plugins-check_email_delivery.spec new file mode 100644 index 0000000..7af2882 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/check_email_delivery-0.7.1b/nagios-plugins-check_email_delivery.spec @@ -0,0 +1,63 @@ +Summary: A Nagios plugin to check IMAP delivery times +#Name: check_email_delivery +Name: nagios-plugins-check_email_delivery +Version: 0.7.1a +Release: 0.2%{?dist} +License: GPLv2 +Group: Applications/System +URL: http://buhacoff.net/software/check_email_delivery/ +Source0: http://buhacoff.net/software/check_email_delivery/archive/check_email_delivery-%{version}.tar.gz +#http://exchange.nagios.org/components/com_mtree/attachment.php?link_id=1339&cf_id=30 +BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root + +# For handling --help options +Requires: /usr/bin/nroff + +%description +The Nagios email delivery plugin uses two other plugins +(smtp send and imap receive), also included, to send a message +to an email account and then check that account for the message +and delete it. The plugin times how long it takes for the +message to be delivered and the warning and critical thresholds +are for this elapsed time. + +%prep +#%setup -q +%setup -n check_email_delivery-%{version} + +# Avoid filenames with unnecessary punction in them +%{__mv} "./docs/check_smtp_send (Greek's conflicted copy 2011-08-24).pod" \ + ./docs/check_smtp_send-Greeks-conflicted-copy-2011-08-24.pod +%{__mv} "docs/How to connect to IMAP server manually.txt" \ + docs/How-to-connect-to-IMAP-server-manually.txt + +%build +# No build required, just drop in place + +%install +rm -rf $RPM_BUILD_ROOT +%{__install} -d -m0755 %{buildroot}%{_libdir}/nagios/plugins + +# No instlalation procedure, install manually +%{__install} -m0755 -m0755 check_* %{buildroot}%{_libdir}/nagios/plugins +%{__install} -m0755 -m0755 imap_* %{buildroot}%{_libdir}/nagios/plugins + + +%clean +rm -rf $RPM_BUILD_ROOT + + +%files +%defattr(-, root, root, 0755) +%{_libdir}/nagios/plugins/check_* +%{_libdir}/nagios/plugins/imap_* +%doc CHANGES.txt LICENSE.txt README.txt +%doc docs/* + +%changelog +* Sun Feb 5 2012 Nico Kadel-Garcia - 0.68-0.1 +- Update to 0.7.1a +- Add nroff dependency for --help options + +* Thu Nov 3 2011 Nico Kadel-Garcia - 0.68-0.1 +- Initial build. diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/control b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/control new file mode 100644 index 0000000..0976284 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/control @@ -0,0 +1,15 @@ +Uploaders: Bernd Zeimetz +Recommends: libio-socket-ssl-perl, libmail-imapclient-perl, libnet-smtp-tls-perl, libnet-smtp-ssl-perl, libnet-ssleay-perl, libnet-smtpauth-perl +Suggests: perl-doc +Version: 0.7.1b +Homepage: http://buhacoff.net/software/check_email_delivery/ +Watch: http://buhacoff.net/software/check_email_delivery/ archive/check_email_delivery-(\S+)\.tar\.gz +Description: plugin to monitor email delivery + Some typical uses of this plugin include: + - check SMTP server + - check messages and quota on IMAP server + - check email delivery loop + - check auto-responder function + - keep an eye on email lag + - monitor automated mailboxes + - check email-to-FTP or other special email gateways diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/copyright b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/copyright new file mode 100644 index 0000000..bc4614a --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/copyright @@ -0,0 +1,15 @@ +Copyright (C) 2005-2011 Jonathan Buhacoff + +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 . + diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/email_delivery.cfg b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/email_delivery.cfg new file mode 100644 index 0000000..1c067bd --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/email_delivery.cfg @@ -0,0 +1,4 @@ +define command{ + command_name check_email_delivery + command_line /usr/lib/nagios/plugins/check_email_delivery -p '$USER1$/check_smtp_send -H $HOSTADDRESS$ --mailfrom $ARG3$ --mailto $ARG4$ -U $ARG5$ -P $ARG6$ --header "Subject: Nagios %TOKEN1%" -w $ARG1$ -c $ARG2$' -p '$USER1$/check_imap_receive -H $HOSTADDRESS$ -U $ARG5$ -P $ARG6$ -s SUBJECT -s "Nagios %TOKEN1%" -w $ARG1$ -c $ARG2$' -w $ARG1$,$ARG1$ -c $ARG2$,$ARG2$ + } diff --git a/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/src b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/src new file mode 120000 index 0000000..3df4986 --- /dev/null +++ b/nagios-plugins-contrib-24.20190301~bpo9+1/check_email_delivery/src @@ -0,0 +1 @@ +check_email_delivery-0.7.1b \ No newline at end of file -- cgit v1.2.3