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 void 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_SET_THREAD_CBS) failed: %s", gcry_strerror (err));
527 gcry_control (GCRYCTL_INITIALIZATION_FINISHED);
528 } /* }}} void network_init_gcrypt */
530 static gcry_cipher_hd_t network_get_aes256_cypher (sockent_t *se, /* {{{ */
531 const void *iv, size_t iv_size, const char *username)
534 gcry_cipher_hd_t *cyper_ptr;
535 unsigned char password_hash[32];
537 if (se->type == SOCKENT_TYPE_CLIENT)
539 cyper_ptr = &se->data.client.cypher;
540 memcpy (password_hash, se->data.client.password_hash,
541 sizeof (password_hash));
547 cyper_ptr = &se->data.server.cypher;
549 if (username == NULL)
552 secret = fbh_get (se->data.server.userdb, username);
556 gcry_md_hash_buffer (GCRY_MD_SHA256,
558 secret, strlen (secret));
563 if (*cyper_ptr == NULL)
565 err = gcry_cipher_open (cyper_ptr,
566 GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB, /* flags = */ 0);
569 ERROR ("network plugin: gcry_cipher_open returned: %s",
570 gcry_strerror (err));
577 gcry_cipher_reset (*cyper_ptr);
579 assert (*cyper_ptr != NULL);
581 err = gcry_cipher_setkey (*cyper_ptr,
582 password_hash, sizeof (password_hash));
585 ERROR ("network plugin: gcry_cipher_setkey returned: %s",
586 gcry_strerror (err));
587 gcry_cipher_close (*cyper_ptr);
592 err = gcry_cipher_setiv (*cyper_ptr, iv, iv_size);
595 ERROR ("network plugin: gcry_cipher_setkey returned: %s",
596 gcry_strerror (err));
597 gcry_cipher_close (*cyper_ptr);
603 } /* }}} int network_get_aes256_cypher */
604 #endif /* HAVE_LIBGCRYPT */
606 static int write_part_values (char **ret_buffer, int *ret_buffer_len,
607 const data_set_t *ds, const value_list_t *vl)
613 part_header_t pkg_ph;
614 uint16_t pkg_num_values;
615 uint8_t *pkg_values_types;
621 num_values = vl->values_len;
622 packet_len = sizeof (part_header_t) + sizeof (uint16_t)
623 + (num_values * sizeof (uint8_t))
624 + (num_values * sizeof (value_t));
626 if (*ret_buffer_len < packet_len)
629 pkg_values_types = (uint8_t *) malloc (num_values * sizeof (uint8_t));
630 if (pkg_values_types == NULL)
632 ERROR ("network plugin: write_part_values: malloc failed.");
636 pkg_values = (value_t *) malloc (num_values * sizeof (value_t));
637 if (pkg_values == NULL)
639 free (pkg_values_types);
640 ERROR ("network plugin: write_part_values: malloc failed.");
644 pkg_ph.type = htons (TYPE_VALUES);
645 pkg_ph.length = htons (packet_len);
647 pkg_num_values = htons ((uint16_t) vl->values_len);
649 for (i = 0; i < num_values; i++)
651 pkg_values_types[i] = (uint8_t) ds->ds[i].type;
652 switch (ds->ds[i].type)
654 case DS_TYPE_COUNTER:
655 pkg_values[i].counter = htonll (vl->values[i].counter);
659 pkg_values[i].gauge = htond (vl->values[i].gauge);
663 pkg_values[i].derive = htonll (vl->values[i].derive);
666 case DS_TYPE_ABSOLUTE:
667 pkg_values[i].absolute = htonll (vl->values[i].absolute);
671 free (pkg_values_types);
673 ERROR ("network plugin: write_part_values: "
674 "Unknown data source type: %i",
677 } /* switch (ds->ds[i].type) */
678 } /* for (num_values) */
681 * Use `memcpy' to write everything to the buffer, because the pointer
682 * may be unaligned and some architectures, such as SPARC, can't handle
685 packet_ptr = *ret_buffer;
687 memcpy (packet_ptr + offset, &pkg_ph, sizeof (pkg_ph));
688 offset += sizeof (pkg_ph);
689 memcpy (packet_ptr + offset, &pkg_num_values, sizeof (pkg_num_values));
690 offset += sizeof (pkg_num_values);
691 memcpy (packet_ptr + offset, pkg_values_types, num_values * sizeof (uint8_t));
692 offset += num_values * sizeof (uint8_t);
693 memcpy (packet_ptr + offset, pkg_values, num_values * sizeof (value_t));
694 offset += num_values * sizeof (value_t);
696 assert (offset == packet_len);
698 *ret_buffer = packet_ptr + packet_len;
699 *ret_buffer_len -= packet_len;
701 free (pkg_values_types);
705 } /* int write_part_values */
707 static int write_part_number (char **ret_buffer, int *ret_buffer_len,
708 int type, uint64_t value)
713 part_header_t pkg_head;
718 packet_len = sizeof (pkg_head) + sizeof (pkg_value);
720 if (*ret_buffer_len < packet_len)
723 pkg_head.type = htons (type);
724 pkg_head.length = htons (packet_len);
725 pkg_value = htonll (value);
727 packet_ptr = *ret_buffer;
729 memcpy (packet_ptr + offset, &pkg_head, sizeof (pkg_head));
730 offset += sizeof (pkg_head);
731 memcpy (packet_ptr + offset, &pkg_value, sizeof (pkg_value));
732 offset += sizeof (pkg_value);
734 assert (offset == packet_len);
736 *ret_buffer = packet_ptr + packet_len;
737 *ret_buffer_len -= packet_len;
740 } /* int write_part_number */
742 static int write_part_string (char **ret_buffer, int *ret_buffer_len,
743 int type, const char *str, int str_len)
753 buffer_len = 2 * sizeof (uint16_t) + str_len + 1;
754 if (*ret_buffer_len < buffer_len)
757 pkg_type = htons (type);
758 pkg_length = htons (buffer_len);
760 buffer = *ret_buffer;
762 memcpy (buffer + offset, (void *) &pkg_type, sizeof (pkg_type));
763 offset += sizeof (pkg_type);
764 memcpy (buffer + offset, (void *) &pkg_length, sizeof (pkg_length));
765 offset += sizeof (pkg_length);
766 memcpy (buffer + offset, str, str_len);
768 memset (buffer + offset, '\0', 1);
771 assert (offset == buffer_len);
773 *ret_buffer = buffer + buffer_len;
774 *ret_buffer_len -= buffer_len;
777 } /* int write_part_string */
779 static int parse_part_values (void **ret_buffer, size_t *ret_buffer_len,
780 value_t **ret_values, int *ret_num_values)
782 char *buffer = *ret_buffer;
783 size_t buffer_len = *ret_buffer_len;
798 NOTICE ("network plugin: packet is too short: "
799 "buffer_len = %zu", buffer_len);
803 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
804 buffer += sizeof (tmp16);
805 pkg_type = ntohs (tmp16);
807 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
808 buffer += sizeof (tmp16);
809 pkg_length = ntohs (tmp16);
811 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
812 buffer += sizeof (tmp16);
813 pkg_numval = ntohs (tmp16);
815 assert (pkg_type == TYPE_VALUES);
817 exp_size = 3 * sizeof (uint16_t)
818 + pkg_numval * (sizeof (uint8_t) + sizeof (value_t));
819 if (buffer_len < exp_size)
821 WARNING ("network plugin: parse_part_values: "
823 "Chunk of size %zu expected, "
824 "but buffer has only %zu bytes left.",
825 exp_size, buffer_len);
829 if (pkg_length != exp_size)
831 WARNING ("network plugin: parse_part_values: "
832 "Length and number of values "
833 "in the packet don't match.");
837 pkg_types = (uint8_t *) malloc (pkg_numval * sizeof (uint8_t));
838 pkg_values = (value_t *) malloc (pkg_numval * sizeof (value_t));
839 if ((pkg_types == NULL) || (pkg_values == NULL))
843 ERROR ("network plugin: parse_part_values: malloc failed.");
847 memcpy ((void *) pkg_types, (void *) buffer, pkg_numval * sizeof (uint8_t));
848 buffer += pkg_numval * sizeof (uint8_t);
849 memcpy ((void *) pkg_values, (void *) buffer, pkg_numval * sizeof (value_t));
850 buffer += pkg_numval * sizeof (value_t);
852 for (i = 0; i < pkg_numval; i++)
854 switch (pkg_types[i])
856 case DS_TYPE_COUNTER:
857 pkg_values[i].counter = (counter_t) ntohll (pkg_values[i].counter);
861 pkg_values[i].gauge = (gauge_t) ntohd (pkg_values[i].gauge);
865 pkg_values[i].derive = (derive_t) ntohll (pkg_values[i].derive);
868 case DS_TYPE_ABSOLUTE:
869 pkg_values[i].absolute = (absolute_t) ntohll (pkg_values[i].absolute);
873 NOTICE ("network plugin: parse_part_values: "
874 "Don't know how to handle data source type %"PRIu8,
879 } /* switch (pkg_types[i]) */
882 *ret_buffer = buffer;
883 *ret_buffer_len = buffer_len - pkg_length;
884 *ret_num_values = pkg_numval;
885 *ret_values = pkg_values;
890 } /* int parse_part_values */
892 static int parse_part_number (void **ret_buffer, size_t *ret_buffer_len,
895 char *buffer = *ret_buffer;
896 size_t buffer_len = *ret_buffer_len;
900 size_t exp_size = 2 * sizeof (uint16_t) + sizeof (uint64_t);
904 if (buffer_len < exp_size)
906 WARNING ("network plugin: parse_part_number: "
908 "Chunk of size %zu expected, "
909 "but buffer has only %zu bytes left.",
910 exp_size, buffer_len);
914 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
915 buffer += sizeof (tmp16);
916 /* pkg_type = ntohs (tmp16); */
918 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
919 buffer += sizeof (tmp16);
920 pkg_length = ntohs (tmp16);
922 memcpy ((void *) &tmp64, buffer, sizeof (tmp64));
923 buffer += sizeof (tmp64);
924 *value = ntohll (tmp64);
926 *ret_buffer = buffer;
927 *ret_buffer_len = buffer_len - pkg_length;
930 } /* int parse_part_number */
932 static int parse_part_string (void **ret_buffer, size_t *ret_buffer_len,
933 char *output, int output_len)
935 char *buffer = *ret_buffer;
936 size_t buffer_len = *ret_buffer_len;
939 size_t header_size = 2 * sizeof (uint16_t);
943 if (buffer_len < header_size)
945 WARNING ("network plugin: parse_part_string: "
947 "Chunk of at least size %zu expected, "
948 "but buffer has only %zu bytes left.",
949 header_size, buffer_len);
953 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
954 buffer += sizeof (tmp16);
955 /* pkg_type = ntohs (tmp16); */
957 memcpy ((void *) &tmp16, buffer, sizeof (tmp16));
958 buffer += sizeof (tmp16);
959 pkg_length = ntohs (tmp16);
961 /* Check that packet fits in the input buffer */
962 if (pkg_length > buffer_len)
964 WARNING ("network plugin: parse_part_string: "
966 "Chunk of size %"PRIu16" received, "
967 "but buffer has only %zu bytes left.",
968 pkg_length, buffer_len);
972 /* Check that pkg_length is in the valid range */
973 if (pkg_length <= header_size)
975 WARNING ("network plugin: parse_part_string: "
977 "Header claims this packet is only %hu "
978 "bytes long.", pkg_length);
982 /* Check that the package data fits into the output buffer.
983 * The previous if-statement ensures that:
984 * `pkg_length > header_size' */
986 || ((size_t) output_len < ((size_t) pkg_length - header_size)))
988 WARNING ("network plugin: parse_part_string: "
989 "Output buffer too small.");
993 /* All sanity checks successfull, let's copy the data over */
994 output_len = pkg_length - header_size;
995 memcpy ((void *) output, (void *) buffer, output_len);
996 buffer += output_len;
998 /* For some very weird reason '\0' doesn't do the trick on SPARC in
1000 if (output[output_len - 1] != 0)
1002 WARNING ("network plugin: parse_part_string: "
1003 "Received string does not end "
1004 "with a NULL-byte.");
1008 *ret_buffer = buffer;
1009 *ret_buffer_len = buffer_len - pkg_length;
1012 } /* int parse_part_string */
1014 /* Forward declaration: parse_part_sign_sha256 and parse_part_encr_aes256 call
1015 * parse_packet and vice versa. */
1016 #define PP_SIGNED 0x01
1017 #define PP_ENCRYPTED 0x02
1018 static int parse_packet (sockent_t *se,
1019 void *buffer, size_t buffer_size, int flags,
1020 const char *username);
1022 #define BUFFER_READ(p,s) do { \
1023 memcpy ((p), buffer + buffer_offset, (s)); \
1024 buffer_offset += (s); \
1028 static int parse_part_sign_sha256 (sockent_t *se, /* {{{ */
1029 void **ret_buffer, size_t *ret_buffer_len, int flags)
1031 static c_complain_t complain_no_users = C_COMPLAIN_INIT_STATIC;
1035 size_t buffer_offset;
1037 size_t username_len;
1040 part_signature_sha256_t pss;
1041 uint16_t pss_head_length;
1042 char hash[sizeof (pss.hash)];
1046 unsigned char *hash_ptr;
1048 buffer = *ret_buffer;
1049 buffer_len = *ret_buffer_len;
1052 if (se->data.server.userdb == NULL)
1054 c_complain (LOG_NOTICE, &complain_no_users,
1055 "network plugin: Received signed network packet but can't verify it "
1056 "because no user DB has been configured. Will accept it.");
1060 /* Check if the buffer has enough data for this structure. */
1061 if (buffer_len <= PART_SIGNATURE_SHA256_SIZE)
1064 /* Read type and length header */
1065 BUFFER_READ (&pss.head.type, sizeof (pss.head.type));
1066 BUFFER_READ (&pss.head.length, sizeof (pss.head.length));
1067 pss_head_length = ntohs (pss.head.length);
1069 /* Check if the `pss_head_length' is within bounds. */
1070 if ((pss_head_length <= PART_SIGNATURE_SHA256_SIZE)
1071 || (pss_head_length > buffer_len))
1073 ERROR ("network plugin: HMAC-SHA-256 with invalid length received.");
1077 /* Copy the hash. */
1078 BUFFER_READ (pss.hash, sizeof (pss.hash));
1080 /* Calculate username length (without null byte) and allocate memory */
1081 username_len = pss_head_length - PART_SIGNATURE_SHA256_SIZE;
1082 pss.username = malloc (username_len + 1);
1083 if (pss.username == NULL)
1086 /* Read the username */
1087 BUFFER_READ (pss.username, username_len);
1088 pss.username[username_len] = 0;
1090 assert (buffer_offset == pss_head_length);
1092 /* Query the password */
1093 secret = fbh_get (se->data.server.userdb, pss.username);
1096 ERROR ("network plugin: Unknown user: %s", pss.username);
1097 sfree (pss.username);
1101 /* Create a hash device and check the HMAC */
1103 err = gcry_md_open (&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
1106 ERROR ("network plugin: Creating HMAC-SHA-256 object failed: %s",
1107 gcry_strerror (err));
1109 sfree (pss.username);
1113 err = gcry_md_setkey (hd, secret, strlen (secret));
1116 ERROR ("network plugin: gcry_md_setkey failed: %s", gcry_strerror (err));
1119 sfree (pss.username);
1124 buffer + PART_SIGNATURE_SHA256_SIZE,
1125 buffer_len - PART_SIGNATURE_SHA256_SIZE);
1126 hash_ptr = gcry_md_read (hd, GCRY_MD_SHA256);
1127 if (hash_ptr == NULL)
1129 ERROR ("network plugin: gcry_md_read failed.");
1132 sfree (pss.username);
1135 memcpy (hash, hash_ptr, sizeof (hash));
1141 if (memcmp (pss.hash, hash, sizeof (pss.hash)) != 0)
1143 WARNING ("network plugin: Verifying HMAC-SHA-256 signature failed: "
1148 parse_packet (se, buffer + buffer_offset, buffer_len - buffer_offset,
1149 flags | PP_SIGNED, pss.username);
1153 sfree (pss.username);
1155 *ret_buffer = buffer + buffer_len;
1156 *ret_buffer_len = 0;
1159 } /* }}} int parse_part_sign_sha256 */
1160 /* #endif HAVE_LIBGCRYPT */
1162 #else /* if !HAVE_LIBGCRYPT */
1163 static int parse_part_sign_sha256 (sockent_t *se, /* {{{ */
1164 void **ret_buffer, size_t *ret_buffer_size, int flags)
1166 static int warning_has_been_printed = 0;
1170 size_t buffer_offset;
1173 part_signature_sha256_t pss;
1175 buffer = *ret_buffer;
1176 buffer_size = *ret_buffer_size;
1179 if (buffer_size <= PART_SIGNATURE_SHA256_SIZE)
1182 BUFFER_READ (&pss.head.type, sizeof (pss.head.type));
1183 BUFFER_READ (&pss.head.length, sizeof (pss.head.length));
1184 part_len = ntohs (pss.head.length);
1186 if ((part_len <= PART_SIGNATURE_SHA256_SIZE)
1187 || (part_len > buffer_size))
1190 if (warning_has_been_printed == 0)
1192 WARNING ("network plugin: Received signed packet, but the network "
1193 "plugin was not linked with libgcrypt, so I cannot "
1194 "verify the signature. The packet will be accepted.");
1195 warning_has_been_printed = 1;
1198 parse_packet (se, buffer + part_len, buffer_size - part_len, flags,
1199 /* username = */ NULL);
1201 *ret_buffer = buffer + buffer_size;
1202 *ret_buffer_size = 0;
1205 } /* }}} int parse_part_sign_sha256 */
1206 #endif /* !HAVE_LIBGCRYPT */
1209 static int parse_part_encr_aes256 (sockent_t *se, /* {{{ */
1210 void **ret_buffer, size_t *ret_buffer_len,
1213 char *buffer = *ret_buffer;
1214 size_t buffer_len = *ret_buffer_len;
1217 size_t buffer_offset;
1218 uint16_t username_len;
1219 part_encryption_aes256_t pea;
1220 unsigned char hash[sizeof (pea.hash)];
1222 gcry_cipher_hd_t cypher;
1225 /* Make sure at least the header if available. */
1226 if (buffer_len <= PART_ENCRYPTION_AES256_SIZE)
1228 NOTICE ("network plugin: parse_part_encr_aes256: "
1229 "Discarding short packet.");
1235 /* Copy the unencrypted information into `pea'. */
1236 BUFFER_READ (&pea.head.type, sizeof (pea.head.type));
1237 BUFFER_READ (&pea.head.length, sizeof (pea.head.length));
1239 /* Check the `part size'. */
1240 part_size = ntohs (pea.head.length);
1241 if ((part_size <= PART_ENCRYPTION_AES256_SIZE)
1242 || (part_size > buffer_len))
1244 NOTICE ("network plugin: parse_part_encr_aes256: "
1245 "Discarding part with invalid size.");
1249 /* Read the username */
1250 BUFFER_READ (&username_len, sizeof (username_len));
1251 username_len = ntohs (username_len);
1253 if ((username_len <= 0)
1254 || (username_len > (part_size - (PART_ENCRYPTION_AES256_SIZE + 1))))
1256 NOTICE ("network plugin: parse_part_encr_aes256: "
1257 "Discarding part with invalid username length.");
1261 assert (username_len > 0);
1262 pea.username = malloc (username_len + 1);
1263 if (pea.username == NULL)
1265 BUFFER_READ (pea.username, username_len);
1266 pea.username[username_len] = 0;
1268 /* Last but not least, the initialization vector */
1269 BUFFER_READ (pea.iv, sizeof (pea.iv));
1271 /* Make sure we are at the right position */
1272 assert (buffer_offset == (username_len +
1273 PART_ENCRYPTION_AES256_SIZE - sizeof (pea.hash)));
1275 cypher = network_get_aes256_cypher (se, pea.iv, sizeof (pea.iv),
1279 sfree (pea.username);
1283 payload_len = part_size - (PART_ENCRYPTION_AES256_SIZE + username_len);
1284 assert (payload_len > 0);
1286 /* Decrypt the packet in-place */
1287 err = gcry_cipher_decrypt (cypher,
1288 buffer + buffer_offset,
1289 part_size - buffer_offset,
1290 /* in = */ NULL, /* in len = */ 0);
1293 sfree (pea.username);
1294 ERROR ("network plugin: gcry_cipher_decrypt returned: %s",
1295 gcry_strerror (err));
1300 BUFFER_READ (pea.hash, sizeof (pea.hash));
1302 /* Make sure we're at the right position - again */
1303 assert (buffer_offset == (username_len + PART_ENCRYPTION_AES256_SIZE));
1304 assert (buffer_offset == (part_size - payload_len));
1306 /* Check hash sum */
1307 memset (hash, 0, sizeof (hash));
1308 gcry_md_hash_buffer (GCRY_MD_SHA1, hash,
1309 buffer + buffer_offset, payload_len);
1310 if (memcmp (hash, pea.hash, sizeof (hash)) != 0)
1312 sfree (pea.username);
1313 ERROR ("network plugin: Decryption failed: Checksum mismatch.");
1317 parse_packet (se, buffer + buffer_offset, payload_len,
1318 flags | PP_ENCRYPTED, pea.username);
1320 /* XXX: Free pea.username?!? */
1322 /* Update return values */
1323 *ret_buffer = buffer + part_size;
1324 *ret_buffer_len = buffer_len - part_size;
1326 sfree (pea.username);
1329 } /* }}} int parse_part_encr_aes256 */
1330 /* #endif HAVE_LIBGCRYPT */
1332 #else /* if !HAVE_LIBGCRYPT */
1333 static int parse_part_encr_aes256 (sockent_t *se, /* {{{ */
1334 void **ret_buffer, size_t *ret_buffer_size, int flags)
1336 static int warning_has_been_printed = 0;
1340 size_t buffer_offset;
1345 buffer = *ret_buffer;
1346 buffer_size = *ret_buffer_size;
1349 /* parse_packet assures this minimum size. */
1350 assert (buffer_size >= (sizeof (ph.type) + sizeof (ph.length)));
1352 BUFFER_READ (&ph.type, sizeof (ph.type));
1353 BUFFER_READ (&ph.length, sizeof (ph.length));
1354 ph_length = ntohs (ph.length);
1356 if ((ph_length <= PART_ENCRYPTION_AES256_SIZE)
1357 || (ph_length > buffer_size))
1359 ERROR ("network plugin: AES-256 encrypted part "
1360 "with invalid length received.");
1364 if (warning_has_been_printed == 0)
1366 WARNING ("network plugin: Received encrypted packet, but the network "
1367 "plugin was not linked with libgcrypt, so I cannot "
1368 "decrypt it. The part will be discarded.");
1369 warning_has_been_printed = 1;
1372 *ret_buffer += ph_length;
1373 *ret_buffer_size -= ph_length;
1376 } /* }}} int parse_part_encr_aes256 */
1377 #endif /* !HAVE_LIBGCRYPT */
1381 static int parse_packet (sockent_t *se, /* {{{ */
1382 void *buffer, size_t buffer_size, int flags,
1383 const char *username)
1387 value_list_t vl = VALUE_LIST_INIT;
1391 int packet_was_signed = (flags & PP_SIGNED);
1392 int packet_was_encrypted = (flags & PP_ENCRYPTED);
1393 int printed_ignore_warning = 0;
1394 #endif /* HAVE_LIBGCRYPT */
1397 memset (&vl, '\0', sizeof (vl));
1398 memset (&n, '\0', sizeof (n));
1401 while ((status == 0) && (0 < buffer_size)
1402 && ((unsigned int) buffer_size > sizeof (part_header_t)))
1404 uint16_t pkg_length;
1407 memcpy ((void *) &pkg_type,
1410 memcpy ((void *) &pkg_length,
1411 (void *) (buffer + sizeof (pkg_type)),
1412 sizeof (pkg_length));
1414 pkg_length = ntohs (pkg_length);
1415 pkg_type = ntohs (pkg_type);
1417 if (pkg_length > buffer_size)
1419 /* Ensure that this loop terminates eventually */
1420 if (pkg_length < (2 * sizeof (uint16_t)))
1423 if (pkg_type == TYPE_ENCR_AES256)
1425 status = parse_part_encr_aes256 (se,
1426 &buffer, &buffer_size, flags);
1429 ERROR ("network plugin: Decrypting AES256 "
1431 "with status %i.", status);
1436 else if ((se->data.server.security_level == SECURITY_LEVEL_ENCRYPT)
1437 && (packet_was_encrypted == 0))
1439 if (printed_ignore_warning == 0)
1441 INFO ("network plugin: Unencrypted packet or "
1442 "part has been ignored.");
1443 printed_ignore_warning = 1;
1445 buffer = ((char *) buffer) + pkg_length;
1446 buffer_size -= (size_t) pkg_length;
1449 #endif /* HAVE_LIBGCRYPT */
1450 else if (pkg_type == TYPE_SIGN_SHA256)
1452 status = parse_part_sign_sha256 (se,
1453 &buffer, &buffer_size, flags);
1456 ERROR ("network plugin: Verifying HMAC-SHA-256 "
1458 "with status %i.", status);
1463 else if ((se->data.server.security_level == SECURITY_LEVEL_SIGN)
1464 && (packet_was_encrypted == 0)
1465 && (packet_was_signed == 0))
1467 if (printed_ignore_warning == 0)
1469 INFO ("network plugin: Unsigned packet or "
1470 "part has been ignored.");
1471 printed_ignore_warning = 1;
1473 buffer = ((char *) buffer) + pkg_length;
1474 buffer_size -= (size_t) pkg_length;
1477 #endif /* HAVE_LIBGCRYPT */
1478 else if (pkg_type == TYPE_VALUES)
1480 status = parse_part_values (&buffer, &buffer_size,
1481 &vl.values, &vl.values_len);
1485 network_dispatch_values (&vl, username);
1489 else if (pkg_type == TYPE_TIME)
1492 status = parse_part_number (&buffer, &buffer_size,
1496 vl.time = (time_t) tmp;
1497 n.time = (time_t) tmp;
1500 else if (pkg_type == TYPE_INTERVAL)
1503 status = parse_part_number (&buffer, &buffer_size,
1506 vl.interval = (int) tmp;
1508 else if (pkg_type == TYPE_HOST)
1510 status = parse_part_string (&buffer, &buffer_size,
1511 vl.host, sizeof (vl.host));
1513 sstrncpy (n.host, vl.host, sizeof (n.host));
1515 else if (pkg_type == TYPE_PLUGIN)
1517 status = parse_part_string (&buffer, &buffer_size,
1518 vl.plugin, sizeof (vl.plugin));
1520 sstrncpy (n.plugin, vl.plugin,
1523 else if (pkg_type == TYPE_PLUGIN_INSTANCE)
1525 status = parse_part_string (&buffer, &buffer_size,
1527 sizeof (vl.plugin_instance));
1529 sstrncpy (n.plugin_instance,
1531 sizeof (n.plugin_instance));
1533 else if (pkg_type == TYPE_TYPE)
1535 status = parse_part_string (&buffer, &buffer_size,
1536 vl.type, sizeof (vl.type));
1538 sstrncpy (n.type, vl.type, sizeof (n.type));
1540 else if (pkg_type == TYPE_TYPE_INSTANCE)
1542 status = parse_part_string (&buffer, &buffer_size,
1544 sizeof (vl.type_instance));
1546 sstrncpy (n.type_instance, vl.type_instance,
1547 sizeof (n.type_instance));
1549 else if (pkg_type == TYPE_MESSAGE)
1551 status = parse_part_string (&buffer, &buffer_size,
1552 n.message, sizeof (n.message));
1558 else if ((n.severity != NOTIF_FAILURE)
1559 && (n.severity != NOTIF_WARNING)
1560 && (n.severity != NOTIF_OKAY))
1562 INFO ("network plugin: "
1563 "Ignoring notification with "
1564 "unknown severity %i.",
1567 else if (n.time <= 0)
1569 INFO ("network plugin: "
1570 "Ignoring notification with "
1573 else if (strlen (n.message) <= 0)
1575 INFO ("network plugin: "
1576 "Ignoring notification with "
1577 "an empty message.");
1581 network_dispatch_notification (&n);
1584 else if (pkg_type == TYPE_SEVERITY)
1587 status = parse_part_number (&buffer, &buffer_size,
1590 n.severity = (int) tmp;
1594 DEBUG ("network plugin: parse_packet: Unknown part"
1595 " type: 0x%04hx", pkg_type);
1596 buffer = ((char *) buffer) + pkg_length;
1597 buffer_size -= (size_t) pkg_length;
1599 } /* while (buffer_size > sizeof (part_header_t)) */
1601 if (status == 0 && buffer_size > 0)
1602 WARNING ("network plugin: parse_packet: Received truncated "
1603 "packet, try increasing `MaxPacketSize'");
1606 } /* }}} int parse_packet */
1608 static void free_sockent_client (struct sockent_client *sec) /* {{{ */
1617 sfree (sec->username);
1618 sfree (sec->password);
1619 if (sec->cypher != NULL)
1620 gcry_cipher_close (sec->cypher);
1622 } /* }}} void free_sockent_client */
1624 static void free_sockent_server (struct sockent_server *ses) /* {{{ */
1628 for (i = 0; i < ses->fd_num; i++)
1630 if (ses->fd[i] >= 0)
1639 sfree (ses->auth_file);
1640 fbh_destroy (ses->userdb);
1641 if (ses->cypher != NULL)
1642 gcry_cipher_close (ses->cypher);
1644 } /* }}} void free_sockent_server */
1646 static void sockent_destroy (sockent_t *se) /* {{{ */
1650 DEBUG ("network plugin: sockent_destroy (se = %p);", (void *) se);
1657 sfree (se->service);
1659 if (se->type == SOCKENT_TYPE_CLIENT)
1660 free_sockent_client (&se->data.client);
1662 free_sockent_server (&se->data.server);
1667 } /* }}} void sockent_destroy */
1670 * int network_set_ttl
1672 * Set the `IP_MULTICAST_TTL', `IP_TTL', `IPV6_MULTICAST_HOPS' or
1673 * `IPV6_UNICAST_HOPS', depending on which option is applicable.
1675 * The `struct addrinfo' is used to destinguish between unicast and multicast
1678 static int network_set_ttl (const sockent_t *se, const struct addrinfo *ai)
1680 DEBUG ("network plugin: network_set_ttl: network_config_ttl = %i;",
1681 network_config_ttl);
1683 assert (se->type == SOCKENT_TYPE_CLIENT);
1685 if ((network_config_ttl < 1) || (network_config_ttl > 255))
1688 if (ai->ai_family == AF_INET)
1690 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
1693 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
1694 optname = IP_MULTICAST_TTL;
1698 if (setsockopt (se->data.client.fd, IPPROTO_IP, optname,
1699 &network_config_ttl,
1700 sizeof (network_config_ttl)) != 0)
1703 ERROR ("network plugin: setsockopt (ipv4-ttl): %s",
1704 sstrerror (errno, errbuf, sizeof (errbuf)));
1708 else if (ai->ai_family == AF_INET6)
1710 /* Useful example: http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
1711 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
1714 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
1715 optname = IPV6_MULTICAST_HOPS;
1717 optname = IPV6_UNICAST_HOPS;
1719 if (setsockopt (se->data.client.fd, IPPROTO_IPV6, optname,
1720 &network_config_ttl,
1721 sizeof (network_config_ttl)) != 0)
1724 ERROR ("network plugin: setsockopt(ipv6-ttl): %s",
1725 sstrerror (errno, errbuf,
1732 } /* int network_set_ttl */
1734 static int network_set_interface (const sockent_t *se, const struct addrinfo *ai) /* {{{ */
1736 DEBUG ("network plugin: network_set_interface: interface index = %i;",
1739 assert (se->type == SOCKENT_TYPE_CLIENT);
1741 if (ai->ai_family == AF_INET)
1743 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
1745 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
1747 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1748 /* If possible, use the "ip_mreqn" structure which has
1749 * an "interface index" member. Using the interface
1750 * index is preferred here, because of its similarity
1751 * to the way IPv6 handles this. Unfortunately, it
1752 * appears not to be portable. */
1753 struct ip_mreqn mreq;
1755 memset (&mreq, 0, sizeof (mreq));
1756 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1757 mreq.imr_address.s_addr = ntohl (INADDR_ANY);
1758 mreq.imr_ifindex = se->interface;
1760 struct ip_mreq mreq;
1762 memset (&mreq, 0, sizeof (mreq));
1763 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1764 mreq.imr_interface.s_addr = ntohl (INADDR_ANY);
1767 if (setsockopt (se->data.client.fd, IPPROTO_IP, IP_MULTICAST_IF,
1768 &mreq, sizeof (mreq)) != 0)
1771 ERROR ("network plugin: setsockopt (ipv4-multicast-if): %s",
1772 sstrerror (errno, errbuf, sizeof (errbuf)));
1779 else if (ai->ai_family == AF_INET6)
1781 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
1783 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
1785 if (setsockopt (se->data.client.fd, IPPROTO_IPV6, IPV6_MULTICAST_IF,
1787 sizeof (se->interface)) != 0)
1790 ERROR ("network plugin: setsockopt (ipv6-multicast-if): %s",
1791 sstrerror (errno, errbuf,
1800 /* else: Not a multicast interface. */
1801 if (se->interface != 0)
1803 #if defined(HAVE_IF_INDEXTONAME) && HAVE_IF_INDEXTONAME && defined(SO_BINDTODEVICE)
1804 char interface_name[IFNAMSIZ];
1806 if (if_indextoname (se->interface, interface_name) == NULL)
1809 DEBUG ("network plugin: Binding socket to interface %s", interface_name);
1811 if (setsockopt (se->data.client.fd, SOL_SOCKET, SO_BINDTODEVICE,
1813 sizeof(interface_name)) == -1 )
1816 ERROR ("network plugin: setsockopt (bind-if): %s",
1817 sstrerror (errno, errbuf, sizeof (errbuf)));
1820 /* #endif HAVE_IF_INDEXTONAME && SO_BINDTODEVICE */
1823 WARNING ("network plugin: Cannot set the interface on a unicast "
1825 # if !defined(SO_BINDTODEVICE)
1826 "the \"SO_BINDTODEVICE\" socket option "
1828 "the \"if_indextoname\" function "
1830 "is not available on your system.");
1836 } /* }}} network_set_interface */
1838 static int network_bind_socket (int fd, const struct addrinfo *ai, const int interface_idx)
1847 /* allow multiple sockets to use the same PORT number */
1848 if (setsockopt (fd, SOL_SOCKET, SO_REUSEADDR,
1849 &yes, sizeof(yes)) == -1) {
1851 ERROR ("network plugin: setsockopt (reuseaddr): %s",
1852 sstrerror (errno, errbuf, sizeof (errbuf)));
1856 DEBUG ("fd = %i; calling `bind'", fd);
1858 if (bind (fd, ai->ai_addr, ai->ai_addrlen) == -1)
1862 sstrerror (errno, errbuf, sizeof (errbuf)));
1866 if (ai->ai_family == AF_INET)
1868 struct sockaddr_in *addr = (struct sockaddr_in *) ai->ai_addr;
1869 if (IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
1871 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1872 struct ip_mreqn mreq;
1874 struct ip_mreq mreq;
1877 DEBUG ("fd = %i; IPv4 multicast address found", fd);
1879 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1880 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1881 /* Set the interface using the interface index if
1882 * possible (available). Unfortunately, the struct
1883 * ip_mreqn is not portable. */
1884 mreq.imr_address.s_addr = ntohl (INADDR_ANY);
1885 mreq.imr_ifindex = interface_idx;
1887 mreq.imr_interface.s_addr = ntohl (INADDR_ANY);
1890 if (setsockopt (fd, IPPROTO_IP, IP_MULTICAST_LOOP,
1891 &loop, sizeof (loop)) == -1)
1894 ERROR ("network plugin: setsockopt (multicast-loop): %s",
1895 sstrerror (errno, errbuf,
1900 if (setsockopt (fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
1901 &mreq, sizeof (mreq)) == -1)
1904 ERROR ("network plugin: setsockopt (add-membership): %s",
1905 sstrerror (errno, errbuf,
1913 else if (ai->ai_family == AF_INET6)
1915 /* Useful example: http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
1916 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) ai->ai_addr;
1917 if (IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
1919 struct ipv6_mreq mreq;
1921 DEBUG ("fd = %i; IPv6 multicast address found", fd);
1923 memcpy (&mreq.ipv6mr_multiaddr,
1925 sizeof (addr->sin6_addr));
1927 /* http://developer.apple.com/documentation/Darwin/Reference/ManPages/man4/ip6.4.html
1928 * ipv6mr_interface may be set to zeroes to
1929 * choose the default multicast interface or to
1930 * the index of a particular multicast-capable
1931 * interface if the host is multihomed.
1932 * Membership is associ-associated with a
1933 * single interface; programs running on
1934 * multihomed hosts may need to join the same
1935 * group on more than one interface.*/
1936 mreq.ipv6mr_interface = interface_idx;
1938 if (setsockopt (fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP,
1939 &loop, sizeof (loop)) == -1)
1942 ERROR ("network plugin: setsockopt (ipv6-multicast-loop): %s",
1943 sstrerror (errno, errbuf,
1948 if (setsockopt (fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP,
1949 &mreq, sizeof (mreq)) == -1)
1952 ERROR ("network plugin: setsockopt (ipv6-add-membership): %s",
1953 sstrerror (errno, errbuf,
1962 #if defined(HAVE_IF_INDEXTONAME) && HAVE_IF_INDEXTONAME && defined(SO_BINDTODEVICE)
1963 /* if a specific interface was set, bind the socket to it. But to avoid
1964 * possible problems with multicast routing, only do that for non-multicast
1966 if (interface_idx != 0)
1968 char interface_name[IFNAMSIZ];
1970 if (if_indextoname (interface_idx, interface_name) == NULL)
1973 DEBUG ("fd = %i; Binding socket to interface %s", fd, interface_name);
1975 if (setsockopt (fd, SOL_SOCKET, SO_BINDTODEVICE,
1977 sizeof(interface_name)) == -1 )
1980 ERROR ("network plugin: setsockopt (bind-if): %s",
1981 sstrerror (errno, errbuf, sizeof (errbuf)));
1985 #endif /* HAVE_IF_INDEXTONAME && SO_BINDTODEVICE */
1988 } /* int network_bind_socket */
1990 /* Initialize a sockent structure. `type' must be either `SOCKENT_TYPE_CLIENT'
1991 * or `SOCKENT_TYPE_SERVER' */
1992 static int sockent_init (sockent_t *se, int type) /* {{{ */
1997 memset (se, 0, sizeof (*se));
1999 se->type = SOCKENT_TYPE_CLIENT;
2005 if (type == SOCKENT_TYPE_SERVER)
2007 se->type = SOCKENT_TYPE_SERVER;
2008 se->data.server.fd = NULL;
2010 se->data.server.security_level = SECURITY_LEVEL_NONE;
2011 se->data.server.auth_file = NULL;
2012 se->data.server.userdb = NULL;
2013 se->data.server.cypher = NULL;
2018 se->data.client.fd = -1;
2019 se->data.client.addr = NULL;
2021 se->data.client.security_level = SECURITY_LEVEL_NONE;
2022 se->data.client.username = NULL;
2023 se->data.client.password = NULL;
2024 se->data.client.cypher = NULL;
2029 } /* }}} int sockent_init */
2031 /* Open the file descriptors for a initialized sockent structure. */
2032 static int sockent_open (sockent_t *se) /* {{{ */
2034 struct addrinfo ai_hints;
2035 struct addrinfo *ai_list, *ai_ptr;
2039 const char *service;
2044 /* Set up the security structures. */
2045 #if HAVE_LIBGCRYPT /* {{{ */
2046 if (se->type == SOCKENT_TYPE_CLIENT)
2048 if (se->data.client.security_level > SECURITY_LEVEL_NONE)
2050 network_init_gcrypt ();
2052 if ((se->data.client.username == NULL)
2053 || (se->data.client.password == NULL))
2055 ERROR ("network plugin: Client socket with "
2056 "security requested, but no "
2057 "credentials are configured.");
2060 gcry_md_hash_buffer (GCRY_MD_SHA256,
2061 se->data.client.password_hash,
2062 se->data.client.password,
2063 strlen (se->data.client.password));
2066 else /* (se->type == SOCKENT_TYPE_SERVER) */
2068 if (se->data.server.security_level > SECURITY_LEVEL_NONE)
2070 network_init_gcrypt ();
2072 if (se->data.server.auth_file == NULL)
2074 ERROR ("network plugin: Server socket with "
2075 "security requested, but no "
2076 "password file is configured.");
2080 if (se->data.server.auth_file != NULL)
2082 se->data.server.userdb = fbh_create (se->data.server.auth_file);
2083 if (se->data.server.userdb == NULL)
2085 ERROR ("network plugin: Reading password file "
2087 se->data.server.auth_file);
2088 if (se->data.server.security_level > SECURITY_LEVEL_NONE)
2093 #endif /* }}} HAVE_LIBGCRYPT */
2096 service = se->service;
2098 if (service == NULL)
2099 service = NET_DEFAULT_PORT;
2101 DEBUG ("network plugin: sockent_open: node = %s; service = %s;",
2104 memset (&ai_hints, 0, sizeof (ai_hints));
2105 ai_hints.ai_flags = 0;
2107 ai_hints.ai_flags |= AI_PASSIVE;
2109 #ifdef AI_ADDRCONFIG
2110 ai_hints.ai_flags |= AI_ADDRCONFIG;
2112 ai_hints.ai_family = AF_UNSPEC;
2113 ai_hints.ai_socktype = SOCK_DGRAM;
2114 ai_hints.ai_protocol = IPPROTO_UDP;
2116 ai_return = getaddrinfo (node, service, &ai_hints, &ai_list);
2119 ERROR ("network plugin: getaddrinfo (%s, %s) failed: %s",
2120 (se->node == NULL) ? "(null)" : se->node,
2121 (se->service == NULL) ? "(null)" : se->service,
2122 gai_strerror (ai_return));
2126 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
2130 if (se->type == SOCKENT_TYPE_SERVER) /* {{{ */
2134 tmp = realloc (se->data.server.fd,
2135 sizeof (*tmp) * (se->data.server.fd_num + 1));
2138 ERROR ("network plugin: realloc failed.");
2141 se->data.server.fd = tmp;
2142 tmp = se->data.server.fd + se->data.server.fd_num;
2144 *tmp = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
2145 ai_ptr->ai_protocol);
2149 ERROR ("network plugin: socket(2) failed: %s",
2150 sstrerror (errno, errbuf,
2155 status = network_bind_socket (*tmp, ai_ptr, se->interface);
2163 se->data.server.fd_num++;
2165 } /* }}} if (se->type == SOCKENT_TYPE_SERVER) */
2166 else /* if (se->type == SOCKENT_TYPE_CLIENT) {{{ */
2168 se->data.client.fd = socket (ai_ptr->ai_family,
2169 ai_ptr->ai_socktype,
2170 ai_ptr->ai_protocol);
2171 if (se->data.client.fd < 0)
2174 ERROR ("network plugin: socket(2) failed: %s",
2175 sstrerror (errno, errbuf,
2180 se->data.client.addr = malloc (sizeof (*se->data.client.addr));
2181 if (se->data.client.addr == NULL)
2183 ERROR ("network plugin: malloc failed.");
2184 close (se->data.client.fd);
2185 se->data.client.fd = -1;
2189 memset (se->data.client.addr, 0, sizeof (*se->data.client.addr));
2190 assert (sizeof (*se->data.client.addr) >= ai_ptr->ai_addrlen);
2191 memcpy (se->data.client.addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
2192 se->data.client.addrlen = ai_ptr->ai_addrlen;
2194 network_set_ttl (se, ai_ptr);
2195 network_set_interface (se, ai_ptr);
2197 /* We don't open more than one write-socket per
2198 * node/service pair.. */
2200 } /* }}} if (se->type == SOCKENT_TYPE_CLIENT) */
2201 } /* for (ai_list) */
2203 freeaddrinfo (ai_list);
2205 /* Check if all went well. */
2206 if (se->type == SOCKENT_TYPE_SERVER)
2208 if (se->data.server.fd_num <= 0)
2211 else /* if (se->type == SOCKENT_TYPE_CLIENT) */
2213 if (se->data.client.fd < 0)
2218 } /* }}} int sockent_open */
2220 /* Add a sockent to the global list of sockets */
2221 static int sockent_add (sockent_t *se) /* {{{ */
2223 sockent_t *last_ptr;
2228 if (se->type == SOCKENT_TYPE_SERVER)
2233 tmp = realloc (listen_sockets_pollfd,
2234 sizeof (*tmp) * (listen_sockets_num
2235 + se->data.server.fd_num));
2238 ERROR ("network plugin: realloc failed.");
2241 listen_sockets_pollfd = tmp;
2242 tmp = listen_sockets_pollfd + listen_sockets_num;
2244 for (i = 0; i < se->data.server.fd_num; i++)
2246 memset (tmp + i, 0, sizeof (*tmp));
2247 tmp[i].fd = se->data.server.fd[i];
2248 tmp[i].events = POLLIN | POLLPRI;
2252 listen_sockets_num += se->data.server.fd_num;
2254 if (listen_sockets == NULL)
2256 listen_sockets = se;
2259 last_ptr = listen_sockets;
2261 else /* if (se->type == SOCKENT_TYPE_CLIENT) */
2263 if (sending_sockets == NULL)
2265 sending_sockets = se;
2268 last_ptr = sending_sockets;
2271 while (last_ptr->next != NULL)
2272 last_ptr = last_ptr->next;
2273 last_ptr->next = se;
2276 } /* }}} int sockent_add */
2278 static void *dispatch_thread (void __attribute__((unused)) *arg) /* {{{ */
2282 receive_list_entry_t *ent;
2285 /* Lock and wait for more data to come in */
2286 pthread_mutex_lock (&receive_list_lock);
2287 while ((listen_loop == 0)
2288 && (receive_list_head == NULL))
2289 pthread_cond_wait (&receive_list_cond, &receive_list_lock);
2291 /* Remove the head entry and unlock */
2292 ent = receive_list_head;
2294 receive_list_head = ent->next;
2295 receive_list_length--;
2296 pthread_mutex_unlock (&receive_list_lock);
2298 /* Check whether we are supposed to exit. We do NOT check `listen_loop'
2299 * because we dispatch all missing packets before shutting down. */
2303 /* Look for the correct `sockent_t' */
2304 se = listen_sockets;
2309 for (i = 0; i < se->data.server.fd_num; i++)
2310 if (se->data.server.fd[i] == ent->fd)
2313 if (i < se->data.server.fd_num)
2321 ERROR ("network plugin: Got packet from FD %i, but can't "
2322 "find an appropriate socket entry.",
2329 parse_packet (se, ent->data, ent->data_len, /* flags = */ 0,
2330 /* username = */ NULL);
2336 } /* }}} void *dispatch_thread */
2338 static int network_receive (void) /* {{{ */
2340 char buffer[network_config_packet_size];
2346 receive_list_entry_t *private_list_head;
2347 receive_list_entry_t *private_list_tail;
2348 uint64_t private_list_length;
2350 assert (listen_sockets_num > 0);
2352 private_list_head = NULL;
2353 private_list_tail = NULL;
2354 private_list_length = 0;
2356 while (listen_loop == 0)
2358 status = poll (listen_sockets_pollfd, listen_sockets_num, -1);
2365 ERROR ("poll failed: %s",
2366 sstrerror (errno, errbuf, sizeof (errbuf)));
2370 for (i = 0; (i < listen_sockets_num) && (status > 0); i++)
2372 receive_list_entry_t *ent;
2374 if ((listen_sockets_pollfd[i].revents
2375 & (POLLIN | POLLPRI)) == 0)
2379 buffer_len = recv (listen_sockets_pollfd[i].fd,
2380 buffer, sizeof (buffer),
2385 ERROR ("recv failed: %s",
2386 sstrerror (errno, errbuf,
2391 stats_octets_rx += ((uint64_t) buffer_len);
2394 /* TODO: Possible performance enhancement: Do not free
2395 * these entries in the dispatch thread but put them in
2396 * another list, so we don't have to allocate more and
2397 * more of these structures. */
2398 ent = malloc (sizeof (receive_list_entry_t));
2401 ERROR ("network plugin: malloc failed.");
2404 memset (ent, 0, sizeof (receive_list_entry_t));
2405 ent->data = malloc (network_config_packet_size);
2406 if (ent->data == NULL)
2409 ERROR ("network plugin: malloc failed.");
2412 ent->fd = listen_sockets_pollfd[i].fd;
2415 memcpy (ent->data, buffer, buffer_len);
2416 ent->data_len = buffer_len;
2418 if (private_list_head == NULL)
2419 private_list_head = ent;
2421 private_list_tail->next = ent;
2422 private_list_tail = ent;
2423 private_list_length++;
2425 /* Do not block here. Blocking here has led to
2426 * insufficient performance in the past. */
2427 if (pthread_mutex_trylock (&receive_list_lock) == 0)
2429 assert (((receive_list_head == NULL) && (receive_list_length == 0))
2430 || ((receive_list_head != NULL) && (receive_list_length != 0)));
2432 if (receive_list_head == NULL)
2433 receive_list_head = private_list_head;
2435 receive_list_tail->next = private_list_head;
2436 receive_list_tail = private_list_tail;
2437 receive_list_length += private_list_length;
2439 pthread_cond_signal (&receive_list_cond);
2440 pthread_mutex_unlock (&receive_list_lock);
2442 private_list_head = NULL;
2443 private_list_tail = NULL;
2444 private_list_length = 0;
2446 } /* for (listen_sockets_pollfd) */
2447 } /* while (listen_loop == 0) */
2449 /* Make sure everything is dispatched before exiting. */
2450 if (private_list_head != NULL)
2452 pthread_mutex_lock (&receive_list_lock);
2454 if (receive_list_head == NULL)
2455 receive_list_head = private_list_head;
2457 receive_list_tail->next = private_list_head;
2458 receive_list_tail = private_list_tail;
2459 receive_list_length += private_list_length;
2461 private_list_head = NULL;
2462 private_list_tail = NULL;
2463 private_list_length = 0;
2465 pthread_cond_signal (&receive_list_cond);
2466 pthread_mutex_unlock (&receive_list_lock);
2470 } /* }}} int network_receive */
2472 static void *receive_thread (void __attribute__((unused)) *arg)
2474 return (network_receive () ? (void *) 1 : (void *) 0);
2475 } /* void *receive_thread */
2477 static void network_init_buffer (void)
2479 memset (send_buffer, 0, network_config_packet_size);
2480 send_buffer_ptr = send_buffer;
2481 send_buffer_fill = 0;
2483 memset (&send_buffer_vl, 0, sizeof (send_buffer_vl));
2484 } /* int network_init_buffer */
2486 static void networt_send_buffer_plain (const sockent_t *se, /* {{{ */
2487 const char *buffer, size_t buffer_size)
2493 status = sendto (se->data.client.fd, buffer, buffer_size,
2495 (struct sockaddr *) se->data.client.addr,
2496 se->data.client.addrlen);
2502 ERROR ("network plugin: sendto failed: %s",
2503 sstrerror (errno, errbuf,
2510 } /* }}} void networt_send_buffer_plain */
2513 #define BUFFER_ADD(p,s) do { \
2514 memcpy (buffer + buffer_offset, (p), (s)); \
2515 buffer_offset += (s); \
2518 static void networt_send_buffer_signed (const sockent_t *se, /* {{{ */
2519 const char *in_buffer, size_t in_buffer_size)
2521 part_signature_sha256_t ps;
2522 char buffer[BUFF_SIG_SIZE + in_buffer_size];
2523 size_t buffer_offset;
2524 size_t username_len;
2528 unsigned char *hash;
2531 err = gcry_md_open (&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
2534 ERROR ("network plugin: Creating HMAC object failed: %s",
2535 gcry_strerror (err));
2539 err = gcry_md_setkey (hd, se->data.client.password,
2540 strlen (se->data.client.password));
2543 ERROR ("network plugin: gcry_md_setkey failed: %s",
2544 gcry_strerror (err));
2549 username_len = strlen (se->data.client.username);
2550 if (username_len > (BUFF_SIG_SIZE - PART_SIGNATURE_SHA256_SIZE))
2552 ERROR ("network plugin: Username too long: %s",
2553 se->data.client.username);
2557 memcpy (buffer + PART_SIGNATURE_SHA256_SIZE,
2558 se->data.client.username, username_len);
2559 memcpy (buffer + PART_SIGNATURE_SHA256_SIZE + username_len,
2560 in_buffer, in_buffer_size);
2562 /* Initialize the `ps' structure. */
2563 memset (&ps, 0, sizeof (ps));
2564 ps.head.type = htons (TYPE_SIGN_SHA256);
2565 ps.head.length = htons (PART_SIGNATURE_SHA256_SIZE + username_len);
2567 /* Calculate the hash value. */
2568 gcry_md_write (hd, buffer + PART_SIGNATURE_SHA256_SIZE,
2569 username_len + in_buffer_size);
2570 hash = gcry_md_read (hd, GCRY_MD_SHA256);
2573 ERROR ("network plugin: gcry_md_read failed.");
2577 memcpy (ps.hash, hash, sizeof (ps.hash));
2579 /* Add the header */
2582 BUFFER_ADD (&ps.head.type, sizeof (ps.head.type));
2583 BUFFER_ADD (&ps.head.length, sizeof (ps.head.length));
2584 BUFFER_ADD (ps.hash, sizeof (ps.hash));
2586 assert (buffer_offset == PART_SIGNATURE_SHA256_SIZE);
2591 buffer_offset = PART_SIGNATURE_SHA256_SIZE + username_len + in_buffer_size;
2592 networt_send_buffer_plain (se, buffer, buffer_offset);
2593 } /* }}} void networt_send_buffer_signed */
2595 static void networt_send_buffer_encrypted (sockent_t *se, /* {{{ */
2596 const char *in_buffer, size_t in_buffer_size)
2598 part_encryption_aes256_t pea;
2599 char buffer[BUFF_SIG_SIZE + in_buffer_size];
2601 size_t buffer_offset;
2603 size_t username_len;
2605 gcry_cipher_hd_t cypher;
2607 /* Initialize the header fields */
2608 memset (&pea, 0, sizeof (pea));
2609 pea.head.type = htons (TYPE_ENCR_AES256);
2611 pea.username = se->data.client.username;
2613 username_len = strlen (pea.username);
2614 if ((PART_ENCRYPTION_AES256_SIZE + username_len) > BUFF_SIG_SIZE)
2616 ERROR ("network plugin: Username too long: %s", pea.username);
2620 buffer_size = PART_ENCRYPTION_AES256_SIZE + username_len + in_buffer_size;
2621 header_size = PART_ENCRYPTION_AES256_SIZE + username_len
2622 - sizeof (pea.hash);
2624 assert (buffer_size <= sizeof (buffer));
2625 DEBUG ("network plugin: networt_send_buffer_encrypted: "
2626 "buffer_size = %zu;", buffer_size);
2628 pea.head.length = htons ((uint16_t) (PART_ENCRYPTION_AES256_SIZE
2629 + username_len + in_buffer_size));
2630 pea.username_length = htons ((uint16_t) username_len);
2632 /* Chose a random initialization vector. */
2633 gcry_randomize ((void *) &pea.iv, sizeof (pea.iv), GCRY_STRONG_RANDOM);
2635 /* Create hash of the payload */
2636 gcry_md_hash_buffer (GCRY_MD_SHA1, pea.hash, in_buffer, in_buffer_size);
2638 /* Initialize the buffer */
2640 memset (buffer, 0, sizeof (buffer));
2643 BUFFER_ADD (&pea.head.type, sizeof (pea.head.type));
2644 BUFFER_ADD (&pea.head.length, sizeof (pea.head.length));
2645 BUFFER_ADD (&pea.username_length, sizeof (pea.username_length));
2646 BUFFER_ADD (pea.username, username_len);
2647 BUFFER_ADD (pea.iv, sizeof (pea.iv));
2648 assert (buffer_offset == header_size);
2649 BUFFER_ADD (pea.hash, sizeof (pea.hash));
2650 BUFFER_ADD (in_buffer, in_buffer_size);
2652 assert (buffer_offset == buffer_size);
2654 cypher = network_get_aes256_cypher (se, pea.iv, sizeof (pea.iv),
2655 se->data.client.password);
2659 /* Encrypt the buffer in-place */
2660 err = gcry_cipher_encrypt (cypher,
2661 buffer + header_size,
2662 buffer_size - header_size,
2663 /* in = */ NULL, /* in len = */ 0);
2666 ERROR ("network plugin: gcry_cipher_encrypt returned: %s",
2667 gcry_strerror (err));
2671 /* Send it out without further modifications */
2672 networt_send_buffer_plain (se, buffer, buffer_size);
2673 } /* }}} void networt_send_buffer_encrypted */
2675 #endif /* HAVE_LIBGCRYPT */
2677 static void network_send_buffer (char *buffer, size_t buffer_len) /* {{{ */
2681 DEBUG ("network plugin: network_send_buffer: buffer_len = %zu", buffer_len);
2683 for (se = sending_sockets; se != NULL; se = se->next)
2686 if (se->data.client.security_level == SECURITY_LEVEL_ENCRYPT)
2687 networt_send_buffer_encrypted (se, buffer, buffer_len);
2688 else if (se->data.client.security_level == SECURITY_LEVEL_SIGN)
2689 networt_send_buffer_signed (se, buffer, buffer_len);
2690 else /* if (se->data.client.security_level == SECURITY_LEVEL_NONE) */
2691 #endif /* HAVE_LIBGCRYPT */
2692 networt_send_buffer_plain (se, buffer, buffer_len);
2693 } /* for (sending_sockets) */
2694 } /* }}} void network_send_buffer */
2696 static int add_to_buffer (char *buffer, int buffer_size, /* {{{ */
2697 value_list_t *vl_def,
2698 const data_set_t *ds, const value_list_t *vl)
2700 char *buffer_orig = buffer;
2702 if (strcmp (vl_def->host, vl->host) != 0)
2704 if (write_part_string (&buffer, &buffer_size, TYPE_HOST,
2705 vl->host, strlen (vl->host)) != 0)
2707 sstrncpy (vl_def->host, vl->host, sizeof (vl_def->host));
2710 if (vl_def->time != vl->time)
2712 if (write_part_number (&buffer, &buffer_size, TYPE_TIME,
2713 (uint64_t) vl->time))
2715 vl_def->time = vl->time;
2718 if (vl_def->interval != vl->interval)
2720 if (write_part_number (&buffer, &buffer_size, TYPE_INTERVAL,
2721 (uint64_t) vl->interval))
2723 vl_def->interval = vl->interval;
2726 if (strcmp (vl_def->plugin, vl->plugin) != 0)
2728 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN,
2729 vl->plugin, strlen (vl->plugin)) != 0)
2731 sstrncpy (vl_def->plugin, vl->plugin, sizeof (vl_def->plugin));
2734 if (strcmp (vl_def->plugin_instance, vl->plugin_instance) != 0)
2736 if (write_part_string (&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE,
2737 vl->plugin_instance,
2738 strlen (vl->plugin_instance)) != 0)
2740 sstrncpy (vl_def->plugin_instance, vl->plugin_instance, sizeof (vl_def->plugin_instance));
2743 if (strcmp (vl_def->type, vl->type) != 0)
2745 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE,
2746 vl->type, strlen (vl->type)) != 0)
2748 sstrncpy (vl_def->type, ds->type, sizeof (vl_def->type));
2751 if (strcmp (vl_def->type_instance, vl->type_instance) != 0)
2753 if (write_part_string (&buffer, &buffer_size, TYPE_TYPE_INSTANCE,
2755 strlen (vl->type_instance)) != 0)
2757 sstrncpy (vl_def->type_instance, vl->type_instance, sizeof (vl_def->type_instance));
2760 if (write_part_values (&buffer, &buffer_size, ds, vl) != 0)
2763 return (buffer - buffer_orig);
2764 } /* }}} int add_to_buffer */
2766 static void flush_buffer (void)
2768 DEBUG ("network plugin: flush_buffer: send_buffer_fill = %i",
2771 network_send_buffer (send_buffer, (size_t) send_buffer_fill);
2773 stats_octets_tx += ((uint64_t) send_buffer_fill);
2776 network_init_buffer ();
2779 static int network_write (const data_set_t *ds, const value_list_t *vl,
2780 user_data_t __attribute__((unused)) *user_data)
2784 if (!check_send_okay (vl))
2787 char name[6*DATA_MAX_NAME_LEN];
2788 FORMAT_VL (name, sizeof (name), vl);
2789 name[sizeof (name) - 1] = 0;
2790 DEBUG ("network plugin: network_write: "
2791 "NOT sending %s.", name);
2793 /* Counter is not protected by another lock and may be reached by
2794 * multiple threads */
2795 pthread_mutex_lock (&stats_lock);
2796 stats_values_not_sent++;
2797 pthread_mutex_unlock (&stats_lock);
2801 uc_meta_data_add_unsigned_int (vl,
2802 "network:time_sent", (uint64_t) vl->time);
2804 pthread_mutex_lock (&send_buffer_lock);
2806 status = add_to_buffer (send_buffer_ptr,
2807 network_config_packet_size - (send_buffer_fill + BUFF_SIG_SIZE),
2812 /* status == bytes added to the buffer */
2813 send_buffer_fill += status;
2814 send_buffer_ptr += status;
2816 stats_values_sent++;
2822 status = add_to_buffer (send_buffer_ptr,
2823 network_config_packet_size - (send_buffer_fill + BUFF_SIG_SIZE),
2829 send_buffer_fill += status;
2830 send_buffer_ptr += status;
2832 stats_values_sent++;
2838 ERROR ("network plugin: Unable to append to the "
2839 "buffer for some weird reason");
2841 else if ((network_config_packet_size - send_buffer_fill) < 15)
2846 pthread_mutex_unlock (&send_buffer_lock);
2848 return ((status < 0) ? -1 : 0);
2849 } /* int network_write */
2851 static int network_config_set_boolean (const oconfig_item_t *ci, /* {{{ */
2854 if ((ci->values_num != 1)
2855 || ((ci->values[0].type != OCONFIG_TYPE_BOOLEAN)
2856 && (ci->values[0].type != OCONFIG_TYPE_STRING)))
2858 ERROR ("network plugin: The `%s' config option needs "
2859 "exactly one boolean argument.", ci->key);
2863 if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
2865 if (ci->values[0].value.boolean)
2872 char *str = ci->values[0].value.string;
2876 else if (IS_FALSE (str))
2880 ERROR ("network plugin: Cannot parse string value `%s' of the `%s' "
2881 "option as boolean value.",
2888 } /* }}} int network_config_set_boolean */
2890 static int network_config_set_ttl (const oconfig_item_t *ci) /* {{{ */
2893 if ((ci->values_num != 1)
2894 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
2896 WARNING ("network plugin: The `TimeToLive' config option needs exactly "
2897 "one numeric argument.");
2901 tmp = (int) ci->values[0].value.number;
2902 if ((tmp > 0) && (tmp <= 255))
2903 network_config_ttl = tmp;
2906 } /* }}} int network_config_set_ttl */
2908 static int network_config_set_interface (const oconfig_item_t *ci, /* {{{ */
2911 if ((ci->values_num != 1)
2912 || (ci->values[0].type != OCONFIG_TYPE_STRING))
2914 WARNING ("network plugin: The `Interface' config option needs exactly "
2915 "one string argument.");
2919 if (interface == NULL)
2922 *interface = if_nametoindex (ci->values[0].value.string);
2925 } /* }}} int network_config_set_interface */
2927 static int network_config_set_buffer_size (const oconfig_item_t *ci) /* {{{ */
2930 if ((ci->values_num != 1)
2931 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
2933 WARNING ("network plugin: The `MaxPacketSize' config option needs exactly "
2934 "one numeric argument.");
2938 tmp = (int) ci->values[0].value.number;
2939 if ((tmp >= 1024) && (tmp <= 65535))
2940 network_config_packet_size = tmp;
2943 } /* }}} int network_config_set_buffer_size */
2946 static int network_config_set_string (const oconfig_item_t *ci, /* {{{ */
2950 if ((ci->values_num != 1)
2951 || (ci->values[0].type != OCONFIG_TYPE_STRING))
2953 WARNING ("network plugin: The `%s' config option needs exactly "
2954 "one string argument.", ci->key);
2958 tmp = strdup (ci->values[0].value.string);
2962 sfree (*ret_string);
2966 } /* }}} int network_config_set_string */
2967 #endif /* HAVE_LIBGCRYPT */
2970 static int network_config_set_security_level (oconfig_item_t *ci, /* {{{ */
2974 if ((ci->values_num != 1)
2975 || (ci->values[0].type != OCONFIG_TYPE_STRING))
2977 WARNING ("network plugin: The `SecurityLevel' config option needs exactly "
2978 "one string argument.");
2982 str = ci->values[0].value.string;
2983 if (strcasecmp ("Encrypt", str) == 0)
2984 *retval = SECURITY_LEVEL_ENCRYPT;
2985 else if (strcasecmp ("Sign", str) == 0)
2986 *retval = SECURITY_LEVEL_SIGN;
2987 else if (strcasecmp ("None", str) == 0)
2988 *retval = SECURITY_LEVEL_NONE;
2991 WARNING ("network plugin: Unknown security level: %s.", str);
2996 } /* }}} int network_config_set_security_level */
2997 #endif /* HAVE_LIBGCRYPT */
2999 static int network_config_add_listen (const oconfig_item_t *ci) /* {{{ */
3005 if ((ci->values_num < 1) || (ci->values_num > 2)
3006 || (ci->values[0].type != OCONFIG_TYPE_STRING)
3007 || ((ci->values_num > 1) && (ci->values[1].type != OCONFIG_TYPE_STRING)))
3009 ERROR ("network plugin: The `%s' config option needs "
3010 "one or two string arguments.", ci->key);
3014 se = malloc (sizeof (*se));
3017 ERROR ("network plugin: malloc failed.");
3020 sockent_init (se, SOCKENT_TYPE_SERVER);
3022 se->node = strdup (ci->values[0].value.string);
3023 if (ci->values_num >= 2)
3024 se->service = strdup (ci->values[1].value.string);
3026 for (i = 0; i < ci->children_num; i++)
3028 oconfig_item_t *child = ci->children + i;
3031 if (strcasecmp ("AuthFile", child->key) == 0)
3032 network_config_set_string (child, &se->data.server.auth_file);
3033 else if (strcasecmp ("SecurityLevel", child->key) == 0)
3034 network_config_set_security_level (child,
3035 &se->data.server.security_level);
3037 #endif /* HAVE_LIBGCRYPT */
3038 if (strcasecmp ("Interface", child->key) == 0)
3039 network_config_set_interface (child,
3043 WARNING ("network plugin: Option `%s' is not allowed here.",
3049 if ((se->data.server.security_level > SECURITY_LEVEL_NONE)
3050 && (se->data.server.auth_file == NULL))
3052 ERROR ("network plugin: A security level higher than `none' was "
3053 "requested, but no AuthFile option was given. Cowardly refusing to "
3054 "open this socket!");
3055 sockent_destroy (se);
3058 #endif /* HAVE_LIBGCRYPT */
3060 status = sockent_open (se);
3063 ERROR ("network plugin: network_config_add_listen: sockent_open failed.");
3064 sockent_destroy (se);
3068 status = sockent_add (se);
3071 ERROR ("network plugin: network_config_add_listen: sockent_add failed.");
3072 sockent_destroy (se);
3077 } /* }}} int network_config_add_listen */
3079 static int network_config_add_server (const oconfig_item_t *ci) /* {{{ */
3085 if ((ci->values_num < 1) || (ci->values_num > 2)
3086 || (ci->values[0].type != OCONFIG_TYPE_STRING)
3087 || ((ci->values_num > 1) && (ci->values[1].type != OCONFIG_TYPE_STRING)))
3089 ERROR ("network plugin: The `%s' config option needs "
3090 "one or two string arguments.", ci->key);
3094 se = malloc (sizeof (*se));
3097 ERROR ("network plugin: malloc failed.");
3100 sockent_init (se, SOCKENT_TYPE_CLIENT);
3102 se->node = strdup (ci->values[0].value.string);
3103 if (ci->values_num >= 2)
3104 se->service = strdup (ci->values[1].value.string);
3106 for (i = 0; i < ci->children_num; i++)
3108 oconfig_item_t *child = ci->children + i;
3111 if (strcasecmp ("Username", child->key) == 0)
3112 network_config_set_string (child, &se->data.client.username);
3113 else if (strcasecmp ("Password", child->key) == 0)
3114 network_config_set_string (child, &se->data.client.password);
3115 else if (strcasecmp ("SecurityLevel", child->key) == 0)
3116 network_config_set_security_level (child,
3117 &se->data.client.security_level);
3119 #endif /* HAVE_LIBGCRYPT */
3120 if (strcasecmp ("Interface", child->key) == 0)
3121 network_config_set_interface (child,
3125 WARNING ("network plugin: Option `%s' is not allowed here.",
3131 if ((se->data.client.security_level > SECURITY_LEVEL_NONE)
3132 && ((se->data.client.username == NULL)
3133 || (se->data.client.password == NULL)))
3135 ERROR ("network plugin: A security level higher than `none' was "
3136 "requested, but no Username or Password option was given. "
3137 "Cowardly refusing to open this socket!");
3138 sockent_destroy (se);
3141 #endif /* HAVE_LIBGCRYPT */
3143 status = sockent_open (se);
3146 ERROR ("network plugin: network_config_add_server: sockent_open failed.");
3147 sockent_destroy (se);
3151 status = sockent_add (se);
3154 ERROR ("network plugin: network_config_add_server: sockent_add failed.");
3155 sockent_destroy (se);
3160 } /* }}} int network_config_add_server */
3162 static int network_config (oconfig_item_t *ci) /* {{{ */
3166 for (i = 0; i < ci->children_num; i++)
3168 oconfig_item_t *child = ci->children + i;
3170 if (strcasecmp ("Listen", child->key) == 0)
3171 network_config_add_listen (child);
3172 else if (strcasecmp ("Server", child->key) == 0)
3173 network_config_add_server (child);
3174 else if (strcasecmp ("TimeToLive", child->key) == 0)
3175 network_config_set_ttl (child);
3176 else if (strcasecmp ("MaxPacketSize", child->key) == 0)
3177 network_config_set_buffer_size (child);
3178 else if (strcasecmp ("Forward", child->key) == 0)
3179 network_config_set_boolean (child, &network_config_forward);
3180 else if (strcasecmp ("ReportStats", child->key) == 0)
3181 network_config_set_boolean (child, &network_config_stats);
3182 else if (strcasecmp ("CacheFlush", child->key) == 0)
3183 /* no op for backwards compatibility only */;
3186 WARNING ("network plugin: Option `%s' is not allowed here.",
3192 } /* }}} int network_config */
3194 static int network_notification (const notification_t *n,
3195 user_data_t __attribute__((unused)) *user_data)
3197 char buffer[network_config_packet_size];
3198 char *buffer_ptr = buffer;
3199 int buffer_free = sizeof (buffer);
3202 if (!check_send_notify_okay (n))
3205 memset (buffer, 0, sizeof (buffer));
3207 status = write_part_number (&buffer_ptr, &buffer_free, TYPE_TIME,
3208 (uint64_t) n->time);
3212 status = write_part_number (&buffer_ptr, &buffer_free, TYPE_SEVERITY,
3213 (uint64_t) n->severity);
3217 if (strlen (n->host) > 0)
3219 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_HOST,
3220 n->host, strlen (n->host));
3225 if (strlen (n->plugin) > 0)
3227 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_PLUGIN,
3228 n->plugin, strlen (n->plugin));
3233 if (strlen (n->plugin_instance) > 0)
3235 status = write_part_string (&buffer_ptr, &buffer_free,
3236 TYPE_PLUGIN_INSTANCE,
3237 n->plugin_instance, strlen (n->plugin_instance));
3242 if (strlen (n->type) > 0)
3244 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_TYPE,
3245 n->type, strlen (n->type));
3250 if (strlen (n->type_instance) > 0)
3252 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_TYPE_INSTANCE,
3253 n->type_instance, strlen (n->type_instance));
3258 status = write_part_string (&buffer_ptr, &buffer_free, TYPE_MESSAGE,
3259 n->message, strlen (n->message));
3263 network_send_buffer (buffer, sizeof (buffer) - buffer_free);
3266 } /* int network_notification */
3268 static int network_shutdown (void)
3272 /* Kill the listening thread */
3273 if (receive_thread_running != 0)
3275 INFO ("network plugin: Stopping receive thread.");
3276 pthread_kill (receive_thread_id, SIGTERM);
3277 pthread_join (receive_thread_id, NULL /* no return value */);
3278 memset (&receive_thread_id, 0, sizeof (receive_thread_id));
3279 receive_thread_running = 0;
3282 /* Shutdown the dispatching thread */
3283 if (dispatch_thread_running != 0)
3285 INFO ("network plugin: Stopping dispatch thread.");
3286 pthread_mutex_lock (&receive_list_lock);
3287 pthread_cond_broadcast (&receive_list_cond);
3288 pthread_mutex_unlock (&receive_list_lock);
3289 pthread_join (dispatch_thread_id, /* ret = */ NULL);
3290 dispatch_thread_running = 0;
3293 sockent_destroy (listen_sockets);
3295 if (send_buffer_fill > 0)
3298 sfree (send_buffer);
3300 /* TODO: Close `sending_sockets' */
3302 plugin_unregister_config ("network");
3303 plugin_unregister_init ("network");
3304 plugin_unregister_write ("network");
3305 plugin_unregister_shutdown ("network");
3308 } /* int network_shutdown */
3310 static int network_stats_read (void) /* {{{ */
3312 uint64_t copy_octets_rx;
3313 uint64_t copy_octets_tx;
3314 uint64_t copy_packets_rx;
3315 uint64_t copy_packets_tx;
3316 uint64_t copy_values_dispatched;
3317 uint64_t copy_values_not_dispatched;
3318 uint64_t copy_values_sent;
3319 uint64_t copy_values_not_sent;
3320 uint64_t copy_receive_list_length;
3321 value_list_t vl = VALUE_LIST_INIT;
3324 copy_octets_rx = stats_octets_rx;
3325 copy_octets_tx = stats_octets_tx;
3326 copy_packets_rx = stats_packets_rx;
3327 copy_packets_tx = stats_packets_tx;
3328 copy_values_dispatched = stats_values_dispatched;
3329 copy_values_not_dispatched = stats_values_not_dispatched;
3330 copy_values_sent = stats_values_sent;
3331 copy_values_not_sent = stats_values_not_sent;
3332 copy_receive_list_length = receive_list_length;
3334 /* Initialize `vl' */
3338 vl.interval = interval_g;
3339 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
3340 sstrncpy (vl.plugin, "network", sizeof (vl.plugin));
3342 /* Octets received / sent */
3343 vl.values[0].counter = (counter_t) copy_octets_rx;
3344 vl.values[1].counter = (counter_t) copy_octets_tx;
3345 sstrncpy (vl.type, "if_octets", sizeof (vl.type));
3346 plugin_dispatch_values_secure (&vl);
3348 /* Packets received / send */
3349 vl.values[0].counter = (counter_t) copy_packets_rx;
3350 vl.values[1].counter = (counter_t) copy_packets_tx;
3351 sstrncpy (vl.type, "if_packets", sizeof (vl.type));
3352 plugin_dispatch_values_secure (&vl);
3354 /* Values (not) dispatched and (not) send */
3355 sstrncpy (vl.type, "total_values", sizeof (vl.type));
3358 vl.values[0].derive = (derive_t) copy_values_dispatched;
3359 sstrncpy (vl.type_instance, "dispatch-accepted",
3360 sizeof (vl.type_instance));
3361 plugin_dispatch_values_secure (&vl);
3363 vl.values[0].derive = (derive_t) copy_values_not_dispatched;
3364 sstrncpy (vl.type_instance, "dispatch-rejected",
3365 sizeof (vl.type_instance));
3366 plugin_dispatch_values_secure (&vl);
3368 vl.values[0].derive = (derive_t) copy_values_sent;
3369 sstrncpy (vl.type_instance, "send-accepted",
3370 sizeof (vl.type_instance));
3371 plugin_dispatch_values_secure (&vl);
3373 vl.values[0].derive = (derive_t) copy_values_not_sent;
3374 sstrncpy (vl.type_instance, "send-rejected",
3375 sizeof (vl.type_instance));
3376 plugin_dispatch_values_secure (&vl);
3378 /* Receive queue length */
3379 vl.values[0].gauge = (gauge_t) copy_receive_list_length;
3380 sstrncpy (vl.type, "queue_length", sizeof (vl.type));
3381 vl.type_instance[0] = 0;
3382 plugin_dispatch_values_secure (&vl);
3385 } /* }}} int network_stats_read */
3387 static int network_init (void)
3389 static _Bool have_init = false;
3391 /* Check if we were already initialized. If so, just return - there's
3392 * nothing more to do (for now, that is). */
3398 network_init_gcrypt ();
3401 if (network_config_stats != 0)
3402 plugin_register_read ("network", network_stats_read);
3404 plugin_register_shutdown ("network", network_shutdown);
3406 send_buffer = malloc (network_config_packet_size);
3407 if (send_buffer == NULL)
3409 ERROR ("network plugin: malloc failed.");
3412 network_init_buffer ();
3414 /* setup socket(s) and so on */
3415 if (sending_sockets != NULL)
3417 plugin_register_write ("network", network_write,
3418 /* user_data = */ NULL);
3419 plugin_register_notification ("network", network_notification,
3420 /* user_data = */ NULL);
3423 /* If no threads need to be started, return here. */
3424 if ((listen_sockets_num == 0)
3425 || ((dispatch_thread_running != 0)
3426 && (receive_thread_running != 0)))
3429 if (dispatch_thread_running == 0)
3432 status = pthread_create (&dispatch_thread_id,
3433 NULL /* no attributes */,
3435 NULL /* no argument */);
3439 ERROR ("network: pthread_create failed: %s",
3440 sstrerror (errno, errbuf,
3445 dispatch_thread_running = 1;
3449 if (receive_thread_running == 0)
3452 status = pthread_create (&receive_thread_id,
3453 NULL /* no attributes */,
3455 NULL /* no argument */);
3459 ERROR ("network: pthread_create failed: %s",
3460 sstrerror (errno, errbuf,
3465 receive_thread_running = 1;
3470 } /* int network_init */
3473 * The flush option of the network plugin cannot flush individual identifiers.
3474 * All the values are added to a buffer and sent when the buffer is full, the
3475 * requested value may or may not be in there, it's not worth finding out. We
3476 * just send the buffer if `flush' is called - if the requested value was in
3477 * there, good. If not, well, then there is nothing to flush.. -octo
3479 static int network_flush (int timeout,
3480 const char __attribute__((unused)) *identifier,
3481 user_data_t __attribute__((unused)) *user_data)
3483 pthread_mutex_lock (&send_buffer_lock);
3485 if (send_buffer_fill > 0)
3488 pthread_mutex_unlock (&send_buffer_lock);
3491 } /* int network_flush */
3493 void module_register (void)
3495 plugin_register_complex_config ("network", network_config);
3496 plugin_register_init ("network", network_init);
3497 plugin_register_flush ("network", network_flush,
3498 /* user_data = */ NULL);
3499 } /* void module_register */
3501 /* vim: set fdm=marker : */