2 * collectd - src/network.c
3 * Copyright (C) 2005-2013 Florian octo Forster
4 * Copyright (C) 2009 Aman Gupta
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU Lesser General Public License as published by
8 * the Free Software Foundation; only version 2.1 of the License is
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Florian octo Forster <octo at collectd.org>
22 * Aman Gupta <aman at tmm1.net>
25 #define _BSD_SOURCE /* For struct ip_mreq */
30 #include "configfile.h"
31 #include "utils_fbhash.h"
32 #include "utils_avltree.h"
33 #include "utils_cache.h"
34 #include "utils_complain.h"
42 # include <sys/socket.h>
48 # include <netinet/in.h>
51 # include <arpa/inet.h>
62 # if defined __APPLE__
63 /* default xcode compiler throws warnings even when deprecated functionality
64 * is not used. -Werror breaks the build because of erroneous warnings.
65 * http://stackoverflow.com/questions/10556299/compiler-warnings-with-libgcrypt-v1-5-0/12830209#12830209
67 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
69 /* FreeBSD's copy of libgcrypt extends the existing GCRYPT_NO_DEPRECATED
70 * to properly hide all deprecated functionality.
71 * http://svnweb.freebsd.org/ports/head/security/libgcrypt/files/patch-src__gcrypt.h.in
73 # define GCRYPT_NO_DEPRECATED
75 # if defined __APPLE__
76 /* Re enable deprecation warnings */
77 # pragma GCC diagnostic warning "-Wdeprecated-declarations"
79 GCRY_THREAD_OPTION_PTHREAD_IMPL;
82 #ifndef IPV6_ADD_MEMBERSHIP
83 # ifdef IPV6_JOIN_GROUP
84 # define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
86 # error "Neither IP_ADD_MEMBERSHIP nor IPV6_JOIN_GROUP is defined"
88 #endif /* !IP_ADD_MEMBERSHIP */
91 * Maximum size required for encryption / signing:
93 * 42 bytes for the encryption header
94 * + 64 bytes for the username
98 #define BUFF_SIG_SIZE 106
103 #define SECURITY_LEVEL_NONE 0
105 # define SECURITY_LEVEL_SIGN 1
106 # define SECURITY_LEVEL_ENCRYPT 2
108 struct sockent_client
111 struct sockaddr_storage *addr;
117 gcry_cipher_hd_t cypher;
118 unsigned char password_hash[32];
122 struct sockent_server
130 gcry_cipher_hd_t cypher;
134 typedef struct sockent
136 #define SOCKENT_TYPE_CLIENT 1
137 #define SOCKENT_TYPE_SERVER 2
146 struct sockent_client client;
147 struct sockent_server server;
150 struct sockent *next;
153 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
154 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
155 * +-------+-----------------------+-------------------------------+
156 * ! Ver. ! ! Length !
157 * +-------+-----------------------+-------------------------------+
164 typedef struct part_header_s part_header_t;
166 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
167 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
168 * +-------------------------------+-------------------------------+
170 * +-------------------------------+-------------------------------+
171 * : (Length - 4) Bytes :
172 * +---------------------------------------------------------------+
179 typedef struct part_string_s part_string_t;
181 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
182 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
183 * +-------------------------------+-------------------------------+
185 * +-------------------------------+-------------------------------+
186 * : (Length - 4 == 2 || 4 || 8) Bytes :
187 * +---------------------------------------------------------------+
194 typedef struct part_number_s part_number_t;
196 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
197 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
198 * +-------------------------------+-------------------------------+
200 * +-------------------------------+---------------+---------------+
201 * ! Num of values ! Type0 ! Type1 !
202 * +-------------------------------+---------------+---------------+
205 * +---------------------------------------------------------------+
208 * +---------------------------------------------------------------+
213 uint16_t *num_values;
214 uint8_t *values_types;
217 typedef struct part_values_s part_values_t;
219 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
220 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
221 * +-------------------------------+-------------------------------+
223 * +-------------------------------+-------------------------------+
224 * ! Hash (Bits 0 - 31) !
226 * ! Hash (Bits 224 - 255) !
227 * +---------------------------------------------------------------+
230 #define PART_SIGNATURE_SHA256_SIZE 36
231 struct part_signature_sha256_s
234 unsigned char hash[32];
237 typedef struct part_signature_sha256_s part_signature_sha256_t;
239 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
240 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
241 * +-------------------------------+-------------------------------+
243 * +-------------------------------+-------------------------------+
244 * ! Original length ! Padding (0 - 15 bytes) !
245 * +-------------------------------+-------------------------------+
246 * ! Hash (Bits 0 - 31) !
248 * ! Hash (Bits 128 - 159) !
249 * +---------------------------------------------------------------+
252 #define PART_ENCRYPTION_AES256_SIZE 42
253 struct part_encryption_aes256_s
256 uint16_t username_length;
258 unsigned char iv[16];
260 unsigned char hash[20];
264 typedef struct part_encryption_aes256_s part_encryption_aes256_t;
266 struct receive_list_entry_s
271 struct receive_list_entry_s *next;
273 typedef struct receive_list_entry_s receive_list_entry_t;
278 static int network_config_ttl = 0;
279 /* Ethernet - (IPv6 + UDP) = 1500 - (40 + 8) = 1452 */
280 static size_t network_config_packet_size = 1452;
281 static int network_config_forward = 0;
282 static int network_config_stats = 0;
284 static sockent_t *sending_sockets = NULL;
286 static receive_list_entry_t *receive_list_head = NULL;
287 static receive_list_entry_t *receive_list_tail = NULL;
288 static pthread_mutex_t receive_list_lock = PTHREAD_MUTEX_INITIALIZER;
289 static pthread_cond_t receive_list_cond = PTHREAD_COND_INITIALIZER;
290 static uint64_t receive_list_length = 0;
292 static sockent_t *listen_sockets = NULL;
293 static struct pollfd *listen_sockets_pollfd = NULL;
294 static size_t listen_sockets_num = 0;
296 /* The receive and dispatch threads will run as long as `listen_loop' is set to
298 static int listen_loop = 0;
299 static int receive_thread_running = 0;
300 static pthread_t receive_thread_id;
301 static int dispatch_thread_running = 0;
302 static pthread_t dispatch_thread_id;
304 /* Buffer in which to-be-sent network packets are constructed. */
305 static char *send_buffer;
306 static char *send_buffer_ptr;
307 static int send_buffer_fill;
308 static value_list_t send_buffer_vl = VALUE_LIST_STATIC;
309 static pthread_mutex_t send_buffer_lock = PTHREAD_MUTEX_INITIALIZER;
311 /* XXX: These counters are incremented from one place only. The spot in which
312 * the values are incremented is either only reachable by one thread (the
313 * dispatch thread, for example) or locked by some lock (send_buffer_lock for
314 * example). Only if neither is true, the stats_lock is acquired. The counters
315 * are always read without holding a lock in the hope that writing 8 bytes to
316 * memory is an atomic operation. */
317 static derive_t stats_octets_rx = 0;
318 static derive_t stats_octets_tx = 0;
319 static derive_t stats_packets_rx = 0;
320 static derive_t stats_packets_tx = 0;
321 static derive_t stats_values_dispatched = 0;
322 static derive_t stats_values_not_dispatched = 0;
323 static derive_t stats_values_sent = 0;
324 static derive_t stats_values_not_sent = 0;
325 static pthread_mutex_t stats_lock = PTHREAD_MUTEX_INITIALIZER;
330 static _Bool check_receive_okay (const value_list_t *vl) /* {{{ */
332 uint64_t time_sent = 0;
335 status = uc_meta_data_get_unsigned_int (vl,
336 "network:time_sent", &time_sent);
338 /* This is a value we already sent. Don't allow it to be received again in
339 * order to avoid looping. */
340 if ((status == 0) && (time_sent >= ((uint64_t) vl->time)))
344 } /* }}} _Bool check_receive_okay */
346 static _Bool check_send_okay (const value_list_t *vl) /* {{{ */
351 if (network_config_forward != 0)
354 if (vl->meta == NULL)
357 status = meta_data_get_boolean (vl->meta, "network:received", &received);
358 if (status == -ENOENT)
360 else if (status != 0)
362 ERROR ("network plugin: check_send_okay: meta_data_get_boolean failed "
363 "with status %i.", status);
367 /* By default, only *send* value lists that were not *received* by the
370 } /* }}} _Bool check_send_okay */
372 static _Bool check_notify_received (const notification_t *n) /* {{{ */
374 notification_meta_t *ptr;
376 for (ptr = n->meta; ptr != NULL; ptr = ptr->next)
377 if ((strcmp ("network:received", ptr->name) == 0)
378 && (ptr->type == NM_TYPE_BOOLEAN))
379 return ((_Bool) ptr->nm_value.nm_boolean);
382 } /* }}} _Bool check_notify_received */
384 static _Bool check_send_notify_okay (const notification_t *n) /* {{{ */
386 static c_complain_t complain_forwarding = C_COMPLAIN_INIT_STATIC;
392 received = check_notify_received (n);
394 if (network_config_forward && received)
396 c_complain_once (LOG_ERR, &complain_forwarding,
397 "network plugin: A notification has been received via the network "
398 "forwarding if enabled. Forwarding of notifications is currently "
399 "not supported, because there is not loop-deteciton available. "
400 "Please contact the collectd mailing list if you need this "
404 /* By default, only *send* value lists that were not *received* by the
407 } /* }}} _Bool check_send_notify_okay */
409 static int network_dispatch_values (value_list_t *vl, /* {{{ */
410 const char *username)
415 || (strlen (vl->host) <= 0)
416 || (strlen (vl->plugin) <= 0)
417 || (strlen (vl->type) <= 0))
420 if (!check_receive_okay (vl))
423 char name[6*DATA_MAX_NAME_LEN];
424 FORMAT_VL (name, sizeof (name), vl);
425 name[sizeof (name) - 1] = 0;
426 DEBUG ("network plugin: network_dispatch_values: "
427 "NOT dispatching %s.", name);
429 stats_values_not_dispatched++;
433 assert (vl->meta == NULL);
435 vl->meta = meta_data_create ();
436 if (vl->meta == NULL)
438 ERROR ("network plugin: meta_data_create failed.");
442 status = meta_data_add_boolean (vl->meta, "network:received", 1);
445 ERROR ("network plugin: meta_data_add_boolean failed.");
446 meta_data_destroy (vl->meta);
451 if (username != NULL)
453 status = meta_data_add_string (vl->meta, "network:username", username);
456 ERROR ("network plugin: meta_data_add_string failed.");
457 meta_data_destroy (vl->meta);
463 plugin_dispatch_values (vl);
464 stats_values_dispatched++;
466 meta_data_destroy (vl->meta);
470 } /* }}} int network_dispatch_values */
472 static int network_dispatch_notification (notification_t *n) /* {{{ */
476 assert (n->meta == NULL);
478 status = plugin_notification_meta_add_boolean (n, "network:received", 1);
481 ERROR ("network plugin: plugin_notification_meta_add_boolean failed.");
482 plugin_notification_meta_free (n->meta);
487 status = plugin_dispatch_notification (n);
489 plugin_notification_meta_free (n->meta);
493 } /* }}} int network_dispatch_notification */
496 static void network_init_gcrypt (void) /* {{{ */
498 /* http://lists.gnupg.org/pipermail/gcrypt-devel/2003-August/000458.html
499 * Because you can't know in a library whether another library has
500 * already initialized the library */
501 if (gcry_control (GCRYCTL_ANY_INITIALIZATION_P))
504 /* http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html
505 * To ensure thread-safety, it's important to set GCRYCTL_SET_THREAD_CBS
506 * *before* initalizing Libgcrypt with gcry_check_version(), which itself must
507 * be called before any other gcry_* function. GCRYCTL_ANY_INITIALIZATION_P
508 * above doesn't count, as it doesn't implicitly initalize Libgcrypt.
510 * tl;dr: keep all these gry_* statements in this exact order please. */
511 gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
512 gcry_check_version (NULL);
513 gcry_control (GCRYCTL_INIT_SECMEM, 32768);
514 gcry_control (GCRYCTL_INITIALIZATION_FINISHED);
515 } /* }}} void network_init_gcrypt */
517 static gcry_cipher_hd_t network_get_aes256_cypher (sockent_t *se, /* {{{ */
518 const void *iv, size_t iv_size, const char *username)
521 gcry_cipher_hd_t *cyper_ptr;
522 unsigned char password_hash[32];
524 if (se->type == SOCKENT_TYPE_CLIENT)
526 cyper_ptr = &se->data.client.cypher;
527 memcpy (password_hash, se->data.client.password_hash,
528 sizeof (password_hash));
534 cyper_ptr = &se->data.server.cypher;
536 if (username == NULL)
539 secret = fbh_get (se->data.server.userdb, username);
543 gcry_md_hash_buffer (GCRY_MD_SHA256,
545 secret, strlen (secret));
550 if (*cyper_ptr == NULL)
552 err = gcry_cipher_open (cyper_ptr,
553 GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB, /* flags = */ 0);
556 ERROR ("network plugin: gcry_cipher_open returned: %s",
557 gcry_strerror (err));
564 gcry_cipher_reset (*cyper_ptr);
566 assert (*cyper_ptr != NULL);
568 err = gcry_cipher_setkey (*cyper_ptr,
569 password_hash, sizeof (password_hash));
572 ERROR ("network plugin: gcry_cipher_setkey returned: %s",
573 gcry_strerror (err));
574 gcry_cipher_close (*cyper_ptr);
579 err = gcry_cipher_setiv (*cyper_ptr, iv, iv_size);
582 ERROR ("network plugin: gcry_cipher_setkey returned: %s",
583 gcry_strerror (err));
584 gcry_cipher_close (*cyper_ptr);
590 } /* }}} int network_get_aes256_cypher */
591 #endif /* HAVE_LIBGCRYPT */
593 static int write_part_values (char **ret_buffer, int *ret_buffer_len,
594 const data_set_t *ds, const value_list_t *vl)
600 part_header_t pkg_ph;
601 uint16_t pkg_num_values;
602 uint8_t *pkg_values_types;
608 num_values = vl->values_len;
609 packet_len = sizeof (part_header_t) + sizeof (uint16_t)
610 + (num_values * sizeof (uint8_t))
611 + (num_values * sizeof (value_t));
613 if (*ret_buffer_len < packet_len)
616 pkg_values_types = (uint8_t *) malloc (num_values * sizeof (uint8_t));
617 if (pkg_values_types == NULL)
619 ERROR ("network plugin: write_part_values: malloc failed.");
623 pkg_values = (value_t *) malloc (num_values * sizeof (value_t));
624 if (pkg_values == NULL)
626 free (pkg_values_types);
627 ERROR ("network plugin: write_part_values: malloc failed.");
631 pkg_ph.type = htons (TYPE_VALUES);
632 pkg_ph.length = htons (packet_len);
634 pkg_num_values = htons ((uint16_t) vl->values_len);
636 for (i = 0; i < num_values; i++)
638 pkg_values_types[i] = (uint8_t) ds->ds[i].type;
639 switch (ds->ds[i].type)
641 case DS_TYPE_COUNTER:
642 pkg_values[i].counter = htonll (vl->values[i].counter);
646 pkg_values[i].gauge = htond (vl->values[i].gauge);
650 pkg_values[i].derive = htonll (vl->values[i].derive);
653 case DS_TYPE_ABSOLUTE:
654 pkg_values[i].absolute = htonll (vl->values[i].absolute);
658 free (pkg_values_types);
660 ERROR ("network plugin: write_part_values: "
661 "Unknown data source type: %i",
664 } /* switch (ds->ds[i].type) */
665 } /* for (num_values) */
668 * Use `memcpy' to write everything to the buffer, because the pointer
669 * may be unaligned and some architectures, such as SPARC, can't handle
672 packet_ptr = *ret_buffer;
674 memcpy (packet_ptr + offset, &pkg_ph, sizeof (pkg_ph));
675 offset += sizeof (pkg_ph);
676 memcpy (packet_ptr + offset, &pkg_num_values, sizeof (pkg_num_values));
677 offset += sizeof (pkg_num_values);
678 memcpy (packet_ptr + offset, pkg_values_types, num_values * sizeof (uint8_t));
679 offset += num_values * sizeof (uint8_t);
680 memcpy (packet_ptr + offset, pkg_values, num_values * sizeof (value_t));
681 offset += num_values * sizeof (value_t);
683 assert (offset == packet_len);
685 *ret_buffer = packet_ptr + packet_len;
686 *ret_buffer_len -= packet_len;
688 free (pkg_values_types);
692 } /* int write_part_values */
694 static int write_part_number (char **ret_buffer, int *ret_buffer_len,
695 int type, uint64_t value)
700 part_header_t pkg_head;
705 packet_len = sizeof (pkg_head) + sizeof (pkg_value);
707 if (*ret_buffer_len < packet_len)
710 pkg_head.type = htons (type);
711 pkg_head.length = htons (packet_len);
712 pkg_value = htonll (value);
714 packet_ptr = *ret_buffer;
716 memcpy (packet_ptr + offset, &pkg_head, sizeof (pkg_head));
717 offset += sizeof (pkg_head);
718 memcpy (packet_ptr + offset, &pkg_value, sizeof (pkg_value));
719 offset += sizeof (pkg_value);
721 assert (offset == packet_len);
723 *ret_buffer = packet_ptr + packet_len;
724 *ret_buffer_len -= packet_len;
727 } /* int write_part_number */
729 static int write_part_string (char **ret_buffer, int *ret_buffer_len,
730 int type, const char *str, int str_len)
740 buffer_len = 2 * sizeof (uint16_t) + str_len + 1;
741 if (*ret_buffer_len < buffer_len)
744 pkg_type = htons (type);
745 pkg_length = htons (buffer_len);
747 buffer = *ret_buffer;
749 memcpy (buffer + offset, (void *) &pkg_type, sizeof (pkg_type));
750 offset += sizeof (pkg_type);
751 memcpy (buffer + offset, (void *) &pkg_length, sizeof (pkg_length));
752 offset += sizeof (pkg_length);
753 memcpy (buffer + offset, str, str_len);
755 memset (buffer + offset, '\0', 1);
758 assert (offset == buffer_len);
760 *ret_buffer = buffer + buffer_len;
761 *ret_buffer_len -= buffer_len;
764 } /* int write_part_string */
766 static int parse_part_values (void **ret_buffer, size_t *ret_buffer_len,
767 value_t **ret_values, int *ret_num_values)
769 char *buffer = *ret_buffer;
770 size_t buffer_len = *ret_buffer_len;
785 NOTICE ("network plugin: packet is too short: "
786 "buffer_len = %zu", buffer_len);
790 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
791 buffer += sizeof (tmp16);
792 pkg_type = ntohs (tmp16);
794 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
795 buffer += sizeof (tmp16);
796 pkg_length = ntohs (tmp16);
798 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
799 buffer += sizeof (tmp16);
800 pkg_numval = ntohs (tmp16);
802 assert (pkg_type == TYPE_VALUES);
804 exp_size = 3 * sizeof (uint16_t)
805 + pkg_numval * (sizeof (uint8_t) + sizeof (value_t));
806 if (buffer_len < exp_size)
808 WARNING ("network plugin: parse_part_values: "
810 "Chunk of size %zu expected, "
811 "but buffer has only %zu bytes left.",
812 exp_size, buffer_len);
816 if (pkg_length != exp_size)
818 WARNING ("network plugin: parse_part_values: "
819 "Length and number of values "
820 "in the packet don't match.");
824 pkg_types = (uint8_t *) malloc (pkg_numval * sizeof (uint8_t));
825 pkg_values = (value_t *) malloc (pkg_numval * sizeof (value_t));
826 if ((pkg_types == NULL) || (pkg_values == NULL))
830 ERROR ("network plugin: parse_part_values: malloc failed.");
834 memcpy ((void *) pkg_types, (void *) buffer, pkg_numval * sizeof (uint8_t));
835 buffer += pkg_numval * sizeof (uint8_t);
836 memcpy ((void *) pkg_values, (void *) buffer, pkg_numval * sizeof (value_t));
837 buffer += pkg_numval * sizeof (value_t);
839 for (i = 0; i < pkg_numval; i++)
841 switch (pkg_types[i])
843 case DS_TYPE_COUNTER:
844 pkg_values[i].counter = (counter_t) ntohll (pkg_values[i].counter);
848 pkg_values[i].gauge = (gauge_t) ntohd (pkg_values[i].gauge);
852 pkg_values[i].derive = (derive_t) ntohll (pkg_values[i].derive);
855 case DS_TYPE_ABSOLUTE:
856 pkg_values[i].absolute = (absolute_t) ntohll (pkg_values[i].absolute);
860 NOTICE ("network plugin: parse_part_values: "
861 "Don't know how to handle data source type %"PRIu8,
866 } /* switch (pkg_types[i]) */
869 *ret_buffer = buffer;
870 *ret_buffer_len = buffer_len - pkg_length;
871 *ret_num_values = pkg_numval;
872 *ret_values = pkg_values;
877 } /* int parse_part_values */
879 static int parse_part_number (void **ret_buffer, size_t *ret_buffer_len,
882 char *buffer = *ret_buffer;
883 size_t buffer_len = *ret_buffer_len;
887 size_t exp_size = 2 * sizeof (uint16_t) + sizeof (uint64_t);
891 if (buffer_len < exp_size)
893 WARNING ("network plugin: parse_part_number: "
895 "Chunk of size %zu expected, "
896 "but buffer has only %zu bytes left.",
897 exp_size, buffer_len);
901 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
902 buffer += sizeof (tmp16);
903 /* pkg_type = ntohs (tmp16); */
905 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
906 buffer += sizeof (tmp16);
907 pkg_length = ntohs (tmp16);
909 memcpy ((void *) &tmp64, buffer, sizeof (tmp64));
910 buffer += sizeof (tmp64);
911 *value = ntohll (tmp64);
913 *ret_buffer = buffer;
914 *ret_buffer_len = buffer_len - pkg_length;
917 } /* int parse_part_number */
919 static int parse_part_string (void **ret_buffer, size_t *ret_buffer_len,
920 char *output, size_t const output_len)
922 char *buffer = *ret_buffer;
923 size_t buffer_len = *ret_buffer_len;
926 size_t const header_size = 2 * sizeof (uint16_t);
934 if (buffer_len < header_size)
936 WARNING ("network plugin: parse_part_string: "
938 "Chunk of at least size %zu expected, "
939 "but buffer has only %zu bytes left.",
940 header_size, buffer_len);
944 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
945 buffer += sizeof (tmp16);
946 /* pkg_type = ntohs (tmp16); */
948 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
949 buffer += sizeof (tmp16);
950 pkg_length = ntohs (tmp16);
951 payload_size = ((size_t) pkg_length) - header_size;
953 /* Check that packet fits in the input buffer */
954 if (pkg_length > buffer_len)
956 WARNING ("network plugin: parse_part_string: "
958 "Chunk of size %"PRIu16" received, "
959 "but buffer has only %zu bytes left.",
960 pkg_length, buffer_len);
964 /* Check that pkg_length is in the valid range */
965 if (pkg_length <= header_size)
967 WARNING ("network plugin: parse_part_string: "
969 "Header claims this packet is only %hu "
970 "bytes long.", pkg_length);
974 /* Check that the package data fits into the output buffer.
975 * The previous if-statement ensures that:
976 * `pkg_length > header_size' */
977 if (output_len < payload_size)
979 WARNING ("network plugin: parse_part_string: "
981 "Output buffer holds %zu bytes, "
982 "which is too small to hold the received "
984 output_len, payload_size);
988 /* All sanity checks successfull, let's copy the data over */
989 memcpy ((void *) output, (void *) buffer, payload_size);
990 buffer += payload_size;
992 /* For some very weird reason '\0' doesn't do the trick on SPARC in
994 if (output[payload_size - 1] != 0)
996 WARNING ("network plugin: parse_part_string: "
997 "Received string does not end "
998 "with a NULL-byte.");
1002 *ret_buffer = buffer;
1003 *ret_buffer_len = buffer_len - pkg_length;
1006 } /* int parse_part_string */
1008 /* Forward declaration: parse_part_sign_sha256 and parse_part_encr_aes256 call
1009 * parse_packet and vice versa. */
1010 #define PP_SIGNED 0x01
1011 #define PP_ENCRYPTED 0x02
1012 static int parse_packet (sockent_t *se,
1013 void *buffer, size_t buffer_size, int flags,
1014 const char *username);
1016 #define BUFFER_READ(p,s) do { \
1017 memcpy ((p), buffer + buffer_offset, (s)); \
1018 buffer_offset += (s); \
1022 static int parse_part_sign_sha256 (sockent_t *se, /* {{{ */
1023 void **ret_buffer, size_t *ret_buffer_len, int flags)
1025 static c_complain_t complain_no_users = C_COMPLAIN_INIT_STATIC;
1029 size_t buffer_offset;
1031 size_t username_len;
1034 part_signature_sha256_t pss;
1035 uint16_t pss_head_length;
1036 char hash[sizeof (pss.hash)];
1040 unsigned char *hash_ptr;
1042 buffer = *ret_buffer;
1043 buffer_len = *ret_buffer_len;
1046 if (se->data.server.userdb == NULL)
1048 c_complain (LOG_NOTICE, &complain_no_users,
1049 "network plugin: Received signed network packet but can't verify it "
1050 "because no user DB has been configured. Will accept it.");
1054 /* Check if the buffer has enough data for this structure. */
1055 if (buffer_len <= PART_SIGNATURE_SHA256_SIZE)
1058 /* Read type and length header */
1059 BUFFER_READ (&pss.head.type, sizeof (pss.head.type));
1060 BUFFER_READ (&pss.head.length, sizeof (pss.head.length));
1061 pss_head_length = ntohs (pss.head.length);
1063 /* Check if the `pss_head_length' is within bounds. */
1064 if ((pss_head_length <= PART_SIGNATURE_SHA256_SIZE)
1065 || (pss_head_length > buffer_len))
1067 ERROR ("network plugin: HMAC-SHA-256 with invalid length received.");
1071 /* Copy the hash. */
1072 BUFFER_READ (pss.hash, sizeof (pss.hash));
1074 /* Calculate username length (without null byte) and allocate memory */
1075 username_len = pss_head_length - PART_SIGNATURE_SHA256_SIZE;
1076 pss.username = malloc (username_len + 1);
1077 if (pss.username == NULL)
1080 /* Read the username */
1081 BUFFER_READ (pss.username, username_len);
1082 pss.username[username_len] = 0;
1084 assert (buffer_offset == pss_head_length);
1086 /* Query the password */
1087 secret = fbh_get (se->data.server.userdb, pss.username);
1090 ERROR ("network plugin: Unknown user: %s", pss.username);
1091 sfree (pss.username);
1095 /* Create a hash device and check the HMAC */
1097 err = gcry_md_open (&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
1100 ERROR ("network plugin: Creating HMAC-SHA-256 object failed: %s",
1101 gcry_strerror (err));
1103 sfree (pss.username);
1107 err = gcry_md_setkey (hd, secret, strlen (secret));
1110 ERROR ("network plugin: gcry_md_setkey failed: %s", gcry_strerror (err));
1113 sfree (pss.username);
1118 buffer + PART_SIGNATURE_SHA256_SIZE,
1119 buffer_len - PART_SIGNATURE_SHA256_SIZE);
1120 hash_ptr = gcry_md_read (hd, GCRY_MD_SHA256);
1121 if (hash_ptr == NULL)
1123 ERROR ("network plugin: gcry_md_read failed.");
1126 sfree (pss.username);
1129 memcpy (hash, hash_ptr, sizeof (hash));
1135 if (memcmp (pss.hash, hash, sizeof (pss.hash)) != 0)
1137 WARNING ("network plugin: Verifying HMAC-SHA-256 signature failed: "
1142 parse_packet (se, buffer + buffer_offset, buffer_len - buffer_offset,
1143 flags | PP_SIGNED, pss.username);
1147 sfree (pss.username);
1149 *ret_buffer = buffer + buffer_len;
1150 *ret_buffer_len = 0;
1153 } /* }}} int parse_part_sign_sha256 */
1154 /* #endif HAVE_LIBGCRYPT */
1156 #else /* if !HAVE_LIBGCRYPT */
1157 static int parse_part_sign_sha256 (sockent_t *se, /* {{{ */
1158 void **ret_buffer, size_t *ret_buffer_size, int flags)
1160 static int warning_has_been_printed = 0;
1164 size_t buffer_offset;
1167 part_signature_sha256_t pss;
1169 buffer = *ret_buffer;
1170 buffer_size = *ret_buffer_size;
1173 if (buffer_size <= PART_SIGNATURE_SHA256_SIZE)
1176 BUFFER_READ (&pss.head.type, sizeof (pss.head.type));
1177 BUFFER_READ (&pss.head.length, sizeof (pss.head.length));
1178 part_len = ntohs (pss.head.length);
1180 if ((part_len <= PART_SIGNATURE_SHA256_SIZE)
1181 || (part_len > buffer_size))
1184 if (warning_has_been_printed == 0)
1186 WARNING ("network plugin: Received signed packet, but the network "
1187 "plugin was not linked with libgcrypt, so I cannot "
1188 "verify the signature. The packet will be accepted.");
1189 warning_has_been_printed = 1;
1192 parse_packet (se, buffer + part_len, buffer_size - part_len, flags,
1193 /* username = */ NULL);
1195 *ret_buffer = buffer + buffer_size;
1196 *ret_buffer_size = 0;
1199 } /* }}} int parse_part_sign_sha256 */
1200 #endif /* !HAVE_LIBGCRYPT */
1203 static int parse_part_encr_aes256 (sockent_t *se, /* {{{ */
1204 void **ret_buffer, size_t *ret_buffer_len,
1207 char *buffer = *ret_buffer;
1208 size_t buffer_len = *ret_buffer_len;
1211 size_t buffer_offset;
1212 uint16_t username_len;
1213 part_encryption_aes256_t pea;
1214 unsigned char hash[sizeof (pea.hash)];
1216 gcry_cipher_hd_t cypher;
1219 /* Make sure at least the header if available. */
1220 if (buffer_len <= PART_ENCRYPTION_AES256_SIZE)
1222 NOTICE ("network plugin: parse_part_encr_aes256: "
1223 "Discarding short packet.");
1229 /* Copy the unencrypted information into `pea'. */
1230 BUFFER_READ (&pea.head.type, sizeof (pea.head.type));
1231 BUFFER_READ (&pea.head.length, sizeof (pea.head.length));
1233 /* Check the `part size'. */
1234 part_size = ntohs (pea.head.length);
1235 if ((part_size <= PART_ENCRYPTION_AES256_SIZE)
1236 || (part_size > buffer_len))
1238 NOTICE ("network plugin: parse_part_encr_aes256: "
1239 "Discarding part with invalid size.");
1243 /* Read the username */
1244 BUFFER_READ (&username_len, sizeof (username_len));
1245 username_len = ntohs (username_len);
1247 if ((username_len <= 0)
1248 || (username_len > (part_size - (PART_ENCRYPTION_AES256_SIZE + 1))))
1250 NOTICE ("network plugin: parse_part_encr_aes256: "
1251 "Discarding part with invalid username length.");
1255 assert (username_len > 0);
1256 pea.username = malloc (username_len + 1);
1257 if (pea.username == NULL)
1259 BUFFER_READ (pea.username, username_len);
1260 pea.username[username_len] = 0;
1262 /* Last but not least, the initialization vector */
1263 BUFFER_READ (pea.iv, sizeof (pea.iv));
1265 /* Make sure we are at the right position */
1266 assert (buffer_offset == (username_len +
1267 PART_ENCRYPTION_AES256_SIZE - sizeof (pea.hash)));
1269 cypher = network_get_aes256_cypher (se, pea.iv, sizeof (pea.iv),
1273 sfree (pea.username);
1277 payload_len = part_size - (PART_ENCRYPTION_AES256_SIZE + username_len);
1278 assert (payload_len > 0);
1280 /* Decrypt the packet in-place */
1281 err = gcry_cipher_decrypt (cypher,
1282 buffer + buffer_offset,
1283 part_size - buffer_offset,
1284 /* in = */ NULL, /* in len = */ 0);
1287 sfree (pea.username);
1288 ERROR ("network plugin: gcry_cipher_decrypt returned: %s",
1289 gcry_strerror (err));
1294 BUFFER_READ (pea.hash, sizeof (pea.hash));
1296 /* Make sure we're at the right position - again */
1297 assert (buffer_offset == (username_len + PART_ENCRYPTION_AES256_SIZE));
1298 assert (buffer_offset == (part_size - payload_len));
1300 /* Check hash sum */
1301 memset (hash, 0, sizeof (hash));
1302 gcry_md_hash_buffer (GCRY_MD_SHA1, hash,
1303 buffer + buffer_offset, payload_len);
1304 if (memcmp (hash, pea.hash, sizeof (hash)) != 0)
1306 sfree (pea.username);
1307 ERROR ("network plugin: Decryption failed: Checksum mismatch.");
1311 parse_packet (se, buffer + buffer_offset, payload_len,
1312 flags | PP_ENCRYPTED, pea.username);
1314 /* XXX: Free pea.username?!? */
1316 /* Update return values */
1317 *ret_buffer = buffer + part_size;
1318 *ret_buffer_len = buffer_len - part_size;
1320 sfree (pea.username);
1323 } /* }}} int parse_part_encr_aes256 */
1324 /* #endif HAVE_LIBGCRYPT */
1326 #else /* if !HAVE_LIBGCRYPT */
1327 static int parse_part_encr_aes256 (sockent_t *se, /* {{{ */
1328 void **ret_buffer, size_t *ret_buffer_size, int flags)
1330 static int warning_has_been_printed = 0;
1334 size_t buffer_offset;
1339 buffer = *ret_buffer;
1340 buffer_size = *ret_buffer_size;
1343 /* parse_packet assures this minimum size. */
1344 assert (buffer_size >= (sizeof (ph.type) + sizeof (ph.length)));
1346 BUFFER_READ (&ph.type, sizeof (ph.type));
1347 BUFFER_READ (&ph.length, sizeof (ph.length));
1348 ph_length = ntohs (ph.length);
1350 if ((ph_length <= PART_ENCRYPTION_AES256_SIZE)
1351 || (ph_length > buffer_size))
1353 ERROR ("network plugin: AES-256 encrypted part "
1354 "with invalid length received.");
1358 if (warning_has_been_printed == 0)
1360 WARNING ("network plugin: Received encrypted packet, but the network "
1361 "plugin was not linked with libgcrypt, so I cannot "
1362 "decrypt it. The part will be discarded.");
1363 warning_has_been_printed = 1;
1366 *ret_buffer += ph_length;
1367 *ret_buffer_size -= ph_length;
1370 } /* }}} int parse_part_encr_aes256 */
1371 #endif /* !HAVE_LIBGCRYPT */
1375 static int parse_packet (sockent_t *se, /* {{{ */
1376 void *buffer, size_t buffer_size, int flags,
1377 const char *username)
1381 value_list_t vl = VALUE_LIST_INIT;
1385 int packet_was_signed = (flags & PP_SIGNED);
1386 int packet_was_encrypted = (flags & PP_ENCRYPTED);
1387 int printed_ignore_warning = 0;
1388 #endif /* HAVE_LIBGCRYPT */
1391 memset (&vl, '\0', sizeof (vl));
1392 memset (&n, '\0', sizeof (n));
1395 while ((status == 0) && (0 < buffer_size)
1396 && ((unsigned int) buffer_size > sizeof (part_header_t)))
1398 uint16_t pkg_length;
1401 memcpy ((void *) &pkg_type,
1404 memcpy ((void *) &pkg_length,
1405 (void *) (buffer + sizeof (pkg_type)),
1406 sizeof (pkg_length));
1408 pkg_length = ntohs (pkg_length);
1409 pkg_type = ntohs (pkg_type);
1411 if (pkg_length > buffer_size)
1413 /* Ensure that this loop terminates eventually */
1414 if (pkg_length < (2 * sizeof (uint16_t)))
1417 if (pkg_type == TYPE_ENCR_AES256)
1419 status = parse_part_encr_aes256 (se,
1420 &buffer, &buffer_size, flags);
1423 ERROR ("network plugin: Decrypting AES256 "
1425 "with status %i.", status);
1430 else if ((se->data.server.security_level == SECURITY_LEVEL_ENCRYPT)
1431 && (packet_was_encrypted == 0))
1433 if (printed_ignore_warning == 0)
1435 INFO ("network plugin: Unencrypted packet or "
1436 "part has been ignored.");
1437 printed_ignore_warning = 1;
1439 buffer = ((char *) buffer) + pkg_length;
1442 #endif /* HAVE_LIBGCRYPT */
1443 else if (pkg_type == TYPE_SIGN_SHA256)
1445 status = parse_part_sign_sha256 (se,
1446 &buffer, &buffer_size, flags);
1449 ERROR ("network plugin: Verifying HMAC-SHA-256 "
1451 "with status %i.", status);
1456 else if ((se->data.server.security_level == SECURITY_LEVEL_SIGN)
1457 && (packet_was_encrypted == 0)
1458 && (packet_was_signed == 0))
1460 if (printed_ignore_warning == 0)
1462 INFO ("network plugin: Unsigned packet or "
1463 "part has been ignored.");
1464 printed_ignore_warning = 1;
1466 buffer = ((char *) buffer) + pkg_length;
1469 #endif /* HAVE_LIBGCRYPT */
1470 else if (pkg_type == TYPE_VALUES)
1472 status = parse_part_values (&buffer, &buffer_size,
1473 &vl.values, &vl.values_len);
1477 network_dispatch_values (&vl, username);
1481 else if (pkg_type == TYPE_TIME)
1484 status = parse_part_number (&buffer, &buffer_size,
1488 vl.time = TIME_T_TO_CDTIME_T (tmp);
1489 n.time = TIME_T_TO_CDTIME_T (tmp);
1492 else if (pkg_type == TYPE_TIME_HR)
1495 status = parse_part_number (&buffer, &buffer_size,
1499 vl.time = (cdtime_t) tmp;
1500 n.time = (cdtime_t) tmp;
1503 else if (pkg_type == TYPE_INTERVAL)
1506 status = parse_part_number (&buffer, &buffer_size,
1509 vl.interval = TIME_T_TO_CDTIME_T (tmp);
1511 else if (pkg_type == TYPE_INTERVAL_HR)
1514 status = parse_part_number (&buffer, &buffer_size,
1517 vl.interval = (cdtime_t) tmp;
1519 else if (pkg_type == TYPE_HOST)
1521 status = parse_part_string (&buffer, &buffer_size,
1522 vl.host, sizeof (vl.host));
1524 sstrncpy (n.host, vl.host, sizeof (n.host));
1526 else if (pkg_type == TYPE_PLUGIN)
1528 status = parse_part_string (&buffer, &buffer_size,
1529 vl.plugin, sizeof (vl.plugin));
1531 sstrncpy (n.plugin, vl.plugin,
1534 else if (pkg_type == TYPE_PLUGIN_INSTANCE)
1536 status = parse_part_string (&buffer, &buffer_size,
1538 sizeof (vl.plugin_instance));
1540 sstrncpy (n.plugin_instance,
1542 sizeof (n.plugin_instance));
1544 else if (pkg_type == TYPE_TYPE)
1546 status = parse_part_string (&buffer, &buffer_size,
1547 vl.type, sizeof (vl.type));
1549 sstrncpy (n.type, vl.type, sizeof (n.type));
1551 else if (pkg_type == TYPE_TYPE_INSTANCE)
1553 status = parse_part_string (&buffer, &buffer_size,
1555 sizeof (vl.type_instance));
1557 sstrncpy (n.type_instance, vl.type_instance,
1558 sizeof (n.type_instance));
1560 else if (pkg_type == TYPE_MESSAGE)
1562 status = parse_part_string (&buffer, &buffer_size,
1563 n.message, sizeof (n.message));
1569 else if ((n.severity != NOTIF_FAILURE)
1570 && (n.severity != NOTIF_WARNING)
1571 && (n.severity != NOTIF_OKAY))
1573 INFO ("network plugin: "
1574 "Ignoring notification with "
1575 "unknown severity %i.",
1578 else if (n.time <= 0)
1580 INFO ("network plugin: "
1581 "Ignoring notification with "
1584 else if (strlen (n.message) <= 0)
1586 INFO ("network plugin: "
1587 "Ignoring notification with "
1588 "an empty message.");
1592 network_dispatch_notification (&n);
1595 else if (pkg_type == TYPE_SEVERITY)
1598 status = parse_part_number (&buffer, &buffer_size,
1601 n.severity = (int) tmp;
1605 DEBUG ("network plugin: parse_packet: Unknown part"
1606 " type: 0x%04hx", pkg_type);
1607 buffer = ((char *) buffer) + pkg_length;
1609 } /* while (buffer_size > sizeof (part_header_t)) */
1611 if (status == 0 && buffer_size > 0)
1612 WARNING ("network plugin: parse_packet: Received truncated "
1613 "packet, try increasing `MaxPacketSize'");
1616 } /* }}} int parse_packet */
1618 static void free_sockent_client (struct sockent_client *sec) /* {{{ */
1627 sfree (sec->username);
1628 sfree (sec->password);
1629 if (sec->cypher != NULL)
1630 gcry_cipher_close (sec->cypher);
1632 } /* }}} void free_sockent_client */
1634 static void free_sockent_server (struct sockent_server *ses) /* {{{ */
1638 for (i = 0; i < ses->fd_num; i++)
1640 if (ses->fd[i] >= 0)
1649 sfree (ses->auth_file);
1650 fbh_destroy (ses->userdb);
1651 if (ses->cypher != NULL)
1652 gcry_cipher_close (ses->cypher);
1654 } /* }}} void free_sockent_server */
1656 static void sockent_destroy (sockent_t *se) /* {{{ */
1660 DEBUG ("network plugin: sockent_destroy (se = %p);", (void *) se);
1667 sfree (se->service);
1669 if (se->type == SOCKENT_TYPE_CLIENT)
1670 free_sockent_client (&se->data.client);
1672 free_sockent_server (&se->data.server);
1677 } /* }}} void sockent_destroy */
1680 * int network_set_ttl
1682 * Set the `IP_MULTICAST_TTL', `IP_TTL', `IPV6_MULTICAST_HOPS' or
1683 * `IPV6_UNICAST_HOPS', depending on which option is applicable.
1685 * The `struct addrinfo' is used to destinguish between unicast and multicast
1688 static int network_set_ttl (const sockent_t *se, const struct addrinfo *ai)
1690 DEBUG ("network plugin: network_set_ttl: network_config_ttl = %i;",
1691 network_config_ttl);
1693 assert (se->type == SOCKENT_TYPE_CLIENT);
1695 if ((network_config_ttl < 1) || (network_config_ttl > 255))
1698 if (ai->ai_family == AF_INET)
1700 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
1703 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
1704 optname = IP_MULTICAST_TTL;
1708 if (setsockopt (se->data.client.fd, IPPROTO_IP, optname,
1709 &network_config_ttl,
1710 sizeof (network_config_ttl)) != 0)
1713 ERROR ("network plugin: setsockopt (ipv4-ttl): %s",
1714 sstrerror (errno, errbuf, sizeof (errbuf)));
1718 else if (ai->ai_family == AF_INET6)
1720 /* Useful example: http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
1721 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
1724 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
1725 optname = IPV6_MULTICAST_HOPS;
1727 optname = IPV6_UNICAST_HOPS;
1729 if (setsockopt (se->data.client.fd, IPPROTO_IPV6, optname,
1730 &network_config_ttl,
1731 sizeof (network_config_ttl)) != 0)
1734 ERROR ("network plugin: setsockopt(ipv6-ttl): %s",
1735 sstrerror (errno, errbuf,
1742 } /* int network_set_ttl */
1744 static int network_set_interface (const sockent_t *se, const struct addrinfo *ai) /* {{{ */
1746 DEBUG ("network plugin: network_set_interface: interface index = %i;",
1749 assert (se->type == SOCKENT_TYPE_CLIENT);
1751 if (ai->ai_family == AF_INET)
1753 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
1755 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
1757 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1758 /* If possible, use the "ip_mreqn" structure which has
1759 * an "interface index" member. Using the interface
1760 * index is preferred here, because of its similarity
1761 * to the way IPv6 handles this. Unfortunately, it
1762 * appears not to be portable. */
1763 struct ip_mreqn mreq;
1765 memset (&mreq, 0, sizeof (mreq));
1766 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1767 mreq.imr_address.s_addr = ntohl (INADDR_ANY);
1768 mreq.imr_ifindex = se->interface;
1770 struct ip_mreq mreq;
1772 memset (&mreq, 0, sizeof (mreq));
1773 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1774 mreq.imr_interface.s_addr = ntohl (INADDR_ANY);
1777 if (setsockopt (se->data.client.fd, IPPROTO_IP, IP_MULTICAST_IF,
1778 &mreq, sizeof (mreq)) != 0)
1781 ERROR ("network plugin: setsockopt (ipv4-multicast-if): %s",
1782 sstrerror (errno, errbuf, sizeof (errbuf)));
1789 else if (ai->ai_family == AF_INET6)
1791 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
1793 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
1795 if (setsockopt (se->data.client.fd, IPPROTO_IPV6, IPV6_MULTICAST_IF,
1797 sizeof (se->interface)) != 0)
1800 ERROR ("network plugin: setsockopt (ipv6-multicast-if): %s",
1801 sstrerror (errno, errbuf,
1810 /* else: Not a multicast interface. */
1811 if (se->interface != 0)
1813 #if defined(HAVE_IF_INDEXTONAME) && HAVE_IF_INDEXTONAME && defined(SO_BINDTODEVICE)
1814 char interface_name[IFNAMSIZ];
1816 if (if_indextoname (se->interface, interface_name) == NULL)
1819 DEBUG ("network plugin: Binding socket to interface %s", interface_name);
1821 if (setsockopt (se->data.client.fd, SOL_SOCKET, SO_BINDTODEVICE,
1823 sizeof(interface_name)) == -1 )
1826 ERROR ("network plugin: setsockopt (bind-if): %s",
1827 sstrerror (errno, errbuf, sizeof (errbuf)));
1830 /* #endif HAVE_IF_INDEXTONAME && SO_BINDTODEVICE */
1833 WARNING ("network plugin: Cannot set the interface on a unicast "
1835 # if !defined(SO_BINDTODEVICE)
1836 "the \"SO_BINDTODEVICE\" socket option "
1838 "the \"if_indextoname\" function "
1840 "is not available on your system.");
1846 } /* }}} network_set_interface */
1848 static int network_bind_socket (int fd, const struct addrinfo *ai, const int interface_idx)
1857 /* allow multiple sockets to use the same PORT number */
1858 if (setsockopt (fd, SOL_SOCKET, SO_REUSEADDR,
1859 &yes, sizeof(yes)) == -1) {
1861 ERROR ("network plugin: setsockopt (reuseaddr): %s",
1862 sstrerror (errno, errbuf, sizeof (errbuf)));
1866 DEBUG ("fd = %i; calling `bind'", fd);
1868 if (bind (fd, ai->ai_addr, ai->ai_addrlen) == -1)
1872 sstrerror (errno, errbuf, sizeof (errbuf)));
1876 if (ai->ai_family == AF_INET)
1878 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
1879 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
1881 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1882 struct ip_mreqn mreq;
1884 struct ip_mreq mreq;
1887 DEBUG ("fd = %i; IPv4 multicast address found", fd);
1889 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1890 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1891 /* Set the interface using the interface index if
1892 * possible (available). Unfortunately, the struct
1893 * ip_mreqn is not portable. */
1894 mreq.imr_address.s_addr = ntohl (INADDR_ANY);
1895 mreq.imr_ifindex = interface_idx;
1897 mreq.imr_interface.s_addr = ntohl (INADDR_ANY);
1900 if (setsockopt (fd, IPPROTO_IP, IP_MULTICAST_LOOP,
1901 &loop, sizeof (loop)) == -1)
1904 ERROR ("network plugin: setsockopt (multicast-loop): %s",
1905 sstrerror (errno, errbuf,
1910 if (setsockopt (fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
1911 &mreq, sizeof (mreq)) == -1)
1914 ERROR ("network plugin: setsockopt (add-membership): %s",
1915 sstrerror (errno, errbuf,
1923 else if (ai->ai_family == AF_INET6)
1925 /* Useful example: http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
1926 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
1927 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
1929 struct ipv6_mreq mreq;
1931 DEBUG ("fd = %i; IPv6 multicast address found", fd);
1933 memcpy (&mreq.ipv6mr_multiaddr,
1935 sizeof (addr->sin6_addr));
1937 /* http://developer.apple.com/documentation/Darwin/Reference/ManPages/man4/ip6.4.html
1938 * ipv6mr_interface may be set to zeroes to
1939 * choose the default multicast interface or to
1940 * the index of a particular multicast-capable
1941 * interface if the host is multihomed.
1942 * Membership is associ-associated with a
1943 * single interface; programs running on
1944 * multihomed hosts may need to join the same
1945 * group on more than one interface.*/
1946 mreq.ipv6mr_interface = interface_idx;
1948 if (setsockopt (fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP,
1949 &loop, sizeof (loop)) == -1)
1952 ERROR ("network plugin: setsockopt (ipv6-multicast-loop): %s",
1953 sstrerror (errno, errbuf,
1958 if (setsockopt (fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP,
1959 &mreq, sizeof (mreq)) == -1)
1962 ERROR ("network plugin: setsockopt (ipv6-add-membership): %s",
1963 sstrerror (errno, errbuf,
1972 #if defined(HAVE_IF_INDEXTONAME) && HAVE_IF_INDEXTONAME && defined(SO_BINDTODEVICE)
1973 /* if a specific interface was set, bind the socket to it. But to avoid
1974 * possible problems with multicast routing, only do that for non-multicast
1976 if (interface_idx != 0)
1978 char interface_name[IFNAMSIZ];
1980 if (if_indextoname (interface_idx, interface_name) == NULL)
1983 DEBUG ("fd = %i; Binding socket to interface %s", fd, interface_name);
1985 if (setsockopt (fd, SOL_SOCKET, SO_BINDTODEVICE,
1987 sizeof(interface_name)) == -1 )
1990 ERROR ("network plugin: setsockopt (bind-if): %s",
1991 sstrerror (errno, errbuf, sizeof (errbuf)));
1995 #endif /* HAVE_IF_INDEXTONAME && SO_BINDTODEVICE */
1998 } /* int network_bind_socket */
2000 /* Initialize a sockent structure. `type' must be either `SOCKENT_TYPE_CLIENT'
2001 * or `SOCKENT_TYPE_SERVER' */
2002 static int sockent_init (sockent_t *se, int type) /* {{{ */
2007 memset (se, 0, sizeof (*se));
2009 se->type = SOCKENT_TYPE_CLIENT;
2015 if (type == SOCKENT_TYPE_SERVER)
2017 se->type = SOCKENT_TYPE_SERVER;
2018 se->data.server.fd = NULL;
2020 se->data.server.security_level = SECURITY_LEVEL_NONE;
2021 se->data.server.auth_file = NULL;
2022 se->data.server.userdb = NULL;
2023 se->data.server.cypher = NULL;
2028 se->data.client.fd = -1;
2029 se->data.client.addr = NULL;
2031 se->data.client.security_level = SECURITY_LEVEL_NONE;
2032 se->data.client.username = NULL;
2033 se->data.client.password = NULL;
2034 se->data.client.cypher = NULL;
2039 } /* }}} int sockent_init */
2041 /* Open the file descriptors for a initialized sockent structure. */
2042 static int sockent_open (sockent_t *se) /* {{{ */
2044 struct addrinfo ai_hints;
2045 struct addrinfo *ai_list, *ai_ptr;
2049 const char *service;
2054 /* Set up the security structures. */
2055 #if HAVE_LIBGCRYPT /* {{{ */
2056 if (se->type == SOCKENT_TYPE_CLIENT)
2058 if (se->data.client.security_level > SECURITY_LEVEL_NONE)
2060 network_init_gcrypt ();
2062 if ((se->data.client.username == NULL)
2063 || (se->data.client.password == NULL))
2065 ERROR ("network plugin: Client socket with "
2066 "security requested, but no "
2067 "credentials are configured.");
2070 gcry_md_hash_buffer (GCRY_MD_SHA256,
2071 se->data.client.password_hash,
2072 se->data.client.password,
2073 strlen (se->data.client.password));
2076 else /* (se->type == SOCKENT_TYPE_SERVER) */
2078 if (se->data.server.security_level > SECURITY_LEVEL_NONE)
2080 network_init_gcrypt ();
2082 if (se->data.server.auth_file == NULL)
2084 ERROR ("network plugin: Server socket with "
2085 "security requested, but no "
2086 "password file is configured.");
2090 if (se->data.server.auth_file != NULL)
2092 se->data.server.userdb = fbh_create (se->data.server.auth_file);
2093 if (se->data.server.userdb == NULL)
2095 ERROR ("network plugin: Reading password file "
2097 se->data.server.auth_file);
2098 if (se->data.server.security_level > SECURITY_LEVEL_NONE)
2103 #endif /* }}} HAVE_LIBGCRYPT */
2106 service = se->service;
2108 if (service == NULL)
2109 service = NET_DEFAULT_PORT;
2111 DEBUG ("network plugin: sockent_open: node = %s; service = %s;",
2114 memset (&ai_hints, 0, sizeof (ai_hints));
2115 ai_hints.ai_flags = 0;
2117 ai_hints.ai_flags |= AI_PASSIVE;
2119 #ifdef AI_ADDRCONFIG
2120 ai_hints.ai_flags |= AI_ADDRCONFIG;
2122 ai_hints.ai_family = AF_UNSPEC;
2123 ai_hints.ai_socktype = SOCK_DGRAM;
2124 ai_hints.ai_protocol = IPPROTO_UDP;
2126 ai_return = getaddrinfo (node, service, &ai_hints, &ai_list);
2129 ERROR ("network plugin: getaddrinfo (%s, %s) failed: %s",
2130 (se->node == NULL) ? "(null)" : se->node,
2131 (se->service == NULL) ? "(null)" : se->service,
2132 gai_strerror (ai_return));
2136 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
2140 if (se->type == SOCKENT_TYPE_SERVER) /* {{{ */
2144 tmp = realloc (se->data.server.fd,
2145 sizeof (*tmp) * (se->data.server.fd_num + 1));
2148 ERROR ("network plugin: realloc failed.");
2151 se->data.server.fd = tmp;
2152 tmp = se->data.server.fd + se->data.server.fd_num;
2154 *tmp = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
2155 ai_ptr->ai_protocol);
2159 ERROR ("network plugin: socket(2) failed: %s",
2160 sstrerror (errno, errbuf,
2165 status = network_bind_socket (*tmp, ai_ptr, se->interface);
2173 se->data.server.fd_num++;
2175 } /* }}} if (se->type == SOCKENT_TYPE_SERVER) */
2176 else /* if (se->type == SOCKENT_TYPE_CLIENT) {{{ */
2178 se->data.client.fd = socket (ai_ptr->ai_family,
2179 ai_ptr->ai_socktype,
2180 ai_ptr->ai_protocol);
2181 if (se->data.client.fd < 0)
2184 ERROR ("network plugin: socket(2) failed: %s",
2185 sstrerror (errno, errbuf,
2190 se->data.client.addr = malloc (sizeof (*se->data.client.addr));
2191 if (se->data.client.addr == NULL)
2193 ERROR ("network plugin: malloc failed.");
2194 close (se->data.client.fd);
2195 se->data.client.fd = -1;
2199 memset (se->data.client.addr, 0, sizeof (*se->data.client.addr));
2200 assert (sizeof (*se->data.client.addr) >= ai_ptr->ai_addrlen);
2201 memcpy (se->data.client.addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
2202 se->data.client.addrlen = ai_ptr->ai_addrlen;
2204 network_set_ttl (se, ai_ptr);
2205 network_set_interface (se, ai_ptr);
2207 /* We don't open more than one write-socket per
2208 * node/service pair.. */
2210 } /* }}} if (se->type == SOCKENT_TYPE_CLIENT) */
2211 } /* for (ai_list) */
2213 freeaddrinfo (ai_list);
2215 /* Check if all went well. */
2216 if (se->type == SOCKENT_TYPE_SERVER)
2218 if (se->data.server.fd_num <= 0)
2221 else /* if (se->type == SOCKENT_TYPE_CLIENT) */
2223 if (se->data.client.fd < 0)
2228 } /* }}} int sockent_open */
2230 /* Add a sockent to the global list of sockets */
2231 static int sockent_add (sockent_t *se) /* {{{ */
2233 sockent_t *last_ptr;
2238 if (se->type == SOCKENT_TYPE_SERVER)
2243 tmp = realloc (listen_sockets_pollfd,
2244 sizeof (*tmp) * (listen_sockets_num
2245 + se->data.server.fd_num));
2248 ERROR ("network plugin: realloc failed.");
2251 listen_sockets_pollfd = tmp;
2252 tmp = listen_sockets_pollfd + listen_sockets_num;
2254 for (i = 0; i < se->data.server.fd_num; i++)
2256 memset (tmp + i, 0, sizeof (*tmp));
2257 tmp[i].fd = se->data.server.fd[i];
2258 tmp[i].events = POLLIN | POLLPRI;
2262 listen_sockets_num += se->data.server.fd_num;
2264 if (listen_sockets == NULL)
2266 listen_sockets = se;
2269 last_ptr = listen_sockets;
2271 else /* if (se->type == SOCKENT_TYPE_CLIENT) */
2273 if (sending_sockets == NULL)
2275 sending_sockets = se;
2278 last_ptr = sending_sockets;
2281 while (last_ptr->next != NULL)
2282 last_ptr = last_ptr->next;
2283 last_ptr->next = se;
2286 } /* }}} int sockent_add */
2288 static void *dispatch_thread (void __attribute__((unused)) *arg) /* {{{ */
2292 receive_list_entry_t *ent;
2295 /* Lock and wait for more data to come in */
2296 pthread_mutex_lock (&receive_list_lock);
2297 while ((listen_loop == 0)
2298 && (receive_list_head == NULL))
2299 pthread_cond_wait (&receive_list_cond, &receive_list_lock);
2301 /* Remove the head entry and unlock */
2302 ent = receive_list_head;
2304 receive_list_head = ent->next;
2305 receive_list_length--;
2306 pthread_mutex_unlock (&receive_list_lock);
2308 /* Check whether we are supposed to exit. We do NOT check `listen_loop'
2309 * because we dispatch all missing packets before shutting down. */
2313 /* Look for the correct `sockent_t' */
2314 se = listen_sockets;
2319 for (i = 0; i < se->data.server.fd_num; i++)
2320 if (se->data.server.fd[i] == ent->fd)
2323 if (i < se->data.server.fd_num)
2331 ERROR ("network plugin: Got packet from FD %i, but can't "
2332 "find an appropriate socket entry.",
2339 parse_packet (se, ent->data, ent->data_len, /* flags = */ 0,
2340 /* username = */ NULL);
2346 } /* }}} void *dispatch_thread */
2348 static int network_receive (void) /* {{{ */
2350 char buffer[network_config_packet_size];
2356 receive_list_entry_t *private_list_head;
2357 receive_list_entry_t *private_list_tail;
2358 uint64_t private_list_length;
2360 assert (listen_sockets_num > 0);
2362 private_list_head = NULL;
2363 private_list_tail = NULL;
2364 private_list_length = 0;
2366 while (listen_loop == 0)
2368 status = poll (listen_sockets_pollfd, listen_sockets_num, -1);
2375 ERROR ("poll failed: %s",
2376 sstrerror (errno, errbuf, sizeof (errbuf)));
2380 for (i = 0; (i < listen_sockets_num) && (status > 0); i++)
2382 receive_list_entry_t *ent;
2384 if ((listen_sockets_pollfd[i].revents
2385 & (POLLIN | POLLPRI)) == 0)
2389 buffer_len = recv (listen_sockets_pollfd[i].fd,
2390 buffer, sizeof (buffer),
2395 ERROR ("recv failed: %s",
2396 sstrerror (errno, errbuf,
2401 stats_octets_rx += ((uint64_t) buffer_len);
2404 /* TODO: Possible performance enhancement: Do not free
2405 * these entries in the dispatch thread but put them in
2406 * another list, so we don't have to allocate more and
2407 * more of these structures. */
2408 ent = malloc (sizeof (receive_list_entry_t));
2411 ERROR ("network plugin: malloc failed.");
2414 memset (ent, 0, sizeof (receive_list_entry_t));
2415 ent->data = malloc (network_config_packet_size);
2416 if (ent->data == NULL)
2419 ERROR ("network plugin: malloc failed.");
2422 ent->fd = listen_sockets_pollfd[i].fd;
2425 memcpy (ent->data, buffer, buffer_len);
2426 ent->data_len = buffer_len;
2428 if (private_list_head == NULL)
2429 private_list_head = ent;
2431 private_list_tail->next = ent;
2432 private_list_tail = ent;
2433 private_list_length++;
2435 /* Do not block here. Blocking here has led to
2436 * insufficient performance in the past. */
2437 if (pthread_mutex_trylock (&receive_list_lock) == 0)
2439 assert (((receive_list_head == NULL) && (receive_list_length == 0))
2440 || ((receive_list_head != NULL) && (receive_list_length != 0)));
2442 if (receive_list_head == NULL)
2443 receive_list_head = private_list_head;
2445 receive_list_tail->next = private_list_head;
2446 receive_list_tail = private_list_tail;
2447 receive_list_length += private_list_length;
2449 pthread_cond_signal (&receive_list_cond);
2450 pthread_mutex_unlock (&receive_list_lock);
2452 private_list_head = NULL;
2453 private_list_tail = NULL;
2454 private_list_length = 0;
2456 } /* for (listen_sockets_pollfd) */
2457 } /* while (listen_loop == 0) */
2459 /* Make sure everything is dispatched before exiting. */
2460 if (private_list_head != NULL)
2462 pthread_mutex_lock (&receive_list_lock);
2464 if (receive_list_head == NULL)
2465 receive_list_head = private_list_head;
2467 receive_list_tail->next = private_list_head;
2468 receive_list_tail = private_list_tail;
2469 receive_list_length += private_list_length;
2471 private_list_head = NULL;
2472 private_list_tail = NULL;
2473 private_list_length = 0;
2475 pthread_cond_signal (&receive_list_cond);
2476 pthread_mutex_unlock (&receive_list_lock);
2480 } /* }}} int network_receive */
2482 static void *receive_thread (void __attribute__((unused)) *arg)
2484 return (network_receive () ? (void *) 1 : (void *) 0);
2485 } /* void *receive_thread */
2487 static void network_init_buffer (void)
2489 memset (send_buffer, 0, network_config_packet_size);
2490 send_buffer_ptr = send_buffer;
2491 send_buffer_fill = 0;
2493 memset (&send_buffer_vl, 0, sizeof (send_buffer_vl));
2494 } /* int network_init_buffer */
2496 static void networt_send_buffer_plain (const sockent_t *se, /* {{{ */
2497 const char *buffer, size_t buffer_size)
2503 status = sendto (se->data.client.fd, buffer, buffer_size,
2505 (struct sockaddr *) se->data.client.addr,
2506 se->data.client.addrlen);
2512 ERROR ("network plugin: sendto failed: %s",
2513 sstrerror (errno, errbuf,
2520 } /* }}} void networt_send_buffer_plain */
2523 #define BUFFER_ADD(p,s) do { \
2524 memcpy (buffer + buffer_offset, (p), (s)); \
2525 buffer_offset += (s); \
2528 static void networt_send_buffer_signed (const sockent_t *se, /* {{{ */
2529 const char *in_buffer, size_t in_buffer_size)
2531 part_signature_sha256_t ps;
2532 char buffer[BUFF_SIG_SIZE + in_buffer_size];
2533 size_t buffer_offset;
2534 size_t username_len;
2538 unsigned char *hash;
2541 err = gcry_md_open (&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
2544 ERROR ("network plugin: Creating HMAC object failed: %s",
2545 gcry_strerror (err));
2549 err = gcry_md_setkey (hd, se->data.client.password,
2550 strlen (se->data.client.password));
2553 ERROR ("network plugin: gcry_md_setkey failed: %s",
2554 gcry_strerror (err));
2559 username_len = strlen (se->data.client.username);
2560 if (username_len > (BUFF_SIG_SIZE - PART_SIGNATURE_SHA256_SIZE))
2562 ERROR ("network plugin: Username too long: %s",
2563 se->data.client.username);
2567 memcpy (buffer + PART_SIGNATURE_SHA256_SIZE,
2568 se->data.client.username, username_len);
2569 memcpy (buffer + PART_SIGNATURE_SHA256_SIZE + username_len,
2570 in_buffer, in_buffer_size);
2572 /* Initialize the `ps' structure. */
2573 memset (&ps, 0, sizeof (ps));
2574 ps.head.type = htons (TYPE_SIGN_SHA256);
2575 ps.head.length = htons (PART_SIGNATURE_SHA256_SIZE + username_len);
2577 /* Calculate the hash value. */
2578 gcry_md_write (hd, buffer + PART_SIGNATURE_SHA256_SIZE,
2579 username_len + in_buffer_size);
2580 hash = gcry_md_read (hd, GCRY_MD_SHA256);
2583 ERROR ("network plugin: gcry_md_read failed.");
2587 memcpy (ps.hash, hash, sizeof (ps.hash));
2589 /* Add the header */
2592 BUFFER_ADD (&ps.head.type, sizeof (ps.head.type));
2593 BUFFER_ADD (&ps.head.length, sizeof (ps.head.length));
2594 BUFFER_ADD (ps.hash, sizeof (ps.hash));
2596 assert (buffer_offset == PART_SIGNATURE_SHA256_SIZE);
2601 buffer_offset = PART_SIGNATURE_SHA256_SIZE + username_len + in_buffer_size;
2602 networt_send_buffer_plain (se, buffer, buffer_offset);
2603 } /* }}} void networt_send_buffer_signed */
2605 static void networt_send_buffer_encrypted (sockent_t *se, /* {{{ */
2606 const char *in_buffer, size_t in_buffer_size)
2608 part_encryption_aes256_t pea;
2609 char buffer[BUFF_SIG_SIZE + in_buffer_size];
2611 size_t buffer_offset;
2613 size_t username_len;
2615 gcry_cipher_hd_t cypher;
2617 /* Initialize the header fields */
2618 memset (&pea, 0, sizeof (pea));
2619 pea.head.type = htons (TYPE_ENCR_AES256);
2621 pea.username = se->data.client.username;
2623 username_len = strlen (pea.username);
2624 if ((PART_ENCRYPTION_AES256_SIZE + username_len) > BUFF_SIG_SIZE)
2626 ERROR ("network plugin: Username too long: %s", pea.username);
2630 buffer_size = PART_ENCRYPTION_AES256_SIZE + username_len + in_buffer_size;
2631 header_size = PART_ENCRYPTION_AES256_SIZE + username_len
2632 - sizeof (pea.hash);
2634 assert (buffer_size <= sizeof (buffer));
2635 DEBUG ("network plugin: networt_send_buffer_encrypted: "
2636 "buffer_size = %zu;", buffer_size);
2638 pea.head.length = htons ((uint16_t) (PART_ENCRYPTION_AES256_SIZE
2639 + username_len + in_buffer_size));
2640 pea.username_length = htons ((uint16_t) username_len);
2642 /* Chose a random initialization vector. */
2643 gcry_randomize ((void *) &pea.iv, sizeof (pea.iv), GCRY_STRONG_RANDOM);
2645 /* Create hash of the payload */
2646 gcry_md_hash_buffer (GCRY_MD_SHA1, pea.hash, in_buffer, in_buffer_size);
2648 /* Initialize the buffer */
2650 memset (buffer, 0, sizeof (buffer));
2653 BUFFER_ADD (&pea.head.type, sizeof (pea.head.type));
2654 BUFFER_ADD (&pea.head.length, sizeof (pea.head.length));
2655 BUFFER_ADD (&pea.username_length, sizeof (pea.username_length));
2656 BUFFER_ADD (pea.username, username_len);
2657 BUFFER_ADD (pea.iv, sizeof (pea.iv));
2658 assert (buffer_offset == header_size);
2659 BUFFER_ADD (pea.hash, sizeof (pea.hash));
2660 BUFFER_ADD (in_buffer, in_buffer_size);
2662 assert (buffer_offset == buffer_size);
2664 cypher = network_get_aes256_cypher (se, pea.iv, sizeof (pea.iv),
2665 se->data.client.password);
2669 /* Encrypt the buffer in-place */
2670 err = gcry_cipher_encrypt (cypher,
2671 buffer + header_size,
2672 buffer_size - header_size,
2673 /* in = */ NULL, /* in len = */ 0);
2676 ERROR ("network plugin: gcry_cipher_encrypt returned: %s",
2677 gcry_strerror (err));
2681 /* Send it out without further modifications */
2682 networt_send_buffer_plain (se, buffer, buffer_size);
2683 } /* }}} void networt_send_buffer_encrypted */
2685 #endif /* HAVE_LIBGCRYPT */
2687 static void network_send_buffer (char *buffer, size_t buffer_len) /* {{{ */
2691 DEBUG ("network plugin: network_send_buffer: buffer_len = %zu", buffer_len);
2693 for (se = sending_sockets; se != NULL; se = se->next)
2696 if (se->data.client.security_level == SECURITY_LEVEL_ENCRYPT)
2697 networt_send_buffer_encrypted (se, buffer, buffer_len);
2698 else if (se->data.client.security_level == SECURITY_LEVEL_SIGN)
2699 networt_send_buffer_signed (se, buffer, buffer_len);
2700 else /* if (se->data.client.security_level == SECURITY_LEVEL_NONE) */
2701 #endif /* HAVE_LIBGCRYPT */
2702 networt_send_buffer_plain (se, buffer, buffer_len);
2703 } /* for (sending_sockets) */
2704 } /* }}} void network_send_buffer */
2706 static int add_to_buffer (char *buffer, int buffer_size, /* {{{ */
2707 value_list_t *vl_def,
2708 const data_set_t *ds, const value_list_t *vl)
2710 char *buffer_orig = buffer;
2712 if (strcmp (vl_def->host, vl->host) != 0)
2714 if (write_part_string (&buffer, &buffer_size, TYPE_HOST,
2715 vl->host, strlen (vl->host)) != 0)
2717 sstrncpy (vl_def->host, vl->host, sizeof (vl_def->host));
2720 if (vl_def->time != vl->time)
2722 if (write_part_number (&buffer, &buffer_size, TYPE_TIME_HR,
2723 (uint64_t) vl->time))
2725 vl_def->time = vl->time;
2728 if (vl_def->interval != vl->interval)
2730 if (write_part_number (&buffer, &buffer_size, TYPE_INTERVAL_HR,
2731 (uint64_t) vl->interval))
2733 vl_def->interval = vl->interval;
2736 if (strcmp (vl_def->plugin, vl->plugin) != 0)
2738 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN,
2739 vl->plugin, strlen (vl->plugin)) != 0)
2741 sstrncpy (vl_def->plugin, vl->plugin, sizeof (vl_def->plugin));
2744 if (strcmp (vl_def->plugin_instance, vl->plugin_instance) != 0)
2746 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE,
2747 vl->plugin_instance,
2748 strlen (vl->plugin_instance)) != 0)
2750 sstrncpy (vl_def->plugin_instance, vl->plugin_instance, sizeof (vl_def->plugin_instance));
2753 if (strcmp (vl_def->type, vl->type) != 0)
2755 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE,
2756 vl->type, strlen (vl->type)) != 0)
2758 sstrncpy (vl_def->type, ds->type, sizeof (vl_def->type));
2761 if (strcmp (vl_def->type_instance, vl->type_instance) != 0)
2763 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE_INSTANCE,
2765 strlen (vl->type_instance)) != 0)
2767 sstrncpy (vl_def->type_instance, vl->type_instance, sizeof (vl_def->type_instance));
2770 if (write_part_values (&buffer, &buffer_size, ds, vl) != 0)
2773 return (buffer - buffer_orig);
2774 } /* }}} int add_to_buffer */
2776 static void flush_buffer (void)
2778 DEBUG ("network plugin: flush_buffer: send_buffer_fill = %i",
2781 network_send_buffer (send_buffer, (size_t) send_buffer_fill);
2783 stats_octets_tx += ((uint64_t) send_buffer_fill);
2786 network_init_buffer ();
2789 static int network_write (const data_set_t *ds, const value_list_t *vl,
2790 user_data_t __attribute__((unused)) *user_data)
2794 if (!check_send_okay (vl))
2797 char name[6*DATA_MAX_NAME_LEN];
2798 FORMAT_VL (name, sizeof (name), vl);
2799 name[sizeof (name) - 1] = 0;
2800 DEBUG ("network plugin: network_write: "
2801 "NOT sending %s.", name);
2803 /* Counter is not protected by another lock and may be reached by
2804 * multiple threads */
2805 pthread_mutex_lock (&stats_lock);
2806 stats_values_not_sent++;
2807 pthread_mutex_unlock (&stats_lock);
2811 uc_meta_data_add_unsigned_int (vl,
2812 "network:time_sent", (uint64_t) vl->time);
2814 pthread_mutex_lock (&send_buffer_lock);
2816 status = add_to_buffer (send_buffer_ptr,
2817 network_config_packet_size - (send_buffer_fill + BUFF_SIG_SIZE),
2822 /* status == bytes added to the buffer */
2823 send_buffer_fill += status;
2824 send_buffer_ptr += status;
2826 stats_values_sent++;
2832 status = add_to_buffer (send_buffer_ptr,
2833 network_config_packet_size - (send_buffer_fill + BUFF_SIG_SIZE),
2839 send_buffer_fill += status;
2840 send_buffer_ptr += status;
2842 stats_values_sent++;
2848 ERROR ("network plugin: Unable to append to the "
2849 "buffer for some weird reason");
2851 else if ((network_config_packet_size - send_buffer_fill) < 15)
2856 pthread_mutex_unlock (&send_buffer_lock);
2858 return ((status < 0) ? -1 : 0);
2859 } /* int network_write */
2861 static int network_config_set_boolean (const oconfig_item_t *ci, /* {{{ */
2864 if ((ci->values_num != 1)
2865 || ((ci->values[0].type != OCONFIG_TYPE_BOOLEAN)
2866 && (ci->values[0].type != OCONFIG_TYPE_STRING)))
2868 ERROR ("network plugin: The `%s' config option needs "
2869 "exactly one boolean argument.", ci->key);
2873 if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
2875 if (ci->values[0].value.boolean)
2882 char *str = ci->values[0].value.string;
2886 else if (IS_FALSE (str))
2890 ERROR ("network plugin: Cannot parse string value `%s' of the `%s' "
2891 "option as boolean value.",
2898 } /* }}} int network_config_set_boolean */
2900 static int network_config_set_ttl (const oconfig_item_t *ci) /* {{{ */
2903 if ((ci->values_num != 1)
2904 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
2906 WARNING ("network plugin: The `TimeToLive' config option needs exactly "
2907 "one numeric argument.");
2911 tmp = (int) ci->values[0].value.number;
2912 if ((tmp > 0) && (tmp <= 255))
2913 network_config_ttl = tmp;
2915 WARNING ("network plugin: The `TimeToLive' must be between 1 and 255.");
2920 } /* }}} int network_config_set_ttl */
2922 static int network_config_set_interface (const oconfig_item_t *ci, /* {{{ */
2925 if ((ci->values_num != 1)
2926 || (ci->values[0].type != OCONFIG_TYPE_STRING))
2928 WARNING ("network plugin: The `Interface' config option needs exactly "
2929 "one string argument.");
2933 if (interface == NULL)
2936 *interface = if_nametoindex (ci->values[0].value.string);
2939 } /* }}} int network_config_set_interface */
2941 static int network_config_set_buffer_size (const oconfig_item_t *ci) /* {{{ */
2944 if ((ci->values_num != 1)
2945 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
2947 WARNING ("network plugin: The `MaxPacketSize' config option needs exactly "
2948 "one numeric argument.");
2952 tmp = (int) ci->values[0].value.number;
2953 if ((tmp >= 1024) && (tmp <= 65535))
2954 network_config_packet_size = tmp;
2957 } /* }}} int network_config_set_buffer_size */
2960 static int network_config_set_string (const oconfig_item_t *ci, /* {{{ */
2964 if ((ci->values_num != 1)
2965 || (ci->values[0].type != OCONFIG_TYPE_STRING))
2967 WARNING ("network plugin: The `%s' config option needs exactly "
2968 "one string argument.", ci->key);
2972 tmp = strdup (ci->values[0].value.string);
2976 sfree (*ret_string);
2980 } /* }}} int network_config_set_string */
2981 #endif /* HAVE_LIBGCRYPT */
2984 static int network_config_set_security_level (oconfig_item_t *ci, /* {{{ */
2988 if ((ci->values_num != 1)
2989 || (ci->values[0].type != OCONFIG_TYPE_STRING))
2991 WARNING ("network plugin: The `SecurityLevel' config option needs exactly "
2992 "one string argument.");
2996 str = ci->values[0].value.string;
2997 if (strcasecmp ("Encrypt", str) == 0)
2998 *retval = SECURITY_LEVEL_ENCRYPT;
2999 else if (strcasecmp ("Sign", str) == 0)
3000 *retval = SECURITY_LEVEL_SIGN;
3001 else if (strcasecmp ("None", str) == 0)
3002 *retval = SECURITY_LEVEL_NONE;
3005 WARNING ("network plugin: Unknown security level: %s.", str);
3010 } /* }}} int network_config_set_security_level */
3011 #endif /* HAVE_LIBGCRYPT */
3013 static int network_config_add_listen (const oconfig_item_t *ci) /* {{{ */
3019 if ((ci->values_num < 1) || (ci->values_num > 2)
3020 || (ci->values[0].type != OCONFIG_TYPE_STRING)
3021 || ((ci->values_num > 1) && (ci->values[1].type != OCONFIG_TYPE_STRING)))
3023 ERROR ("network plugin: The `%s' config option needs "
3024 "one or two string arguments.", ci->key);
3028 se = malloc (sizeof (*se));
3031 ERROR ("network plugin: malloc failed.");
3034 sockent_init (se, SOCKENT_TYPE_SERVER);
3036 se->node = strdup (ci->values[0].value.string);
3037 if (ci->values_num >= 2)
3038 se->service = strdup (ci->values[1].value.string);
3040 for (i = 0; i < ci->children_num; i++)
3042 oconfig_item_t *child = ci->children + i;
3045 if (strcasecmp ("AuthFile", child->key) == 0)
3046 network_config_set_string (child, &se->data.server.auth_file);
3047 else if (strcasecmp ("SecurityLevel", child->key) == 0)
3048 network_config_set_security_level (child,
3049 &se->data.server.security_level);
3051 #endif /* HAVE_LIBGCRYPT */
3052 if (strcasecmp ("Interface", child->key) == 0)
3053 network_config_set_interface (child,
3057 WARNING ("network plugin: Option `%s' is not allowed here.",
3063 if ((se->data.server.security_level > SECURITY_LEVEL_NONE)
3064 && (se->data.server.auth_file == NULL))
3066 ERROR ("network plugin: A security level higher than `none' was "
3067 "requested, but no AuthFile option was given. Cowardly refusing to "
3068 "open this socket!");
3069 sockent_destroy (se);
3072 #endif /* HAVE_LIBGCRYPT */
3074 status = sockent_open (se);
3077 ERROR ("network plugin: network_config_add_listen: sockent_open failed.");
3078 sockent_destroy (se);
3082 status = sockent_add (se);
3085 ERROR ("network plugin: network_config_add_listen: sockent_add failed.");
3086 sockent_destroy (se);
3091 } /* }}} int network_config_add_listen */
3093 static int network_config_add_server (const oconfig_item_t *ci) /* {{{ */
3099 if ((ci->values_num < 1) || (ci->values_num > 2)
3100 || (ci->values[0].type != OCONFIG_TYPE_STRING)
3101 || ((ci->values_num > 1) && (ci->values[1].type != OCONFIG_TYPE_STRING)))
3103 ERROR ("network plugin: The `%s' config option needs "
3104 "one or two string arguments.", ci->key);
3108 se = malloc (sizeof (*se));
3111 ERROR ("network plugin: malloc failed.");
3114 sockent_init (se, SOCKENT_TYPE_CLIENT);
3116 se->node = strdup (ci->values[0].value.string);
3117 if (ci->values_num >= 2)
3118 se->service = strdup (ci->values[1].value.string);
3120 for (i = 0; i < ci->children_num; i++)
3122 oconfig_item_t *child = ci->children + i;
3125 if (strcasecmp ("Username", child->key) == 0)
3126 network_config_set_string (child, &se->data.client.username);
3127 else if (strcasecmp ("Password", child->key) == 0)
3128 network_config_set_string (child, &se->data.client.password);
3129 else if (strcasecmp ("SecurityLevel", child->key) == 0)
3130 network_config_set_security_level (child,
3131 &se->data.client.security_level);
3133 #endif /* HAVE_LIBGCRYPT */
3134 if (strcasecmp ("Interface", child->key) == 0)
3135 network_config_set_interface (child,
3139 WARNING ("network plugin: Option `%s' is not allowed here.",
3145 if ((se->data.client.security_level > SECURITY_LEVEL_NONE)
3146 && ((se->data.client.username == NULL)
3147 || (se->data.client.password == NULL)))
3149 ERROR ("network plugin: A security level higher than `none' was "
3150 "requested, but no Username or Password option was given. "
3151 "Cowardly refusing to open this socket!");
3152 sockent_destroy (se);
3155 #endif /* HAVE_LIBGCRYPT */
3157 status = sockent_open (se);
3160 ERROR ("network plugin: network_config_add_server: sockent_open failed.");
3161 sockent_destroy (se);
3165 status = sockent_add (se);
3168 ERROR ("network plugin: network_config_add_server: sockent_add failed.");
3169 sockent_destroy (se);
3174 } /* }}} int network_config_add_server */
3176 static int network_config (oconfig_item_t *ci) /* {{{ */
3180 /* The options need to be applied first */
3181 for (i = 0; i < ci->children_num; i++)
3183 oconfig_item_t *child = ci->children + i;
3184 if (strcasecmp ("TimeToLive", child->key) == 0)
3185 network_config_set_ttl (child);
3188 for (i = 0; i < ci->children_num; i++)
3190 oconfig_item_t *child = ci->children + i;
3192 if (strcasecmp ("Listen", child->key) == 0)
3193 network_config_add_listen (child);
3194 else if (strcasecmp ("Server", child->key) == 0)
3195 network_config_add_server (child);
3196 else if (strcasecmp ("TimeToLive", child->key) == 0) {
3197 /* Handled earlier */
3199 else if (strcasecmp ("MaxPacketSize", child->key) == 0)
3200 network_config_set_buffer_size (child);
3201 else if (strcasecmp ("Forward", child->key) == 0)
3202 network_config_set_boolean (child, &network_config_forward);
3203 else if (strcasecmp ("ReportStats", child->key) == 0)
3204 network_config_set_boolean (child, &network_config_stats);
3207 WARNING ("network plugin: Option `%s' is not allowed here.",
3213 } /* }}} int network_config */
3215 static int network_notification (const notification_t *n,
3216 user_data_t __attribute__((unused)) *user_data)
3218 char buffer[network_config_packet_size];
3219 char *buffer_ptr = buffer;
3220 int buffer_free = sizeof (buffer);
3223 if (!check_send_notify_okay (n))
3226 memset (buffer, 0, sizeof (buffer));
3228 status = write_part_number (&buffer_ptr, &buffer_free, TYPE_TIME_HR,
3229 (uint64_t) n->time);
3233 status = write_part_number (&buffer_ptr, &buffer_free, TYPE_SEVERITY,
3234 (uint64_t) n->severity);
3238 if (strlen (n->host) > 0)
3240 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_HOST,
3241 n->host, strlen (n->host));
3246 if (strlen (n->plugin) > 0)
3248 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_PLUGIN,
3249 n->plugin, strlen (n->plugin));
3254 if (strlen (n->plugin_instance) > 0)
3256 status = write_part_string (&buffer_ptr, &buffer_free,
3257 TYPE_PLUGIN_INSTANCE,
3258 n->plugin_instance, strlen (n->plugin_instance));
3263 if (strlen (n->type) > 0)
3265 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_TYPE,
3266 n->type, strlen (n->type));
3271 if (strlen (n->type_instance) > 0)
3273 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_TYPE_INSTANCE,
3274 n->type_instance, strlen (n->type_instance));
3279 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_MESSAGE,
3280 n->message, strlen (n->message));
3284 network_send_buffer (buffer, sizeof (buffer) - buffer_free);
3287 } /* int network_notification */
3289 static int network_shutdown (void)
3293 /* Kill the listening thread */
3294 if (receive_thread_running != 0)
3296 INFO ("network plugin: Stopping receive thread.");
3297 pthread_kill (receive_thread_id, SIGTERM);
3298 pthread_join (receive_thread_id, NULL /* no return value */);
3299 memset (&receive_thread_id, 0, sizeof (receive_thread_id));
3300 receive_thread_running = 0;
3303 /* Shutdown the dispatching thread */
3304 if (dispatch_thread_running != 0)
3306 INFO ("network plugin: Stopping dispatch thread.");
3307 pthread_mutex_lock (&receive_list_lock);
3308 pthread_cond_broadcast (&receive_list_cond);
3309 pthread_mutex_unlock (&receive_list_lock);
3310 pthread_join (dispatch_thread_id, /* ret = */ NULL);
3311 dispatch_thread_running = 0;
3314 sockent_destroy (listen_sockets);
3316 if (send_buffer_fill > 0)
3319 sfree (send_buffer);
3321 /* TODO: Close `sending_sockets' */
3323 plugin_unregister_config ("network");
3324 plugin_unregister_init ("network");
3325 plugin_unregister_write ("network");
3326 plugin_unregister_shutdown ("network");
3329 } /* int network_shutdown */
3331 static int network_stats_read (void) /* {{{ */
3333 derive_t copy_octets_rx;
3334 derive_t copy_octets_tx;
3335 derive_t copy_packets_rx;
3336 derive_t copy_packets_tx;
3337 derive_t copy_values_dispatched;
3338 derive_t copy_values_not_dispatched;
3339 derive_t copy_values_sent;
3340 derive_t copy_values_not_sent;
3341 derive_t copy_receive_list_length;
3342 value_list_t vl = VALUE_LIST_INIT;
3345 copy_octets_rx = stats_octets_rx;
3346 copy_octets_tx = stats_octets_tx;
3347 copy_packets_rx = stats_packets_rx;
3348 copy_packets_tx = stats_packets_tx;
3349 copy_values_dispatched = stats_values_dispatched;
3350 copy_values_not_dispatched = stats_values_not_dispatched;
3351 copy_values_sent = stats_values_sent;
3352 copy_values_not_sent = stats_values_not_sent;
3353 copy_receive_list_length = receive_list_length;
3355 /* Initialize `vl' */
3359 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
3360 sstrncpy (vl.plugin, "network", sizeof (vl.plugin));
3362 /* Octets received / sent */
3363 vl.values[0].derive = (derive_t) copy_octets_rx;
3364 vl.values[1].derive = (derive_t) copy_octets_tx;
3365 sstrncpy (vl.type, "if_octets", sizeof (vl.type));
3366 plugin_dispatch_values (&vl);
3368 /* Packets received / send */
3369 vl.values[0].derive = (derive_t) copy_packets_rx;
3370 vl.values[1].derive = (derive_t) copy_packets_tx;
3371 sstrncpy (vl.type, "if_packets", sizeof (vl.type));
3372 plugin_dispatch_values (&vl);
3374 /* Values (not) dispatched and (not) send */
3375 sstrncpy (vl.type, "total_values", sizeof (vl.type));
3378 vl.values[0].derive = (derive_t) copy_values_dispatched;
3379 sstrncpy (vl.type_instance, "dispatch-accepted",
3380 sizeof (vl.type_instance));
3381 plugin_dispatch_values (&vl);
3383 vl.values[0].derive = (derive_t) copy_values_not_dispatched;
3384 sstrncpy (vl.type_instance, "dispatch-rejected",
3385 sizeof (vl.type_instance));
3386 plugin_dispatch_values (&vl);
3388 vl.values[0].derive = (derive_t) copy_values_sent;
3389 sstrncpy (vl.type_instance, "send-accepted",
3390 sizeof (vl.type_instance));
3391 plugin_dispatch_values (&vl);
3393 vl.values[0].derive = (derive_t) copy_values_not_sent;
3394 sstrncpy (vl.type_instance, "send-rejected",
3395 sizeof (vl.type_instance));
3396 plugin_dispatch_values (&vl);
3398 /* Receive queue length */
3399 vl.values[0].gauge = (gauge_t) copy_receive_list_length;
3400 sstrncpy (vl.type, "queue_length", sizeof (vl.type));
3401 vl.type_instance[0] = 0;
3402 plugin_dispatch_values (&vl);
3405 } /* }}} int network_stats_read */
3407 static int network_init (void)
3409 static _Bool have_init = 0;
3411 /* Check if we were already initialized. If so, just return - there's
3412 * nothing more to do (for now, that is). */
3418 network_init_gcrypt ();
3421 if (network_config_stats != 0)
3422 plugin_register_read ("network", network_stats_read);
3424 plugin_register_shutdown ("network", network_shutdown);
3426 send_buffer = malloc (network_config_packet_size);
3427 if (send_buffer == NULL)
3429 ERROR ("network plugin: malloc failed.");
3432 network_init_buffer ();
3434 /* setup socket(s) and so on */
3435 if (sending_sockets != NULL)
3437 plugin_register_write ("network", network_write,
3438 /* user_data = */ NULL);
3439 plugin_register_notification ("network", network_notification,
3440 /* user_data = */ NULL);
3443 /* If no threads need to be started, return here. */
3444 if ((listen_sockets_num == 0)
3445 || ((dispatch_thread_running != 0)
3446 && (receive_thread_running != 0)))
3449 if (dispatch_thread_running == 0)
3452 status = plugin_thread_create (&dispatch_thread_id,
3453 NULL /* no attributes */,
3455 NULL /* no argument */);
3459 ERROR ("network: pthread_create failed: %s",
3460 sstrerror (errno, errbuf,
3465 dispatch_thread_running = 1;
3469 if (receive_thread_running == 0)
3472 status = plugin_thread_create (&receive_thread_id,
3473 NULL /* no attributes */,
3475 NULL /* no argument */);
3479 ERROR ("network: pthread_create failed: %s",
3480 sstrerror (errno, errbuf,
3485 receive_thread_running = 1;
3490 } /* int network_init */
3493 * The flush option of the network plugin cannot flush individual identifiers.
3494 * All the values are added to a buffer and sent when the buffer is full, the
3495 * requested value may or may not be in there, it's not worth finding out. We
3496 * just send the buffer if `flush' is called - if the requested value was in
3497 * there, good. If not, well, then there is nothing to flush.. -octo
3499 static int network_flush (__attribute__((unused)) cdtime_t timeout,
3500 __attribute__((unused)) const char *identifier,
3501 __attribute__((unused)) user_data_t *user_data)
3503 pthread_mutex_lock (&send_buffer_lock);
3505 if (send_buffer_fill > 0)
3508 pthread_mutex_unlock (&send_buffer_lock);
3511 } /* int network_flush */
3513 void module_register (void)
3515 plugin_register_complex_config ("network", network_config);
3516 plugin_register_init ("network", network_init);
3517 plugin_register_flush ("network", network_flush,
3518 /* user_data = */ NULL);
3519 } /* void module_register */
3521 /* vim: set fdm=marker : */