plugins/netutils.c

   1 /*****************************************************************************
   2 *
   3 * Monitoring Plugins network utilities
   4 *
   5 * License: GPL
   6 * Copyright (c) 1999 Ethan Galstad (nagios@nagios.org)
   7 * Copyright (c) 2003-2008 Monitoring Plugins Development Team
   8 *
   9 * Description:
  10 *
  11 * This file contains commons functions used in many of the plugins.
  12 *
  13 *
  14 * This program is free software: you can redistribute it and/or modify
  15 * it under the terms of the GNU General Public License as published by
  16 * the Free Software Foundation, either version 3 of the License, or
  17 * (at your option) any later version.
  18 *
  19 * This program is distributed in the hope that it will be useful,
  20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 * GNU General Public License for more details.
  23 *
  24 * You should have received a copy of the GNU General Public License
  25 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26 *
  27 *
  28 *****************************************************************************/
  29
  30 #include "common.h"
  31 #include "netutils.h"
  32
  33 unsigned int socket_timeout = DEFAULT_SOCKET_TIMEOUT;
  34 unsigned int socket_timeout_state = STATE_CRITICAL;
  35
  36 int econn_refuse_state = STATE_CRITICAL;
  37 int was_refused = FALSE;
  38 #if USE_IPV6
  39 int address_family = AF_UNSPEC;
  40 #else
  41 int address_family = AF_INET;
  42 #endif
  43
  44 /* handles socket timeouts */
  45 void
  46 socket_timeout_alarm_handler (int sig)
  47 {
  48         if (sig == SIGALRM)
  49                 printf (_("%s - Socket timeout after %d seconds\n"), state_text(socket_timeout_state),  socket_timeout);
  50         else
  51                 printf (_("%s - Abnormal timeout after %d seconds\n"), state_text(socket_timeout_state), socket_timeout);
  52
  53         exit (socket_timeout_state);
  54 }
  55
  56
  57 /* connects to a host on a specified tcp port, sends a string, and gets a
  58          response. loops on select-recv until timeout or eof to get all of a
  59          multi-packet answer */
  60 int
  61 process_tcp_request2 (const char *server_address, int server_port,
  62         const char *send_buffer, char *recv_buffer, int recv_size)
  63 {
  64
  65         int result;
  66         int send_result;
  67         int recv_result;
  68         int sd;
  69         struct timeval tv;
  70         fd_set readfds;
  71         int recv_length = 0;
  72
  73         result = np_net_connect (server_address, server_port, &sd, IPPROTO_TCP);
  74         if (result != STATE_OK)
  75                 return STATE_CRITICAL;
  76
  77         send_result = send (sd, send_buffer, strlen (send_buffer), 0);
  78         if (send_result<0 || (size_t)send_result!=strlen(send_buffer)) {
  79                 printf ("%s\n", _("Send failed"));
  80                 result = STATE_WARNING;
  81         }
  82
  83         while (1) {
  84                 /* wait up to the number of seconds for socket timeout
  85                    minus one for data from the host */
  86                 tv.tv_sec = socket_timeout - 1;
  87                 tv.tv_usec = 0;
  88                 FD_ZERO (&readfds);
  89                 FD_SET (sd, &readfds);
  90                 select (sd + 1, &readfds, NULL, NULL, &tv);
  91
  92                 /* make sure some data has arrived */
  93                 if (!FD_ISSET (sd, &readfds)) { /* it hasn't */
  94                         if (!recv_length) {
  95                                 strcpy (recv_buffer, "");
  96                                 printf ("%s\n", _("No data was received from host!"));
  97                                 result = STATE_WARNING;
  98                         }
  99                         else {                                                                          /* this one failed, but previous ones worked */
 100                                 recv_buffer[recv_length] = 0;
 101                         }
 102                         break;
 103                 }
 104                 else {                                                                                  /* it has */
 105                         recv_result =
 106                                 recv (sd, recv_buffer + recv_length,
 107                                         (size_t)recv_size - recv_length - 1, 0);
 108                         if (recv_result == -1) {
 109                                 /* recv failed, bail out */
 110                                 strcpy (recv_buffer + recv_length, "");
 111                                 result = STATE_WARNING;
 112                                 break;
 113                         }
 114                         else if (recv_result == 0) {
 115                                 /* end of file ? */
 116                                 recv_buffer[recv_length] = 0;
 117                                 break;
 118                         }
 119                         else {                                                                          /* we got data! */
 120                                 recv_length += recv_result;
 121                                 if (recv_length >= recv_size - 1) {
 122                                         /* buffer full, we're done */
 123                                         recv_buffer[recv_size - 1] = 0;
 124                                         break;
 125                                 }
 126                         }
 127                 }
 128                 /* end if(!FD_ISSET(sd,&readfds)) */
 129         }
 130         /* end while(1) */
 131
 132         close (sd);
 133         return result;
 134 }
 135
 136
 137 /* connects to a host on a specified port, sends a string, and gets a
 138    response */
 139 int
 140 process_request (const char *server_address, int server_port, int proto,
 141         const char *send_buffer, char *recv_buffer, int recv_size)
 142 {
 143         int result;
 144         int sd;
 145
 146         result = STATE_OK;
 147
 148         result = np_net_connect (server_address, server_port, &sd, proto);
 149         if (result != STATE_OK)
 150                 return STATE_CRITICAL;
 151
 152         result = send_request (sd, proto, send_buffer, recv_buffer, recv_size);
 153
 154         close (sd);
 155
 156         return result;
 157 }
 158
 159
 160 /* opens a tcp or udp connection to a remote host or local socket */
 161 int
 162 np_net_connect (const char *host_name, int port, int *sd, int proto)
 163 {
 164         struct addrinfo hints;
 165         struct addrinfo *r, *res;
 166         struct sockaddr_un su;
 167         char port_str[6], host[MAX_HOST_ADDRESS_LENGTH];
 168         size_t len;
 169         int socktype, result;
 170         short is_socket = (host_name[0] == '/');
 171
 172         socktype = (proto == IPPROTO_UDP) ? SOCK_DGRAM : SOCK_STREAM;
 173
 174         /* as long as it doesn't start with a '/', it's assumed a host or ip */
 175         if (!is_socket){
 176                 memset (&hints, 0, sizeof (hints));
 177                 hints.ai_family = address_family;
 178                 hints.ai_protocol = proto;
 179                 hints.ai_socktype = socktype;
 180
 181                 len = strlen (host_name);
 182                 /* check for an [IPv6] address (and strip the brackets) */
 183                 if (len >= 2 && host_name[0] == '[' && host_name[len - 1] == ']') {
 184                         host_name++;
 185                         len -= 2;
 186                 }
 187                 if (len >= sizeof(host))
 188                         return STATE_UNKNOWN;
 189                 memcpy (host, host_name, len);
 190                 host[len] = '\0';
 191                 snprintf (port_str, sizeof (port_str), "%d", port);
 192                 result = getaddrinfo (host, port_str, &hints, &res);
 193
 194                 if (result != 0) {
 195                         printf ("%s\n", gai_strerror (result));
 196                         return STATE_UNKNOWN;
 197                 }
 198
 199                 r = res;
 200                 while (r) {
 201                         /* attempt to create a socket */
 202                         *sd = socket (r->ai_family, socktype, r->ai_protocol);
 203
 204                         if (*sd < 0) {
 205                                 printf ("%s\n", _("Socket creation failed"));
 206                                 freeaddrinfo (r);
 207                                 return STATE_UNKNOWN;
 208                         }
 209
 210                         /* attempt to open a connection */
 211                         result = connect (*sd, r->ai_addr, r->ai_addrlen);
 212
 213                         if (result == 0) {
 214                                 was_refused = FALSE;
 215                                 break;
 216                         }
 217
 218                         if (result < 0) {
 219                                 switch (errno) {
 220                                 case ECONNREFUSED:
 221                                         was_refused = TRUE;
 222                                         break;
 223                                 }
 224                         }
 225
 226                         close (*sd);
 227                         r = r->ai_next;
 228                 }
 229                 freeaddrinfo (res);
 230         }
 231         /* else the hostname is interpreted as a path to a unix socket */
 232         else {
 233                 if(strlen(host_name) >= UNIX_PATH_MAX){
 234                         die(STATE_UNKNOWN, _("Supplied path too long unix domain socket"));
 235                 }
 236                 memset(&su, 0, sizeof(su));
 237                 su.sun_family = AF_UNIX;
 238                 strncpy(su.sun_path, host_name, UNIX_PATH_MAX);
 239                 *sd = socket(PF_UNIX, SOCK_STREAM, 0);
 240                 if(*sd < 0){
 241                         die(STATE_UNKNOWN, _("Socket creation failed"));
 242                 }
 243                 result = connect(*sd, (struct sockaddr *)&su, sizeof(su));
 244                 if (result < 0 && errno == ECONNREFUSED)
 245                         was_refused = TRUE;
 246         }
 247
 248         if (result == 0)
 249                 return STATE_OK;
 250         else if (was_refused) {
 251                 switch (econn_refuse_state) { /* a user-defined expected outcome */
 252                 case STATE_OK:
 253                 case STATE_WARNING:  /* user wants WARN or OK on refusal */
 254                         return econn_refuse_state;
 255                         break;
 256                 case STATE_CRITICAL: /* user did not set econn_refuse_state */
 257                         if (is_socket)
 258                                 printf("connect to file socket %s: %s\n", host_name, strerror(errno));
 259                         else
 260                                 printf("connect to address %s and port %d: %s\n",
 261                                        host_name, port, strerror(errno));
 262                         return econn_refuse_state;
 263                         break;
 264                 default: /* it's a logic error if we do not end up in STATE_(OK|WARNING|CRITICAL) */
 265                         return STATE_UNKNOWN;
 266                         break;
 267                 }
 268         }
 269         else {
 270                 if (is_socket)
 271                         printf("connect to file socket %s: %s\n", host_name, strerror(errno));
 272                 else
 273                         printf("connect to address %s and port %d: %s\n",
 274                                host_name, port, strerror(errno));
 275                 return STATE_CRITICAL;
 276         }
 277 }
 278
 279 int
 280 send_request (int sd, int proto, const char *send_buffer, char *recv_buffer, int recv_size)
 281 {
 282         int result = STATE_OK;
 283         int send_result;
 284         int recv_result;
 285         struct timeval tv;
 286         fd_set readfds;
 287
 288         send_result = send (sd, send_buffer, strlen (send_buffer), 0);
 289         if (send_result<0 || (size_t)send_result!=strlen(send_buffer)) {
 290                 printf ("%s\n", _("Send failed"));
 291                 result = STATE_WARNING;
 292         }
 293
 294         /* wait up to the number of seconds for socket timeout minus one
 295            for data from the host */
 296         tv.tv_sec = socket_timeout - 1;
 297         tv.tv_usec = 0;
 298         FD_ZERO (&readfds);
 299         FD_SET (sd, &readfds);
 300         select (sd + 1, &readfds, NULL, NULL, &tv);
 301
 302         /* make sure some data has arrived */
 303         if (!FD_ISSET (sd, &readfds)) {
 304                 strcpy (recv_buffer, "");
 305                 printf ("%s\n", _("No data was received from host!"));
 306                 result = STATE_WARNING;
 307         }
 308
 309         else {
 310                 recv_result = recv (sd, recv_buffer, (size_t)recv_size - 1, 0);
 311                 if (recv_result == -1) {
 312                         strcpy (recv_buffer, "");
 313                         if (proto != IPPROTO_TCP)
 314                                 printf ("%s\n", _("Receive failed"));
 315                         result = STATE_WARNING;
 316                 }
 317                 else
 318                         recv_buffer[recv_result] = 0;
 319
 320                 /* die returned string */
 321                 recv_buffer[recv_size - 1] = 0;
 322         }
 323         return result;
 324 }
 325
 326
 327 int
 328 is_host (const char *address)
 329 {
 330         if (is_addr (address) || is_hostname (address))
 331                 return (TRUE);
 332
 333         return (FALSE);
 334 }
 335
 336 void
 337 host_or_die(const char *str)
 338 {
 339         if(!str || (!is_addr(str) && !is_hostname(str)))
 340                 usage_va(_("Invalid hostname/address - %s"), str);
 341 }
 342
 343 int
 344 is_addr (const char *address)
 345 {
 346 #ifdef USE_IPV6
 347         if (address_family == AF_INET && is_inet_addr (address))
 348                 return TRUE;
 349         else if (address_family == AF_INET6 && is_inet6_addr (address))
 350                 return TRUE;
 351 #else
 352         if (is_inet_addr (address))
 353                 return (TRUE);
 354 #endif
 355
 356         return (FALSE);
 357 }
 358
 359 int
 360 resolve_host_or_addr (const char *address, int family)
 361 {
 362         struct addrinfo hints;
 363         struct addrinfo *res;
 364         int retval;
 365
 366         memset (&hints, 0, sizeof (hints));
 367         hints.ai_family = family;
 368         retval = getaddrinfo (address, NULL, &hints, &res);
 369
 370         if (retval != 0)
 371                 return FALSE;
 372         else {
 373                 freeaddrinfo (res);
 374                 return TRUE;
 375         }
 376 }