├── LICENSE ├── README.md ├── check_jenkins ├── LICENSE ├── README.md └── check_jenkins ├── check_sql ├── LICENSE ├── README.md └── check_sql └── check_vpn ├── LICENSE ├── README.md ├── check_vpn ├── check_vpn_plugins ├── iodine.sh ├── l2tp.sh ├── openvpn.sh ├── pptp.sh └── ssh.sh ├── examples ├── l2tp_default_install.md ├── openvpn_default_install.md ├── pptp_default_install.md └── ssh_default_install.md ├── shunit2_test_integ.sh └── shunit2_test_unit.sh /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | Nagios Plugins I maintain, currently only check_vpn and check_sql 294 | Copyright (C) 2013 Dan Fruehauf 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # nagios-plugins 2 | 3 | Nagios plugins I maintain, currently in: 4 | * [check_vpn](check_vpn) - Check VPN connectivity through VPN 5 | * [check_sql](check_sql) - Generic plugin to check the output of SQL commands 6 | * [check_jenkins](check_jenkins) - Check job status in Jenkins 7 | -------------------------------------------------------------------------------- /check_jenkins/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /check_jenkins/README.md: -------------------------------------------------------------------------------- 1 | # check_jenkins 2 | 3 | Returns the status of a jenkins job 4 | 5 | ## Features 6 | 7 | check_jenkins features the following: 8 | * Authentication with jenkins (optional) 9 | * Query the status of a job 10 | 11 | ## Simple Usage 12 | 13 | With authentication: 14 | ``` 15 | $ ./check_jenkins -U http://your-jenkins-instance.com -j job_name -U USERNAME -P PASSWORD 16 | ``` 17 | 18 | Without authentication: 19 | ``` 20 | $ ./check_jenkins -U http://your-jenkins-instance.com -j job_name 21 | ``` 22 | -------------------------------------------------------------------------------- /check_jenkins/check_jenkins: -------------------------------------------------------------------------------- 1 | #!/usr/bin/ruby 2 | 3 | require 'json' 4 | require 'open-uri' 5 | require 'trollop' 6 | require 'net/http' 7 | require 'net/https' 8 | 9 | # Get job status 10 | def get_job_status_json(url, username, password) 11 | uri = URI(url) 12 | 13 | http_response_body = "" 14 | Net::HTTP.start(uri.host, uri.port, 15 | :use_ssl => uri.scheme == 'https') do |http| 16 | request = Net::HTTP::Get.new uri.request_uri 17 | if username && password 18 | request.basic_auth username, password 19 | end 20 | 21 | response = http.request request 22 | http_response_body = response.body 23 | end 24 | 25 | return http_response_body 26 | end 27 | 28 | # Given a host_name and monitor_name, returns its status 29 | def get_jenkins_job_status(opts) 30 | jenkins_url = opts[:jenkins_url] 31 | jenkins_job = opts[:jenkins_job] 32 | jenkins_username = opts[:jenkins_username] 33 | jenkins_password = opts[:jenkins_password] 34 | 35 | job_url = jenkins_url + "/job/" + URI::encode(jenkins_job) + "/api/json" 36 | 37 | begin 38 | job_status = get_job_status_json(job_url, jenkins_username, jenkins_password) 39 | job_status = JSON.parse(job_status) 40 | rescue 41 | puts "UNKNOWN: Could not parse JSON at '#{job_url}'" 42 | return 3 43 | end 44 | 45 | job_color = job_status['color'] 46 | 47 | if "blue" == job_color 48 | puts "OK: Job '#{jenkins_job}' passed" 49 | return 0 50 | elsif "aborted" == job_color || "yellow" == job_color 51 | puts "Warning: Job '#{jenkins_job}' #{job_color}" 52 | return 1 53 | elsif "red" == job_color 54 | puts "Critical: Job '#{jenkins_job}' failed" 55 | return 2 56 | else 57 | puts "Unknown: Job '#{jenkins_job}' in '#{job_color}' state" 58 | return 3 59 | end 60 | end 61 | 62 | # Arguments parsing 63 | opts = Trollop::options do 64 | banner <<-EOS 65 | Get status of a jenkins job. 66 | 67 | Example: 68 | Show job status for 'job_name' on 'jenkins.com' 69 | check_jenkins -u username -p password -U https://jenkins.com -j job_name 70 | 71 | Options: 72 | EOS 73 | opt :jenkins_url, "Jenkins base URL", 74 | :type => :string, 75 | :short => '-U' 76 | opt :jenkins_username, 77 | "Jenkins username for login", 78 | :type => :string, 79 | :short => '-u' 80 | opt :jenkins_password, 81 | "Jenkins password for login", 82 | :type => :string, 83 | :short => '-p' 84 | opt :jenkins_job, 85 | "Job to check", 86 | :type => :string, 87 | :short => '-j' 88 | end 89 | 90 | %w{ jenkins_url jenkins_job }.each do |option| 91 | Trollop::die option.to_sym, "Must specify #{option.gsub('_', ' ')}" if ! opts[option.to_sym] 92 | end 93 | 94 | exit(get_jenkins_job_status(opts)) 95 | -------------------------------------------------------------------------------- /check_sql/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /check_sql/README.md: -------------------------------------------------------------------------------- 1 | # check_sql 2 | 3 | http://exchange.nagios.org/directory/Plugins/Databases/Others/check_sql/details 4 | 5 | check_sql is a nagios plugin to check SQL queries using perl DBI. 6 | 7 | check_sql is database agnostic and the support depends only on what DBI can support. 8 | 9 | I've personally tested check_sql with the following: 10 | * MySQL 11 | * PostgreSQL 12 | * SQL Server 13 | * SQLite 14 | 15 | It should support also: 16 | * Oracle databases 17 | * CSV 18 | * Many other databases I've never used :) 19 | 20 | check_sql is based on work done by Nagios Plugin Development Team and Thomas Guyot-Sionnest, I've decided to inherit it and add generic DBI support. I promise to do my best to maintain it... 21 | 22 | ## Features 23 | 24 | check_sql features the following: 25 | * Support any database supported by DBI 26 | * Run any query you'd like 27 | * Compare values returned in queries 28 | * Regular expression matching on returned queries 29 | * Return warning or critical based on thresholds (numeric results only) 30 | 31 | ## Simple Usage 32 | 33 | ./check_sql -v -s -d DSN -U USERNAME -P PASSWORD -q "select count(*) from some_table" 34 | 35 | DSN is the DBI connection string to connect to the database. Some examples: 36 | 37 | # mysql database at localhost:3306 38 | DBI:mysql:database=users;host=localhost;port=3306 39 | 40 | # postgresql database at localhost:5432 41 | DBI:Pg:dbname=homes;host=localhost;port=5432 42 | 43 | # SQL server at cakes.microsoft.com:1433 44 | DBI:Sybase:server=cakes.microsoft.com:1433 45 | 46 | # sqlite3 database located at /var/db/sqlite.db 47 | DBI:SQLite:dbname=/var/db/sqlite.db 48 | 49 | Refer to the specific tutorial to find the right DSN for your DB. 50 | 51 | ## Expecting Results 52 | 53 | Expecting "Awesome" at the result (-e): 54 | 55 | ./check_sql -v -s -d DSN -U USERNAME -P PASSWORD -e "Awesome" -q "select 'Awesome'" 56 | 57 | Expect a regular expression (-r and -e): 58 | 59 | ./check_sql -v -s -d DSN -U USERNAME -P PASSWORD -r -e "Awesome" -q "select 'Awesome yiiiiiiiiiiha'" 60 | 61 | ## Threshold results 62 | 63 | Show a warning if larger than 10 (-W 10) and critical if larger than 100 (-C 100): 64 | 65 | # will show an OK 66 | ./check_sql -v -s -d DSN -U USERNAME -P PASSWORD -W 10 -C 100 -q "select 9" 67 | # will show a warning 68 | ./check_sql -v -s -d DSN -U USERNAME -P PASSWORD -W 10 -C 100 -q "select 11" 69 | # will show an error 70 | ./check_sql -v -s -d DSN -U USERNAME -P PASSWORD -W 10 -C 100 -q "select 101" 71 | 72 | ## Plugin Specifics 73 | 74 | ### MySQL 75 | 76 | Things you'll need: 77 | * perl DBD::MySQL 78 | 79 | Example: 80 | 81 | ./check_sql -v -s -d "DBI:mysql:database=DB_NAME;host=DB_HOSTNAME;port=DB_PORT" -U USERNAME -P PASSWORD -q "select count(*) from some_table" 82 | 83 | ### PostgreSQL 84 | 85 | Things you'll need: 86 | * perl DBD::Pg 87 | 88 | Example: 89 | 90 | ./check_sql -v -s -d "DBI:Pg:dbname=DB_NAME" -U USERNAME -P PASSWORD -q "select count(*) from some_table" 91 | 92 | ### SQL Server 93 | 94 | Things you'll need: 95 | * perl DBD::Sybase 96 | * FreeTDS (compiled with --with-tdsver=8.0) 97 | 98 | Example: 99 | 100 | ./check_sql -v -s -d DBI:Sybase:server=SERVER_NAME:PORT -U DB_USERNAME -P DB_PASSWORD -q "select count(*) from some_table" 101 | 102 | ### SQLite 103 | 104 | Things you'll need: 105 | * perl DBD-SQLite 106 | 107 | Example: 108 | 109 | ./check_sql -v -s -d DBI:SQLite:dbname=/var/db/sqlite.db -q "SELECT COUNT(*) FROM some_table" 110 | 111 | ### Limitations 112 | 113 | Please open me issues if you find any. I promise to address them as soon as I can. 114 | 115 | 116 | 117 | -------------------------------------------------------------------------------- /check_sql/check_sql: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env -S perl -w 2 | 3 | # 4 | # check_sql - run a simple test query against a database via DBI 5 | # Copyright (C) 2013 Dan Fruehauf 6 | # Copyright (c) 2007 Thomas Guyot-Sionnest 7 | # Copyright (c) 2007 Nagios Plugin Development Team 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | # 22 | 23 | use strict; 24 | use warnings; 25 | use vars qw($PROGNAME $VERSION $QSTRING $LABEL); 26 | use File::Basename qw(basename); 27 | use Monitoring::Plugin; 28 | use Monitoring::Plugin::Functions qw(max_state); 29 | use Time::HiRes qw(gettimeofday tv_interval); 30 | use DBI; 31 | 32 | $PROGNAME = basename($0); 33 | $VERSION = '0.9.3'; 34 | $QSTRING = 'SELECT 1 AS Response'; 35 | $LABEL = 'result'; 36 | 37 | my $np = Monitoring::Plugin->new( 38 | usage => "Usage: %s -d dsn [ -t ]\n" 39 | . " [ -U ] [ -P ] [ -w ] [ -c ]\n" 40 | . " [ -W ] [ -C ] [ -q query ] [ -e expect_string ]\n" 41 | . ' [ -r ] [ -s ] [ -l label ]', 42 | version => $VERSION, 43 | plugin => $PROGNAME, 44 | shortname => uc($PROGNAME), 45 | blurb => 'Run a simple test query against a database', 46 | extra => "\n\nCopyright (c) 2007 Nagios Plugin Development Team", 47 | timeout => 30, 48 | ); 49 | 50 | $np->add_arg( 51 | spec => 'dsn|d=s', 52 | help => "-d, --dsn=\n" 53 | . ' SQL Database dsn', 54 | required => 1, 55 | ); 56 | 57 | $np->add_arg( 58 | spec => 'username|U=s', 59 | help => "-U, --username=\n" 60 | . ' Username to connect with.', 61 | required => 0, 62 | ); 63 | 64 | $np->add_arg( 65 | spec => 'password|P=s', 66 | help => "-P, --password=\n" 67 | . ' Password to use with the username.', 68 | required => 0, 69 | ); 70 | 71 | $np->add_arg( 72 | spec => 'warning|w=s', 73 | help => "-w, --warning=THRESHOLD\n" 74 | . " Warning threshold for the response time. See\n" 75 | . " http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT\n" 76 | . ' for the threshold format.', 77 | required => 0, 78 | ); 79 | 80 | $np->add_arg( 81 | spec => 'critical|c=s', 82 | help => "-c, --critical=THRESHOLD\n" 83 | . " Critical threshold for the response time. See\n" 84 | . " http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT\n" 85 | . ' for the threshold format.', 86 | required => 0, 87 | ); 88 | 89 | $np->add_arg( 90 | spec => 'query|q=s', 91 | help => "-q, --query=\n" 92 | . " SQL Query ro execute on the server (default: '$QSTRING').", 93 | default => $QSTRING, 94 | required => 0, 95 | ); 96 | 97 | $np->add_arg( 98 | spec => 'expect|e=s', 99 | help => "-e, --expect=\n" 100 | . " The expected result from the SQL server (first cell of first row). Cannot\n" 101 | . ' be used with -W or -C.', 102 | required => 0, 103 | ); 104 | 105 | $np->add_arg( 106 | spec => 'regexp|r+', 107 | help => "-r, --regexp\n" 108 | . ' Allow Perl regular expressions to be used with -e.', 109 | required => 0, 110 | ); 111 | 112 | $np->add_arg( 113 | spec => 'rwarning|W=s', 114 | help => "-W, --rwarning=THRESHOLD\n" 115 | . " Warning threshold for the returned value. Value must be numeric. See\n" 116 | . " http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT\n" 117 | . ' for the threshold format. Cannot be used with -e.', 118 | required => 0, 119 | ); 120 | 121 | $np->add_arg( 122 | spec => 'rcritical|C=s', 123 | help => "-C, --rcritical=THRESHOLD\n" 124 | . " Critical threshold for the returned value. Value must be numeric. See\n" 125 | . " http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT\n" 126 | . ' for the threshold format. Cannot be used with -e.', 127 | required => 0, 128 | ); 129 | 130 | $np->add_arg( 131 | spec => 'show|s+', 132 | help => "-s, --show\n" 133 | . ' Show the result of the SQL query in the status text.', 134 | required => 0, 135 | ); 136 | 137 | $np->add_arg( 138 | spec => 'label|l=s', 139 | help => "-l, --label=label\n" 140 | . " Label used to present the SQL result (default: '$LABEL'). If in the form\n" 141 | . " 'LABEL,UOM', enables performance data for the result. Label is effective\n" 142 | . " only when used with --show or in the form 'LABEL,UOM'.", 143 | default => $LABEL, 144 | required => 0, 145 | ); 146 | 147 | $np->getopts; 148 | 149 | # Assign, then check args 150 | 151 | my $dsn = $np->opts->dsn; 152 | my $username = $np->opts->username; 153 | my $password = $np->opts->password; 154 | my $warning = $np->opts->warning; 155 | my $critical = $np->opts->critical; 156 | my $query = $np->opts->query; 157 | my $expect = $np->opts->expect; 158 | my $regexp = $np->opts->regexp; 159 | my $rwarning = $np->opts->rwarning; 160 | my $rcritical = $np->opts->rcritical; 161 | my $show = $np->opts->show; 162 | my ($label, $uom) = split(/,/, $np->opts->label); 163 | my $verbose = $np->opts->verbose; 164 | 165 | # Check existence of DBI driver 166 | my $driver = (split(/:/, $dsn))[1]; 167 | 168 | $np->nagios_exit('UNKNOWN', "Cannot find DBI driver '$driver'") 169 | if (not grep(/^$driver$/, DBI->available_drivers)); 170 | 171 | $np->nagios_exit('UNKNOWN', 'DSN contains invalid characters.') 172 | if ($dsn =~ /\`|\~|\!|\$|\%|\^|\&|\*|\||\'|\"|\<|\>|\?|\,|\(|\)/); 173 | 174 | $np->nagios_exit('UNKNOWN', '-e cannot be used with -W or -C') 175 | if ($expect && ($rwarning || $rcritical)); 176 | 177 | $np->nagios_exit('UNKNOWN', '-r have no effect without -e') 178 | if ($regexp && !$expect); 179 | 180 | $np->nagios_exit('UNKNOWN', 'LABEL must be defined if UOM is used') 181 | if ($uom && !$label); 182 | 183 | # First set the r* thresholds to validate them and get the threshold object. 184 | $np->set_thresholds( 185 | warning => $rwarning, 186 | critical => $rcritical, 187 | ); 188 | my $rthreshold = $np->threshold; 189 | 190 | # Then we can set the normal thresholds for validation and future use. 191 | $np->set_thresholds( 192 | warning => $warning, 193 | critical => $critical, 194 | ); 195 | 196 | # Note: There's no automated way to check if ranges makes sense, so you can 197 | # have a WARNING range within a CRITICAL range with no warning. I'm not going 198 | # to do N::P's job here so such thresholds are allowed for now. 199 | 200 | my $cs = $dsn; 201 | 202 | warn("Trying to connect. Connect string: '$cs'\n") if ($verbose); 203 | warn("Using the following credentials: $username, $password\n") if ($verbose > 2); 204 | 205 | # Just in case of problems, let's not hang Nagios 206 | alarm $np->opts->timeout; 207 | 208 | my $timestart = [gettimeofday]; 209 | 210 | my $dbh = DBI->connect($cs, $username, $password, 211 | { 212 | PrintWarn => ($verbose ? 1 : 0), 213 | PrintError => ($verbose ? 1 : 0) 214 | }) or $np->nagios_exit('CRITICAL', $DBI::errstr); 215 | 216 | warn("Connected. Querying server with '$query'\n") if ($verbose > 1); 217 | 218 | # selectrow_array behavior in scalar context is undefined (driver-dependent) 219 | # if multiple collumns are returned. Just get the first or only collumn: 220 | my ($result) = $dbh->selectrow_array($query) 221 | or $np->nagios_exit('CRITICAL', $DBI::errstr); 222 | 223 | $dbh->disconnect; 224 | 225 | my $timeend = [gettimeofday]; 226 | 227 | #Turn off alarm 228 | alarm(0); 229 | 230 | my $elapsed = tv_interval($timestart, $timeend); 231 | 232 | warn("Request complete. Time elapsed: $elapsed\n") if ($verbose); 233 | warn("Server returned $result\n") if ($verbose > 1); 234 | 235 | $np->add_perfdata( 236 | label => "time", 237 | value => $elapsed, 238 | uom => 's', 239 | threshold => $np->threshold, 240 | ); 241 | 242 | # Add result perfdata if UOM is specified (see usage) and result is numeric. 243 | if ($uom && $result =~ /^[-+]?\d+$/) { 244 | $np->add_perfdata( 245 | label => lc($label), 246 | value => $result, 247 | uom => $uom, 248 | threshold => $rthreshold, 249 | ); 250 | } 251 | 252 | # First check expect strings (if defined) as they always return CRITICAL 253 | if ($expect && $regexp) { 254 | $np->nagios_exit('CRITICAL', "Unexpected $label" . ($show ? ": $result" : '')) unless ($result =~ /$expect/); 255 | } elsif ($expect) { 256 | $np->nagios_exit('CRITICAL', "Unexpected $label" . ($show ? ": $result" : '')) if ($result ne $expect); 257 | } 258 | 259 | my @results; 260 | 261 | push (@results, $np->check_threshold($elapsed)); 262 | 263 | my $nonnumeric = 0; 264 | if (($rwarning || $rcritical) && !($result =~ /^[-+]?\d+$/)) { 265 | push (@results, ($rcritical ? CRITICAL : WARNING)); 266 | $nonnumeric = 1; 267 | } else { 268 | push (@results, $np->check_threshold(check => $result, warning => $rwarning, critical => $rcritical)); 269 | } 270 | 271 | warn ('Thresholds results: time=' . $results[0] . ', result=' . $results[1] . ', nonnumeric=' . $nonnumeric) if ($verbose); 272 | 273 | my $status = max_state(@results); 274 | 275 | if ($nonnumeric) { 276 | $np->nagios_exit($status, "Result is not numeric with result threshold defined ($elapsed seconds)"); 277 | } elsif ($show) { 278 | $np->nagios_exit($status, "SQL $label: $result ($elapsed seconds)"); 279 | } else { 280 | $np->nagios_exit($status, "SQL responded in $elapsed seconds"); 281 | } 282 | 283 | -------------------------------------------------------------------------------- /check_vpn/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /check_vpn/README.md: -------------------------------------------------------------------------------- 1 | # check_vpn 2 | 3 | http://exchange.nagios.org/directory/Plugins/Network-and-Systems-Management/check_vpn/details 4 | 5 | check_vpn is a nagios plugin to check VPN status. 6 | 7 | The types of VPNs currently supported are: 8 | * Iodine 9 | * OpenVPN 10 | * SSH 11 | * L2TP 12 | * PPTP 13 | 14 | Future: 15 | * IPSEC (using racoon road warrior client) 16 | * Anything else people would like to see supported 17 | 18 | ## Features 19 | 20 | check_vpn features the following: 21 | * Connect to a VPN using command line supplied parameters 22 | * Verify VPN connection succeeded 23 | * Test if an address behind the VPN is reachable (default is http://www.google.com) 24 | * Support multiple VPN connection attempts at the same time, using source based routing 25 | * Does not interfere with current network communications of machine (using source based routing per connected device) 26 | * Plugin architecture allows addition of more VPN plugins easily 27 | 28 | ## Installation 29 | 30 | Simply check out the repository, or copy `check_vpn` and `check_vpn_plugins` to 31 | your nagios directory, usually under `/usr/lib64/nagios/plugins` or 32 | `/usr/lib/nagios/plugins`. 33 | 34 | check_vpn must run as root, hence, if you're planning it to run it from 35 | nagios, you must add a line in sudoers such as: 36 | ``` 37 | nagios ALL=(ALL) NOPASSWD:/usr/lib64/nagios/plugins/check_vpn 38 | Defaults!/usr/lib64/nagios/plugins/check_vpn !requiretty 39 | ``` 40 | 41 | ### Nagios 42 | 43 | Please consult the usage for proper understanding of how check_vpn works. I 44 | highly encourage you to first configure check_vpn to work without nagios and 45 | only then to start integrating with nagios. Either way, here is a command and 46 | service definition for nagios for your convenience: 47 | ``` 48 | define command{ 49 | command_name check_vpn 50 | command_line sudo $USER1$/check_vpn -t $ARG1$ -H $HOSTADDRESS$ -u $ARG2$ -p $ARG3$ -- $ARG4$ 51 | } 52 | 53 | define service { 54 | host_name some_host 55 | service_description check_vpn 56 | check_command check_vpn!openvpn!nagios_vpn!secret_password!--ca /etc/openvpn/ca.crt 57 | use default-service 58 | } 59 | 60 | ``` 61 | 62 | 63 | ## Simple Usage 64 | 65 | ./check_vpn -t VPN_TYPE -H REMOTE_HOST -u USERNAME -p PASSWORD -- EXTRA_ARGS 66 | 67 | * VPN_TYPE is one of the plugins under check_vpn_plugins: 68 | * iodine 69 | * openvpn 70 | * ssh 71 | * l2tp 72 | * pptp 73 | 74 | ## Plugin Specifics 75 | 76 | ### Iodine 77 | 78 | Example: 79 | ``` 80 | ./check_vpn -t iodine -H iodine.vpn.com -u www.somedomain.com -p password -- -m 500 81 | ``` 82 | 83 | ### OpenVPN 84 | 85 | Example: 86 | ``` 87 | ./check_vpn -t openvpn -H openvpn.vpn.com -u dan -p password -- --ca /etc/openvpn/ca.crt --config /etc/openvpn/vpn.com.conf --proto tcp 88 | 89 | # running on a tap device 90 | ./check_vpn -t openvpn -H openvpn.vpn.com -u dan -p password -d tap -- --ca /etc/openvpn/ca.crt --config /etc/openvpn/vpn.com.conf --proto tcp 91 | ``` 92 | 93 | ### SSH 94 | 95 | Example: 96 | ``` 97 | ./check_vpn -t ssh -H ssh.vpn.com -u dan -p DUMMY_UNUSED_BY_SSH -- -o Port=4022 98 | 99 | # running on a tap device 100 | ./check_vpn -t ssh -H ssh.vpn.com -u dan -p DUMMY_UNUSED_BY_SSH -d tap 101 | ``` 102 | 103 | SSH plugin does not support password authentication. You will have to either use ssh-agent or -i KEY_FILE. 104 | 105 | ### L2TP 106 | 107 | L2TP specific argument passing is still rather limited. It takes pppd options as specific argument and they should be comma separated. 108 | 109 | Example: 110 | ``` 111 | ./check_vpn -t l2tp -H l2tp.vpn.com -u dan -p password -- mru 1410,mtu 1410 112 | ``` 113 | 114 | ### PPTP 115 | 116 | PPTP takes pppd options as specific arguments. Don't comma separate them. 117 | 118 | Example: 119 | ``` 120 | ./check_vpn -t pptp -H pptp.vpn.com -u dan -p password -- mru 1410 mtu 1410 novj novjccomp nobsdcomp 121 | ``` 122 | 123 | Connect to a Windows PPTP VPN server: 124 | ``` 125 | ./check_vpn -t pptp -H windows.pptp.vpn.com -u dan -p password -- require-mppe refuse-pap refuse-eap refuse-chap refuse-mschap 126 | ``` 127 | 128 | ## Locking 129 | 130 | Running from nagios one cannot really control when checks take place. Some of the limitations listed below can be addressed by using exclusive locking with check_vpn, causing checks to run sequentially. 131 | 132 | I've implemented rather simplistic mkdir locks but it seems to suffice, I don't like to over-engineer when not necessary. 133 | 134 | To use locking you need ot specify -l or --lock. For instance the following will run sequentially: 135 | 136 | ``` 137 | ./check_vpn -l -t l2tp -H l2tp-1.vpn.com -u dan -p password & 138 | ./check_vpn -l -t l2tp -H l2tp-2.vpn.com -u dan -p password & 139 | ./check_vpn -l -t l2tp -H l2tp-3.vpn.com -u dan -p password & 140 | ``` 141 | 142 | Generally speaking I would encourage running check_vpn with the --lock option as it can avoid many problems. Should the lock file get stuck and undeleted for any reason please: 143 | * Fill in an issue of how to reproduce 144 | * Run: 145 | ``` 146 | rmdir /var/run/check_vpn 147 | ``` 148 | 149 | ## Limitations 150 | 151 | ### TAP Device Gateway Guessing 152 | 153 | If using TAP devices with OpenVPN, the remote gateway cannot be guessed, causing packets to not route properly. This can be overcome by running: 154 | ``` 155 | REMOTE_GW=10.1.0.1 ./check_vpn -t openvpn -H vpn.openvpn.com -u dan -p my_secret_password -d tap76 -- --ca ca.crt 156 | ``` 157 | 158 | This will cause the source based routing line to be: 159 | ``` 160 | ip route add default via 10.1.0.1 table PRIVATE_ROUTING_TABLE 161 | ``` 162 | 163 | Instead of: 164 | ``` 165 | ip route add default dev tap76 table PRIVATE_ROUTING_TABLE 166 | ``` 167 | 168 | If you have any ideas about how to overcome this nicely, please advise me. 169 | 170 | ### Multiple Access 171 | 172 | Currently auto-allocation of devices is not fully "process safe", meaning that potentially two (or more) running instances may try to allocate and use the same device. This problem can be mitigated if you use the -d or --device option, so for instance if you have 3 hosts you'd like to check, the commands for each would be: 173 | ``` 174 | # host1 175 | ./check_vpn -t openvpn -H host1.openvpn.vpn.com -u nagios_user -p nagios_password -d tun1 176 | # host2 177 | ./check_vpn -t openvpn -H host2.openvpn.vpn.com -u nagios_user -p nagios_password -d tun2 178 | # host3 179 | ./check_vpn -t openvpn -H host3.openvpn.vpn.com -u nagios_user -p nagios_password -d tun3 180 | 181 | # or the general case 182 | host=hostX.openvpn.vpn.com 183 | ./check_vpn -t openvpn -H $host -u nagios_user -p nagios_password -d tun`echo $host | cut -c5` 184 | ``` 185 | 186 | That would completely separate them from each other, allowing every check to use a different device. 187 | 188 | If your hosts are not really aligned with nice hostnames, another way of generating a unique device number per host is using a checksum and a hash: 189 | ``` 190 | # first-host.openvpn.vpn.com 191 | declare -i device_number=$(expr `echo first-host.openvpn.vpn.com | cksum | cut -d' ' -f1` % 255) 192 | # device_number=11 193 | 194 | # another-host.openvpn.vpn.com 195 | declare -i device_number=$(expr `echo another-host.openvpn.vpn.com | cksum | cut -d' ' -f1` % 255) 196 | # device_number=168 197 | ``` 198 | 199 | In case multiple access is still being an issue, please refer to the section about [Locking](README.md#locking). 200 | 201 | ### Same IP, Different Interface 202 | 203 | If you may be connecting to two (or more) different servers who may assign you the same IP address, such as: 204 | 205 | ``` 206 | # ifconfig 207 | tap0 Link encap:Ethernet HWaddr XX:XX:XX:XX:XX:XX 208 | inet addr:10.1.0.1 Bcast:10.1.0.255 Mask:255.255.255.0 209 | ... 210 | 211 | tap1 Link encap:Ethernet HWaddr XX:XX:XX:XX:XX:XX 212 | inet addr:10.1.0.1 Bcast:10.1.0.255 Mask:255.255.255.0 213 | ... 214 | 215 | tap2 Link encap:Ethernet HWaddr XX:XX:XX:XX:XX:XX 216 | inet addr:10.1.0.1 Bcast:10.1.0.255 Mask:255.255.255.0 217 | ... 218 | ``` 219 | 220 | The behavior in this case would be undefined. I've asked on Server Fault just to be sure and here is the link: 221 | http://serverfault.com/questions/459919/multiple-vpn-devices-with-the-same-ip 222 | 223 | If you are facing such a situation please refer to the section of [Locking](README.md#locking) 224 | -------------------------------------------------------------------------------- /check_vpn/check_vpn: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # 4 | # check_vpn - a nagios plugin to check VPN status 5 | # Copyright (C) 2013 Dan Fruehauf 6 | # Copyright (C) 2012 Lacoon Security 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | 19 | # test in front of google.com 20 | declare -r DEFAULT_TEST_URL=http://www.google.com 21 | 22 | # check_vpn lock, for preventing multiple access to resources 23 | CHECK_VPN_LOCK=/var/run/check_vpn 24 | 25 | # global error string to report errors 26 | ERROR_STRING="" 27 | 28 | # returns a free vpn device 29 | # $1 - device prefix (tun/tap/ppp) 30 | allocate_vpn_device() { 31 | local device_prefix=$1; shift 32 | local i 33 | for i in `seq 0 255`; do 34 | ! ifconfig ${device_prefix}$i >& /dev/null && \ 35 | echo "${device_prefix}$i" && \ 36 | return 0 37 | done 38 | return 1 39 | } 40 | 41 | # returns 0 if this is a specific device (i.e. tun0) or 1 if not. for instance 42 | # 'tun', 'tap' or 'ppp' are not speficic devices, but 'tun10', 'tap43' or 43 | # 'ppp51' are 44 | # $1 - device 45 | is_specific_device() { 46 | local device=$1; shift 47 | echo $device | grep -q -o '\(tun\|tap\|ppp\|dns\)[[:digit:]]\+$' 48 | } 49 | 50 | # emits critical error and quits if not running as root 51 | check_root() { 52 | if [ `id -u` -ne 0 ]; then 53 | echo "Critical: check_vpn must be run as root" 54 | exit 2 55 | fi 56 | } 57 | 58 | ################################ 59 | # CORE check_vpn FUNCTIONALITY # 60 | ################################ 61 | 62 | # locks and prevents from multiple access 63 | lock_check_vpn() { 64 | local -i i=0 65 | while [ $i -lt 30 ]; do 66 | mkdir $CHECK_VPN_LOCK >& /dev/null && \ 67 | trap "{ rmdir $CHECK_VPN_LOCK; echo 'Critical: Aborted.'; exit 2; }" INT && \ 68 | return 0 69 | sleep 1 70 | let i=$i+1 71 | done 72 | echo "Critical: Couldn't obtain exclusive check_vpn lock '$CHECK_VPN_LOCK'" 73 | exit 2 74 | } 75 | 76 | # unlocks lock 77 | unlock_check_vpn() { 78 | rmdir $CHECK_VPN_LOCK 79 | } 80 | 81 | # return true if vpn is up, false if it hadn't 82 | # $1 - type 83 | # $2 - lns 84 | # $3 - vpn device 85 | wait_for_vpn_to_come_up() { 86 | local type=$1; shift 87 | local lns=$1; shift 88 | local vpn_device=$1; shift 89 | for i in `seq 1 30`; do 90 | sleep 1 91 | if _${type}_is_vpn_up $lns $vpn_device; then 92 | return 0 93 | fi 94 | done 95 | return 1 96 | } 97 | 98 | # return true if vpn is down, false if it hadn't 99 | # $1 - type 100 | # $2 - lns 101 | # $3 - vpn device 102 | wait_for_vpn_to_come_down() { 103 | local type=$1; shift 104 | local lns=$1; shift 105 | local vpn_device=$1; shift 106 | for i in `seq 1 30`; do 107 | sleep 1 108 | if ! _${type}_is_vpn_up $lns $vpn_device; then 109 | return 0 110 | fi 111 | done 112 | return 1 113 | } 114 | 115 | # checks if a port is open 116 | # $1 - host 117 | # $2 - port 118 | check_open_port() { 119 | local host=$1; shift 120 | local -i port=$1; shift 121 | echo -n | nc -w 5 $host $port >& /dev/null 122 | } 123 | 124 | # returns routing table number for device 125 | # $1 - device 126 | get_routing_table_for_device() { 127 | local device=$1; shift 128 | local device_prefix=${device:0:3} 129 | local -i device_nr=`echo $device | sed -e 's/^[a-z]\+//g'` 130 | 131 | local -i device_nr_base=5000 132 | case "$device_prefix" in 133 | tap) device_nr_base=2000;; 134 | tun) device_nr_base=3000;; 135 | ppp) device_nr_base=4000;; 136 | dns) device_nr_base=5000;; 137 | *) device_nr_base=6000;; 138 | esac 139 | 140 | local -i table_nr=`expr $device_nr_base + $device_nr` 141 | echo $table_nr 142 | } 143 | 144 | # add/remove source based routing for given device 145 | # $1 - device 146 | # $2 - action (up/down) 147 | source_based_routing() { 148 | local device=$1; shift 149 | local action=$1; shift 150 | 151 | # extract table number, local and remote addressess 152 | local -i table_nr=`get_routing_table_for_device $device` 153 | local interface_remote_address=`ip addr show $device | grep "\binet\b" | cut -d' ' -f8 | cut -d/ -f1` 154 | local interface_local_address=`ip addr show $device | grep "\binet\b" | cut -d' ' -f6` 155 | 156 | # TODO should somehow probe remote address, as tap devices 157 | # will not work without the remote address being set as gateways 158 | local via_argument="dev $device" 159 | [ x"$REMOTE_GW" != x ] && via_argument="via $REMOTE_GW" 160 | 161 | # act on action 162 | if [ "$action" = "up" ]; then 163 | route add $interface_remote_address dev $device >& /dev/null 164 | ip rule add from $interface_local_address table $table_nr >& /dev/null 165 | ip route add default $via_argument table $table_nr 166 | elif [ "$action" = "down" ]; then 167 | ip rule delete from $interface_local_address table $table_nr >& /dev/null 168 | ip route delete table $routing_table_number >& /dev/null 169 | else 170 | ERROR_STRING="source_based_routing: action required" && return 2 171 | fi 172 | } 173 | 174 | # run connectivity check 175 | # $1 - device 176 | # $2 - test url 177 | vpn_connectivity_check() { 178 | local device=$1; shift 179 | local test_url=$1; shift 180 | # add source based routing for device 181 | source_based_routing $device up 182 | 183 | # perform test 184 | curl \ 185 | --interface $device \ 186 | --connect-timeout 10 \ 187 | --speed-time 5 \ 188 | -w "time=%{time_connect}s;size=%{size_download}B" \ 189 | -s -o /dev/null $test_url 190 | local -i retval=$? 191 | 192 | # remove routing 193 | source_based_routing $device down 194 | 195 | return $retval 196 | } 197 | 198 | # prints usage and exits 199 | usage() { 200 | echo "Usage: $0 -t VPN_TYPE -H HOSTNAME -u USERNAME -p PASSWORD [OPTIONS]... -- extra_arguments" 201 | echo "Tests a VPN connection." 202 | echo "Extra arguments can be specified after --, please refer to the plugin" 203 | echo "you're using to understand what options can be passed" 204 | echo 205 | echo " 206 | Options: 207 | -t, --type VPN type, one of: l2tp, openvpn, pptp, ssh. 208 | -h, --hostname Hostname to connect to. 209 | -u, --username Username to use with VPN. 210 | -p, --password Password to use with VPN. 211 | -l, --lock Use global lock to avoid running check_vpn more 212 | then once at the same time. 213 | -d, --device Device to use, can be a specific device (tunX, 214 | tapX, pppX) or just a prefix (tun, tap, ppp). 215 | -U, --url URL to test connectivity with, the default is 216 | http://www.google.com" 217 | exit 2 218 | } 219 | 220 | # main 221 | main() { 222 | # lets get into business with getopt 223 | local tmp_getops=`getopt -o hlt:H:u:p:d:U: --long help,lock,type:,host:,username:,password:,device:,url: -- "$@"` 224 | [ $? != 0 ] && usage 225 | eval set -- "$tmp_getops" 226 | 227 | # business time!! 228 | local lock type lns username password device test_url 229 | while true ; do 230 | case "$1" in 231 | -h|--help) usage;; 232 | -l|--lock) lock=yes; shift 1;; 233 | -t|--type) type=$2; shift 2;; 234 | -H|--host) lns="$2"; shift 2;; 235 | -u|--username) username="$2"; shift 2;; 236 | -p|--password) password="$2"; shift 2;; 237 | -d|--device) device="$2"; shift 2;; 238 | -U|--url) test_url="$2"; shift 2;; 239 | --) shift; break;; 240 | *) usage;; 241 | esac 242 | done 243 | [ x"$type" = x ] && usage 244 | [ x"$username" = x ] && usage 245 | [ x"$password" = x ] && usage 246 | [ x"$test_url" = x ] && test_url=$DEFAULT_TEST_URL 247 | 248 | # must run as root 249 | check_root 250 | 251 | # source plugin 252 | source `dirname $0`/check_vpn_plugins/$type.sh || usage 253 | 254 | # locks and prevents multiple access 255 | [ x"$lock" = x"yes" ] && lock_check_vpn 256 | 257 | # allocate device if user did not supply a specific one 258 | if ! is_specific_device $device; then 259 | device=`_${type}_allocate_vpn_device "$device"` 260 | fi 261 | 262 | local -i retval=0 263 | 264 | # destroy any running VPN connections to this lns 265 | _${type}_stop_vpn $lns $device 266 | 267 | # start vpn 268 | _${type}_start_vpn $lns $username $password $device "$@" 269 | if [ $? -eq 0 ] && wait_for_vpn_to_come_up $type $lns $device; then 270 | local tmp_perf_data=`mktemp` 271 | if vpn_connectivity_check $device $test_url > $tmp_perf_data; then 272 | echo "OK: VPN to '$lns' up and running on '$device', '$test_url' reachable|"`cat $tmp_perf_data` 273 | else 274 | echo "Warning: VPN ($type) up, connectivity check failed to '$test_url'|"`cat $tmp_perf_data` 275 | retval=1 276 | fi 277 | rm -f $tmp_perf_data 278 | else 279 | echo "Critical: VPN ($type) connection failed to '$lns': '$ERROR_STRING'" 280 | retval=2 281 | fi 282 | _${type}_stop_vpn $lns $device 283 | wait_for_vpn_to_come_down $type $lns $device 284 | # go back to previous directory 285 | rm -rf --preserve-root $tmp_vpn_dir 286 | [ x"$lock" = x"yes" ] && unlock_check_vpn 287 | return $retval 288 | } 289 | 290 | # don't run main if running shunit 291 | if [[ `basename $0` =~ ^shunit2_.* ]]; then 292 | true 293 | else 294 | main "$@" 295 | fi 296 | -------------------------------------------------------------------------------- /check_vpn/check_vpn_plugins/iodine.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # 4 | # iodine - iodine plugin for check_vpn 5 | # Copyright (C) 2013 Dan Fruehauf 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | 18 | ############## 19 | ### IODINE ### 20 | ############## 21 | declare -r IODINE_DEVICE_PREFIX=dns 22 | 23 | # returns a free vpn device 24 | # $1 - device prefix 25 | _iodine_allocate_vpn_device() { 26 | local device_prefix=$1; shift 27 | allocate_vpn_device $device_prefix 28 | } 29 | 30 | # returns the vpn devices for the given lns 31 | # $1 - lns 32 | _iodine_vpn_device() { 33 | local lns=$1; shift 34 | local pids=`_iodine_get_pids $lns` 35 | local pid 36 | for pid in $pids; do 37 | if ps -p $pid --no-header -o cmd | grep -q "\b-r $lns\b"; then 38 | local iodine_command_line=`ps -p $pid --no-header -o cmd` 39 | local device=`echo $iodine_command_line | grep -o "\b-d $IODINE_DEVICE_PREFIX[[:digit:]]\+:" | cut -d' ' -f2 | cut -d: -f1` 40 | devices="$devices $device" 41 | fi 42 | done 43 | echo "$devices" 44 | } 45 | 46 | # initiate a iodine connection 47 | # $1 - lns - where to connect to 48 | # $2 - username 49 | # $3 - password 50 | # $4 - device 51 | # "$@" - extra options 52 | _iodine_start_vpn() { 53 | local lns=$1; shift 54 | local username=$1; shift 55 | local password=$1; shift 56 | local device=$1; shift 57 | 58 | local -i retval=0 59 | local tmp_output=`mktemp` 60 | 61 | if ! which iodine >& /dev/null; then 62 | ERROR_STRING="Error: iodine not installed" 63 | return 1 64 | fi 65 | 66 | echo "$password" | iodine -r $lns $username -d $device "$@" >& $tmp_output 67 | retval=$? 68 | 69 | if [ $retval -ne 0 ]; then 70 | ERROR_STRING=`tail -1 $tmp_output` 71 | rm -f $tmp_output 72 | return 1 73 | fi 74 | 75 | rm -f $tmp_output 76 | return 0 77 | } 78 | 79 | # stops the vpn 80 | # $1 - lns 81 | # $2 - vpn device (optional) 82 | _iodine_stop_vpn() { 83 | local lns=$1; shift 84 | local device=$1; shift 85 | if [ x"$lns" = x ]; then 86 | echo "lns unspecified, can't kill iodine" 1>&2 87 | return 1 88 | fi 89 | local pids=`_iodine_get_pids $lns $device` 90 | if [ x"$pids" != x ]; then 91 | kill $pids 92 | fi 93 | } 94 | 95 | # returns a list of iodine pids 96 | # $1 - lns 97 | # $2 - vpn device (optional) 98 | _iodine_get_pids() { 99 | local lns=$1; shift 100 | local device=$1; shift 101 | local iodine_pids=`pgrep iodine | xargs` 102 | local iodine_relevant_pids 103 | for pid in $iodine_pids; do 104 | if ps -p $pid --no-header -o cmd | grep -q " -r $lns\b"; then 105 | if [ x"$device" != x ]; then 106 | if ps -p $pid --no-header -o cmd | grep -q " -d $device\b"; then 107 | iodine_relevant_pids="$iodine_relevant_pids $pid" 108 | fi 109 | else 110 | iodine_relevant_pids="$iodine_relevant_pids $pid" 111 | fi 112 | fi 113 | done 114 | echo $iodine_relevant_pids 115 | } 116 | 117 | # return true if VPN is up, false otherwise... 118 | # $1 - lns 119 | # $2 - vpn device (optional) 120 | _iodine_is_vpn_up() { 121 | local lns=$1; shift 122 | local device=$1; shift 123 | ifconfig $device >& /dev/null && \ 124 | ip addr show dev $device | grep -q "\binet\b" 125 | } 126 | 127 | -------------------------------------------------------------------------------- /check_vpn/check_vpn_plugins/l2tp.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # 4 | # l2tp.sh - L2TP plugin for check_vpn 5 | # Copyright (C) 2013 Dan Fruehauf 6 | # Copyright (C) 2012 Lacoon Security 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | 19 | ############ 20 | ### L2TP ### 21 | ############ 22 | declare -r L2TP_DEVICE_PREFIX=ppp 23 | declare -i -r L2TP_PORT=1701 24 | 25 | # returns a free vpn device 26 | # $1 - device prefix 27 | _l2tp_allocate_vpn_device() { 28 | local device_prefix=$1; shift 29 | allocate_vpn_device $L2TP_DEVICE_PREFIX 30 | } 31 | 32 | # returns the vpn devices for the given lns 33 | # $1 - lns 34 | _l2tp_vpn_device() { 35 | local lns=$1; shift 36 | local pids=`_l2tp_get_pids $lns` 37 | local pid 38 | for pid in $pids; do 39 | if ps -p $pid --no-header -o cmd | grep -q "\.$lns-"; then 40 | local l2tp_pid_file=`ps -p $pid --no-header -o cmd | grep -o "\-p .*\b" | cut -d' ' -f2` 41 | local device=`basename $l2tp_pid_file | cut -d. -f3- | cut -d- -f2` 42 | devices="$devices $device" 43 | fi 44 | done 45 | echo "$devices" 46 | } 47 | 48 | # initiate a l2tp connection 49 | # $1 - lns - where to connect to 50 | # $2 - username 51 | # $3 - password 52 | # $4 - device 53 | # "$@" - extra options 54 | _l2tp_start_vpn() { 55 | local lns=$1; shift 56 | local username=$1; shift 57 | local password=$1; shift 58 | local device=$1; shift 59 | 60 | if lsmod | grep -q pppol2tp; then 61 | ERROR_STRING="Error: pppol2tp.ko is loaded, please rmmod it!" 62 | return 1 63 | fi 64 | 65 | if ! which xl2tpd >& /dev/null; then 66 | ERROR_STRING="Error: xl2tpd not installed" 67 | return 1 68 | fi 69 | 70 | local ppp_options_file=`mktemp` 71 | local xl2tpd_secrect_file=`mktemp` 72 | local xl2tpd_config_file=`mktemp` 73 | local xl2tpd_control_file=`mktemp -u` 74 | local xl2tpd_pid_file=`mktemp -u --suffix _${lns}_${device}` 75 | _l2tp_generate_ppp_options $lns $username $password $device "$@" > $ppp_options_file 76 | _l2tp_generate_xl2tpd_options $lns $username $password $device $ppp_options_file > $xl2tpd_config_file 77 | 78 | # execute xl2tpd 79 | xl2tpd -D -c $xl2tpd_config_file -C $xl2tpd_control_file -p $xl2tpd_pid_file >& /dev/null & 80 | 81 | # wait for xl2tpd to come up 82 | local -i i=0 83 | while ! fuser $xl2tpd_control_file >& /dev/null; do 84 | sleep 1 85 | let i=$i+1 86 | if [ $i -ge 10 ]; then 87 | ERROR_STRING="Error: xl2tpd could not start" 88 | rm -f $xl2tpd_secrect_file $xl2tpd_config_file $xl2tpd_pid_file $ppp_options_file 89 | return 1 90 | fi 91 | done 92 | 93 | sleep 2 94 | echo "c $lns" > $xl2tpd_control_file 95 | # let xl2tpd have a chance to get to the ppp options file 96 | sleep 5 97 | 98 | # cleanup everything 99 | rm -f $xl2tpd_secrect_file $xl2tpd_config_file $xl2tpd_pid_file $ppp_options_file 100 | } 101 | 102 | # stops the vpn 103 | # $1 - lns 104 | # $2 - vpn device (optional) 105 | _l2tp_stop_vpn() { 106 | local lns=$1; shift 107 | local device=$1; shift 108 | if [ x"$lns" = x ]; then 109 | echo "lns unspecified, can't kill l2tp" 1>&2 110 | return 1 111 | fi 112 | local pids=`_l2tp_get_pids $lns $device` 113 | if [ x"$pids" != x ]; then 114 | kill $pids 115 | fi 116 | } 117 | 118 | # returns a list of l2tp pids 119 | # $1 - lns 120 | # $2 - vpn device (optional) 121 | _l2tp_get_pids() { 122 | local lns=$1; shift 123 | local device=$1; shift 124 | 125 | local xl2tpd_pids=`pgrep xl2tpd | xargs` 126 | echo $xl2tpd_pids 127 | local xl2tpd_relevant_pids 128 | local pid 129 | for pid in $xl2tpd_pids; do 130 | # the pid file will contain the proper format of stuff 131 | local xl2tpd_pid_file=`ps -p $pid --no-header -o cmd | grep -o "\-p .*\b" | cut -d' ' -f2` 132 | local lns_for_pid=`basename $xl2tpd_pid_file | cut -d_ -f2` 133 | local device_for_pid=`basename $xl2tpd_pid_file | cut -d_ -f3` 134 | if [ "$lns_for_pid" == "$lns" ]; then 135 | if [ x"$device" != x ]; then 136 | if [ "$device_for_pid" == "$device" ]; then 137 | xl2tpd_relevant_pids="$xl2tpd_relevant_pids $pid" 138 | fi 139 | else 140 | xl2tpd_relevant_pids="$xl2tpd_relevant_pids $pid" 141 | fi 142 | 143 | fi 144 | done 145 | echo $xl2tpd_relevant_pids 146 | } 147 | 148 | # return true if VPN is up, false otherwise... 149 | # $1 - lns 150 | # $2 - vpn device (optional) 151 | _l2tp_is_vpn_up() { 152 | local lns=$1; shift 153 | local device=$1; shift 154 | ifconfig $device >& /dev/null && \ 155 | ip addr show dev $device | grep -q "\binet\b" 156 | } 157 | 158 | # generate ppp options file, generically 159 | # $1 - lns - where to connect to 160 | # $2 - username 161 | # $3 - password 162 | # $4 - device 163 | # $@ - extra parameters 164 | _l2tp_generate_ppp_options() { 165 | local lns=$1; shift 166 | local username=$1; shift 167 | local password=$1; shift 168 | local device=$1; shift 169 | local -i device_nr=`echo $device | sed -e "s/^$L2TP_DEVICE_PREFIX//"` 170 | local extra_ppp_opts=`echo "$@" | tr -s "," "\n"` 171 | 172 | echo "user $username 173 | password $password 174 | unit $device_nr 175 | lock 176 | noauth 177 | nodefaultroute 178 | noipdefault 179 | debug 180 | $extra_ppp_opts" 181 | } 182 | 183 | # generate xl2tpd options 184 | # $1 - ppp options file 185 | # $2 - lns - where to connect to 186 | # $3 - username 187 | # $4 - password 188 | # $5 - device 189 | _l2tp_generate_xl2tpd_options() { 190 | local lns=$1; shift 191 | local username=$1; shift 192 | local password=$1; shift 193 | local device=$1; shift 194 | local ppp_options_file=$1; shift 195 | 196 | echo "[global] 197 | port = 0 198 | access control = no 199 | [lac $lns] 200 | name = $lns 201 | lns = $lns 202 | pppoptfile = $ppp_options_file 203 | ppp debug = yes 204 | require authentication = yes 205 | require chap = yes 206 | length bit = yes" 207 | } 208 | -------------------------------------------------------------------------------- /check_vpn/check_vpn_plugins/openvpn.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # 4 | # openvpn.sh - OpenVPN plugin for check_vpn 5 | # Copyright (C) 2013 Dan Fruehauf 6 | # Copyright (C) 2012 Lacoon Security 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | 19 | ########### 20 | # OPENVPN # 21 | ########### 22 | declare -r OPENVPN_DEVICE_PREFIX=tun 23 | declare -i -r OPENVPN_PORT=1194 24 | 25 | # returns a free vpn device 26 | # $1 - device prefix 27 | _openvpn_allocate_vpn_device() { 28 | local device_prefix=$1; shift 29 | if [ x"$device_prefix" = x ]; then 30 | device_prefix=$OPENVPN_DEVICE_PREFIX 31 | fi 32 | allocate_vpn_device $device_prefix 33 | } 34 | 35 | # returns the vpn devices for the given lns 36 | # $1 - lns 37 | _openvpn_vpn_device() { 38 | local lns=$1; shift 39 | local pids=`_openvpn_get_pids $lns` 40 | local pid 41 | for pid in $pids; do 42 | if ps -p $pid --no-header -o cmd | grep -q "remote $lns"; then 43 | local openvpn_command_line=`ps -p $pid --no-header -o cmd` 44 | local device=`_openvpn_parse_arg_from_extra_options dev $openvpn_command_line` 45 | devices="$devices $device" 46 | fi 47 | done 48 | echo "$devices" 49 | } 50 | 51 | # initiate an openvpn connection 52 | # $1 - lns - where to connect to 53 | # $2 - username 54 | # $3 - password 55 | # $4 - device 56 | # "$@" - extra options 57 | _openvpn_start_vpn() { 58 | local lns=$1; shift 59 | local username=$1; shift 60 | local password=$1; shift 61 | local device=$1; shift 62 | local -i retval=0 63 | 64 | if ! which openvpn >& /dev/null; then 65 | ERROR_STRING="Error: openvpn not installed" 66 | return 1 67 | fi 68 | 69 | # specific parsing of options such as port and protocol 70 | local protocol=`_openvpn_parse_arg_from_extra_options proto "$@"` 71 | local -i port=`_openvpn_parse_arg_from_extra_options port "$@"` 72 | [ $port -eq 0 ] && port=$OPENVPN_PORT 73 | 74 | # extra logic we're going to add to the openvpn command 75 | local extra_args 76 | 77 | # skip port testing if on udp 78 | if [ x"$protocol" = x"tcp" ] || [ x"$protocol" = x"tcp-client" ]; then 79 | check_open_port $lns $port 80 | if [ $? -ne 0 ]; then 81 | ERROR_STRING="Port '$port' closed on '$lns'" 82 | return 1 83 | fi 84 | 85 | extra_args='--connect-retry 1' 86 | fi 87 | 88 | # you might want to add --nobind if the port number is taken, ti basically 89 | # allocates a random port on the client side 90 | #extra_args="$extra_args --nobind" 91 | 92 | local tmp_username_password=`mktemp` 93 | echo -e "$username\n$password" > $tmp_username_password 94 | openvpn --daemon "OpenVPN-$lns" --client \ 95 | --remote $lns --tls-exit --tls-client --route-nopull --persist-key \ 96 | --persist-tun --persist-remote-ip --persist-local-ip \ 97 | $extra_args \ 98 | "$@" \ 99 | --script-security 2 --auth-user-pass $tmp_username_password --dev $device 100 | 101 | local -i retval=$? 102 | rm -f $tmp_username_password 103 | if [ $retval -ne 0 ]; then 104 | ERROR_STRING="Error: OpenVPN connection failed to '$lns'" 105 | fi 106 | return $retval 107 | } 108 | 109 | # stops the vpn 110 | # $1 - lns 111 | # $2 - vpn device (optional) 112 | _openvpn_stop_vpn() { 113 | local lns=$1; shift 114 | local device=$1; shift 115 | if [ x"$lns" = x ]; then 116 | echo "lns unspecified, can't kill openvpn" 1>&2 117 | return 1 118 | fi 119 | local pids=`_openvpn_get_pids $lns $device` 120 | if [ x"$pids" != x ]; then 121 | kill $pids 122 | fi 123 | } 124 | 125 | # returns a list of openvpn pids 126 | # $1 - lns 127 | # $2 - vpn device (optional) 128 | _openvpn_get_pids() { 129 | local lns=$1; shift 130 | local device=$1; shift 131 | 132 | local openvpn_pids=`pgrep openvpn | xargs` 133 | local openvpn_relevant_pids 134 | local pid 135 | for pid in $openvpn_pids; do 136 | if ps -p $pid --no-header -o cmd | grep -q "\-\-remote $lns\b"; then 137 | if [ x"$device" != x ]; then 138 | if ps -p $pid --no-header -o cmd | grep -q "\-\-dev $device\b"; then 139 | openvpn_relevant_pids="$openvpn_relevant_pids $pid" 140 | fi 141 | else 142 | openvpn_relevant_pids="$openvpn_relevant_pids $pid" 143 | fi 144 | 145 | fi 146 | done 147 | echo $openvpn_relevant_pids 148 | } 149 | 150 | # return true if VPN is up, false otherwise... 151 | # $1 - lns 152 | # $2 - vpn device (optional) 153 | _openvpn_is_vpn_up() { 154 | local lns=$1; shift 155 | local device=$1; shift 156 | ifconfig $device >& /dev/null && \ 157 | ip addr show dev $device | grep -q "\binet\b" 158 | } 159 | 160 | # returns a parsed argument from extra options passed to openvpn 161 | # $1 - argument name (such as proto, port, etc) 162 | # "$@" - argument list 163 | _openvpn_parse_arg_from_extra_options() { 164 | local arg=$1; shift 165 | # if arg=proto and $@ is '--proto tcp --port 1194 --arg something' we 166 | # should return 'tcp' 167 | echo "$@" | sed -e 's#[[:space:]]\+# #g' -e 's#--#\n#g' | grep "^$arg\b" | tail -1 | cut -d' ' -f2 168 | } 169 | 170 | -------------------------------------------------------------------------------- /check_vpn/check_vpn_plugins/pptp.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # 4 | # pptp.sh - PPTP plugin for check_vpn 5 | # Copyright (C) 2013 Dan Fruehauf 6 | # Copyright (C) 2012 Lacoon Security 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | 19 | ############ 20 | ### PPTP ### 21 | ############ 22 | declare -r PPTP_DEVICE_PREFIX=ppp 23 | declare -i -r PPTP_PORT=1723 24 | 25 | # returns a free vpn device 26 | # $1 - device prefix 27 | _pptp_allocate_vpn_device() { 28 | local device_prefix=$1; shift 29 | allocate_vpn_device $PPTP_DEVICE_PREFIX 30 | } 31 | 32 | # returns the vpn devices for the given lns 33 | # $1 - lns 34 | _pptp_vpn_device() { 35 | local lns=$1; shift 36 | local pids=`_pptp_get_pids $lns` 37 | local pid 38 | for pid in $pids; do 39 | if ps -p $pid --no-header -o cmd | grep -q "\b$lns\b"; then 40 | local device_nr=`ps -p $pid --no-header -o cmd | grep -o "unit [[:digit:]]\+" | cut -d' ' -f2` 41 | devices="$devices ${DEVICE_PREFIX}$device_nr" 42 | fi 43 | done 44 | # devices will be displayed twice, sort it out 45 | device=`echo $devices | tr -s " " "\n" | sort | uniq | xargs` 46 | echo "$devices" 47 | } 48 | 49 | # initiate a pptp connection 50 | # $1 - lns - where to connect to 51 | # $2 - username 52 | # $3 - password 53 | # $4 - device 54 | # "$@" - extra options 55 | _pptp_start_vpn() { 56 | local lns=$1; shift 57 | local username=$1; shift 58 | local password=$1; shift 59 | local device=$1; shift 60 | local -i device_nr=`echo $device | sed -e "s/^$PPTP_DEVICE_PREFIX//"` 61 | 62 | if ! which pptp >& /dev/null; then 63 | ERROR_STRING="Error: pptp not installed" 64 | return 1 65 | fi 66 | 67 | check_open_port $lns $PPTP_PORT 68 | if [ $? -ne 0 ]; then 69 | ERROR_STRING="Port '$PPTP_PORT' closed on '$lns'" 70 | return 1 71 | fi 72 | 73 | pptp --debug --timeout 10 $lns -- lock debug unit $device_nr nodefaultroute noauth user $username password $password "$@" 74 | if [ $? -ne 0 ]; then 75 | ERROR_STRING="Error: PPTP connection failed to '$lns'" 76 | return 1 77 | fi 78 | } 79 | 80 | # stops the vpn 81 | # $1 - lns 82 | # $2 - vpn device (optional) 83 | _pptp_stop_vpn() { 84 | local lns=$1; shift 85 | local device=$1; shift 86 | if [ x"$lns" = x ]; then 87 | echo "lns unspecified, can't kill pptp" 1>&2 88 | return 1 89 | fi 90 | local pids=`_pptp_get_pids $lns $device` 91 | if [ x"$pids" != x ]; then 92 | kill $pids 93 | fi 94 | } 95 | 96 | # returns a list of pptp pids 97 | # $1 - lns 98 | # $2 - vpn device (optional) 99 | _pptp_get_pids() { 100 | local lns=$1; shift 101 | local device=$1; shift 102 | local -i device_nr=`echo $device | sed -e "s/^$PPTP_DEVICE_PREFIX//"` 103 | 104 | local pptp_pids=`pgrep pptp | xargs` 105 | local pptp_relevant_pids 106 | local pid 107 | for pid in $pptp_pids; do 108 | if ps -p $pid --no-header -o cmd | grep -q "\b$lns\b"; then 109 | if [ x"$device" != x ]; then 110 | if ps -p $pid --no-header -o cmd | grep -q "\bunit $device_nr\b"; then 111 | pptp_relevant_pids="$pptp_relevant_pids $pid" 112 | fi 113 | else 114 | pptp_relevant_pids="$pptp_relevant_pids $pid" 115 | fi 116 | 117 | fi 118 | done 119 | echo $pptp_relevant_pids 120 | } 121 | 122 | # return true if VPN is up, false otherwise... 123 | # $1 - lns 124 | # $2 - vpn device (optional) 125 | _pptp_is_vpn_up() { 126 | local lns=$1; shift 127 | local device=$1; shift 128 | ifconfig $device >& /dev/null && \ 129 | ip addr show dev $device | grep -q "\binet\b" 130 | #local local_peer_addr=`ip -f inet addr show dev $device | grep inet | tr -s " " | cut -d' ' -f3` && \ 131 | #local remote_peer_addr=`ip -f inet addr show dev $device | grep inet | tr -s " " | cut -d' ' -f5 | cut -d'/' -f1` && \ 132 | #ping -W 3 -c 1 -I $local_peer_addr $remote_peer_addr >& /dev/null 133 | } 134 | 135 | -------------------------------------------------------------------------------- /check_vpn/check_vpn_plugins/ssh.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # 4 | # ssh.sh - SSH plugin for check_vpn 5 | # Copyright (C) 2013 Dan Fruehauf 6 | # Copyright (C) 2012 Lacoon Security 7 | # 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | 19 | ########### 20 | ### SSH ### 21 | ########### 22 | # You'll have to enable on the SSH server: 23 | #PermitTunnel=yes 24 | 25 | declare -r SSH_DEVICE_PREFIX=tun 26 | declare -r SSH_VPN_NET=192.168.8. 27 | declare -i -r SSH_PORT=22 28 | 29 | # returns a free vpn device 30 | # $1 - device prefix 31 | _ssh_allocate_vpn_device() { 32 | local device_prefix=$1; shift 33 | allocate_vpn_device $device_prefix 34 | } 35 | 36 | # returns the vpn devices for the given lns 37 | # $1 - lns 38 | _ssh_vpn_device() { 39 | local lns=$1; shift 40 | local pids=`_ssh_get_pids $lns` 41 | local pid 42 | for pid in $pids; do 43 | if ps -p $pid --no-header -o cmd | grep -q "\b$lns\b"; then 44 | local ssh_command_line=`ps -p $pid --no-header -o cmd` 45 | local -i device_nr=`echo $ssh_command_line | grep -o "\-w [[:digit:]]\+:" | cut -d' ' -f2 | cut -d: -f1` 46 | local device_prefix=`_ssh_parse_device_prefix $ssh_command_line` 47 | devices="$devices ${device_prefix}${device_nr}" 48 | fi 49 | done 50 | echo "$devices" 51 | } 52 | 53 | # initiate a ssh connection 54 | # $1 - lns - where to connect to 55 | # $2 - username 56 | # $3 - password 57 | # $4 - device 58 | # "$@" - extra options 59 | _ssh_start_vpn() { 60 | local lns=$1; shift 61 | local username=$1; shift 62 | local password=$1; shift 63 | local device=$1; shift 64 | 65 | # device prefix length is always 3 (either tun, or tap) 66 | local -i device_nr=${device:3} 67 | local device_prefix=${device:0:3} 68 | local -i retval=0 69 | 70 | if ! which ssh >& /dev/null; then 71 | ERROR_STRING="Error: ssh not installed" 72 | return 1 73 | fi 74 | 75 | local -i port=`_ssh_parse_port "$@"` 76 | check_open_port $lns $port 77 | if [ $? -ne 0 ]; then 78 | ERROR_STRING="Port '$port' closed on '$lns'" 79 | return 1 80 | fi 81 | 82 | # TODO HARDCODED!!! 83 | local remote_ip="$SSH_VPN_NET"1 84 | local local_ip="$SSH_VPN_NET"2 85 | 86 | if ! ssh -o ServerAliveInterval=10 -o TCPKeepAlive=yes "$@" $username@$lns "true"; then 87 | ERROR_STRING="Could not SSH to '$username@$lns'" 88 | return 1 89 | fi 90 | 91 | # TODO this is susecptible to race conditions if a few people try to 92 | # allocate a device at the same time 93 | local remote_device=$(ssh "$@" $username@$lns "for i in \`seq 0 255\`; do ! ip link show $device_prefix\$i >& /dev/null && echo $device_prefix\$i && break; done") 94 | if [ x"$remote_device" = x ]; then 95 | ERROR_STRING="Error: Could not allocate '$device_prefix' device on '$lns'" 96 | return 1 97 | fi 98 | local -i remote_device_nr=`echo $remote_device | sed -e "s/^$device_prefix//"` 99 | 100 | # pass correct tunnel parameters 101 | local tunnel_parameters="-o Tunnel=point-to-point" 102 | if [ "$device_prefix" = "tap" ]; then 103 | tunnel_parameters="-o Tunnel=ethernet" 104 | fi 105 | 106 | # activate tunnel 107 | ssh -o ServerAliveInterval=10 -o TCPKeepAlive=yes -f "$@" -w $device_nr:$remote_device_nr $tunnel_parameters $username@$lns "ip addr change $remote_ip/30 dev $remote_device && ip link set $remote_device up" && \ 108 | ip addr change $local_ip/30 dev $device && ip link set $device up && \ 109 | 110 | if [ $? -ne 0 ]; then 111 | ERROR_STRING="Error: SSH connection failed to '$lns'" 112 | return 1 113 | fi 114 | } 115 | 116 | # stops the vpn 117 | # $1 - lns 118 | # $2 - vpn device (optional) 119 | _ssh_stop_vpn() { 120 | local lns=$1; shift 121 | local device=$1; shift 122 | if [ x"$lns" = x ]; then 123 | echo "lns unspecified, can't kill ssh" 1>&2 124 | return 1 125 | fi 126 | local pids=`_ssh_get_pids $lns $device` 127 | if [ x"$pids" != x ]; then 128 | kill $pids 129 | fi 130 | } 131 | 132 | # returns a list of ssh pids 133 | # $1 - lns 134 | # $2 - vpn device (optional) 135 | _ssh_get_pids() { 136 | local lns=$1; shift 137 | local device=$1; shift 138 | local ssh_pids=`pgrep ssh | xargs` 139 | local ssh_relevant_pids 140 | for pid in $ssh_pids; do 141 | if ps -p $pid --no-header -o cmd | grep -q "\b$lns\b"; then 142 | if [ x"$device" != x ]; then 143 | if ps -p $pid --no-header -o cmd | grep -q " -w $device_nr\b"; then 144 | ssh_relevant_pids="$ssh_relevant_pids $pid" 145 | fi 146 | else 147 | ssh_relevant_pids="$ssh_relevant_pids $pid" 148 | fi 149 | fi 150 | done 151 | echo $ssh_relevant_pids 152 | } 153 | 154 | # return true if VPN is up, false otherwise... 155 | # $1 - lns 156 | # $2 - vpn device (optional) 157 | _ssh_is_vpn_up() { 158 | local lns=$1; shift 159 | local device=$1; shift 160 | ifconfig $device >& /dev/null && \ 161 | ip addr show dev $device | grep -q "\binet\b" 162 | } 163 | 164 | # a generic function to parse options 165 | # $1 - short parameter name (-p, for instance) 166 | # $2 - long parameter name (Port, for instance) 167 | # "$@" - extra parameters 168 | _ssh_parse_option() { 169 | local short_param_name=$1; shift 170 | local long_param_name=$1; shift 171 | local retval 172 | 173 | # TODO doesn't care about parameter order, short parameter always takes 174 | # precedence 175 | 176 | # probe for short parameter name 177 | retval=`echo "$@" | grep -o "[[:space:]]*${short_param_name} [[:print:]]\+[[:space:]]*" | cut -d' ' -f2` 178 | [ x"$retval" != x ] && echo $retval && return 179 | 180 | # probe for long parameter name 181 | retval=`echo "$@" | grep -o "[[:space:]]*\-o ${long_param_name}=[[:print:]]\+[[:space:]]*" | cut -d'=' -f2` 182 | [ x"$retval" != x ] && echo $retval && return 183 | 184 | return 1 185 | } 186 | 187 | # parse port from extra parameters 188 | # "$@" - extra parameters 189 | _ssh_parse_port() { 190 | local -i port=0 191 | port=`_ssh_parse_option -p Port "$@"` 192 | 193 | if [ $port -eq 0 ]; then 194 | port=$SSH_PORT 195 | fi 196 | 197 | echo $port 198 | } 199 | 200 | # parse device prefix from extra parameters 201 | # "$@" - extra parameters 202 | _ssh_parse_device_prefix() { 203 | local device_prefix 204 | 205 | local device=`_ssh_parse_option UNUSED Tunnel "$@"` 206 | 207 | if [ x"$device" != x ] && [ "$device" = "ethernet" ]; then 208 | device_prefix=tap 209 | else 210 | device_prefix=$SSH_DEVICE_PREFIX 211 | fi 212 | 213 | echo $device_prefix 214 | } 215 | 216 | -------------------------------------------------------------------------------- /check_vpn/examples/l2tp_default_install.md: -------------------------------------------------------------------------------- 1 | # L2TP 2 | 3 | This is an example for running the default installation of xl2tpd (on Fedora 19). 4 | 5 | ## Configuration 6 | 7 | Your `/etc/xl2tpd/xl2tpd.conf` would look like: 8 | ``` 9 | [global] 10 | [lns default] 11 | ip range = 192.168.1.128-192.168.1.254 12 | local ip = 192.168.1.99 13 | refuse pap = yes 14 | require authentication = yes 15 | name = LinuxVPNserver 16 | ppp debug = yes 17 | pppoptfile = /etc/ppp/options.xl2tpd 18 | length bit = yes 19 | ``` 20 | 21 | And `/etc/ppp/options.xl2tpd`: 22 | ``` 23 | ipcp-accept-local 24 | ipcp-accept-remote 25 | ms-dns 8.8.8.8 26 | noccp 27 | auth 28 | crtscts 29 | idle 1800 30 | mtu 1410 31 | mru 1410 32 | nodefaultroute 33 | debug 34 | lock 35 | proxyarp 36 | connect-delay 5000 37 | ``` 38 | 39 | Finally, your passwords should be stored in `/etc/ppp/chap-secrets`: 40 | ``` 41 | username * some_password * 42 | ``` 43 | 44 | ## check_vpn command 45 | 46 | The command that should work with the above configuration is: 47 | ``` 48 | # check_vpn -t l2tp -H $VPN_SERVER_L2TP -u username -p some_password -- noccp 49 | ``` 50 | -------------------------------------------------------------------------------- /check_vpn/examples/openvpn_default_install.md: -------------------------------------------------------------------------------- 1 | # OpenVPN 2 | 3 | This is an example for running the default installation of openvpn (on Fedora 24). 4 | 5 | ## Configuration 6 | 7 | Your `/etc/openvpn/server.conf`: 8 | ``` 9 | port 1194 10 | proto tcp 11 | dev tun 12 | comp-lzo 13 | cipher AES-256-CBC 14 | dh dh2048.pem 15 | server 10.1.0.0 255.255.255.0 16 | persist-key 17 | persist-tun 18 | status /etc/openvpn/openvpn-status.log 1 19 | status-version 1 20 | verb 1 21 | client-cert-not-required 22 | username-as-common-name 23 | duplicate-cn 24 | cert server.crt 25 | ca ca.crt 26 | key server.key 27 | push "redirect-gateway def1 bypass-dhcp" 28 | push "dhcp-option DNS 8.8.8.8" 29 | ``` 30 | 31 | Copy default keys from the openvpn installation: 32 | ``` 33 | # cp -a /usr/share/doc/openvpn/sample/sample-keys/{ca.crt,dh2048.pem,server.crt,server.key} /etc/openvpn/ 34 | ``` 35 | 36 | **Finally**, make sure you choose some sort of authentication mechanism. Sorry, but 37 | I can't help you with that :) 38 | 39 | For the sake of this example we'll assume that `username/some_password` is a 40 | valid combination to login to this OpenVPN configuration. 41 | 42 | ## check_vpn command 43 | 44 | The command that should work with the above configuration is: 45 | ``` 46 | # check_vpn -t openvpn -H $VPN_SERVER_OPENVPN -u username -p some_password -d tun -- --ca /usr/share/doc/openvpn/sample/sample-keys/ca.crt --proto tcp --cipher AES-256-CBC --comp-lzo 47 | ``` 48 | -------------------------------------------------------------------------------- /check_vpn/examples/pptp_default_install.md: -------------------------------------------------------------------------------- 1 | # PPTP 2 | 3 | This is an example for running the default installation of poptop pptpd (on Fedora 19). 4 | 5 | ## Configuration 6 | 7 | Your `/etc/pptpd.conf` would look like: 8 | ``` 9 | option /etc/ppp/options.pptpd 10 | logwtmp 11 | ``` 12 | 13 | And `/etc/ppp/options.pptpd`: 14 | ``` 15 | name pptpd 16 | refuse-pap 17 | refuse-chap 18 | refuse-mschap 19 | require-mschap-v2 20 | require-mppe-128 21 | proxyarp 22 | lock 23 | nobsdcomp 24 | novj 25 | novjccomp 26 | nologfd 27 | ``` 28 | 29 | Finally, your passwords should be stored in `/etc/ppp/chap-secrets`: 30 | ``` 31 | username * some_password * 32 | ``` 33 | 34 | ## check_vpn command 35 | 36 | The command that should work with the above configuration is: 37 | ``` 38 | # check_vpn -t pptp -H $VPN_SERVER_PPTP -u username -p some_password -- require-mppe-128 refuse-pap refuse-eap refuse-chap refuse-mschap novj novjccomp nobsdcomp 39 | ``` 40 | -------------------------------------------------------------------------------- /check_vpn/examples/ssh_default_install.md: -------------------------------------------------------------------------------- 1 | # SSH 2 | 3 | This is an example for running a simple openssh VPN installation (on Fedora 19). 4 | 5 | ## Configuration 6 | 7 | Your `/etc/ssh/sshd_config` should include at least those lines: 8 | ``` 9 | PermitRootLogin yes 10 | PermitTunnel yes 11 | UsePAM yes 12 | ``` 13 | 14 | Make sure you can login to your machine using your root account, after 15 | exchanging your key by placing it at `/root/.ssh/authorized_keys`. 16 | 17 | ## check_vpn command 18 | 19 | The command that should work with the above configuration is: 20 | ``` 21 | # check_vpn -t ssh -H $VPN_SERVER_SSH -u root -p unused_anyway 22 | ``` 23 | -------------------------------------------------------------------------------- /check_vpn/shunit2_test_integ.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # 4 | # Copyright (C) 2013 Dan Fruehauf 5 | # 6 | # This program is free software; you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation; either version 2 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License along 17 | # with this program; if not, write to the Free Software Foundation, Inc., 18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 19 | # 20 | 21 | # integration tests for check_vpn 22 | 23 | ########## 24 | # IODINE # 25 | ########## 26 | # test l2tp integration 27 | test_iodine_vpn_integration() { 28 | _test_root || return 29 | 30 | local -i retval=0 31 | local domain=www.something.com 32 | local password=`pwmake $RANDOM` 33 | local tmp_output=`mktemp` 34 | 35 | # setup iodine on the other end 36 | ssh root@$VPN_SERVER_IODINE "pkill iodined; iodined -P '$password' 10.1.1.2/24 $domain >& /dev/null" 37 | 38 | $CHECK_VPN -l -t iodine -H $VPN_SERVER_IODINE -u $domain -p $password -d dns50 -- -m 500 > $tmp_output 39 | retval=$? 40 | 41 | assertTrue "iodine vpn connection" \ 42 | "[ $retval -eq 0 ]" 43 | 44 | local expected_string="OK: VPN to '$VPN_SERVER_IODINE' up and running on 'dns50', 'http://www.google.com' reachable" 45 | local output=`cut -d\| -f1 $tmp_output` 46 | assertTrue "iodine vpn connection output" \ 47 | "[ x'$output' = x'$expected_string' ]" 48 | 49 | rm -f $tmp_output 50 | } 51 | 52 | ######## 53 | # L2TP # 54 | ######## 55 | # test l2tp integration 56 | test_l2tp_vpn_integration() { 57 | _test_root || return 58 | 59 | local -i retval=0 60 | local username=root 61 | local password=`pwmake $RANDOM` 62 | local tmp_output=`mktemp` 63 | 64 | # setup the vpn server, using ssh :) 65 | ssh root@$VPN_SERVER_L2TP "echo '$username * $password *' > /etc/ppp/chap-secrets" 66 | 67 | $CHECK_VPN -l -t l2tp -H $VPN_SERVER_L2TP -u $username -p $password -d ppp6 -- noccp > $tmp_output 68 | retval=$? 69 | 70 | assertTrue "l2tp vpn connection" \ 71 | "[ $retval -eq 0 ]" 72 | 73 | local expected_string="OK: VPN to '$VPN_SERVER_L2TP' up and running on 'ppp6', 'http://www.google.com' reachable" 74 | local output=`cut -d\| -f1 $tmp_output` 75 | assertTrue "l2tp vpn connection output" \ 76 | "[ x'$output' = x'$expected_string' ]" 77 | 78 | rm -f $tmp_output 79 | } 80 | 81 | ########### 82 | # OPENVPN # 83 | ########### 84 | # test l2tp integration 85 | test_openvpn_vpn_integration() { 86 | _test_root || return 87 | 88 | local -i retval=0 89 | local username=root 90 | local password=`pwmake $RANDOM` 91 | local tmp_output=`mktemp` 92 | local tmp_server_cert=`mktemp` 93 | 94 | # setup the vpn server, using ssh :) 95 | ssh root@$VPN_SERVER_OPENVPN \ 96 | "echo '$username' > /etc/openvpn/passwd && echo '$password' >> /etc/openvpn/passwd" 97 | 98 | # get server certificate 99 | scp root@$VPN_SERVER_OPENVPN:/etc/openvpn/ca.crt $tmp_server_cert > /dev/null 100 | retval=$? 101 | assertTrue "openvpn vpn server certificate copy" \ 102 | "[ $retval -eq 0 ]" 103 | 104 | $CHECK_VPN -l -t openvpn -H $VPN_SERVER_OPENVPN -u $username -p $password -d tun91 -- --ca $tmp_server_cert --proto tcp --cipher AES-256-CBC --comp-lzo > $tmp_output 105 | retval=$? 106 | 107 | assertTrue "openvpn vpn connection" \ 108 | "[ $retval -eq 0 ]" 109 | 110 | local expected_string="OK: VPN to '$VPN_SERVER_OPENVPN' up and running on 'tun91', 'http://www.google.com' reachable" 111 | local output=`cut -d\| -f1 $tmp_output` 112 | assertTrue "openvpn vpn connection output" \ 113 | "[ x'$output' = x'$expected_string' ]" 114 | 115 | rm -f $tmp_output $tmp_server_cert 116 | } 117 | 118 | ######## 119 | # PPTP # 120 | ######## 121 | # test pptp integration 122 | test_pptp_vpn_integration() { 123 | _test_root || return 124 | 125 | local -i retval=0 126 | local username=root 127 | local password=`pwmake $RANDOM` 128 | local tmp_output=`mktemp` 129 | 130 | # setup the vpn server, using ssh :) 131 | ssh root@$VPN_SERVER_PPTP "echo '$username * $password *' > /etc/ppp/chap-secrets" 132 | 133 | $CHECK_VPN -l -t pptp -H $VPN_SERVER_PPTP -u $username -p $password -d ppp40 -- require-mppe-128 refuse-pap refuse-eap refuse-chap refuse-mschap novj novjccomp nobsdcomp > $tmp_output 134 | retval=$? 135 | 136 | assertTrue "pptp vpn connection" \ 137 | "[ $retval -eq 0 ]" 138 | 139 | local expected_string="OK: VPN to '$VPN_SERVER_PPTP' up and running on 'ppp40', 'http://www.google.com' reachable" 140 | local output=`cut -d\| -f1 $tmp_output` 141 | assertTrue "pptp vpn connection output" \ 142 | "[ x'$output' = x'$expected_string' ]" 143 | 144 | rm -f $tmp_output 145 | } 146 | 147 | ####### 148 | # SSH # 149 | ####### 150 | # test ssh integration 151 | test_ssh_vpn_integration() { 152 | _test_root || return 153 | 154 | local -i retval=0 155 | local tmp_output=`mktemp` 156 | 157 | ./check_vpn -l -t ssh -H $VPN_SERVER_SSH -u root -p uga -d tun1 > $tmp_output 158 | retval=$? 159 | 160 | assertTrue "ssh vpn connection" \ 161 | "[ $retval -eq 0 ]" 162 | 163 | local expected_string="OK: VPN to '$VPN_SERVER_PPTP' up and running on 'tun1', 'http://www.google.com' reachable" 164 | local output=`cut -d\| -f1 $tmp_output` 165 | assertTrue "ssh vpn connection output" \ 166 | "[ x'$output' = x'$expected_string' ]" 167 | 168 | rm -f $tmp_output 169 | } 170 | 171 | #################### 172 | # COMMON FUNCTIONS # 173 | #################### 174 | _test_root() { 175 | assertTrue "test running as root" "[ `id -u` -eq 0 ]" 176 | } 177 | 178 | ################## 179 | # SETUP/TEARDOWN # 180 | ################## 181 | 182 | oneTimeSetUp() { 183 | CHECK_VPN=`dirname $0`/check_vpn 184 | 185 | echo "Please set your VPN server in order to run these tests" && exit 2 186 | 187 | VPN_SERVER_IODINE=$VPN_SERVER 188 | VPN_SERVER_L2TP=$VPN_SERVER 189 | VPN_SERVER_OPENVPN=$VPN_SERVER 190 | VPN_SERVER_PPTP=$VPN_SERVER 191 | VPN_SERVER_SSH=$VPN_SERVER 192 | } 193 | 194 | oneTimeTearDown() { 195 | true 196 | } 197 | 198 | setUp() { 199 | true 200 | } 201 | 202 | tearDown() { 203 | true 204 | } 205 | 206 | # load and run shUnit2 207 | . /usr/share/shunit2/shunit2 208 | -------------------------------------------------------------------------------- /check_vpn/shunit2_test_unit.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # 4 | # Copyright (C) 2013 Dan Fruehauf 5 | # 6 | # This program is free software; you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation; either version 2 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License along 17 | # with this program; if not, write to the Free Software Foundation, Inc., 18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 19 | # 20 | 21 | ###################### 22 | # CORE FUNCTIONALITY # 23 | ###################### 24 | # test check_open_port, unreachable host 25 | test_check_open_port_unresolvable() { 26 | source $CHECK_VPN 27 | check_open_port some.domain.that.doesnt.exist.com 1111 >& /dev/null 28 | assertFalse "host unresolvable" \ 29 | "[ $? -eq 0 ]" 30 | } 31 | 32 | # test check_open_port 33 | test_check_open_port_filtered() { 34 | source $CHECK_VPN 35 | check_open_port www.google.com 1111 >& /dev/null 36 | assertFalse "port filtered" \ 37 | "[ $? -eq 0 ]" 38 | } 39 | 40 | # test check_open_port, filtered port 41 | test_check_open_port_closed() { 42 | source $CHECK_VPN 43 | check_open_port localhost 1111 >& /dev/null 44 | assertFalse "port closed" \ 45 | "[ $? -eq 0 ]" 46 | } 47 | 48 | # test check_open_port 49 | test_check_open_port_open() { 50 | source $CHECK_VPN 51 | check_open_port www.google.com 80 >& /dev/null 52 | assertTrue "port open" \ 53 | "[ $? -eq 0 ]" 54 | } 55 | 56 | # test the is_specific_device function 57 | test_is_specific_device() { 58 | source $CHECK_VPN 59 | 60 | assertTrue "tun1: specific" "is_specific_device tun1" 61 | assertTrue "tap10: specific" "is_specific_device tap10" 62 | assertTrue "ppp250: specific" "is_specific_device ppp250" 63 | 64 | assertFalse "tun: specific" "is_specific_device tun" 65 | assertFalse "tap: specific" "is_specific_device tap" 66 | assertFalse "ppp: specific" "is_specific_device ppp" 67 | assertFalse "ttt20: specific" "is_specific_device ttt20" 68 | assertFalse "ttt: specific" "is_specific_device ttt" 69 | } 70 | 71 | # test check_vpn locking 72 | test_lock_check_vpn() { 73 | source $CHECK_VPN 74 | 75 | # mock CHECK_VPN_LOCK 76 | export CHECK_VPN_LOCK=`mktemp -d -u` 77 | assertFalse "lock doesn't exists" "test -d $CHECK_VPN_LOCK" 78 | lock_check_vpn 79 | assertTrue "lock exists" "test -d $CHECK_VPN_LOCK" 80 | rmdir $CHECK_VPN_LOCK 81 | } 82 | 83 | # test check_vpn locking 84 | test_unlock_check_vpn() { 85 | source $CHECK_VPN 86 | 87 | # mock CHECK_VPN_LOCK 88 | export CHECK_VPN_LOCK=`mktemp -d` 89 | assertTrue "lock exists" "test -d $CHECK_VPN_LOCK" 90 | unlock_check_vpn 91 | assertFalse "lock doesn't exists" "test -d $CHECK_VPN_LOCK" 92 | } 93 | 94 | # test routing table used for device 95 | test_routing_table_for_device() { 96 | source $CHECK_VPN 97 | local -i routing_table 98 | 99 | routing_table=`get_routing_table_for_device tap101` 100 | assertTrue "routing table for tap101" "[ $routing_table -eq 2101 ]" 101 | 102 | routing_table=`get_routing_table_for_device tun32` 103 | assertTrue "routing table for tun32" "[ $routing_table -eq 3032 ]" 104 | 105 | routing_table=`get_routing_table_for_device ppp250` 106 | assertTrue "routing table for ppp250" "[ $routing_table -eq 4250 ]" 107 | 108 | routing_table=`get_routing_table_for_device crapper1020` 109 | assertTrue "routing table for crapper1020" "[ $routing_table -eq 7020 ]" 110 | } 111 | 112 | ########### 113 | # MODULES # 114 | ########### 115 | 116 | ######## 117 | # L2TP # 118 | ######## 119 | # allocate device for l2tp 120 | test_l2tp_allocate_vpn_device() { 121 | source check_vpn_plugins/l2tp.sh 122 | 123 | local device=`_l2tp_allocate_vpn_device` 124 | assertTrue "allocate l2tp device" "[ x$device = x'ppp0' ]" 125 | } 126 | 127 | # test _l2tp_generate_ppp_options 128 | test_l2tp_generate_ppp_options() { 129 | source check_vpn_plugins/l2tp.sh 130 | 131 | local tmp_ppp_options=`mktemp` 132 | local tmp_ppp_options_expected=`mktemp` 133 | 134 | _l2tp_generate_ppp_options \ 135 | l2tp.vpn.com my-username my-password ppp140 \ 136 | require-mppe-128,require-mschapv2 > $tmp_ppp_options 137 | 138 | cat > $tmp_ppp_options_expected < $tmp_l2tp_options 167 | 168 | cat > $tmp_l2tp_options_expected <