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 static size_t network_config_packet_size = 1024;
280 static int network_config_forward = 0;
281 static int network_config_stats = 0;
283 static sockent_t *sending_sockets = NULL;
285 static receive_list_entry_t *receive_list_head = NULL;
286 static receive_list_entry_t *receive_list_tail = NULL;
287 static pthread_mutex_t receive_list_lock = PTHREAD_MUTEX_INITIALIZER;
288 static pthread_cond_t receive_list_cond = PTHREAD_COND_INITIALIZER;
289 static uint64_t receive_list_length = 0;
291 static sockent_t *listen_sockets = NULL;
292 static struct pollfd *listen_sockets_pollfd = NULL;
293 static size_t listen_sockets_num = 0;
295 /* The receive and dispatch threads will run as long as `listen_loop' is set to
297 static int listen_loop = 0;
298 static int receive_thread_running = 0;
299 static pthread_t receive_thread_id;
300 static int dispatch_thread_running = 0;
301 static pthread_t dispatch_thread_id;
303 /* Buffer in which to-be-sent network packets are constructed. */
304 static char *send_buffer;
305 static char *send_buffer_ptr;
306 static int send_buffer_fill;
307 static value_list_t send_buffer_vl = VALUE_LIST_STATIC;
308 static pthread_mutex_t send_buffer_lock = PTHREAD_MUTEX_INITIALIZER;
310 /* XXX: These counters are incremented from one place only. The spot in which
311 * the values are incremented is either only reachable by one thread (the
312 * dispatch thread, for example) or locked by some lock (send_buffer_lock for
313 * example). Only if neither is true, the stats_lock is acquired. The counters
314 * are always read without holding a lock in the hope that writing 8 bytes to
315 * memory is an atomic operation. */
316 static uint64_t stats_octets_rx = 0;
317 static uint64_t stats_octets_tx = 0;
318 static uint64_t stats_packets_rx = 0;
319 static uint64_t stats_packets_tx = 0;
320 static uint64_t stats_values_dispatched = 0;
321 static uint64_t stats_values_not_dispatched = 0;
322 static uint64_t stats_values_sent = 0;
323 static uint64_t stats_values_not_sent = 0;
324 static pthread_mutex_t stats_lock = PTHREAD_MUTEX_INITIALIZER;
329 static _Bool check_receive_okay (const value_list_t *vl) /* {{{ */
331 uint64_t time_sent = 0;
334 status = uc_meta_data_get_unsigned_int (vl,
335 "network:time_sent", &time_sent);
337 /* This is a value we already sent. Don't allow it to be received again in
338 * order to avoid looping. */
339 if ((status == 0) && (time_sent >= ((uint64_t) vl->time)))
343 } /* }}} _Bool check_receive_okay */
345 static _Bool check_send_okay (const value_list_t *vl) /* {{{ */
347 _Bool received = false;
350 if (network_config_forward != 0)
353 if (vl->meta == NULL)
356 status = meta_data_get_boolean (vl->meta, "network:received", &received);
357 if (status == -ENOENT)
359 else if (status != 0)
361 ERROR ("network plugin: check_send_okay: meta_data_get_boolean failed "
362 "with status %i.", status);
366 /* By default, only *send* value lists that were not *received* by the
369 } /* }}} _Bool check_send_okay */
371 static _Bool check_notify_received (const notification_t *n) /* {{{ */
373 notification_meta_t *ptr;
375 for (ptr = n->meta; ptr != NULL; ptr = ptr->next)
376 if ((strcmp ("network:received", ptr->name) == 0)
377 && (ptr->type == NM_TYPE_BOOLEAN))
378 return ((_Bool) ptr->nm_value.nm_boolean);
381 } /* }}} _Bool check_notify_received */
383 static _Bool check_send_notify_okay (const notification_t *n) /* {{{ */
385 static c_complain_t complain_forwarding = C_COMPLAIN_INIT_STATIC;
391 received = check_notify_received (n);
393 if (network_config_forward && received)
395 c_complain_once (LOG_ERR, &complain_forwarding,
396 "network plugin: A notification has been received via the network "
397 "forwarding if enabled. Forwarding of notifications is currently "
398 "not supported, because there is not loop-deteciton available. "
399 "Please contact the collectd mailing list if you need this "
403 /* By default, only *send* value lists that were not *received* by the
406 } /* }}} _Bool check_send_notify_okay */
408 static int network_dispatch_values (value_list_t *vl, /* {{{ */
409 const char *username)
414 || (strlen (vl->host) <= 0)
415 || (strlen (vl->plugin) <= 0)
416 || (strlen (vl->type) <= 0))
419 if (!check_receive_okay (vl))
422 char name[6*DATA_MAX_NAME_LEN];
423 FORMAT_VL (name, sizeof (name), vl);
424 name[sizeof (name) - 1] = 0;
425 DEBUG ("network plugin: network_dispatch_values: "
426 "NOT dispatching %s.", name);
428 stats_values_not_dispatched++;
432 assert (vl->meta == NULL);
434 vl->meta = meta_data_create ();
435 if (vl->meta == NULL)
437 ERROR ("network plugin: meta_data_create failed.");
441 status = meta_data_add_boolean (vl->meta, "network:received", true);
444 ERROR ("network plugin: meta_data_add_boolean failed.");
445 meta_data_destroy (vl->meta);
450 if (username != NULL)
452 status = meta_data_add_string (vl->meta, "network:username", username);
455 ERROR ("network plugin: meta_data_add_string failed.");
456 meta_data_destroy (vl->meta);
462 plugin_dispatch_values_secure (vl);
463 stats_values_dispatched++;
465 meta_data_destroy (vl->meta);
469 } /* }}} int network_dispatch_values */
471 static int network_dispatch_notification (notification_t *n) /* {{{ */
475 assert (n->meta == NULL);
477 status = plugin_notification_meta_add_boolean (n, "network:received", 1);
480 ERROR ("network plugin: plugin_notification_meta_add_boolean failed.");
481 plugin_notification_meta_free (n->meta);
486 status = plugin_dispatch_notification (n);
488 plugin_notification_meta_free (n->meta);
492 } /* }}} int network_dispatch_notification */
495 static int network_init_gcrypt (void) /* {{{ */
499 /* http://lists.gnupg.org/pipermail/gcrypt-devel/2003-August/000458.html
500 * Because you can't know in a library whether another library has
501 * already initialized the library */
502 if (gcry_control (GCRYCTL_ANY_INITIALIZATION_P))
505 /* http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html
506 * To ensure thread-safety, it's important to set GCRYCTL_SET_THREAD_CBS
507 * *before* initalizing Libgcrypt with gcry_check_version(), which itself must
508 * be called before any other gcry_* function. GCRYCTL_ANY_INITIALIZATION_P
509 * above doesn't count, as it doesn't implicitly initalize Libgcrypt.
511 * tl;dr: keep all these gry_* statements in this exact order please. */
512 err = gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
515 ERROR ("network plugin: gcry_control (GCRYCTL_SET_THREAD_CBS) failed: %s", gcry_strerror (err));
518 gcry_check_version (NULL);
520 err = gcry_control (GCRYCTL_INIT_SECMEM, 32768);
523 ERROR ("network plugin: gcry_control (GCRYCTL_INIT_SECMEM) failed: %s", gcry_strerror (err));
527 gcry_control (GCRYCTL_INITIALIZATION_FINISHED);
529 } /* }}} int network_init_gcrypt */
531 static gcry_cipher_hd_t network_get_aes256_cypher (sockent_t *se, /* {{{ */
532 const void *iv, size_t iv_size, const char *username)
535 gcry_cipher_hd_t *cyper_ptr;
536 unsigned char password_hash[32];
538 if (se->type == SOCKENT_TYPE_CLIENT)
540 cyper_ptr = &se->data.client.cypher;
541 memcpy (password_hash, se->data.client.password_hash,
542 sizeof (password_hash));
548 cyper_ptr = &se->data.server.cypher;
550 if (username == NULL)
553 secret = fbh_get (se->data.server.userdb, username);
557 gcry_md_hash_buffer (GCRY_MD_SHA256,
559 secret, strlen (secret));
564 if (*cyper_ptr == NULL)
566 err = gcry_cipher_open (cyper_ptr,
567 GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB, /* flags = */ 0);
570 ERROR ("network plugin: gcry_cipher_open returned: %s",
571 gcry_strerror (err));
578 gcry_cipher_reset (*cyper_ptr);
580 assert (*cyper_ptr != NULL);
582 err = gcry_cipher_setkey (*cyper_ptr,
583 password_hash, sizeof (password_hash));
586 ERROR ("network plugin: gcry_cipher_setkey returned: %s",
587 gcry_strerror (err));
588 gcry_cipher_close (*cyper_ptr);
593 err = gcry_cipher_setiv (*cyper_ptr, iv, iv_size);
596 ERROR ("network plugin: gcry_cipher_setkey returned: %s",
597 gcry_strerror (err));
598 gcry_cipher_close (*cyper_ptr);
604 } /* }}} int network_get_aes256_cypher */
605 #endif /* HAVE_LIBGCRYPT */
607 static int write_part_values (char **ret_buffer, int *ret_buffer_len,
608 const data_set_t *ds, const value_list_t *vl)
614 part_header_t pkg_ph;
615 uint16_t pkg_num_values;
616 uint8_t *pkg_values_types;
622 num_values = vl->values_len;
623 packet_len = sizeof (part_header_t) + sizeof (uint16_t)
624 + (num_values * sizeof (uint8_t))
625 + (num_values * sizeof (value_t));
627 if (*ret_buffer_len < packet_len)
630 pkg_values_types = (uint8_t *) malloc (num_values * sizeof (uint8_t));
631 if (pkg_values_types == NULL)
633 ERROR ("network plugin: write_part_values: malloc failed.");
637 pkg_values = (value_t *) malloc (num_values * sizeof (value_t));
638 if (pkg_values == NULL)
640 free (pkg_values_types);
641 ERROR ("network plugin: write_part_values: malloc failed.");
645 pkg_ph.type = htons (TYPE_VALUES);
646 pkg_ph.length = htons (packet_len);
648 pkg_num_values = htons ((uint16_t) vl->values_len);
650 for (i = 0; i < num_values; i++)
652 pkg_values_types[i] = (uint8_t) ds->ds[i].type;
653 switch (ds->ds[i].type)
655 case DS_TYPE_COUNTER:
656 pkg_values[i].counter = htonll (vl->values[i].counter);
660 pkg_values[i].gauge = htond (vl->values[i].gauge);
664 pkg_values[i].derive = htonll (vl->values[i].derive);
667 case DS_TYPE_ABSOLUTE:
668 pkg_values[i].absolute = htonll (vl->values[i].absolute);
672 free (pkg_values_types);
674 ERROR ("network plugin: write_part_values: "
675 "Unknown data source type: %i",
678 } /* switch (ds->ds[i].type) */
679 } /* for (num_values) */
682 * Use `memcpy' to write everything to the buffer, because the pointer
683 * may be unaligned and some architectures, such as SPARC, can't handle
686 packet_ptr = *ret_buffer;
688 memcpy (packet_ptr + offset, &pkg_ph, sizeof (pkg_ph));
689 offset += sizeof (pkg_ph);
690 memcpy (packet_ptr + offset, &pkg_num_values, sizeof (pkg_num_values));
691 offset += sizeof (pkg_num_values);
692 memcpy (packet_ptr + offset, pkg_values_types, num_values * sizeof (uint8_t));
693 offset += num_values * sizeof (uint8_t);
694 memcpy (packet_ptr + offset, pkg_values, num_values * sizeof (value_t));
695 offset += num_values * sizeof (value_t);
697 assert (offset == packet_len);
699 *ret_buffer = packet_ptr + packet_len;
700 *ret_buffer_len -= packet_len;
702 free (pkg_values_types);
706 } /* int write_part_values */
708 static int write_part_number (char **ret_buffer, int *ret_buffer_len,
709 int type, uint64_t value)
714 part_header_t pkg_head;
719 packet_len = sizeof (pkg_head) + sizeof (pkg_value);
721 if (*ret_buffer_len < packet_len)
724 pkg_head.type = htons (type);
725 pkg_head.length = htons (packet_len);
726 pkg_value = htonll (value);
728 packet_ptr = *ret_buffer;
730 memcpy (packet_ptr + offset, &pkg_head, sizeof (pkg_head));
731 offset += sizeof (pkg_head);
732 memcpy (packet_ptr + offset, &pkg_value, sizeof (pkg_value));
733 offset += sizeof (pkg_value);
735 assert (offset == packet_len);
737 *ret_buffer = packet_ptr + packet_len;
738 *ret_buffer_len -= packet_len;
741 } /* int write_part_number */
743 static int write_part_string (char **ret_buffer, int *ret_buffer_len,
744 int type, const char *str, int str_len)
754 buffer_len = 2 * sizeof (uint16_t) + str_len + 1;
755 if (*ret_buffer_len < buffer_len)
758 pkg_type = htons (type);
759 pkg_length = htons (buffer_len);
761 buffer = *ret_buffer;
763 memcpy (buffer + offset, (void *) &pkg_type, sizeof (pkg_type));
764 offset += sizeof (pkg_type);
765 memcpy (buffer + offset, (void *) &pkg_length, sizeof (pkg_length));
766 offset += sizeof (pkg_length);
767 memcpy (buffer + offset, str, str_len);
769 memset (buffer + offset, '\0', 1);
772 assert (offset == buffer_len);
774 *ret_buffer = buffer + buffer_len;
775 *ret_buffer_len -= buffer_len;
778 } /* int write_part_string */
780 static int parse_part_values (void **ret_buffer, size_t *ret_buffer_len,
781 value_t **ret_values, int *ret_num_values)
783 char *buffer = *ret_buffer;
784 size_t buffer_len = *ret_buffer_len;
799 NOTICE ("network plugin: packet is too short: "
800 "buffer_len = %zu", buffer_len);
804 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
805 buffer += sizeof (tmp16);
806 pkg_type = ntohs (tmp16);
808 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
809 buffer += sizeof (tmp16);
810 pkg_length = ntohs (tmp16);
812 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
813 buffer += sizeof (tmp16);
814 pkg_numval = ntohs (tmp16);
816 assert (pkg_type == TYPE_VALUES);
818 exp_size = 3 * sizeof (uint16_t)
819 + pkg_numval * (sizeof (uint8_t) + sizeof (value_t));
820 if (buffer_len < exp_size)
822 WARNING ("network plugin: parse_part_values: "
824 "Chunk of size %zu expected, "
825 "but buffer has only %zu bytes left.",
826 exp_size, buffer_len);
830 if (pkg_length != exp_size)
832 WARNING ("network plugin: parse_part_values: "
833 "Length and number of values "
834 "in the packet don't match.");
838 pkg_types = (uint8_t *) malloc (pkg_numval * sizeof (uint8_t));
839 pkg_values = (value_t *) malloc (pkg_numval * sizeof (value_t));
840 if ((pkg_types == NULL) || (pkg_values == NULL))
844 ERROR ("network plugin: parse_part_values: malloc failed.");
848 memcpy ((void *) pkg_types, (void *) buffer, pkg_numval * sizeof (uint8_t));
849 buffer += pkg_numval * sizeof (uint8_t);
850 memcpy ((void *) pkg_values, (void *) buffer, pkg_numval * sizeof (value_t));
851 buffer += pkg_numval * sizeof (value_t);
853 for (i = 0; i < pkg_numval; i++)
855 switch (pkg_types[i])
857 case DS_TYPE_COUNTER:
858 pkg_values[i].counter = (counter_t) ntohll (pkg_values[i].counter);
862 pkg_values[i].gauge = (gauge_t) ntohd (pkg_values[i].gauge);
866 pkg_values[i].derive = (derive_t) ntohll (pkg_values[i].derive);
869 case DS_TYPE_ABSOLUTE:
870 pkg_values[i].absolute = (absolute_t) ntohll (pkg_values[i].absolute);
874 NOTICE ("network plugin: parse_part_values: "
875 "Don't know how to handle data source type %"PRIu8,
880 } /* switch (pkg_types[i]) */
883 *ret_buffer = buffer;
884 *ret_buffer_len = buffer_len - pkg_length;
885 *ret_num_values = pkg_numval;
886 *ret_values = pkg_values;
891 } /* int parse_part_values */
893 static int parse_part_number (void **ret_buffer, size_t *ret_buffer_len,
896 char *buffer = *ret_buffer;
897 size_t buffer_len = *ret_buffer_len;
901 size_t exp_size = 2 * sizeof (uint16_t) + sizeof (uint64_t);
905 if (buffer_len < exp_size)
907 WARNING ("network plugin: parse_part_number: "
909 "Chunk of size %zu expected, "
910 "but buffer has only %zu bytes left.",
911 exp_size, buffer_len);
915 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
916 buffer += sizeof (tmp16);
917 /* pkg_type = ntohs (tmp16); */
919 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
920 buffer += sizeof (tmp16);
921 pkg_length = ntohs (tmp16);
923 memcpy ((void *) &tmp64, buffer, sizeof (tmp64));
924 buffer += sizeof (tmp64);
925 *value = ntohll (tmp64);
927 *ret_buffer = buffer;
928 *ret_buffer_len = buffer_len - pkg_length;
931 } /* int parse_part_number */
933 static int parse_part_string (void **ret_buffer, size_t *ret_buffer_len,
934 char *output, int output_len)
936 char *buffer = *ret_buffer;
937 size_t buffer_len = *ret_buffer_len;
940 size_t header_size = 2 * sizeof (uint16_t);
944 if (buffer_len < header_size)
946 WARNING ("network plugin: parse_part_string: "
948 "Chunk of at least size %zu expected, "
949 "but buffer has only %zu bytes left.",
950 header_size, buffer_len);
954 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
955 buffer += sizeof (tmp16);
956 /* pkg_type = ntohs (tmp16); */
958 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
959 buffer += sizeof (tmp16);
960 pkg_length = ntohs (tmp16);
962 /* Check that packet fits in the input buffer */
963 if (pkg_length > buffer_len)
965 WARNING ("network plugin: parse_part_string: "
967 "Chunk of size %"PRIu16" received, "
968 "but buffer has only %zu bytes left.",
969 pkg_length, buffer_len);
973 /* Check that pkg_length is in the valid range */
974 if (pkg_length <= header_size)
976 WARNING ("network plugin: parse_part_string: "
978 "Header claims this packet is only %hu "
979 "bytes long.", pkg_length);
983 /* Check that the package data fits into the output buffer.
984 * The previous if-statement ensures that:
985 * `pkg_length > header_size' */
987 || ((size_t) output_len < ((size_t) pkg_length - header_size)))
989 WARNING ("network plugin: parse_part_string: "
990 "Output buffer too small.");
994 /* All sanity checks successfull, let's copy the data over */
995 output_len = pkg_length - header_size;
996 memcpy ((void *) output, (void *) buffer, output_len);
997 buffer += output_len;
999 /* For some very weird reason '\0' doesn't do the trick on SPARC in
1000 * this statement. */
1001 if (output[output_len - 1] != 0)
1003 WARNING ("network plugin: parse_part_string: "
1004 "Received string does not end "
1005 "with a NULL-byte.");
1009 *ret_buffer = buffer;
1010 *ret_buffer_len = buffer_len - pkg_length;
1013 } /* int parse_part_string */
1015 /* Forward declaration: parse_part_sign_sha256 and parse_part_encr_aes256 call
1016 * parse_packet and vice versa. */
1017 #define PP_SIGNED 0x01
1018 #define PP_ENCRYPTED 0x02
1019 static int parse_packet (sockent_t *se,
1020 void *buffer, size_t buffer_size, int flags,
1021 const char *username);
1023 #define BUFFER_READ(p,s) do { \
1024 memcpy ((p), buffer + buffer_offset, (s)); \
1025 buffer_offset += (s); \
1029 static int parse_part_sign_sha256 (sockent_t *se, /* {{{ */
1030 void **ret_buffer, size_t *ret_buffer_len, int flags)
1032 static c_complain_t complain_no_users = C_COMPLAIN_INIT_STATIC;
1036 size_t buffer_offset;
1038 size_t username_len;
1041 part_signature_sha256_t pss;
1042 uint16_t pss_head_length;
1043 char hash[sizeof (pss.hash)];
1047 unsigned char *hash_ptr;
1049 buffer = *ret_buffer;
1050 buffer_len = *ret_buffer_len;
1053 /* Check if the buffer has enough data for this structure. */
1054 if (buffer_len <= PART_SIGNATURE_SHA256_SIZE)
1057 /* Read type and length header */
1058 BUFFER_READ (&pss.head.type, sizeof (pss.head.type));
1059 BUFFER_READ (&pss.head.length, sizeof (pss.head.length));
1060 pss_head_length = ntohs (pss.head.length);
1062 /* Check if the `pss_head_length' is within bounds. */
1063 if ((pss_head_length <= PART_SIGNATURE_SHA256_SIZE)
1064 || (pss_head_length > buffer_len))
1066 ERROR ("network plugin: HMAC-SHA-256 with invalid length received.");
1070 if (se->data.server.userdb == NULL)
1072 c_complain (LOG_NOTICE, &complain_no_users,
1073 "network plugin: Received signed network packet but can't verify it "
1074 "because no user DB has been configured. Will accept it.");
1076 *ret_buffer = buffer + pss_head_length;
1077 *ret_buffer_len -= pss_head_length;
1082 /* Copy the hash. */
1083 BUFFER_READ (pss.hash, sizeof (pss.hash));
1085 /* Calculate username length (without null byte) and allocate memory */
1086 username_len = pss_head_length - PART_SIGNATURE_SHA256_SIZE;
1087 pss.username = malloc (username_len + 1);
1088 if (pss.username == NULL)
1091 /* Read the username */
1092 BUFFER_READ (pss.username, username_len);
1093 pss.username[username_len] = 0;
1095 assert (buffer_offset == pss_head_length);
1097 /* Query the password */
1098 secret = fbh_get (se->data.server.userdb, pss.username);
1101 ERROR ("network plugin: Unknown user: %s", pss.username);
1102 sfree (pss.username);
1106 /* Create a hash device and check the HMAC */
1108 err = gcry_md_open (&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
1111 ERROR ("network plugin: Creating HMAC-SHA-256 object failed: %s",
1112 gcry_strerror (err));
1114 sfree (pss.username);
1118 err = gcry_md_setkey (hd, secret, strlen (secret));
1121 ERROR ("network plugin: gcry_md_setkey failed: %s", gcry_strerror (err));
1124 sfree (pss.username);
1129 buffer + PART_SIGNATURE_SHA256_SIZE,
1130 buffer_len - PART_SIGNATURE_SHA256_SIZE);
1131 hash_ptr = gcry_md_read (hd, GCRY_MD_SHA256);
1132 if (hash_ptr == NULL)
1134 ERROR ("network plugin: gcry_md_read failed.");
1137 sfree (pss.username);
1140 memcpy (hash, hash_ptr, sizeof (hash));
1146 if (memcmp (pss.hash, hash, sizeof (pss.hash)) != 0)
1148 WARNING ("network plugin: Verifying HMAC-SHA-256 signature failed: "
1153 parse_packet (se, buffer + buffer_offset, buffer_len - buffer_offset,
1154 flags | PP_SIGNED, pss.username);
1158 sfree (pss.username);
1160 *ret_buffer = buffer + buffer_len;
1161 *ret_buffer_len = 0;
1164 } /* }}} int parse_part_sign_sha256 */
1165 /* #endif HAVE_LIBGCRYPT */
1167 #else /* if !HAVE_LIBGCRYPT */
1168 static int parse_part_sign_sha256 (sockent_t *se, /* {{{ */
1169 void **ret_buffer, size_t *ret_buffer_size, int flags)
1171 static int warning_has_been_printed = 0;
1175 size_t buffer_offset;
1178 part_signature_sha256_t pss;
1180 buffer = *ret_buffer;
1181 buffer_size = *ret_buffer_size;
1184 if (buffer_size <= PART_SIGNATURE_SHA256_SIZE)
1187 BUFFER_READ (&pss.head.type, sizeof (pss.head.type));
1188 BUFFER_READ (&pss.head.length, sizeof (pss.head.length));
1189 part_len = ntohs (pss.head.length);
1191 if ((part_len <= PART_SIGNATURE_SHA256_SIZE)
1192 || (part_len > buffer_size))
1195 if (warning_has_been_printed == 0)
1197 WARNING ("network plugin: Received signed packet, but the network "
1198 "plugin was not linked with libgcrypt, so I cannot "
1199 "verify the signature. The packet will be accepted.");
1200 warning_has_been_printed = 1;
1203 parse_packet (se, buffer + part_len, buffer_size - part_len, flags,
1204 /* username = */ NULL);
1206 *ret_buffer = buffer + buffer_size;
1207 *ret_buffer_size = 0;
1210 } /* }}} int parse_part_sign_sha256 */
1211 #endif /* !HAVE_LIBGCRYPT */
1214 static int parse_part_encr_aes256 (sockent_t *se, /* {{{ */
1215 void **ret_buffer, size_t *ret_buffer_len,
1218 char *buffer = *ret_buffer;
1219 size_t buffer_len = *ret_buffer_len;
1222 size_t buffer_offset;
1223 uint16_t username_len;
1224 part_encryption_aes256_t pea;
1225 unsigned char hash[sizeof (pea.hash)];
1227 gcry_cipher_hd_t cypher;
1230 /* Make sure at least the header if available. */
1231 if (buffer_len <= PART_ENCRYPTION_AES256_SIZE)
1233 NOTICE ("network plugin: parse_part_encr_aes256: "
1234 "Discarding short packet.");
1240 /* Copy the unencrypted information into `pea'. */
1241 BUFFER_READ (&pea.head.type, sizeof (pea.head.type));
1242 BUFFER_READ (&pea.head.length, sizeof (pea.head.length));
1244 /* Check the `part size'. */
1245 part_size = ntohs (pea.head.length);
1246 if ((part_size <= PART_ENCRYPTION_AES256_SIZE)
1247 || (part_size > buffer_len))
1249 NOTICE ("network plugin: parse_part_encr_aes256: "
1250 "Discarding part with invalid size.");
1254 /* Read the username */
1255 BUFFER_READ (&username_len, sizeof (username_len));
1256 username_len = ntohs (username_len);
1258 if ((username_len <= 0)
1259 || (username_len > (part_size - (PART_ENCRYPTION_AES256_SIZE + 1))))
1261 NOTICE ("network plugin: parse_part_encr_aes256: "
1262 "Discarding part with invalid username length.");
1266 assert (username_len > 0);
1267 pea.username = malloc (username_len + 1);
1268 if (pea.username == NULL)
1270 BUFFER_READ (pea.username, username_len);
1271 pea.username[username_len] = 0;
1273 /* Last but not least, the initialization vector */
1274 BUFFER_READ (pea.iv, sizeof (pea.iv));
1276 /* Make sure we are at the right position */
1277 assert (buffer_offset == (username_len +
1278 PART_ENCRYPTION_AES256_SIZE - sizeof (pea.hash)));
1280 cypher = network_get_aes256_cypher (se, pea.iv, sizeof (pea.iv),
1284 sfree (pea.username);
1288 payload_len = part_size - (PART_ENCRYPTION_AES256_SIZE + username_len);
1289 assert (payload_len > 0);
1291 /* Decrypt the packet in-place */
1292 err = gcry_cipher_decrypt (cypher,
1293 buffer + buffer_offset,
1294 part_size - buffer_offset,
1295 /* in = */ NULL, /* in len = */ 0);
1298 sfree (pea.username);
1299 ERROR ("network plugin: gcry_cipher_decrypt returned: %s",
1300 gcry_strerror (err));
1305 BUFFER_READ (pea.hash, sizeof (pea.hash));
1307 /* Make sure we're at the right position - again */
1308 assert (buffer_offset == (username_len + PART_ENCRYPTION_AES256_SIZE));
1309 assert (buffer_offset == (part_size - payload_len));
1311 /* Check hash sum */
1312 memset (hash, 0, sizeof (hash));
1313 gcry_md_hash_buffer (GCRY_MD_SHA1, hash,
1314 buffer + buffer_offset, payload_len);
1315 if (memcmp (hash, pea.hash, sizeof (hash)) != 0)
1317 sfree (pea.username);
1318 ERROR ("network plugin: Decryption failed: Checksum mismatch.");
1322 parse_packet (se, buffer + buffer_offset, payload_len,
1323 flags | PP_ENCRYPTED, pea.username);
1325 /* XXX: Free pea.username?!? */
1327 /* Update return values */
1328 *ret_buffer = buffer + part_size;
1329 *ret_buffer_len = buffer_len - part_size;
1331 sfree (pea.username);
1334 } /* }}} int parse_part_encr_aes256 */
1335 /* #endif HAVE_LIBGCRYPT */
1337 #else /* if !HAVE_LIBGCRYPT */
1338 static int parse_part_encr_aes256 (sockent_t *se, /* {{{ */
1339 void **ret_buffer, size_t *ret_buffer_size, int flags)
1341 static int warning_has_been_printed = 0;
1345 size_t buffer_offset;
1350 buffer = *ret_buffer;
1351 buffer_size = *ret_buffer_size;
1354 /* parse_packet assures this minimum size. */
1355 assert (buffer_size >= (sizeof (ph.type) + sizeof (ph.length)));
1357 BUFFER_READ (&ph.type, sizeof (ph.type));
1358 BUFFER_READ (&ph.length, sizeof (ph.length));
1359 ph_length = ntohs (ph.length);
1361 if ((ph_length <= PART_ENCRYPTION_AES256_SIZE)
1362 || (ph_length > buffer_size))
1364 ERROR ("network plugin: AES-256 encrypted part "
1365 "with invalid length received.");
1369 if (warning_has_been_printed == 0)
1371 WARNING ("network plugin: Received encrypted packet, but the network "
1372 "plugin was not linked with libgcrypt, so I cannot "
1373 "decrypt it. The part will be discarded.");
1374 warning_has_been_printed = 1;
1377 *ret_buffer += ph_length;
1378 *ret_buffer_size -= ph_length;
1381 } /* }}} int parse_part_encr_aes256 */
1382 #endif /* !HAVE_LIBGCRYPT */
1386 static int parse_packet (sockent_t *se, /* {{{ */
1387 void *buffer, size_t buffer_size, int flags,
1388 const char *username)
1392 value_list_t vl = VALUE_LIST_INIT;
1396 int packet_was_signed = (flags & PP_SIGNED);
1397 int packet_was_encrypted = (flags & PP_ENCRYPTED);
1398 int printed_ignore_warning = 0;
1399 #endif /* HAVE_LIBGCRYPT */
1402 memset (&vl, '\0', sizeof (vl));
1403 memset (&n, '\0', sizeof (n));
1406 while ((status == 0) && (0 < buffer_size)
1407 && ((unsigned int) buffer_size > sizeof (part_header_t)))
1409 uint16_t pkg_length;
1412 memcpy ((void *) &pkg_type,
1415 memcpy ((void *) &pkg_length,
1416 (void *) (buffer + sizeof (pkg_type)),
1417 sizeof (pkg_length));
1419 pkg_length = ntohs (pkg_length);
1420 pkg_type = ntohs (pkg_type);
1422 if (pkg_length > buffer_size)
1424 /* Ensure that this loop terminates eventually */
1425 if (pkg_length < (2 * sizeof (uint16_t)))
1428 if (pkg_type == TYPE_ENCR_AES256)
1430 status = parse_part_encr_aes256 (se,
1431 &buffer, &buffer_size, flags);
1434 ERROR ("network plugin: Decrypting AES256 "
1436 "with status %i.", status);
1441 else if ((se->data.server.security_level == SECURITY_LEVEL_ENCRYPT)
1442 && (packet_was_encrypted == 0))
1444 if (printed_ignore_warning == 0)
1446 INFO ("network plugin: Unencrypted packet or "
1447 "part has been ignored.");
1448 printed_ignore_warning = 1;
1450 buffer = ((char *) buffer) + pkg_length;
1451 buffer_size -= (size_t) pkg_length;
1454 #endif /* HAVE_LIBGCRYPT */
1455 else if (pkg_type == TYPE_SIGN_SHA256)
1457 status = parse_part_sign_sha256 (se,
1458 &buffer, &buffer_size, flags);
1461 ERROR ("network plugin: Verifying HMAC-SHA-256 "
1463 "with status %i.", status);
1468 else if ((se->data.server.security_level == SECURITY_LEVEL_SIGN)
1469 && (packet_was_encrypted == 0)
1470 && (packet_was_signed == 0))
1472 if (printed_ignore_warning == 0)
1474 INFO ("network plugin: Unsigned packet or "
1475 "part has been ignored.");
1476 printed_ignore_warning = 1;
1478 buffer = ((char *) buffer) + pkg_length;
1479 buffer_size -= (size_t) pkg_length;
1482 #endif /* HAVE_LIBGCRYPT */
1483 else if (pkg_type == TYPE_VALUES)
1485 status = parse_part_values (&buffer, &buffer_size,
1486 &vl.values, &vl.values_len);
1490 network_dispatch_values (&vl, username);
1494 else if (pkg_type == TYPE_TIME)
1497 status = parse_part_number (&buffer, &buffer_size,
1501 vl.time = (time_t) tmp;
1502 n.time = (time_t) tmp;
1505 else if (pkg_type == TYPE_INTERVAL)
1508 status = parse_part_number (&buffer, &buffer_size,
1511 vl.interval = (int) tmp;
1513 else if (pkg_type == TYPE_HOST)
1515 status = parse_part_string (&buffer, &buffer_size,
1516 vl.host, sizeof (vl.host));
1518 sstrncpy (n.host, vl.host, sizeof (n.host));
1520 else if (pkg_type == TYPE_PLUGIN)
1522 status = parse_part_string (&buffer, &buffer_size,
1523 vl.plugin, sizeof (vl.plugin));
1525 sstrncpy (n.plugin, vl.plugin,
1528 else if (pkg_type == TYPE_PLUGIN_INSTANCE)
1530 status = parse_part_string (&buffer, &buffer_size,
1532 sizeof (vl.plugin_instance));
1534 sstrncpy (n.plugin_instance,
1536 sizeof (n.plugin_instance));
1538 else if (pkg_type == TYPE_TYPE)
1540 status = parse_part_string (&buffer, &buffer_size,
1541 vl.type, sizeof (vl.type));
1543 sstrncpy (n.type, vl.type, sizeof (n.type));
1545 else if (pkg_type == TYPE_TYPE_INSTANCE)
1547 status = parse_part_string (&buffer, &buffer_size,
1549 sizeof (vl.type_instance));
1551 sstrncpy (n.type_instance, vl.type_instance,
1552 sizeof (n.type_instance));
1554 else if (pkg_type == TYPE_MESSAGE)
1556 status = parse_part_string (&buffer, &buffer_size,
1557 n.message, sizeof (n.message));
1563 else if ((n.severity != NOTIF_FAILURE)
1564 && (n.severity != NOTIF_WARNING)
1565 && (n.severity != NOTIF_OKAY))
1567 INFO ("network plugin: "
1568 "Ignoring notification with "
1569 "unknown severity %i.",
1572 else if (n.time <= 0)
1574 INFO ("network plugin: "
1575 "Ignoring notification with "
1578 else if (strlen (n.message) <= 0)
1580 INFO ("network plugin: "
1581 "Ignoring notification with "
1582 "an empty message.");
1586 network_dispatch_notification (&n);
1589 else if (pkg_type == TYPE_SEVERITY)
1592 status = parse_part_number (&buffer, &buffer_size,
1595 n.severity = (int) tmp;
1599 DEBUG ("network plugin: parse_packet: Unknown part"
1600 " type: 0x%04hx", pkg_type);
1601 buffer = ((char *) buffer) + pkg_length;
1602 buffer_size -= (size_t) pkg_length;
1604 } /* while (buffer_size > sizeof (part_header_t)) */
1606 if (status == 0 && buffer_size > 0)
1607 WARNING ("network plugin: parse_packet: Received truncated "
1608 "packet, try increasing `MaxPacketSize'");
1611 } /* }}} int parse_packet */
1613 static void free_sockent_client (struct sockent_client *sec) /* {{{ */
1622 sfree (sec->username);
1623 sfree (sec->password);
1624 if (sec->cypher != NULL)
1625 gcry_cipher_close (sec->cypher);
1627 } /* }}} void free_sockent_client */
1629 static void free_sockent_server (struct sockent_server *ses) /* {{{ */
1633 for (i = 0; i < ses->fd_num; i++)
1635 if (ses->fd[i] >= 0)
1644 sfree (ses->auth_file);
1645 fbh_destroy (ses->userdb);
1646 if (ses->cypher != NULL)
1647 gcry_cipher_close (ses->cypher);
1649 } /* }}} void free_sockent_server */
1651 static void sockent_destroy (sockent_t *se) /* {{{ */
1655 DEBUG ("network plugin: sockent_destroy (se = %p);", (void *) se);
1662 sfree (se->service);
1664 if (se->type == SOCKENT_TYPE_CLIENT)
1665 free_sockent_client (&se->data.client);
1667 free_sockent_server (&se->data.server);
1672 } /* }}} void sockent_destroy */
1675 * int network_set_ttl
1677 * Set the `IP_MULTICAST_TTL', `IP_TTL', `IPV6_MULTICAST_HOPS' or
1678 * `IPV6_UNICAST_HOPS', depending on which option is applicable.
1680 * The `struct addrinfo' is used to destinguish between unicast and multicast
1683 static int network_set_ttl (const sockent_t *se, const struct addrinfo *ai)
1685 DEBUG ("network plugin: network_set_ttl: network_config_ttl = %i;",
1686 network_config_ttl);
1688 assert (se->type == SOCKENT_TYPE_CLIENT);
1690 if ((network_config_ttl < 1) || (network_config_ttl > 255))
1693 if (ai->ai_family == AF_INET)
1695 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
1698 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
1699 optname = IP_MULTICAST_TTL;
1703 if (setsockopt (se->data.client.fd, IPPROTO_IP, optname,
1704 &network_config_ttl,
1705 sizeof (network_config_ttl)) != 0)
1708 ERROR ("network plugin: setsockopt (ipv4-ttl): %s",
1709 sstrerror (errno, errbuf, sizeof (errbuf)));
1713 else if (ai->ai_family == AF_INET6)
1715 /* Useful example: http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
1716 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
1719 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
1720 optname = IPV6_MULTICAST_HOPS;
1722 optname = IPV6_UNICAST_HOPS;
1724 if (setsockopt (se->data.client.fd, IPPROTO_IPV6, optname,
1725 &network_config_ttl,
1726 sizeof (network_config_ttl)) != 0)
1729 ERROR ("network plugin: setsockopt(ipv6-ttl): %s",
1730 sstrerror (errno, errbuf,
1737 } /* int network_set_ttl */
1739 static int network_set_interface (const sockent_t *se, const struct addrinfo *ai) /* {{{ */
1741 DEBUG ("network plugin: network_set_interface: interface index = %i;",
1744 assert (se->type == SOCKENT_TYPE_CLIENT);
1746 if (ai->ai_family == AF_INET)
1748 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
1750 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
1752 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1753 /* If possible, use the "ip_mreqn" structure which has
1754 * an "interface index" member. Using the interface
1755 * index is preferred here, because of its similarity
1756 * to the way IPv6 handles this. Unfortunately, it
1757 * appears not to be portable. */
1758 struct ip_mreqn mreq;
1760 memset (&mreq, 0, sizeof (mreq));
1761 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1762 mreq.imr_address.s_addr = ntohl (INADDR_ANY);
1763 mreq.imr_ifindex = se->interface;
1765 struct ip_mreq mreq;
1767 memset (&mreq, 0, sizeof (mreq));
1768 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1769 mreq.imr_interface.s_addr = ntohl (INADDR_ANY);
1772 if (setsockopt (se->data.client.fd, IPPROTO_IP, IP_MULTICAST_IF,
1773 &mreq, sizeof (mreq)) != 0)
1776 ERROR ("network plugin: setsockopt (ipv4-multicast-if): %s",
1777 sstrerror (errno, errbuf, sizeof (errbuf)));
1784 else if (ai->ai_family == AF_INET6)
1786 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
1788 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
1790 if (setsockopt (se->data.client.fd, IPPROTO_IPV6, IPV6_MULTICAST_IF,
1792 sizeof (se->interface)) != 0)
1795 ERROR ("network plugin: setsockopt (ipv6-multicast-if): %s",
1796 sstrerror (errno, errbuf,
1805 /* else: Not a multicast interface. */
1806 if (se->interface != 0)
1808 #if defined(HAVE_IF_INDEXTONAME) && HAVE_IF_INDEXTONAME && defined(SO_BINDTODEVICE)
1809 char interface_name[IFNAMSIZ];
1811 if (if_indextoname (se->interface, interface_name) == NULL)
1814 DEBUG ("network plugin: Binding socket to interface %s", interface_name);
1816 if (setsockopt (se->data.client.fd, SOL_SOCKET, SO_BINDTODEVICE,
1818 sizeof(interface_name)) == -1 )
1821 ERROR ("network plugin: setsockopt (bind-if): %s",
1822 sstrerror (errno, errbuf, sizeof (errbuf)));
1825 /* #endif HAVE_IF_INDEXTONAME && SO_BINDTODEVICE */
1828 WARNING ("network plugin: Cannot set the interface on a unicast "
1830 # if !defined(SO_BINDTODEVICE)
1831 "the \"SO_BINDTODEVICE\" socket option "
1833 "the \"if_indextoname\" function "
1835 "is not available on your system.");
1841 } /* }}} network_set_interface */
1843 static int network_bind_socket (int fd, const struct addrinfo *ai, const int interface_idx)
1852 /* allow multiple sockets to use the same PORT number */
1853 if (setsockopt (fd, SOL_SOCKET, SO_REUSEADDR,
1854 &yes, sizeof(yes)) == -1) {
1856 ERROR ("network plugin: setsockopt (reuseaddr): %s",
1857 sstrerror (errno, errbuf, sizeof (errbuf)));
1861 DEBUG ("fd = %i; calling `bind'", fd);
1863 if (bind (fd, ai->ai_addr, ai->ai_addrlen) == -1)
1867 sstrerror (errno, errbuf, sizeof (errbuf)));
1871 if (ai->ai_family == AF_INET)
1873 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
1874 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
1876 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1877 struct ip_mreqn mreq;
1879 struct ip_mreq mreq;
1882 DEBUG ("fd = %i; IPv4 multicast address found", fd);
1884 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1885 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1886 /* Set the interface using the interface index if
1887 * possible (available). Unfortunately, the struct
1888 * ip_mreqn is not portable. */
1889 mreq.imr_address.s_addr = ntohl (INADDR_ANY);
1890 mreq.imr_ifindex = interface_idx;
1892 mreq.imr_interface.s_addr = ntohl (INADDR_ANY);
1895 if (setsockopt (fd, IPPROTO_IP, IP_MULTICAST_LOOP,
1896 &loop, sizeof (loop)) == -1)
1899 ERROR ("network plugin: setsockopt (multicast-loop): %s",
1900 sstrerror (errno, errbuf,
1905 if (setsockopt (fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
1906 &mreq, sizeof (mreq)) == -1)
1909 ERROR ("network plugin: setsockopt (add-membership): %s",
1910 sstrerror (errno, errbuf,
1918 else if (ai->ai_family == AF_INET6)
1920 /* Useful example: http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
1921 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
1922 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
1924 struct ipv6_mreq mreq;
1926 DEBUG ("fd = %i; IPv6 multicast address found", fd);
1928 memcpy (&mreq.ipv6mr_multiaddr,
1930 sizeof (addr->sin6_addr));
1932 /* http://developer.apple.com/documentation/Darwin/Reference/ManPages/man4/ip6.4.html
1933 * ipv6mr_interface may be set to zeroes to
1934 * choose the default multicast interface or to
1935 * the index of a particular multicast-capable
1936 * interface if the host is multihomed.
1937 * Membership is associ-associated with a
1938 * single interface; programs running on
1939 * multihomed hosts may need to join the same
1940 * group on more than one interface.*/
1941 mreq.ipv6mr_interface = interface_idx;
1943 if (setsockopt (fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP,
1944 &loop, sizeof (loop)) == -1)
1947 ERROR ("network plugin: setsockopt (ipv6-multicast-loop): %s",
1948 sstrerror (errno, errbuf,
1953 if (setsockopt (fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP,
1954 &mreq, sizeof (mreq)) == -1)
1957 ERROR ("network plugin: setsockopt (ipv6-add-membership): %s",
1958 sstrerror (errno, errbuf,
1967 #if defined(HAVE_IF_INDEXTONAME) && HAVE_IF_INDEXTONAME && defined(SO_BINDTODEVICE)
1968 /* if a specific interface was set, bind the socket to it. But to avoid
1969 * possible problems with multicast routing, only do that for non-multicast
1971 if (interface_idx != 0)
1973 char interface_name[IFNAMSIZ];
1975 if (if_indextoname (interface_idx, interface_name) == NULL)
1978 DEBUG ("fd = %i; Binding socket to interface %s", fd, interface_name);
1980 if (setsockopt (fd, SOL_SOCKET, SO_BINDTODEVICE,
1982 sizeof(interface_name)) == -1 )
1985 ERROR ("network plugin: setsockopt (bind-if): %s",
1986 sstrerror (errno, errbuf, sizeof (errbuf)));
1990 #endif /* HAVE_IF_INDEXTONAME && SO_BINDTODEVICE */
1993 } /* int network_bind_socket */
1995 /* Initialize a sockent structure. `type' must be either `SOCKENT_TYPE_CLIENT'
1996 * or `SOCKENT_TYPE_SERVER' */
1997 static int sockent_init (sockent_t *se, int type) /* {{{ */
2002 memset (se, 0, sizeof (*se));
2004 se->type = SOCKENT_TYPE_CLIENT;
2010 if (type == SOCKENT_TYPE_SERVER)
2012 se->type = SOCKENT_TYPE_SERVER;
2013 se->data.server.fd = NULL;
2015 se->data.server.security_level = SECURITY_LEVEL_NONE;
2016 se->data.server.auth_file = NULL;
2017 se->data.server.userdb = NULL;
2018 se->data.server.cypher = NULL;
2023 se->data.client.fd = -1;
2024 se->data.client.addr = NULL;
2026 se->data.client.security_level = SECURITY_LEVEL_NONE;
2027 se->data.client.username = NULL;
2028 se->data.client.password = NULL;
2029 se->data.client.cypher = NULL;
2034 } /* }}} int sockent_init */
2036 /* Open the file descriptors for a initialized sockent structure. */
2037 static int sockent_open (sockent_t *se) /* {{{ */
2039 struct addrinfo ai_hints;
2040 struct addrinfo *ai_list, *ai_ptr;
2044 const char *service;
2049 /* Set up the security structures. */
2050 #if HAVE_LIBGCRYPT /* {{{ */
2051 if (se->type == SOCKENT_TYPE_CLIENT)
2053 if (se->data.client.security_level > SECURITY_LEVEL_NONE)
2055 if (network_init_gcrypt () < 0)
2057 ERROR ("network plugin: Cannot configure client socket with "
2058 "security: Failed to initialize crypto library.");
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 if (network_init_gcrypt () < 0)
2082 ERROR ("network plugin: Cannot configure server socket with "
2083 "security: Failed to initialize crypto library.");
2087 if (se->data.server.auth_file == NULL)
2089 ERROR ("network plugin: Server socket with "
2090 "security requested, but no "
2091 "password file is configured.");
2095 if (se->data.server.auth_file != NULL)
2097 se->data.server.userdb = fbh_create (se->data.server.auth_file);
2098 if (se->data.server.userdb == NULL)
2100 ERROR ("network plugin: Reading password file "
2102 se->data.server.auth_file);
2103 if (se->data.server.security_level > SECURITY_LEVEL_NONE)
2108 #endif /* }}} HAVE_LIBGCRYPT */
2111 service = se->service;
2113 if (service == NULL)
2114 service = NET_DEFAULT_PORT;
2116 DEBUG ("network plugin: sockent_open: node = %s; service = %s;",
2119 memset (&ai_hints, 0, sizeof (ai_hints));
2120 ai_hints.ai_flags = 0;
2122 ai_hints.ai_flags |= AI_PASSIVE;
2124 #ifdef AI_ADDRCONFIG
2125 ai_hints.ai_flags |= AI_ADDRCONFIG;
2127 ai_hints.ai_family = AF_UNSPEC;
2128 ai_hints.ai_socktype = SOCK_DGRAM;
2129 ai_hints.ai_protocol = IPPROTO_UDP;
2131 ai_return = getaddrinfo (node, service, &ai_hints, &ai_list);
2134 ERROR ("network plugin: getaddrinfo (%s, %s) failed: %s",
2135 (se->node == NULL) ? "(null)" : se->node,
2136 (se->service == NULL) ? "(null)" : se->service,
2137 gai_strerror (ai_return));
2141 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
2145 if (se->type == SOCKENT_TYPE_SERVER) /* {{{ */
2149 tmp = realloc (se->data.server.fd,
2150 sizeof (*tmp) * (se->data.server.fd_num + 1));
2153 ERROR ("network plugin: realloc failed.");
2156 se->data.server.fd = tmp;
2157 tmp = se->data.server.fd + se->data.server.fd_num;
2159 *tmp = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
2160 ai_ptr->ai_protocol);
2164 ERROR ("network plugin: socket(2) failed: %s",
2165 sstrerror (errno, errbuf,
2170 status = network_bind_socket (*tmp, ai_ptr, se->interface);
2178 se->data.server.fd_num++;
2180 } /* }}} if (se->type == SOCKENT_TYPE_SERVER) */
2181 else /* if (se->type == SOCKENT_TYPE_CLIENT) {{{ */
2183 se->data.client.fd = socket (ai_ptr->ai_family,
2184 ai_ptr->ai_socktype,
2185 ai_ptr->ai_protocol);
2186 if (se->data.client.fd < 0)
2189 ERROR ("network plugin: socket(2) failed: %s",
2190 sstrerror (errno, errbuf,
2195 se->data.client.addr = malloc (sizeof (*se->data.client.addr));
2196 if (se->data.client.addr == NULL)
2198 ERROR ("network plugin: malloc failed.");
2199 close (se->data.client.fd);
2200 se->data.client.fd = -1;
2204 memset (se->data.client.addr, 0, sizeof (*se->data.client.addr));
2205 assert (sizeof (*se->data.client.addr) >= ai_ptr->ai_addrlen);
2206 memcpy (se->data.client.addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
2207 se->data.client.addrlen = ai_ptr->ai_addrlen;
2209 network_set_ttl (se, ai_ptr);
2210 network_set_interface (se, ai_ptr);
2212 /* We don't open more than one write-socket per
2213 * node/service pair.. */
2215 } /* }}} if (se->type == SOCKENT_TYPE_CLIENT) */
2216 } /* for (ai_list) */
2218 freeaddrinfo (ai_list);
2220 /* Check if all went well. */
2221 if (se->type == SOCKENT_TYPE_SERVER)
2223 if (se->data.server.fd_num <= 0)
2226 else /* if (se->type == SOCKENT_TYPE_CLIENT) */
2228 if (se->data.client.fd < 0)
2233 } /* }}} int sockent_open */
2235 /* Add a sockent to the global list of sockets */
2236 static int sockent_add (sockent_t *se) /* {{{ */
2238 sockent_t *last_ptr;
2243 if (se->type == SOCKENT_TYPE_SERVER)
2248 tmp = realloc (listen_sockets_pollfd,
2249 sizeof (*tmp) * (listen_sockets_num
2250 + se->data.server.fd_num));
2253 ERROR ("network plugin: realloc failed.");
2256 listen_sockets_pollfd = tmp;
2257 tmp = listen_sockets_pollfd + listen_sockets_num;
2259 for (i = 0; i < se->data.server.fd_num; i++)
2261 memset (tmp + i, 0, sizeof (*tmp));
2262 tmp[i].fd = se->data.server.fd[i];
2263 tmp[i].events = POLLIN | POLLPRI;
2267 listen_sockets_num += se->data.server.fd_num;
2269 if (listen_sockets == NULL)
2271 listen_sockets = se;
2274 last_ptr = listen_sockets;
2276 else /* if (se->type == SOCKENT_TYPE_CLIENT) */
2278 if (sending_sockets == NULL)
2280 sending_sockets = se;
2283 last_ptr = sending_sockets;
2286 while (last_ptr->next != NULL)
2287 last_ptr = last_ptr->next;
2288 last_ptr->next = se;
2291 } /* }}} int sockent_add */
2293 static void *dispatch_thread (void __attribute__((unused)) *arg) /* {{{ */
2297 receive_list_entry_t *ent;
2300 /* Lock and wait for more data to come in */
2301 pthread_mutex_lock (&receive_list_lock);
2302 while ((listen_loop == 0)
2303 && (receive_list_head == NULL))
2304 pthread_cond_wait (&receive_list_cond, &receive_list_lock);
2306 /* Remove the head entry and unlock */
2307 ent = receive_list_head;
2309 receive_list_head = ent->next;
2310 receive_list_length--;
2311 pthread_mutex_unlock (&receive_list_lock);
2313 /* Check whether we are supposed to exit. We do NOT check `listen_loop'
2314 * because we dispatch all missing packets before shutting down. */
2318 /* Look for the correct `sockent_t' */
2319 se = listen_sockets;
2324 for (i = 0; i < se->data.server.fd_num; i++)
2325 if (se->data.server.fd[i] == ent->fd)
2328 if (i < se->data.server.fd_num)
2336 ERROR ("network plugin: Got packet from FD %i, but can't "
2337 "find an appropriate socket entry.",
2344 parse_packet (se, ent->data, ent->data_len, /* flags = */ 0,
2345 /* username = */ NULL);
2351 } /* }}} void *dispatch_thread */
2353 static int network_receive (void) /* {{{ */
2355 char buffer[network_config_packet_size];
2361 receive_list_entry_t *private_list_head;
2362 receive_list_entry_t *private_list_tail;
2363 uint64_t private_list_length;
2365 assert (listen_sockets_num > 0);
2367 private_list_head = NULL;
2368 private_list_tail = NULL;
2369 private_list_length = 0;
2371 while (listen_loop == 0)
2373 status = poll (listen_sockets_pollfd, listen_sockets_num, -1);
2380 ERROR ("poll failed: %s",
2381 sstrerror (errno, errbuf, sizeof (errbuf)));
2385 for (i = 0; (i < listen_sockets_num) && (status > 0); i++)
2387 receive_list_entry_t *ent;
2389 if ((listen_sockets_pollfd[i].revents
2390 & (POLLIN | POLLPRI)) == 0)
2394 buffer_len = recv (listen_sockets_pollfd[i].fd,
2395 buffer, sizeof (buffer),
2400 ERROR ("recv failed: %s",
2401 sstrerror (errno, errbuf,
2406 stats_octets_rx += ((uint64_t) buffer_len);
2409 /* TODO: Possible performance enhancement: Do not free
2410 * these entries in the dispatch thread but put them in
2411 * another list, so we don't have to allocate more and
2412 * more of these structures. */
2413 ent = malloc (sizeof (receive_list_entry_t));
2416 ERROR ("network plugin: malloc failed.");
2419 memset (ent, 0, sizeof (receive_list_entry_t));
2420 ent->data = malloc (network_config_packet_size);
2421 if (ent->data == NULL)
2424 ERROR ("network plugin: malloc failed.");
2427 ent->fd = listen_sockets_pollfd[i].fd;
2430 memcpy (ent->data, buffer, buffer_len);
2431 ent->data_len = buffer_len;
2433 if (private_list_head == NULL)
2434 private_list_head = ent;
2436 private_list_tail->next = ent;
2437 private_list_tail = ent;
2438 private_list_length++;
2440 /* Do not block here. Blocking here has led to
2441 * insufficient performance in the past. */
2442 if (pthread_mutex_trylock (&receive_list_lock) == 0)
2444 assert (((receive_list_head == NULL) && (receive_list_length == 0))
2445 || ((receive_list_head != NULL) && (receive_list_length != 0)));
2447 if (receive_list_head == NULL)
2448 receive_list_head = private_list_head;
2450 receive_list_tail->next = private_list_head;
2451 receive_list_tail = private_list_tail;
2452 receive_list_length += private_list_length;
2454 pthread_cond_signal (&receive_list_cond);
2455 pthread_mutex_unlock (&receive_list_lock);
2457 private_list_head = NULL;
2458 private_list_tail = NULL;
2459 private_list_length = 0;
2461 } /* for (listen_sockets_pollfd) */
2462 } /* while (listen_loop == 0) */
2464 /* Make sure everything is dispatched before exiting. */
2465 if (private_list_head != NULL)
2467 pthread_mutex_lock (&receive_list_lock);
2469 if (receive_list_head == NULL)
2470 receive_list_head = private_list_head;
2472 receive_list_tail->next = private_list_head;
2473 receive_list_tail = private_list_tail;
2474 receive_list_length += private_list_length;
2476 private_list_head = NULL;
2477 private_list_tail = NULL;
2478 private_list_length = 0;
2480 pthread_cond_signal (&receive_list_cond);
2481 pthread_mutex_unlock (&receive_list_lock);
2485 } /* }}} int network_receive */
2487 static void *receive_thread (void __attribute__((unused)) *arg)
2489 return (network_receive () ? (void *) 1 : (void *) 0);
2490 } /* void *receive_thread */
2492 static void network_init_buffer (void)
2494 memset (send_buffer, 0, network_config_packet_size);
2495 send_buffer_ptr = send_buffer;
2496 send_buffer_fill = 0;
2498 memset (&send_buffer_vl, 0, sizeof (send_buffer_vl));
2499 } /* int network_init_buffer */
2501 static void networt_send_buffer_plain (const sockent_t *se, /* {{{ */
2502 const char *buffer, size_t buffer_size)
2508 status = sendto (se->data.client.fd, buffer, buffer_size,
2510 (struct sockaddr *) se->data.client.addr,
2511 se->data.client.addrlen);
2517 ERROR ("network plugin: sendto failed: %s",
2518 sstrerror (errno, errbuf,
2525 } /* }}} void networt_send_buffer_plain */
2528 #define BUFFER_ADD(p,s) do { \
2529 memcpy (buffer + buffer_offset, (p), (s)); \
2530 buffer_offset += (s); \
2533 static void networt_send_buffer_signed (const sockent_t *se, /* {{{ */
2534 const char *in_buffer, size_t in_buffer_size)
2536 part_signature_sha256_t ps;
2537 char buffer[BUFF_SIG_SIZE + in_buffer_size];
2538 size_t buffer_offset;
2539 size_t username_len;
2543 unsigned char *hash;
2546 err = gcry_md_open (&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
2549 ERROR ("network plugin: Creating HMAC object failed: %s",
2550 gcry_strerror (err));
2554 err = gcry_md_setkey (hd, se->data.client.password,
2555 strlen (se->data.client.password));
2558 ERROR ("network plugin: gcry_md_setkey failed: %s",
2559 gcry_strerror (err));
2564 username_len = strlen (se->data.client.username);
2565 if (username_len > (BUFF_SIG_SIZE - PART_SIGNATURE_SHA256_SIZE))
2567 ERROR ("network plugin: Username too long: %s",
2568 se->data.client.username);
2572 memcpy (buffer + PART_SIGNATURE_SHA256_SIZE,
2573 se->data.client.username, username_len);
2574 memcpy (buffer + PART_SIGNATURE_SHA256_SIZE + username_len,
2575 in_buffer, in_buffer_size);
2577 /* Initialize the `ps' structure. */
2578 memset (&ps, 0, sizeof (ps));
2579 ps.head.type = htons (TYPE_SIGN_SHA256);
2580 ps.head.length = htons (PART_SIGNATURE_SHA256_SIZE + username_len);
2582 /* Calculate the hash value. */
2583 gcry_md_write (hd, buffer + PART_SIGNATURE_SHA256_SIZE,
2584 username_len + in_buffer_size);
2585 hash = gcry_md_read (hd, GCRY_MD_SHA256);
2588 ERROR ("network plugin: gcry_md_read failed.");
2592 memcpy (ps.hash, hash, sizeof (ps.hash));
2594 /* Add the header */
2597 BUFFER_ADD (&ps.head.type, sizeof (ps.head.type));
2598 BUFFER_ADD (&ps.head.length, sizeof (ps.head.length));
2599 BUFFER_ADD (ps.hash, sizeof (ps.hash));
2601 assert (buffer_offset == PART_SIGNATURE_SHA256_SIZE);
2606 buffer_offset = PART_SIGNATURE_SHA256_SIZE + username_len + in_buffer_size;
2607 networt_send_buffer_plain (se, buffer, buffer_offset);
2608 } /* }}} void networt_send_buffer_signed */
2610 static void networt_send_buffer_encrypted (sockent_t *se, /* {{{ */
2611 const char *in_buffer, size_t in_buffer_size)
2613 part_encryption_aes256_t pea;
2614 char buffer[BUFF_SIG_SIZE + in_buffer_size];
2616 size_t buffer_offset;
2618 size_t username_len;
2620 gcry_cipher_hd_t cypher;
2622 /* Initialize the header fields */
2623 memset (&pea, 0, sizeof (pea));
2624 pea.head.type = htons (TYPE_ENCR_AES256);
2626 pea.username = se->data.client.username;
2628 username_len = strlen (pea.username);
2629 if ((PART_ENCRYPTION_AES256_SIZE + username_len) > BUFF_SIG_SIZE)
2631 ERROR ("network plugin: Username too long: %s", pea.username);
2635 buffer_size = PART_ENCRYPTION_AES256_SIZE + username_len + in_buffer_size;
2636 header_size = PART_ENCRYPTION_AES256_SIZE + username_len
2637 - sizeof (pea.hash);
2639 assert (buffer_size <= sizeof (buffer));
2640 DEBUG ("network plugin: networt_send_buffer_encrypted: "
2641 "buffer_size = %zu;", buffer_size);
2643 pea.head.length = htons ((uint16_t) (PART_ENCRYPTION_AES256_SIZE
2644 + username_len + in_buffer_size));
2645 pea.username_length = htons ((uint16_t) username_len);
2647 /* Chose a random initialization vector. */
2648 gcry_randomize ((void *) &pea.iv, sizeof (pea.iv), GCRY_STRONG_RANDOM);
2650 /* Create hash of the payload */
2651 gcry_md_hash_buffer (GCRY_MD_SHA1, pea.hash, in_buffer, in_buffer_size);
2653 /* Initialize the buffer */
2655 memset (buffer, 0, sizeof (buffer));
2658 BUFFER_ADD (&pea.head.type, sizeof (pea.head.type));
2659 BUFFER_ADD (&pea.head.length, sizeof (pea.head.length));
2660 BUFFER_ADD (&pea.username_length, sizeof (pea.username_length));
2661 BUFFER_ADD (pea.username, username_len);
2662 BUFFER_ADD (pea.iv, sizeof (pea.iv));
2663 assert (buffer_offset == header_size);
2664 BUFFER_ADD (pea.hash, sizeof (pea.hash));
2665 BUFFER_ADD (in_buffer, in_buffer_size);
2667 assert (buffer_offset == buffer_size);
2669 cypher = network_get_aes256_cypher (se, pea.iv, sizeof (pea.iv),
2670 se->data.client.password);
2674 /* Encrypt the buffer in-place */
2675 err = gcry_cipher_encrypt (cypher,
2676 buffer + header_size,
2677 buffer_size - header_size,
2678 /* in = */ NULL, /* in len = */ 0);
2681 ERROR ("network plugin: gcry_cipher_encrypt returned: %s",
2682 gcry_strerror (err));
2686 /* Send it out without further modifications */
2687 networt_send_buffer_plain (se, buffer, buffer_size);
2688 } /* }}} void networt_send_buffer_encrypted */
2690 #endif /* HAVE_LIBGCRYPT */
2692 static void network_send_buffer (char *buffer, size_t buffer_len) /* {{{ */
2696 DEBUG ("network plugin: network_send_buffer: buffer_len = %zu", buffer_len);
2698 for (se = sending_sockets; se != NULL; se = se->next)
2701 if (se->data.client.security_level == SECURITY_LEVEL_ENCRYPT)
2702 networt_send_buffer_encrypted (se, buffer, buffer_len);
2703 else if (se->data.client.security_level == SECURITY_LEVEL_SIGN)
2704 networt_send_buffer_signed (se, buffer, buffer_len);
2705 else /* if (se->data.client.security_level == SECURITY_LEVEL_NONE) */
2706 #endif /* HAVE_LIBGCRYPT */
2707 networt_send_buffer_plain (se, buffer, buffer_len);
2708 } /* for (sending_sockets) */
2709 } /* }}} void network_send_buffer */
2711 static int add_to_buffer (char *buffer, int buffer_size, /* {{{ */
2712 value_list_t *vl_def,
2713 const data_set_t *ds, const value_list_t *vl)
2715 char *buffer_orig = buffer;
2717 if (strcmp (vl_def->host, vl->host) != 0)
2719 if (write_part_string (&buffer, &buffer_size, TYPE_HOST,
2720 vl->host, strlen (vl->host)) != 0)
2722 sstrncpy (vl_def->host, vl->host, sizeof (vl_def->host));
2725 if (vl_def->time != vl->time)
2727 if (write_part_number (&buffer, &buffer_size, TYPE_TIME,
2728 (uint64_t) vl->time))
2730 vl_def->time = vl->time;
2733 if (vl_def->interval != vl->interval)
2735 if (write_part_number (&buffer, &buffer_size, TYPE_INTERVAL,
2736 (uint64_t) vl->interval))
2738 vl_def->interval = vl->interval;
2741 if (strcmp (vl_def->plugin, vl->plugin) != 0)
2743 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN,
2744 vl->plugin, strlen (vl->plugin)) != 0)
2746 sstrncpy (vl_def->plugin, vl->plugin, sizeof (vl_def->plugin));
2749 if (strcmp (vl_def->plugin_instance, vl->plugin_instance) != 0)
2751 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE,
2752 vl->plugin_instance,
2753 strlen (vl->plugin_instance)) != 0)
2755 sstrncpy (vl_def->plugin_instance, vl->plugin_instance, sizeof (vl_def->plugin_instance));
2758 if (strcmp (vl_def->type, vl->type) != 0)
2760 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE,
2761 vl->type, strlen (vl->type)) != 0)
2763 sstrncpy (vl_def->type, ds->type, sizeof (vl_def->type));
2766 if (strcmp (vl_def->type_instance, vl->type_instance) != 0)
2768 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE_INSTANCE,
2770 strlen (vl->type_instance)) != 0)
2772 sstrncpy (vl_def->type_instance, vl->type_instance, sizeof (vl_def->type_instance));
2775 if (write_part_values (&buffer, &buffer_size, ds, vl) != 0)
2778 return (buffer - buffer_orig);
2779 } /* }}} int add_to_buffer */
2781 static void flush_buffer (void)
2783 DEBUG ("network plugin: flush_buffer: send_buffer_fill = %i",
2786 network_send_buffer (send_buffer, (size_t) send_buffer_fill);
2788 stats_octets_tx += ((uint64_t) send_buffer_fill);
2791 network_init_buffer ();
2794 static int network_write (const data_set_t *ds, const value_list_t *vl,
2795 user_data_t __attribute__((unused)) *user_data)
2799 if (!check_send_okay (vl))
2802 char name[6*DATA_MAX_NAME_LEN];
2803 FORMAT_VL (name, sizeof (name), vl);
2804 name[sizeof (name) - 1] = 0;
2805 DEBUG ("network plugin: network_write: "
2806 "NOT sending %s.", name);
2808 /* Counter is not protected by another lock and may be reached by
2809 * multiple threads */
2810 pthread_mutex_lock (&stats_lock);
2811 stats_values_not_sent++;
2812 pthread_mutex_unlock (&stats_lock);
2816 uc_meta_data_add_unsigned_int (vl,
2817 "network:time_sent", (uint64_t) vl->time);
2819 pthread_mutex_lock (&send_buffer_lock);
2821 status = add_to_buffer (send_buffer_ptr,
2822 network_config_packet_size - (send_buffer_fill + BUFF_SIG_SIZE),
2827 /* status == bytes added to the buffer */
2828 send_buffer_fill += status;
2829 send_buffer_ptr += status;
2831 stats_values_sent++;
2837 status = add_to_buffer (send_buffer_ptr,
2838 network_config_packet_size - (send_buffer_fill + BUFF_SIG_SIZE),
2844 send_buffer_fill += status;
2845 send_buffer_ptr += status;
2847 stats_values_sent++;
2853 ERROR ("network plugin: Unable to append to the "
2854 "buffer for some weird reason");
2856 else if ((network_config_packet_size - send_buffer_fill) < 15)
2861 pthread_mutex_unlock (&send_buffer_lock);
2863 return ((status < 0) ? -1 : 0);
2864 } /* int network_write */
2866 static int network_config_set_boolean (const oconfig_item_t *ci, /* {{{ */
2869 if ((ci->values_num != 1)
2870 || ((ci->values[0].type != OCONFIG_TYPE_BOOLEAN)
2871 && (ci->values[0].type != OCONFIG_TYPE_STRING)))
2873 ERROR ("network plugin: The `%s' config option needs "
2874 "exactly one boolean argument.", ci->key);
2878 if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
2880 if (ci->values[0].value.boolean)
2887 char *str = ci->values[0].value.string;
2891 else if (IS_FALSE (str))
2895 ERROR ("network plugin: Cannot parse string value `%s' of the `%s' "
2896 "option as boolean value.",
2903 } /* }}} int network_config_set_boolean */
2905 static int network_config_set_ttl (const oconfig_item_t *ci) /* {{{ */
2908 if ((ci->values_num != 1)
2909 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
2911 WARNING ("network plugin: The `TimeToLive' config option needs exactly "
2912 "one numeric argument.");
2916 tmp = (int) ci->values[0].value.number;
2917 if ((tmp > 0) && (tmp <= 255))
2918 network_config_ttl = tmp;
2921 } /* }}} int network_config_set_ttl */
2923 static int network_config_set_interface (const oconfig_item_t *ci, /* {{{ */
2926 if ((ci->values_num != 1)
2927 || (ci->values[0].type != OCONFIG_TYPE_STRING))
2929 WARNING ("network plugin: The `Interface' config option needs exactly "
2930 "one string argument.");
2934 if (interface == NULL)
2937 *interface = if_nametoindex (ci->values[0].value.string);
2940 } /* }}} int network_config_set_interface */
2942 static int network_config_set_buffer_size (const oconfig_item_t *ci) /* {{{ */
2945 if ((ci->values_num != 1)
2946 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
2948 WARNING ("network plugin: The `MaxPacketSize' config option needs exactly "
2949 "one numeric argument.");
2953 tmp = (int) ci->values[0].value.number;
2954 if ((tmp >= 1024) && (tmp <= 65535))
2955 network_config_packet_size = tmp;
2958 } /* }}} int network_config_set_buffer_size */
2961 static int network_config_set_string (const oconfig_item_t *ci, /* {{{ */
2965 if ((ci->values_num != 1)
2966 || (ci->values[0].type != OCONFIG_TYPE_STRING))
2968 WARNING ("network plugin: The `%s' config option needs exactly "
2969 "one string argument.", ci->key);
2973 tmp = strdup (ci->values[0].value.string);
2977 sfree (*ret_string);
2981 } /* }}} int network_config_set_string */
2982 #endif /* HAVE_LIBGCRYPT */
2985 static int network_config_set_security_level (oconfig_item_t *ci, /* {{{ */
2989 if ((ci->values_num != 1)
2990 || (ci->values[0].type != OCONFIG_TYPE_STRING))
2992 WARNING ("network plugin: The `SecurityLevel' config option needs exactly "
2993 "one string argument.");
2997 str = ci->values[0].value.string;
2998 if (strcasecmp ("Encrypt", str) == 0)
2999 *retval = SECURITY_LEVEL_ENCRYPT;
3000 else if (strcasecmp ("Sign", str) == 0)
3001 *retval = SECURITY_LEVEL_SIGN;
3002 else if (strcasecmp ("None", str) == 0)
3003 *retval = SECURITY_LEVEL_NONE;
3006 WARNING ("network plugin: Unknown security level: %s.", str);
3011 } /* }}} int network_config_set_security_level */
3012 #endif /* HAVE_LIBGCRYPT */
3014 static int network_config_add_listen (const oconfig_item_t *ci) /* {{{ */
3020 if ((ci->values_num < 1) || (ci->values_num > 2)
3021 || (ci->values[0].type != OCONFIG_TYPE_STRING)
3022 || ((ci->values_num > 1) && (ci->values[1].type != OCONFIG_TYPE_STRING)))
3024 ERROR ("network plugin: The `%s' config option needs "
3025 "one or two string arguments.", ci->key);
3029 se = malloc (sizeof (*se));
3032 ERROR ("network plugin: malloc failed.");
3035 sockent_init (se, SOCKENT_TYPE_SERVER);
3037 se->node = strdup (ci->values[0].value.string);
3038 if (ci->values_num >= 2)
3039 se->service = strdup (ci->values[1].value.string);
3041 for (i = 0; i < ci->children_num; i++)
3043 oconfig_item_t *child = ci->children + i;
3046 if (strcasecmp ("AuthFile", child->key) == 0)
3047 network_config_set_string (child, &se->data.server.auth_file);
3048 else if (strcasecmp ("SecurityLevel", child->key) == 0)
3049 network_config_set_security_level (child,
3050 &se->data.server.security_level);
3052 #endif /* HAVE_LIBGCRYPT */
3053 if (strcasecmp ("Interface", child->key) == 0)
3054 network_config_set_interface (child,
3058 WARNING ("network plugin: Option `%s' is not allowed here.",
3064 if ((se->data.server.security_level > SECURITY_LEVEL_NONE)
3065 && (se->data.server.auth_file == NULL))
3067 ERROR ("network plugin: A security level higher than `none' was "
3068 "requested, but no AuthFile option was given. Cowardly refusing to "
3069 "open this socket!");
3070 sockent_destroy (se);
3073 #endif /* HAVE_LIBGCRYPT */
3075 status = sockent_open (se);
3078 ERROR ("network plugin: network_config_add_listen: sockent_open failed.");
3079 sockent_destroy (se);
3083 status = sockent_add (se);
3086 ERROR ("network plugin: network_config_add_listen: sockent_add failed.");
3087 sockent_destroy (se);
3092 } /* }}} int network_config_add_listen */
3094 static int network_config_add_server (const oconfig_item_t *ci) /* {{{ */
3100 if ((ci->values_num < 1) || (ci->values_num > 2)
3101 || (ci->values[0].type != OCONFIG_TYPE_STRING)
3102 || ((ci->values_num > 1) && (ci->values[1].type != OCONFIG_TYPE_STRING)))
3104 ERROR ("network plugin: The `%s' config option needs "
3105 "one or two string arguments.", ci->key);
3109 se = malloc (sizeof (*se));
3112 ERROR ("network plugin: malloc failed.");
3115 sockent_init (se, SOCKENT_TYPE_CLIENT);
3117 se->node = strdup (ci->values[0].value.string);
3118 if (ci->values_num >= 2)
3119 se->service = strdup (ci->values[1].value.string);
3121 for (i = 0; i < ci->children_num; i++)
3123 oconfig_item_t *child = ci->children + i;
3126 if (strcasecmp ("Username", child->key) == 0)
3127 network_config_set_string (child, &se->data.client.username);
3128 else if (strcasecmp ("Password", child->key) == 0)
3129 network_config_set_string (child, &se->data.client.password);
3130 else if (strcasecmp ("SecurityLevel", child->key) == 0)
3131 network_config_set_security_level (child,
3132 &se->data.client.security_level);
3134 #endif /* HAVE_LIBGCRYPT */
3135 if (strcasecmp ("Interface", child->key) == 0)
3136 network_config_set_interface (child,
3140 WARNING ("network plugin: Option `%s' is not allowed here.",
3146 if ((se->data.client.security_level > SECURITY_LEVEL_NONE)
3147 && ((se->data.client.username == NULL)
3148 || (se->data.client.password == NULL)))
3150 ERROR ("network plugin: A security level higher than `none' was "
3151 "requested, but no Username or Password option was given. "
3152 "Cowardly refusing to open this socket!");
3153 sockent_destroy (se);
3156 #endif /* HAVE_LIBGCRYPT */
3158 status = sockent_open (se);
3161 ERROR ("network plugin: network_config_add_server: sockent_open failed.");
3162 sockent_destroy (se);
3166 status = sockent_add (se);
3169 ERROR ("network plugin: network_config_add_server: sockent_add failed.");
3170 sockent_destroy (se);
3175 } /* }}} int network_config_add_server */
3177 static int network_config (oconfig_item_t *ci) /* {{{ */
3181 for (i = 0; i < ci->children_num; i++)
3183 oconfig_item_t *child = ci->children + i;
3185 if (strcasecmp ("Listen", child->key) == 0)
3186 network_config_add_listen (child);
3187 else if (strcasecmp ("Server", child->key) == 0)
3188 network_config_add_server (child);
3189 else if (strcasecmp ("TimeToLive", child->key) == 0)
3190 network_config_set_ttl (child);
3191 else if (strcasecmp ("MaxPacketSize", child->key) == 0)
3192 network_config_set_buffer_size (child);
3193 else if (strcasecmp ("Forward", child->key) == 0)
3194 network_config_set_boolean (child, &network_config_forward);
3195 else if (strcasecmp ("ReportStats", child->key) == 0)
3196 network_config_set_boolean (child, &network_config_stats);
3197 else if (strcasecmp ("CacheFlush", child->key) == 0)
3198 /* no op for backwards compatibility only */;
3201 WARNING ("network plugin: Option `%s' is not allowed here.",
3207 } /* }}} int network_config */
3209 static int network_notification (const notification_t *n,
3210 user_data_t __attribute__((unused)) *user_data)
3212 char buffer[network_config_packet_size];
3213 char *buffer_ptr = buffer;
3214 int buffer_free = sizeof (buffer);
3217 if (!check_send_notify_okay (n))
3220 memset (buffer, 0, sizeof (buffer));
3222 status = write_part_number (&buffer_ptr, &buffer_free, TYPE_TIME,
3223 (uint64_t) n->time);
3227 status = write_part_number (&buffer_ptr, &buffer_free, TYPE_SEVERITY,
3228 (uint64_t) n->severity);
3232 if (strlen (n->host) > 0)
3234 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_HOST,
3235 n->host, strlen (n->host));
3240 if (strlen (n->plugin) > 0)
3242 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_PLUGIN,
3243 n->plugin, strlen (n->plugin));
3248 if (strlen (n->plugin_instance) > 0)
3250 status = write_part_string (&buffer_ptr, &buffer_free,
3251 TYPE_PLUGIN_INSTANCE,
3252 n->plugin_instance, strlen (n->plugin_instance));
3257 if (strlen (n->type) > 0)
3259 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_TYPE,
3260 n->type, strlen (n->type));
3265 if (strlen (n->type_instance) > 0)
3267 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_TYPE_INSTANCE,
3268 n->type_instance, strlen (n->type_instance));
3273 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_MESSAGE,
3274 n->message, strlen (n->message));
3278 network_send_buffer (buffer, sizeof (buffer) - buffer_free);
3281 } /* int network_notification */
3283 static int network_shutdown (void)
3287 /* Kill the listening thread */
3288 if (receive_thread_running != 0)
3290 INFO ("network plugin: Stopping receive thread.");
3291 pthread_kill (receive_thread_id, SIGTERM);
3292 pthread_join (receive_thread_id, NULL /* no return value */);
3293 memset (&receive_thread_id, 0, sizeof (receive_thread_id));
3294 receive_thread_running = 0;
3297 /* Shutdown the dispatching thread */
3298 if (dispatch_thread_running != 0)
3300 INFO ("network plugin: Stopping dispatch thread.");
3301 pthread_mutex_lock (&receive_list_lock);
3302 pthread_cond_broadcast (&receive_list_cond);
3303 pthread_mutex_unlock (&receive_list_lock);
3304 pthread_join (dispatch_thread_id, /* ret = */ NULL);
3305 dispatch_thread_running = 0;
3308 sockent_destroy (listen_sockets);
3310 if (send_buffer_fill > 0)
3313 sfree (send_buffer);
3315 /* TODO: Close `sending_sockets' */
3317 plugin_unregister_config ("network");
3318 plugin_unregister_init ("network");
3319 plugin_unregister_write ("network");
3320 plugin_unregister_shutdown ("network");
3323 } /* int network_shutdown */
3325 static int network_stats_read (void) /* {{{ */
3327 uint64_t copy_octets_rx;
3328 uint64_t copy_octets_tx;
3329 uint64_t copy_packets_rx;
3330 uint64_t copy_packets_tx;
3331 uint64_t copy_values_dispatched;
3332 uint64_t copy_values_not_dispatched;
3333 uint64_t copy_values_sent;
3334 uint64_t copy_values_not_sent;
3335 uint64_t copy_receive_list_length;
3336 value_list_t vl = VALUE_LIST_INIT;
3339 copy_octets_rx = stats_octets_rx;
3340 copy_octets_tx = stats_octets_tx;
3341 copy_packets_rx = stats_packets_rx;
3342 copy_packets_tx = stats_packets_tx;
3343 copy_values_dispatched = stats_values_dispatched;
3344 copy_values_not_dispatched = stats_values_not_dispatched;
3345 copy_values_sent = stats_values_sent;
3346 copy_values_not_sent = stats_values_not_sent;
3347 copy_receive_list_length = receive_list_length;
3349 /* Initialize `vl' */
3353 vl.interval = interval_g;
3354 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
3355 sstrncpy (vl.plugin, "network", sizeof (vl.plugin));
3357 /* Octets received / sent */
3358 vl.values[0].counter = (counter_t) copy_octets_rx;
3359 vl.values[1].counter = (counter_t) copy_octets_tx;
3360 sstrncpy (vl.type, "if_octets", sizeof (vl.type));
3361 plugin_dispatch_values_secure (&vl);
3363 /* Packets received / send */
3364 vl.values[0].counter = (counter_t) copy_packets_rx;
3365 vl.values[1].counter = (counter_t) copy_packets_tx;
3366 sstrncpy (vl.type, "if_packets", sizeof (vl.type));
3367 plugin_dispatch_values_secure (&vl);
3369 /* Values (not) dispatched and (not) send */
3370 sstrncpy (vl.type, "total_values", sizeof (vl.type));
3373 vl.values[0].derive = (derive_t) copy_values_dispatched;
3374 sstrncpy (vl.type_instance, "dispatch-accepted",
3375 sizeof (vl.type_instance));
3376 plugin_dispatch_values_secure (&vl);
3378 vl.values[0].derive = (derive_t) copy_values_not_dispatched;
3379 sstrncpy (vl.type_instance, "dispatch-rejected",
3380 sizeof (vl.type_instance));
3381 plugin_dispatch_values_secure (&vl);
3383 vl.values[0].derive = (derive_t) copy_values_sent;
3384 sstrncpy (vl.type_instance, "send-accepted",
3385 sizeof (vl.type_instance));
3386 plugin_dispatch_values_secure (&vl);
3388 vl.values[0].derive = (derive_t) copy_values_not_sent;
3389 sstrncpy (vl.type_instance, "send-rejected",
3390 sizeof (vl.type_instance));
3391 plugin_dispatch_values_secure (&vl);
3393 /* Receive queue length */
3394 vl.values[0].gauge = (gauge_t) copy_receive_list_length;
3395 sstrncpy (vl.type, "queue_length", sizeof (vl.type));
3396 vl.type_instance[0] = 0;
3397 plugin_dispatch_values_secure (&vl);
3400 } /* }}} int network_stats_read */
3402 static int network_init (void)
3404 static _Bool have_init = false;
3406 /* Check if we were already initialized. If so, just return - there's
3407 * nothing more to do (for now, that is). */
3413 if (network_init_gcrypt () < 0)
3415 ERROR ("network plugin: Failed to initialize crypto library.");
3420 if (network_config_stats != 0)
3421 plugin_register_read ("network", network_stats_read);
3423 plugin_register_shutdown ("network", network_shutdown);
3425 send_buffer = malloc (network_config_packet_size);
3426 if (send_buffer == NULL)
3428 ERROR ("network plugin: malloc failed.");
3431 network_init_buffer ();
3433 /* setup socket(s) and so on */
3434 if (sending_sockets != NULL)
3436 plugin_register_write ("network", network_write,
3437 /* user_data = */ NULL);
3438 plugin_register_notification ("network", network_notification,
3439 /* user_data = */ NULL);
3442 /* If no threads need to be started, return here. */
3443 if ((listen_sockets_num == 0)
3444 || ((dispatch_thread_running != 0)
3445 && (receive_thread_running != 0)))
3448 if (dispatch_thread_running == 0)
3451 status = pthread_create (&dispatch_thread_id,
3452 NULL /* no attributes */,
3454 NULL /* no argument */);
3458 ERROR ("network: pthread_create failed: %s",
3459 sstrerror (errno, errbuf,
3464 dispatch_thread_running = 1;
3468 if (receive_thread_running == 0)
3471 status = pthread_create (&receive_thread_id,
3472 NULL /* no attributes */,
3474 NULL /* no argument */);
3478 ERROR ("network: pthread_create failed: %s",
3479 sstrerror (errno, errbuf,
3484 receive_thread_running = 1;
3489 } /* int network_init */
3492 * The flush option of the network plugin cannot flush individual identifiers.
3493 * All the values are added to a buffer and sent when the buffer is full, the
3494 * requested value may or may not be in there, it's not worth finding out. We
3495 * just send the buffer if `flush' is called - if the requested value was in
3496 * there, good. If not, well, then there is nothing to flush.. -octo
3498 static int network_flush (int timeout,
3499 const char __attribute__((unused)) *identifier,
3500 user_data_t __attribute__((unused)) *user_data)
3502 pthread_mutex_lock (&send_buffer_lock);
3504 if (send_buffer_fill > 0)
3507 pthread_mutex_unlock (&send_buffer_lock);
3510 } /* int network_flush */
3512 void module_register (void)
3514 plugin_register_complex_config ("network", network_config);
3515 plugin_register_init ("network", network_init);
3516 plugin_register_flush ("network", network_flush,
3517 /* user_data = */ NULL);
3518 } /* void module_register */
3520 /* vim: set fdm=marker : */