From 36c688390e5a9b841c7736c40513b89ef063b057 Mon Sep 17 00:00:00 2001 From: garnier-quentin Date: Wed, 30 Jul 2014 10:17:27 +0200 Subject: [PATCH] Fix #5388 --- apps/protocols/ftp/lib/ftp.pm | 104 ++++++++++++++++++++ apps/protocols/ftp/mode/login.pm | 158 +++++++++++++++++++++++++++++++ apps/protocols/ftp/plugin.pm | 63 ++++++++++++ 3 files changed, 325 insertions(+) create mode 100644 apps/protocols/ftp/lib/ftp.pm create mode 100644 apps/protocols/ftp/mode/login.pm create mode 100644 apps/protocols/ftp/plugin.pm diff --git a/apps/protocols/ftp/lib/ftp.pm b/apps/protocols/ftp/lib/ftp.pm new file mode 100644 index 000000000..67eb49fa6 --- /dev/null +++ b/apps/protocols/ftp/lib/ftp.pm @@ -0,0 +1,104 @@ +############################################################################### +# Copyright 2005-2014 MERETHIS +# Centreon is developped by : Julien Mathis and Romain Le Merlus under +# GPL Licence 2.0. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation ; either version 2 of the License. +# +# This program is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along with +# this program; if not, see . +# +# Linking this program statically or dynamically with other modules is making a +# combined work based on this program. Thus, the terms and conditions of the GNU +# General Public License cover the whole combination. +# +# As a special exception, the copyright holders of this program give MERETHIS +# permission to link this program with independent modules to produce an timeelapsedutable, +# regardless of the license terms of these independent modules, and to copy and +# distribute the resulting timeelapsedutable under terms of MERETHIS choice, provided that +# MERETHIS also meet, for each linked independent module, the terms and conditions +# of the license of that module. An independent module is a module which is not +# derived from this program. If you modify this program, you may extend this +# exception to your version of the program, but you are not obliged to do so. If you +# do not wish to do so, delete this exception statement from your version. +# +# For more information : contact@centreon.com +# Author : Simon BOMM +# +#################################################################################### + +package apps::protocols::ftp::lib::ftp; + +use strict; +use warnings; +use centreon::plugins::misc; +use Net::FTP; + +my $ftp_handle; + +sub quit { + $ftp_handle->quit; +} + +sub connect { + my ($self, %options) = @_; + my %ftp_options = (); + + my $ftp_class = 'Net::FTP'; + if (defined($self->{option_results}->{use_ssl})) { + centreon::plugins::misc::mymodule_load(output => $self->{output}, module => 'Net::FTPSSL', + error_msg => "Cannot load module 'Net::FTPSSL'."); + $ftp_class = 'Net::FTPSSL'; + } + + my $connection_exit = defined($options{connection_exit}) ? $options{connection_exit} : 'unknown'; + $ftp_options{Port} = $self->{option_results}->{port} if (defined($self->{option_results}->{port})); + $ftp_options{Timeout} = $self->{option_results}->{timeout} if (defined($self->{option_results}->{timeout})); + foreach my $option (@{$self->{option_results}->{ftp_options}}) { + my ($key, $value) = split /=/, $option; + if (defined($key) && defined($value)) { + $ftp_options{$key} = $value; + } + } + + if (defined($self->{option_results}->{username}) && $self->{option_results}->{username} ne '' && + !defined($self->{option_results}->{password})) { + $self->{output}->add_option_msg(short_msg => "Please set --password option."); + $self->{output}->option_exit(); + } + + $ftp_handle = $ftp_class->new($self->{option_results}->{hostname}, + %ftp_options + ); + + + if (!defined($ftp_handle)) { + if (defined($self->{option_results}->{use_ssl})) { + $self->{output}->output_add(severity => $connection_exit, + short_msg => 'Unable to connect to FTP: ' . $Net::FTPSSL::ERRSTR); + } else { + $self->{output}->output_add(severity => $connection_exit, + short_msg => 'Unable to connect to FTP: ' . $@); + } + $self->{output}->display(); + $self->{output}->exit(); + } + + if (defined($self->{option_results}->{username}) && $self->{option_results}->{username} ne '') { + if (!$ftp_handle->login($self->{option_results}->{username}, $self->{option_results}->{password})) { + $self->{output}->output_add(severity => $connection_exit, + short_msg => 'Login failed: ' . $ftp_handle->message); + quit(); + $self->{output}->display(); + $self->{output}->exit(); + } + } +} + +1; diff --git a/apps/protocols/ftp/mode/login.pm b/apps/protocols/ftp/mode/login.pm new file mode 100644 index 000000000..66bf4e242 --- /dev/null +++ b/apps/protocols/ftp/mode/login.pm @@ -0,0 +1,158 @@ +############################################################################### +# Copyright 2005-2014 MERETHIS +# Centreon is developped by : Julien Mathis and Romain Le Merlus under +# GPL Licence 2.0. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation ; either version 2 of the License. +# +# This program is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along with +# this program; if not, see . +# +# Linking this program statically or dynamically with other modules is making a +# combined work based on this program. Thus, the terms and conditions of the GNU +# General Public License cover the whole combination. +# +# As a special exception, the copyright holders of this program give MERETHIS +# permission to link this program with independent modules to produce an timeelapsedutable, +# regardless of the license terms of these independent modules, and to copy and +# distribute the resulting timeelapsedutable under terms of MERETHIS choice, provided that +# MERETHIS also meet, for each linked independent module, the terms and conditions +# of the license of that module. An independent module is a module which is not +# derived from this program. If you modify this program, you may extend this +# exception to your version of the program, but you are not obliged to do so. If you +# do not wish to do so, delete this exception statement from your version. +# +# For more information : contact@centreon.com +# Author : Quentin Garnier +# +#################################################################################### + +package apps::protocols::ftp::mode::login; + +use base qw(centreon::plugins::mode); + +use strict; +use warnings; +use Time::HiRes qw(gettimeofday tv_interval); +use apps::protocols::ftp::lib::ftp; + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options); + bless $self, $class; + + $self->{version} = '1.0'; + $options{options}->add_options(arguments => + { + "hostname:s" => { name => 'hostname' }, + "port:s" => { name => 'port', }, + "ssl" => { name => 'use_ssl' }, + "ftp-options:s@" => { name => 'ftp_options' }, + "username:s" => { name => 'username' }, + "password:s" => { name => 'password' }, + "warning:s" => { name => 'warning' }, + "critical:s" => { name => 'critical' }, + "timeout:s" => { name => 'timeout', default => '30' }, + }); + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::init(%options); + + if (($self->{perfdata}->threshold_validate(label => 'warning', value => $self->{option_results}->{warning})) == 0) { + $self->{output}->add_option_msg(short_msg => "Wrong warning threshold '" . $self->{option_results}->{warning} . "'."); + $self->{output}->option_exit(); + } + if (($self->{perfdata}->threshold_validate(label => 'critical', value => $self->{option_results}->{critical})) == 0) { + $self->{output}->add_option_msg(short_msg => "Wrong critical threshold '" . $self->{option_results}->{critical} . "'."); + $self->{output}->option_exit(); + } + + if (!defined($self->{option_results}->{hostname})) { + $self->{output}->add_option_msg(short_msg => "Please set the hostname option"); + $self->{output}->option_exit(); + } +} + +sub run { + my ($self, %options) = @_; + + my $timing0 = [gettimeofday]; + + apps::protocols::ftp::lib::ftp::connect($self, connection_exit => 'critical'); + apps::protocols::ftp::lib::ftp::quit(); + + my $timeelapsed = tv_interval ($timing0, [gettimeofday]); + + my $exit = $self->{perfdata}->threshold_check(value => $timeelapsed, + threshold => [ { label => 'critical', 'exit_litteral' => 'critical' }, { label => 'warning', exit_litteral => 'warning' } ]); + $self->{output}->output_add(severity => $exit, + short_msg => sprintf("Response time %.3f ", $timeelapsed)); + $self->{output}->perfdata_add(label => "time", + value => sprintf('%.3f', $timeelapsed), + warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning'), + critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical')); + + $self->{output}->display(); + $self->{output}->exit(); +} + +1; + +__END__ + +=head1 MODE + +Check Connection (also login) to an FTP Server. + +=over 8 + +=item B<--hostname> + +IP Addr/FQDN of the ftp host + +=item B<--port> + +Port used + +=item B<--ssl> + +Use SSL connection +Need Perl 'Net::FTPSSL' module + +=item B<--ftp-options> + +Add custom ftp options. +Example: --ftp-options='Debug=1" --ftp-options='useSSL=1" + +=item B<--username> + +Specify username for authentification + +=item B<--password> + +Specify password for authentification + +=item B<--timeout> + +Connection timeout in seconds (Default: 30) + +=item B<--warning> + +Threshold warning in seconds + +=item B<--critical> + +Threshold critical in seconds + +=back + +=cut diff --git a/apps/protocols/ftp/plugin.pm b/apps/protocols/ftp/plugin.pm new file mode 100644 index 000000000..5c91d9664 --- /dev/null +++ b/apps/protocols/ftp/plugin.pm @@ -0,0 +1,63 @@ +################################################################################ +# Copyright 2005-2014 MERETHIS +# Centreon is developped by : Julien Mathis and Romain Le Merlus under +# GPL Licence 2.0. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation ; either version 2 of the License. +# +# This program is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along with +# this program; if not, see . +# +# Linking this program statically or dynamically with other modules is making a +# combined work based on this program. Thus, the terms and conditions of the GNU +# General Public License cover the whole combination. +# +# As a special exception, the copyright holders of this program give MERETHIS +# permission to link this program with independent modules to produce an executable, +# regardless of the license terms of these independent modules, and to copy and +# distribute the resulting executable under terms of MERETHIS choice, provided that +# MERETHIS also meet, for each linked independent module, the terms and conditions +# of the license of that module. An independent module is a module which is not +# derived from this program. If you modify this program, you may extend this +# exception to your version of the program, but you are not obliged to do so. If you +# do not wish to do so, delete this exception statement from your version. +# +# For more information : contact@centreon.com +# Authors : Quentin Garnier +# +#################################################################################### + +package apps::protocols::ftp::plugin; + +use strict; +use warnings; +use base qw(centreon::plugins::script_simple); + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options); + bless $self, $class; + # $options->{options} = options object + + $self->{version} = '0.1'; + %{$self->{modes}} = ( + 'login' => 'apps::protocols::ftp::mode::login', + ); + return $self; +} + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Check an FTP server. + +=cut