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 _DEFAULT_SOURCE
26 #define _BSD_SOURCE /* For struct ip_mreq */
32 #include "utils_cache.h"
33 #include "utils_complain.h"
34 #include "utils_fbhash.h"
42 #include <netinet/in.h>
45 #include <arpa/inet.h>
56 /* default xcode compiler throws warnings even when deprecated functionality
57 * is not used. -Werror breaks the build because of erroneous warnings.
58 * http://stackoverflow.com/questions/10556299/compiler-warnings-with-libgcrypt-v1-5-0/12830209#12830209
60 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
62 /* FreeBSD's copy of libgcrypt extends the existing GCRYPT_NO_DEPRECATED
63 * to properly hide all deprecated functionality.
64 * http://svnweb.freebsd.org/ports/head/security/libgcrypt/files/patch-src__gcrypt.h.in
66 #define GCRYPT_NO_DEPRECATED
69 /* Re enable deprecation warnings */
70 #pragma GCC diagnostic warning "-Wdeprecated-declarations"
72 #if GCRYPT_VERSION_NUMBER < 0x010600
73 GCRY_THREAD_OPTION_PTHREAD_IMPL;
77 #ifndef IPV6_ADD_MEMBERSHIP
78 #ifdef IPV6_JOIN_GROUP
79 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
81 #error "Neither IP_ADD_MEMBERSHIP nor IPV6_JOIN_GROUP is defined"
83 #endif /* !IP_ADD_MEMBERSHIP */
86 * Maximum size required for encryption / signing:
88 * 42 bytes for the encryption header
89 * + 64 bytes for the username
93 #define BUFF_SIG_SIZE 106
98 #define SECURITY_LEVEL_NONE 0
100 #define SECURITY_LEVEL_SIGN 1
101 #define SECURITY_LEVEL_ENCRYPT 2
103 struct sockent_client {
105 struct sockaddr_storage *addr;
111 gcry_cipher_hd_t cypher;
112 unsigned char password_hash[32];
114 cdtime_t next_resolve_reconnect;
115 cdtime_t resolve_interval;
118 struct sockent_server {
125 gcry_cipher_hd_t cypher;
129 typedef struct sockent {
130 #define SOCKENT_TYPE_CLIENT 1
131 #define SOCKENT_TYPE_SERVER 2
139 struct sockent_client client;
140 struct sockent_server server;
143 struct sockent *next;
146 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
147 * 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
148 * +-------+-----------------------+-------------------------------+
149 * ! Ver. ! ! Length !
150 * +-------+-----------------------+-------------------------------+
152 struct part_header_s {
156 typedef struct part_header_s part_header_t;
158 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
159 * 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
160 * +-------------------------------+-------------------------------+
162 * +-------------------------------+-------------------------------+
163 * : (Length - 4) Bytes :
164 * +---------------------------------------------------------------+
166 struct part_string_s {
170 typedef struct part_string_s part_string_t;
172 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
173 * 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
174 * +-------------------------------+-------------------------------+
176 * +-------------------------------+-------------------------------+
177 * : (Length - 4 == 2 || 4 || 8) Bytes :
178 * +---------------------------------------------------------------+
180 struct part_number_s {
184 typedef struct part_number_s part_number_t;
186 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
187 * 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
188 * +-------------------------------+-------------------------------+
190 * +-------------------------------+---------------+---------------+
191 * ! Num of values ! Type0 ! Type1 !
192 * +-------------------------------+---------------+---------------+
195 * +---------------------------------------------------------------+
198 * +---------------------------------------------------------------+
200 struct part_values_s {
202 uint16_t *num_values;
203 uint8_t *values_types;
206 typedef struct part_values_s part_values_t;
208 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
209 * 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
210 * +-------------------------------+-------------------------------+
212 * +-------------------------------+-------------------------------+
213 * ! Hash (Bits 0 - 31) !
215 * ! Hash (Bits 224 - 255) !
216 * +---------------------------------------------------------------+
219 #define PART_SIGNATURE_SHA256_SIZE 36
220 struct part_signature_sha256_s {
222 unsigned char hash[32];
225 typedef struct part_signature_sha256_s part_signature_sha256_t;
227 /* 1 1 1 1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 3 3
228 * 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
229 * +-------------------------------+-------------------------------+
231 * +-------------------------------+-------------------------------+
232 * ! Original length ! Padding (0 - 15 bytes) !
233 * +-------------------------------+-------------------------------+
234 * ! Hash (Bits 0 - 31) !
236 * ! Hash (Bits 128 - 159) !
237 * +---------------------------------------------------------------+
240 #define PART_ENCRYPTION_AES256_SIZE 42
241 struct part_encryption_aes256_s {
243 uint16_t username_length;
245 unsigned char iv[16];
247 unsigned char hash[20];
251 typedef struct part_encryption_aes256_s part_encryption_aes256_t;
253 struct receive_list_entry_s {
257 struct receive_list_entry_s *next;
259 typedef struct receive_list_entry_s receive_list_entry_t;
264 static int network_config_ttl = 0;
265 /* Ethernet - (IPv6 + UDP) = 1500 - (40 + 8) = 1452 */
266 static size_t network_config_packet_size = 1452;
267 static _Bool network_config_forward = 0;
268 static _Bool network_config_stats = 0;
270 static sockent_t *sending_sockets = NULL;
272 static receive_list_entry_t *receive_list_head = NULL;
273 static receive_list_entry_t *receive_list_tail = NULL;
274 static pthread_mutex_t receive_list_lock = PTHREAD_MUTEX_INITIALIZER;
275 static pthread_cond_t receive_list_cond = PTHREAD_COND_INITIALIZER;
276 static uint64_t receive_list_length = 0;
278 static sockent_t *listen_sockets = NULL;
279 static struct pollfd *listen_sockets_pollfd = NULL;
280 static size_t listen_sockets_num = 0;
282 /* The receive and dispatch threads will run as long as `listen_loop' is set to
284 static int listen_loop = 0;
285 static int receive_thread_running = 0;
286 static pthread_t receive_thread_id;
287 static int dispatch_thread_running = 0;
288 static pthread_t dispatch_thread_id;
290 /* Buffer in which to-be-sent network packets are constructed. */
291 static char *send_buffer;
292 static char *send_buffer_ptr;
293 static int send_buffer_fill;
294 static cdtime_t send_buffer_last_update;
295 static value_list_t send_buffer_vl = VALUE_LIST_INIT;
296 static pthread_mutex_t send_buffer_lock = PTHREAD_MUTEX_INITIALIZER;
298 /* XXX: These counters are incremented from one place only. The spot in which
299 * the values are incremented is either only reachable by one thread (the
300 * dispatch thread, for example) or locked by some lock (send_buffer_lock for
301 * example). Only if neither is true, the stats_lock is acquired. The counters
302 * are always read without holding a lock in the hope that writing 8 bytes to
303 * memory is an atomic operation. */
304 static derive_t stats_octets_rx = 0;
305 static derive_t stats_octets_tx = 0;
306 static derive_t stats_packets_rx = 0;
307 static derive_t stats_packets_tx = 0;
308 static derive_t stats_values_dispatched = 0;
309 static derive_t stats_values_not_dispatched = 0;
310 static derive_t stats_values_sent = 0;
311 static derive_t stats_values_not_sent = 0;
312 static pthread_mutex_t stats_lock = PTHREAD_MUTEX_INITIALIZER;
317 static _Bool check_receive_okay(const value_list_t *vl) /* {{{ */
319 uint64_t time_sent = 0;
322 status = uc_meta_data_get_unsigned_int(vl, "network:time_sent", &time_sent);
324 /* This is a value we already sent. Don't allow it to be received again in
325 * order to avoid looping. */
326 if ((status == 0) && (time_sent >= ((uint64_t)vl->time)))
330 } /* }}} _Bool check_receive_okay */
332 static _Bool check_send_okay(const value_list_t *vl) /* {{{ */
337 if (network_config_forward)
340 if (vl->meta == NULL)
343 status = meta_data_get_boolean(vl->meta, "network:received", &received);
344 if (status == -ENOENT)
346 else if (status != 0) {
347 ERROR("network plugin: check_send_okay: meta_data_get_boolean failed "
353 /* By default, only *send* value lists that were not *received* by the
356 } /* }}} _Bool check_send_okay */
358 static _Bool check_notify_received(const notification_t *n) /* {{{ */
360 for (notification_meta_t *ptr = n->meta; ptr != NULL; ptr = ptr->next)
361 if ((strcmp("network:received", ptr->name) == 0) &&
362 (ptr->type == NM_TYPE_BOOLEAN))
363 return (_Bool)ptr->nm_value.nm_boolean;
366 } /* }}} _Bool check_notify_received */
368 static _Bool check_send_notify_okay(const notification_t *n) /* {{{ */
370 static c_complain_t complain_forwarding = C_COMPLAIN_INIT_STATIC;
376 received = check_notify_received(n);
378 if (network_config_forward && received) {
380 LOG_ERR, &complain_forwarding,
381 "network plugin: A notification has been received via the network "
382 "and forwarding is enabled. Forwarding of notifications is currently "
383 "not supported, because there is not loop-deteciton available. "
384 "Please contact the collectd mailing list if you need this "
388 /* By default, only *send* value lists that were not *received* by the
391 } /* }}} _Bool check_send_notify_okay */
393 static int network_dispatch_values(value_list_t *vl, /* {{{ */
394 const char *username) {
397 if ((vl->time == 0) || (strlen(vl->host) == 0) || (strlen(vl->plugin) == 0) ||
398 (strlen(vl->type) == 0))
401 if (!check_receive_okay(vl)) {
403 char name[6 * DATA_MAX_NAME_LEN];
404 FORMAT_VL(name, sizeof(name), vl);
405 name[sizeof(name) - 1] = 0;
406 DEBUG("network plugin: network_dispatch_values: "
407 "NOT dispatching %s.",
410 stats_values_not_dispatched++;
414 assert(vl->meta == NULL);
416 vl->meta = meta_data_create();
417 if (vl->meta == NULL) {
418 ERROR("network plugin: meta_data_create failed.");
422 status = meta_data_add_boolean(vl->meta, "network:received", 1);
424 ERROR("network plugin: meta_data_add_boolean failed.");
425 meta_data_destroy(vl->meta);
430 if (username != NULL) {
431 status = meta_data_add_string(vl->meta, "network:username", username);
433 ERROR("network plugin: meta_data_add_string failed.");
434 meta_data_destroy(vl->meta);
440 plugin_dispatch_values(vl);
441 stats_values_dispatched++;
443 meta_data_destroy(vl->meta);
447 } /* }}} int network_dispatch_values */
449 static int network_dispatch_notification(notification_t *n) /* {{{ */
453 assert(n->meta == NULL);
455 status = plugin_notification_meta_add_boolean(n, "network:received", 1);
457 ERROR("network plugin: plugin_notification_meta_add_boolean failed.");
458 plugin_notification_meta_free(n->meta);
463 status = plugin_dispatch_notification(n);
465 plugin_notification_meta_free(n->meta);
469 } /* }}} int network_dispatch_notification */
472 static int network_init_gcrypt(void) /* {{{ */
476 /* http://lists.gnupg.org/pipermail/gcrypt-devel/2003-August/000458.html
477 * Because you can't know in a library whether another library has
478 * already initialized the library */
479 if (gcry_control(GCRYCTL_ANY_INITIALIZATION_P))
482 /* http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html
483 * To ensure thread-safety, it's important to set GCRYCTL_SET_THREAD_CBS
484 * *before* initalizing Libgcrypt with gcry_check_version(), which itself must
485 * be called before any other gcry_* function. GCRYCTL_ANY_INITIALIZATION_P
486 * above doesn't count, as it doesn't implicitly initalize Libgcrypt.
488 * tl;dr: keep all these gry_* statements in this exact order please. */
489 #if GCRYPT_VERSION_NUMBER < 0x010600
490 err = gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
492 ERROR("network plugin: gcry_control (GCRYCTL_SET_THREAD_CBS) failed: %s",
498 gcry_check_version(NULL);
500 err = gcry_control(GCRYCTL_INIT_SECMEM, 32768);
502 ERROR("network plugin: gcry_control (GCRYCTL_INIT_SECMEM) failed: %s",
507 gcry_control(GCRYCTL_INITIALIZATION_FINISHED);
509 } /* }}} int network_init_gcrypt */
511 static gcry_cipher_hd_t network_get_aes256_cypher(sockent_t *se, /* {{{ */
514 const char *username) {
516 gcry_cipher_hd_t *cyper_ptr;
517 unsigned char password_hash[32];
519 if (se->type == SOCKENT_TYPE_CLIENT) {
520 cyper_ptr = &se->data.client.cypher;
521 memcpy(password_hash, se->data.client.password_hash, sizeof(password_hash));
525 cyper_ptr = &se->data.server.cypher;
527 if (username == NULL)
530 secret = fbh_get(se->data.server.userdb, username);
534 gcry_md_hash_buffer(GCRY_MD_SHA256, password_hash, secret, strlen(secret));
539 if (*cyper_ptr == NULL) {
540 err = gcry_cipher_open(cyper_ptr, GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB,
543 ERROR("network plugin: gcry_cipher_open returned: %s",
549 gcry_cipher_reset(*cyper_ptr);
551 assert(*cyper_ptr != NULL);
553 err = gcry_cipher_setkey(*cyper_ptr, password_hash, sizeof(password_hash));
555 ERROR("network plugin: gcry_cipher_setkey returned: %s",
557 gcry_cipher_close(*cyper_ptr);
562 err = gcry_cipher_setiv(*cyper_ptr, iv, iv_size);
564 ERROR("network plugin: gcry_cipher_setkey returned: %s",
566 gcry_cipher_close(*cyper_ptr);
572 } /* }}} int network_get_aes256_cypher */
573 #endif /* HAVE_GCRYPT_H */
575 static int write_part_values(char **ret_buffer, size_t *ret_buffer_len,
576 const data_set_t *ds, const value_list_t *vl) {
581 part_header_t pkg_ph;
582 uint16_t pkg_num_values;
583 uint8_t *pkg_values_types;
588 num_values = vl->values_len;
589 packet_len = sizeof(part_header_t) + sizeof(uint16_t) +
590 (num_values * sizeof(uint8_t)) + (num_values * sizeof(value_t));
592 if (*ret_buffer_len < packet_len)
595 pkg_values_types = malloc(num_values * sizeof(*pkg_values_types));
596 if (pkg_values_types == NULL) {
597 ERROR("network plugin: write_part_values: malloc failed.");
601 pkg_values = malloc(num_values * sizeof(*pkg_values));
602 if (pkg_values == NULL) {
603 free(pkg_values_types);
604 ERROR("network plugin: write_part_values: malloc failed.");
608 pkg_ph.type = htons(TYPE_VALUES);
609 pkg_ph.length = htons(packet_len);
611 pkg_num_values = htons((uint16_t)vl->values_len);
613 for (int i = 0; i < num_values; i++) {
614 pkg_values_types[i] = (uint8_t)ds->ds[i].type;
615 switch (ds->ds[i].type) {
616 case DS_TYPE_COUNTER:
617 pkg_values[i].counter = htonll(vl->values[i].counter);
621 pkg_values[i].gauge = htond(vl->values[i].gauge);
625 pkg_values[i].derive = htonll(vl->values[i].derive);
628 case DS_TYPE_ABSOLUTE:
629 pkg_values[i].absolute = htonll(vl->values[i].absolute);
633 free(pkg_values_types);
635 ERROR("network plugin: write_part_values: "
636 "Unknown data source type: %i",
639 } /* switch (ds->ds[i].type) */
640 } /* for (num_values) */
643 * Use `memcpy' to write everything to the buffer, because the pointer
644 * may be unaligned and some architectures, such as SPARC, can't handle
647 packet_ptr = *ret_buffer;
649 memcpy(packet_ptr + offset, &pkg_ph, sizeof(pkg_ph));
650 offset += sizeof(pkg_ph);
651 memcpy(packet_ptr + offset, &pkg_num_values, sizeof(pkg_num_values));
652 offset += sizeof(pkg_num_values);
653 memcpy(packet_ptr + offset, pkg_values_types, num_values * sizeof(uint8_t));
654 offset += num_values * sizeof(uint8_t);
655 memcpy(packet_ptr + offset, pkg_values, num_values * sizeof(value_t));
656 offset += num_values * sizeof(value_t);
658 assert(offset == packet_len);
660 *ret_buffer = packet_ptr + packet_len;
661 *ret_buffer_len -= packet_len;
663 free(pkg_values_types);
667 } /* int write_part_values */
669 static int write_part_number(char **ret_buffer, size_t *ret_buffer_len,
670 int type, uint64_t value) {
674 part_header_t pkg_head;
679 packet_len = sizeof(pkg_head) + sizeof(pkg_value);
681 if (*ret_buffer_len < packet_len)
684 pkg_head.type = htons(type);
685 pkg_head.length = htons(packet_len);
686 pkg_value = htonll(value);
688 packet_ptr = *ret_buffer;
690 memcpy(packet_ptr + offset, &pkg_head, sizeof(pkg_head));
691 offset += sizeof(pkg_head);
692 memcpy(packet_ptr + offset, &pkg_value, sizeof(pkg_value));
693 offset += sizeof(pkg_value);
695 assert(offset == packet_len);
697 *ret_buffer = packet_ptr + packet_len;
698 *ret_buffer_len -= packet_len;
701 } /* int write_part_number */
703 static int write_part_string(char **ret_buffer, size_t *ret_buffer_len,
704 int type, const char *str, size_t str_len) {
713 buffer_len = 2 * sizeof(uint16_t) + str_len + 1;
714 if (*ret_buffer_len < buffer_len)
717 pkg_type = htons(type);
718 pkg_length = htons(buffer_len);
720 buffer = *ret_buffer;
722 memcpy(buffer + offset, (void *)&pkg_type, sizeof(pkg_type));
723 offset += sizeof(pkg_type);
724 memcpy(buffer + offset, (void *)&pkg_length, sizeof(pkg_length));
725 offset += sizeof(pkg_length);
726 memcpy(buffer + offset, str, str_len);
728 memset(buffer + offset, '\0', 1);
731 assert(offset == buffer_len);
733 *ret_buffer = buffer + buffer_len;
734 *ret_buffer_len -= buffer_len;
737 } /* int write_part_string */
739 static int parse_part_values(void **ret_buffer, size_t *ret_buffer_len,
740 value_t **ret_values, size_t *ret_num_values) {
741 char *buffer = *ret_buffer;
742 size_t buffer_len = *ret_buffer_len;
754 if (buffer_len < 15) {
755 NOTICE("network plugin: packet is too short: "
761 memcpy((void *)&tmp16, buffer, sizeof(tmp16));
762 buffer += sizeof(tmp16);
763 pkg_type = ntohs(tmp16);
765 memcpy((void *)&tmp16, buffer, sizeof(tmp16));
766 buffer += sizeof(tmp16);
767 pkg_length = ntohs(tmp16);
769 memcpy((void *)&tmp16, buffer, sizeof(tmp16));
770 buffer += sizeof(tmp16);
771 pkg_numval = (size_t)ntohs(tmp16);
773 assert(pkg_type == TYPE_VALUES);
776 3 * sizeof(uint16_t) + pkg_numval * (sizeof(uint8_t) + sizeof(value_t));
777 if (buffer_len < exp_size) {
778 WARNING("network plugin: parse_part_values: "
780 "Chunk of size %zu expected, "
781 "but buffer has only %zu bytes left.",
782 exp_size, buffer_len);
785 assert(pkg_numval <= ((buffer_len - 6) / 9));
787 if (pkg_length != exp_size) {
788 WARNING("network plugin: parse_part_values: "
789 "Length and number of values "
790 "in the packet don't match.");
794 pkg_types = calloc(pkg_numval, sizeof(*pkg_types));
795 pkg_values = calloc(pkg_numval, sizeof(*pkg_values));
796 if ((pkg_types == NULL) || (pkg_values == NULL)) {
799 ERROR("network plugin: parse_part_values: calloc failed.");
803 memcpy(pkg_types, buffer, pkg_numval * sizeof(*pkg_types));
804 buffer += pkg_numval * sizeof(*pkg_types);
805 memcpy(pkg_values, buffer, pkg_numval * sizeof(*pkg_values));
806 buffer += pkg_numval * sizeof(*pkg_values);
808 for (size_t i = 0; i < pkg_numval; i++) {
809 switch (pkg_types[i]) {
810 case DS_TYPE_COUNTER:
811 pkg_values[i].counter = (counter_t)ntohll(pkg_values[i].counter);
815 pkg_values[i].gauge = (gauge_t)ntohd(pkg_values[i].gauge);
819 pkg_values[i].derive = (derive_t)ntohll(pkg_values[i].derive);
822 case DS_TYPE_ABSOLUTE:
823 pkg_values[i].absolute = (absolute_t)ntohll(pkg_values[i].absolute);
827 NOTICE("network plugin: parse_part_values: "
828 "Don't know how to handle data source type %" PRIu8,
833 } /* switch (pkg_types[i]) */
836 *ret_buffer = buffer;
837 *ret_buffer_len = buffer_len - pkg_length;
838 *ret_num_values = pkg_numval;
839 *ret_values = pkg_values;
844 } /* int parse_part_values */
846 static int parse_part_number(void **ret_buffer, size_t *ret_buffer_len,
848 char *buffer = *ret_buffer;
849 size_t buffer_len = *ret_buffer_len;
853 size_t exp_size = 2 * sizeof(uint16_t) + sizeof(uint64_t);
857 if (buffer_len < exp_size) {
858 WARNING("network plugin: parse_part_number: "
860 "Chunk of size %zu expected, "
861 "but buffer has only %zu bytes left.",
862 exp_size, buffer_len);
866 memcpy((void *)&tmp16, buffer, sizeof(tmp16));
867 buffer += sizeof(tmp16);
868 /* pkg_type = ntohs (tmp16); */
870 memcpy((void *)&tmp16, buffer, sizeof(tmp16));
871 buffer += sizeof(tmp16);
872 pkg_length = ntohs(tmp16);
874 memcpy((void *)&tmp64, buffer, sizeof(tmp64));
875 buffer += sizeof(tmp64);
876 *value = ntohll(tmp64);
878 *ret_buffer = buffer;
879 *ret_buffer_len = buffer_len - pkg_length;
882 } /* int parse_part_number */
884 static int parse_part_string(void **ret_buffer, size_t *ret_buffer_len,
885 char *output, size_t const output_len) {
886 char *buffer = *ret_buffer;
887 size_t buffer_len = *ret_buffer_len;
890 size_t const header_size = 2 * sizeof(uint16_t);
898 if (buffer_len < header_size) {
899 WARNING("network plugin: parse_part_string: "
901 "Chunk of at least size %zu expected, "
902 "but buffer has only %zu bytes left.",
903 header_size, buffer_len);
907 memcpy((void *)&tmp16, buffer, sizeof(tmp16));
908 buffer += sizeof(tmp16);
909 /* pkg_type = ntohs (tmp16); */
911 memcpy((void *)&tmp16, buffer, sizeof(tmp16));
912 buffer += sizeof(tmp16);
913 pkg_length = ntohs(tmp16);
914 payload_size = ((size_t)pkg_length) - header_size;
916 /* Check that packet fits in the input buffer */
917 if (pkg_length > buffer_len) {
918 WARNING("network plugin: parse_part_string: "
920 "Chunk of size %" PRIu16 " received, "
921 "but buffer has only %zu bytes left.",
922 pkg_length, buffer_len);
926 /* Check that pkg_length is in the valid range */
927 if (pkg_length <= header_size) {
928 WARNING("network plugin: parse_part_string: "
930 "Header claims this packet is only %hu "
936 /* Check that the package data fits into the output buffer.
937 * The previous if-statement ensures that:
938 * `pkg_length > header_size' */
939 if (output_len < payload_size) {
940 WARNING("network plugin: parse_part_string: "
942 "Output buffer holds %zu bytes, "
943 "which is too small to hold the received "
945 output_len, payload_size);
949 /* All sanity checks successfull, let's copy the data over */
950 memcpy((void *)output, (void *)buffer, payload_size);
951 buffer += payload_size;
953 /* For some very weird reason '\0' doesn't do the trick on SPARC in
955 if (output[payload_size - 1] != 0) {
956 WARNING("network plugin: parse_part_string: "
957 "Received string does not end "
958 "with a NULL-byte.");
962 *ret_buffer = buffer;
963 *ret_buffer_len = buffer_len - pkg_length;
966 } /* int parse_part_string */
968 /* Forward declaration: parse_part_sign_sha256 and parse_part_encr_aes256 call
969 * parse_packet and vice versa. */
970 #define PP_SIGNED 0x01
971 #define PP_ENCRYPTED 0x02
972 static int parse_packet(sockent_t *se, void *buffer, size_t buffer_size,
973 int flags, const char *username);
975 #define BUFFER_READ(p, s) \
977 memcpy((p), buffer + buffer_offset, (s)); \
978 buffer_offset += (s); \
982 static int parse_part_sign_sha256(sockent_t *se, /* {{{ */
983 void **ret_buffer, size_t *ret_buffer_len,
985 static c_complain_t complain_no_users = C_COMPLAIN_INIT_STATIC;
989 size_t buffer_offset;
994 part_signature_sha256_t pss;
995 uint16_t pss_head_length;
996 char hash[sizeof(pss.hash)];
1000 unsigned char *hash_ptr;
1002 buffer = *ret_buffer;
1003 buffer_len = *ret_buffer_len;
1006 /* Check if the buffer has enough data for this structure. */
1007 if (buffer_len <= PART_SIGNATURE_SHA256_SIZE)
1010 /* Read type and length header */
1011 BUFFER_READ(&pss.head.type, sizeof(pss.head.type));
1012 BUFFER_READ(&pss.head.length, sizeof(pss.head.length));
1013 pss_head_length = ntohs(pss.head.length);
1015 /* Check if the `pss_head_length' is within bounds. */
1016 if ((pss_head_length <= PART_SIGNATURE_SHA256_SIZE) ||
1017 (pss_head_length > buffer_len)) {
1018 ERROR("network plugin: HMAC-SHA-256 with invalid length received.");
1022 if (se->data.server.userdb == NULL) {
1024 LOG_NOTICE, &complain_no_users,
1025 "network plugin: Received signed network packet but can't verify it "
1026 "because no user DB has been configured. Will accept it.");
1028 *ret_buffer = buffer + pss_head_length;
1029 *ret_buffer_len -= pss_head_length;
1034 /* Copy the hash. */
1035 BUFFER_READ(pss.hash, sizeof(pss.hash));
1037 /* Calculate username length (without null byte) and allocate memory */
1038 username_len = pss_head_length - PART_SIGNATURE_SHA256_SIZE;
1039 pss.username = malloc(username_len + 1);
1040 if (pss.username == NULL)
1043 /* Read the username */
1044 BUFFER_READ(pss.username, username_len);
1045 pss.username[username_len] = 0;
1047 assert(buffer_offset == pss_head_length);
1049 /* Query the password */
1050 secret = fbh_get(se->data.server.userdb, pss.username);
1051 if (secret == NULL) {
1052 ERROR("network plugin: Unknown user: %s", pss.username);
1053 sfree(pss.username);
1057 /* Create a hash device and check the HMAC */
1059 err = gcry_md_open(&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
1061 ERROR("network plugin: Creating HMAC-SHA-256 object failed: %s",
1062 gcry_strerror(err));
1064 sfree(pss.username);
1068 err = gcry_md_setkey(hd, secret, strlen(secret));
1070 ERROR("network plugin: gcry_md_setkey failed: %s", gcry_strerror(err));
1073 sfree(pss.username);
1077 gcry_md_write(hd, buffer + PART_SIGNATURE_SHA256_SIZE,
1078 buffer_len - PART_SIGNATURE_SHA256_SIZE);
1079 hash_ptr = gcry_md_read(hd, GCRY_MD_SHA256);
1080 if (hash_ptr == NULL) {
1081 ERROR("network plugin: gcry_md_read failed.");
1084 sfree(pss.username);
1087 memcpy(hash, hash_ptr, sizeof(hash));
1093 if (memcmp(pss.hash, hash, sizeof(pss.hash)) != 0) {
1094 WARNING("network plugin: Verifying HMAC-SHA-256 signature failed: "
1095 "Hash mismatch. Username: %s",
1098 parse_packet(se, buffer + buffer_offset, buffer_len - buffer_offset,
1099 flags | PP_SIGNED, pss.username);
1103 sfree(pss.username);
1105 *ret_buffer = buffer + buffer_len;
1106 *ret_buffer_len = 0;
1109 } /* }}} int parse_part_sign_sha256 */
1110 /* #endif HAVE_GCRYPT_H */
1112 #else /* if !HAVE_GCRYPT_H */
1113 static int parse_part_sign_sha256(sockent_t *se, /* {{{ */
1114 void **ret_buffer, size_t *ret_buffer_size,
1116 static int warning_has_been_printed = 0;
1120 size_t buffer_offset;
1123 part_signature_sha256_t pss;
1125 buffer = *ret_buffer;
1126 buffer_size = *ret_buffer_size;
1129 if (buffer_size <= PART_SIGNATURE_SHA256_SIZE)
1132 BUFFER_READ(&pss.head.type, sizeof(pss.head.type));
1133 BUFFER_READ(&pss.head.length, sizeof(pss.head.length));
1134 part_len = ntohs(pss.head.length);
1136 if ((part_len <= PART_SIGNATURE_SHA256_SIZE) || (part_len > buffer_size))
1139 if (warning_has_been_printed == 0) {
1140 WARNING("network plugin: Received signed packet, but the network "
1141 "plugin was not linked with libgcrypt, so I cannot "
1142 "verify the signature. The packet will be accepted.");
1143 warning_has_been_printed = 1;
1146 parse_packet(se, buffer + part_len, buffer_size - part_len, flags,
1147 /* username = */ NULL);
1149 *ret_buffer = buffer + buffer_size;
1150 *ret_buffer_size = 0;
1153 } /* }}} int parse_part_sign_sha256 */
1154 #endif /* !HAVE_GCRYPT_H */
1157 static int parse_part_encr_aes256(sockent_t *se, /* {{{ */
1158 void **ret_buffer, size_t *ret_buffer_len,
1160 char *buffer = *ret_buffer;
1161 size_t buffer_len = *ret_buffer_len;
1164 size_t buffer_offset;
1165 uint16_t username_len;
1166 part_encryption_aes256_t pea;
1167 unsigned char hash[sizeof(pea.hash)] = {0};
1169 gcry_cipher_hd_t cypher;
1172 /* Make sure at least the header if available. */
1173 if (buffer_len <= PART_ENCRYPTION_AES256_SIZE) {
1174 NOTICE("network plugin: parse_part_encr_aes256: "
1175 "Discarding short packet.");
1181 /* Copy the unencrypted information into `pea'. */
1182 BUFFER_READ(&pea.head.type, sizeof(pea.head.type));
1183 BUFFER_READ(&pea.head.length, sizeof(pea.head.length));
1185 /* Check the `part size'. */
1186 part_size = ntohs(pea.head.length);
1187 if ((part_size <= PART_ENCRYPTION_AES256_SIZE) || (part_size > buffer_len)) {
1188 NOTICE("network plugin: parse_part_encr_aes256: "
1189 "Discarding part with invalid size.");
1193 /* Read the username */
1194 BUFFER_READ(&username_len, sizeof(username_len));
1195 username_len = ntohs(username_len);
1197 if ((username_len == 0) ||
1198 (username_len > (part_size - (PART_ENCRYPTION_AES256_SIZE + 1)))) {
1199 NOTICE("network plugin: parse_part_encr_aes256: "
1200 "Discarding part with invalid username length.");
1204 assert(username_len > 0);
1205 pea.username = malloc(username_len + 1);
1206 if (pea.username == NULL)
1208 BUFFER_READ(pea.username, username_len);
1209 pea.username[username_len] = 0;
1211 /* Last but not least, the initialization vector */
1212 BUFFER_READ(pea.iv, sizeof(pea.iv));
1214 /* Make sure we are at the right position */
1215 assert(buffer_offset ==
1216 (username_len + PART_ENCRYPTION_AES256_SIZE - sizeof(pea.hash)));
1218 cypher = network_get_aes256_cypher(se, pea.iv, sizeof(pea.iv), pea.username);
1219 if (cypher == NULL) {
1220 ERROR("network plugin: Failed to get cypher. Username: %s", pea.username);
1221 sfree(pea.username);
1225 payload_len = part_size - (PART_ENCRYPTION_AES256_SIZE + username_len);
1226 assert(payload_len > 0);
1228 /* Decrypt the packet in-place */
1229 err = gcry_cipher_decrypt(cypher, buffer + buffer_offset,
1230 part_size - buffer_offset,
1231 /* in = */ NULL, /* in len = */ 0);
1233 sfree(pea.username);
1234 ERROR("network plugin: gcry_cipher_decrypt returned: %s. Username: %s",
1235 gcry_strerror(err), pea.username);
1240 BUFFER_READ(pea.hash, sizeof(pea.hash));
1242 /* Make sure we're at the right position - again */
1243 assert(buffer_offset == (username_len + PART_ENCRYPTION_AES256_SIZE));
1244 assert(buffer_offset == (part_size - payload_len));
1246 /* Check hash sum */
1247 gcry_md_hash_buffer(GCRY_MD_SHA1, hash, buffer + buffer_offset, payload_len);
1248 if (memcmp(hash, pea.hash, sizeof(hash)) != 0) {
1249 ERROR("network plugin: Checksum mismatch. Username: %s", pea.username);
1250 sfree(pea.username);
1254 parse_packet(se, buffer + buffer_offset, payload_len, flags | PP_ENCRYPTED,
1257 /* XXX: Free pea.username?!? */
1259 /* Update return values */
1260 *ret_buffer = buffer + part_size;
1261 *ret_buffer_len = buffer_len - part_size;
1263 sfree(pea.username);
1266 } /* }}} int parse_part_encr_aes256 */
1267 /* #endif HAVE_GCRYPT_H */
1269 #else /* if !HAVE_GCRYPT_H */
1270 static int parse_part_encr_aes256(sockent_t *se, /* {{{ */
1271 void **ret_buffer, size_t *ret_buffer_size,
1273 static int warning_has_been_printed = 0;
1277 size_t buffer_offset;
1282 buffer = *ret_buffer;
1283 buffer_size = *ret_buffer_size;
1286 /* parse_packet assures this minimum size. */
1287 assert(buffer_size >= (sizeof(ph.type) + sizeof(ph.length)));
1289 BUFFER_READ(&ph.type, sizeof(ph.type));
1290 BUFFER_READ(&ph.length, sizeof(ph.length));
1291 ph_length = ntohs(ph.length);
1293 if ((ph_length <= PART_ENCRYPTION_AES256_SIZE) || (ph_length > buffer_size)) {
1294 ERROR("network plugin: AES-256 encrypted part "
1295 "with invalid length received.");
1299 if (warning_has_been_printed == 0) {
1300 WARNING("network plugin: Received encrypted packet, but the network "
1301 "plugin was not linked with libgcrypt, so I cannot "
1302 "decrypt it. The part will be discarded.");
1303 warning_has_been_printed = 1;
1306 *ret_buffer = (void *)(((char *)*ret_buffer) + ph_length);
1307 *ret_buffer_size -= ph_length;
1310 } /* }}} int parse_part_encr_aes256 */
1311 #endif /* !HAVE_GCRYPT_H */
1315 static int parse_packet(sockent_t *se, /* {{{ */
1316 void *buffer, size_t buffer_size, int flags,
1317 const char *username) {
1320 value_list_t vl = VALUE_LIST_INIT;
1321 notification_t n = {0};
1324 int packet_was_signed = (flags & PP_SIGNED);
1325 int packet_was_encrypted = (flags & PP_ENCRYPTED);
1326 int printed_ignore_warning = 0;
1327 #endif /* HAVE_GCRYPT_H */
1329 memset(&vl, '\0', sizeof(vl));
1332 while ((status == 0) && (0 < buffer_size) &&
1333 ((unsigned int)buffer_size > sizeof(part_header_t))) {
1334 uint16_t pkg_length;
1337 memcpy((void *)&pkg_type, (void *)buffer, sizeof(pkg_type));
1338 memcpy((void *)&pkg_length, (void *)(((char *)buffer) + sizeof(pkg_type)),
1339 sizeof(pkg_length));
1341 pkg_length = ntohs(pkg_length);
1342 pkg_type = ntohs(pkg_type);
1344 if (pkg_length > buffer_size)
1346 /* Ensure that this loop terminates eventually */
1347 if (pkg_length < (2 * sizeof(uint16_t)))
1350 if (pkg_type == TYPE_ENCR_AES256) {
1351 status = parse_part_encr_aes256(se, &buffer, &buffer_size, flags);
1353 ERROR("network plugin: Decrypting AES256 "
1361 else if ((se->data.server.security_level == SECURITY_LEVEL_ENCRYPT) &&
1362 (packet_was_encrypted == 0)) {
1363 if (printed_ignore_warning == 0) {
1364 INFO("network plugin: Unencrypted packet or "
1365 "part has been ignored.");
1366 printed_ignore_warning = 1;
1368 buffer = ((char *)buffer) + pkg_length;
1369 buffer_size -= (size_t)pkg_length;
1372 #endif /* HAVE_GCRYPT_H */
1373 else if (pkg_type == TYPE_SIGN_SHA256) {
1374 status = parse_part_sign_sha256(se, &buffer, &buffer_size, flags);
1376 ERROR("network plugin: Verifying HMAC-SHA-256 "
1384 else if ((se->data.server.security_level == SECURITY_LEVEL_SIGN) &&
1385 (packet_was_encrypted == 0) && (packet_was_signed == 0)) {
1386 if (printed_ignore_warning == 0) {
1387 INFO("network plugin: Unsigned packet or "
1388 "part has been ignored.");
1389 printed_ignore_warning = 1;
1391 buffer = ((char *)buffer) + pkg_length;
1392 buffer_size -= (size_t)pkg_length;
1395 #endif /* HAVE_GCRYPT_H */
1396 else if (pkg_type == TYPE_VALUES) {
1398 parse_part_values(&buffer, &buffer_size, &vl.values, &vl.values_len);
1402 network_dispatch_values(&vl, username);
1405 } else if (pkg_type == TYPE_TIME) {
1407 status = parse_part_number(&buffer, &buffer_size, &tmp);
1409 vl.time = TIME_T_TO_CDTIME_T(tmp);
1410 n.time = TIME_T_TO_CDTIME_T(tmp);
1412 } else if (pkg_type == TYPE_TIME_HR) {
1414 status = parse_part_number(&buffer, &buffer_size, &tmp);
1416 vl.time = (cdtime_t)tmp;
1417 n.time = (cdtime_t)tmp;
1419 } else if (pkg_type == TYPE_INTERVAL) {
1421 status = parse_part_number(&buffer, &buffer_size, &tmp);
1423 vl.interval = TIME_T_TO_CDTIME_T(tmp);
1424 } else if (pkg_type == TYPE_INTERVAL_HR) {
1426 status = parse_part_number(&buffer, &buffer_size, &tmp);
1428 vl.interval = (cdtime_t)tmp;
1429 } else if (pkg_type == TYPE_HOST) {
1431 parse_part_string(&buffer, &buffer_size, vl.host, sizeof(vl.host));
1433 sstrncpy(n.host, vl.host, sizeof(n.host));
1434 } else if (pkg_type == TYPE_PLUGIN) {
1435 status = parse_part_string(&buffer, &buffer_size, vl.plugin,
1438 sstrncpy(n.plugin, vl.plugin, sizeof(n.plugin));
1439 } else if (pkg_type == TYPE_PLUGIN_INSTANCE) {
1440 status = parse_part_string(&buffer, &buffer_size, vl.plugin_instance,
1441 sizeof(vl.plugin_instance));
1443 sstrncpy(n.plugin_instance, vl.plugin_instance,
1444 sizeof(n.plugin_instance));
1445 } else if (pkg_type == TYPE_TYPE) {
1447 parse_part_string(&buffer, &buffer_size, vl.type, sizeof(vl.type));
1449 sstrncpy(n.type, vl.type, sizeof(n.type));
1450 } else if (pkg_type == TYPE_TYPE_INSTANCE) {
1451 status = parse_part_string(&buffer, &buffer_size, vl.type_instance,
1452 sizeof(vl.type_instance));
1454 sstrncpy(n.type_instance, vl.type_instance, sizeof(n.type_instance));
1455 } else if (pkg_type == TYPE_MESSAGE) {
1456 status = parse_part_string(&buffer, &buffer_size, n.message,
1461 } else if ((n.severity != NOTIF_FAILURE) &&
1462 (n.severity != NOTIF_WARNING) && (n.severity != NOTIF_OKAY)) {
1463 INFO("network plugin: "
1464 "Ignoring notification with "
1465 "unknown severity %i.",
1467 } else if (n.time == 0) {
1468 INFO("network plugin: "
1469 "Ignoring notification with "
1471 } else if (strlen(n.message) == 0) {
1472 INFO("network plugin: "
1473 "Ignoring notification with "
1474 "an empty message.");
1476 network_dispatch_notification(&n);
1478 } else if (pkg_type == TYPE_SEVERITY) {
1480 status = parse_part_number(&buffer, &buffer_size, &tmp);
1482 n.severity = (int)tmp;
1484 DEBUG("network plugin: parse_packet: Unknown part"
1487 buffer = ((char *)buffer) + pkg_length;
1488 buffer_size -= (size_t)pkg_length;
1490 } /* while (buffer_size > sizeof (part_header_t)) */
1492 if (status == 0 && buffer_size > 0)
1493 WARNING("network plugin: parse_packet: Received truncated "
1494 "packet, try increasing `MaxPacketSize'");
1497 } /* }}} int parse_packet */
1499 static void free_sockent_client(struct sockent_client *sec) /* {{{ */
1507 sfree(sec->username);
1508 sfree(sec->password);
1509 if (sec->cypher != NULL)
1510 gcry_cipher_close(sec->cypher);
1512 } /* }}} void free_sockent_client */
1514 static void free_sockent_server(struct sockent_server *ses) /* {{{ */
1516 for (size_t i = 0; i < ses->fd_num; i++) {
1517 if (ses->fd[i] >= 0) {
1525 sfree(ses->auth_file);
1526 fbh_destroy(ses->userdb);
1527 if (ses->cypher != NULL)
1528 gcry_cipher_close(ses->cypher);
1530 } /* }}} void free_sockent_server */
1532 static void sockent_destroy(sockent_t *se) /* {{{ */
1536 DEBUG("network plugin: sockent_destroy (se = %p);", (void *)se);
1538 while (se != NULL) {
1544 if (se->type == SOCKENT_TYPE_CLIENT)
1545 free_sockent_client(&se->data.client);
1547 free_sockent_server(&se->data.server);
1552 } /* }}} void sockent_destroy */
1555 * int network_set_ttl
1557 * Set the `IP_MULTICAST_TTL', `IP_TTL', `IPV6_MULTICAST_HOPS' or
1558 * `IPV6_UNICAST_HOPS', depending on which option is applicable.
1560 * The `struct addrinfo' is used to destinguish between unicast and multicast
1563 static int network_set_ttl(const sockent_t *se, const struct addrinfo *ai) {
1564 DEBUG("network plugin: network_set_ttl: network_config_ttl = %i;",
1565 network_config_ttl);
1567 assert(se->type == SOCKENT_TYPE_CLIENT);
1569 if ((network_config_ttl < 1) || (network_config_ttl > 255))
1572 if (ai->ai_family == AF_INET) {
1573 struct sockaddr_in *addr = (struct sockaddr_in *)ai->ai_addr;
1576 if (IN_MULTICAST(ntohl(addr->sin_addr.s_addr)))
1577 optname = IP_MULTICAST_TTL;
1581 if (setsockopt(se->data.client.fd, IPPROTO_IP, optname, &network_config_ttl,
1582 sizeof(network_config_ttl)) != 0) {
1584 ERROR("network plugin: setsockopt (ipv4-ttl): %s",
1585 sstrerror(errno, errbuf, sizeof(errbuf)));
1588 } else if (ai->ai_family == AF_INET6) {
1590 * http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
1591 struct sockaddr_in6 *addr = (struct sockaddr_in6 *)ai->ai_addr;
1594 if (IN6_IS_ADDR_MULTICAST(&addr->sin6_addr))
1595 optname = IPV6_MULTICAST_HOPS;
1597 optname = IPV6_UNICAST_HOPS;
1599 if (setsockopt(se->data.client.fd, IPPROTO_IPV6, optname,
1600 &network_config_ttl, sizeof(network_config_ttl)) != 0) {
1602 ERROR("network plugin: setsockopt(ipv6-ttl): %s",
1603 sstrerror(errno, errbuf, sizeof(errbuf)));
1609 } /* int network_set_ttl */
1611 static int network_set_interface(const sockent_t *se,
1612 const struct addrinfo *ai) /* {{{ */
1614 DEBUG("network plugin: network_set_interface: interface index = %i;",
1617 assert(se->type == SOCKENT_TYPE_CLIENT);
1619 if (ai->ai_family == AF_INET) {
1620 struct sockaddr_in *addr = (struct sockaddr_in *)ai->ai_addr;
1622 if (IN_MULTICAST(ntohl(addr->sin_addr.s_addr))) {
1623 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1624 /* If possible, use the "ip_mreqn" structure which has
1625 * an "interface index" member. Using the interface
1626 * index is preferred here, because of its similarity
1627 * to the way IPv6 handles this. Unfortunately, it
1628 * appears not to be portable. */
1629 struct ip_mreqn mreq = {.imr_multiaddr.s_addr = addr->sin_addr.s_addr,
1630 .imr_address.s_addr = ntohl(INADDR_ANY),
1631 .imr_ifindex = se->interface};
1633 struct ip_mreq mreq = {.imr_multiaddr.s_addr = addr->sin_addr.s_addr,
1634 .imr_interface.s_addr = ntohl(INADDR_ANY)};
1637 if (setsockopt(se->data.client.fd, IPPROTO_IP, IP_MULTICAST_IF, &mreq,
1638 sizeof(mreq)) != 0) {
1640 ERROR("network plugin: setsockopt (ipv4-multicast-if): %s",
1641 sstrerror(errno, errbuf, sizeof(errbuf)));
1647 } else if (ai->ai_family == AF_INET6) {
1648 struct sockaddr_in6 *addr = (struct sockaddr_in6 *)ai->ai_addr;
1650 if (IN6_IS_ADDR_MULTICAST(&addr->sin6_addr)) {
1651 if (setsockopt(se->data.client.fd, IPPROTO_IPV6, IPV6_MULTICAST_IF,
1652 &se->interface, sizeof(se->interface)) != 0) {
1654 ERROR("network plugin: setsockopt (ipv6-multicast-if): %s",
1655 sstrerror(errno, errbuf, sizeof(errbuf)));
1663 /* else: Not a multicast interface. */
1664 if (se->interface != 0) {
1665 #if defined(HAVE_IF_INDEXTONAME) && HAVE_IF_INDEXTONAME && \
1666 defined(SO_BINDTODEVICE)
1667 char interface_name[IFNAMSIZ];
1669 if (if_indextoname(se->interface, interface_name) == NULL)
1672 DEBUG("network plugin: Binding socket to interface %s", interface_name);
1674 if (setsockopt(se->data.client.fd, SOL_SOCKET, SO_BINDTODEVICE,
1675 interface_name, sizeof(interface_name)) == -1) {
1677 ERROR("network plugin: setsockopt (bind-if): %s",
1678 sstrerror(errno, errbuf, sizeof(errbuf)));
1681 /* #endif HAVE_IF_INDEXTONAME && SO_BINDTODEVICE */
1684 WARNING("network plugin: Cannot set the interface on a unicast "
1686 #if !defined(SO_BINDTODEVICE)
1687 "the \"SO_BINDTODEVICE\" socket option "
1689 "the \"if_indextoname\" function "
1691 "is not available on your system.");
1696 } /* }}} network_set_interface */
1698 static int network_bind_socket(int fd, const struct addrinfo *ai,
1699 const int interface_idx) {
1707 /* allow multiple sockets to use the same PORT number */
1708 if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes)) == -1) {
1710 ERROR("network plugin: setsockopt (reuseaddr): %s",
1711 sstrerror(errno, errbuf, sizeof(errbuf)));
1715 DEBUG("fd = %i; calling `bind'", fd);
1717 if (bind(fd, ai->ai_addr, ai->ai_addrlen) == -1) {
1719 ERROR("bind: %s", sstrerror(errno, errbuf, sizeof(errbuf)));
1723 if (ai->ai_family == AF_INET) {
1724 struct sockaddr_in *addr = (struct sockaddr_in *)ai->ai_addr;
1725 if (IN_MULTICAST(ntohl(addr->sin_addr.s_addr))) {
1726 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1727 struct ip_mreqn mreq;
1729 struct ip_mreq mreq;
1732 DEBUG("fd = %i; IPv4 multicast address found", fd);
1734 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
1735 #if HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
1736 /* Set the interface using the interface index if
1737 * possible (available). Unfortunately, the struct
1738 * ip_mreqn is not portable. */
1739 mreq.imr_address.s_addr = ntohl(INADDR_ANY);
1740 mreq.imr_ifindex = interface_idx;
1742 mreq.imr_interface.s_addr = ntohl(INADDR_ANY);
1745 if (setsockopt(fd, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop)) ==
1748 ERROR("network plugin: setsockopt (multicast-loop): %s",
1749 sstrerror(errno, errbuf, sizeof(errbuf)));
1753 if (setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq)) ==
1756 ERROR("network plugin: setsockopt (add-membership): %s",
1757 sstrerror(errno, errbuf, sizeof(errbuf)));
1763 } else if (ai->ai_family == AF_INET6) {
1765 * http://gsyc.escet.urjc.es/~eva/IPv6-web/examples/mcast.html */
1766 struct sockaddr_in6 *addr = (struct sockaddr_in6 *)ai->ai_addr;
1767 if (IN6_IS_ADDR_MULTICAST(&addr->sin6_addr)) {
1768 struct ipv6_mreq mreq;
1770 DEBUG("fd = %i; IPv6 multicast address found", fd);
1772 memcpy(&mreq.ipv6mr_multiaddr, &addr->sin6_addr, sizeof(addr->sin6_addr));
1774 /* http://developer.apple.com/documentation/Darwin/Reference/ManPages/man4/ip6.4.html
1775 * ipv6mr_interface may be set to zeroes to
1776 * choose the default multicast interface or to
1777 * the index of a particular multicast-capable
1778 * interface if the host is multihomed.
1779 * Membership is associ-associated with a
1780 * single interface; programs running on
1781 * multihomed hosts may need to join the same
1782 * group on more than one interface.*/
1783 mreq.ipv6mr_interface = interface_idx;
1785 if (setsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, &loop,
1786 sizeof(loop)) == -1) {
1788 ERROR("network plugin: setsockopt (ipv6-multicast-loop): %s",
1789 sstrerror(errno, errbuf, sizeof(errbuf)));
1793 if (setsockopt(fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq,
1794 sizeof(mreq)) == -1) {
1796 ERROR("network plugin: setsockopt (ipv6-add-membership): %s",
1797 sstrerror(errno, errbuf, sizeof(errbuf)));
1805 #if defined(HAVE_IF_INDEXTONAME) && HAVE_IF_INDEXTONAME && \
1806 defined(SO_BINDTODEVICE)
1807 /* if a specific interface was set, bind the socket to it. But to avoid
1808 * possible problems with multicast routing, only do that for non-multicast
1810 if (interface_idx != 0) {
1811 char interface_name[IFNAMSIZ];
1813 if (if_indextoname(interface_idx, interface_name) == NULL)
1816 DEBUG("fd = %i; Binding socket to interface %s", fd, interface_name);
1818 if (setsockopt(fd, SOL_SOCKET, SO_BINDTODEVICE, interface_name,
1819 sizeof(interface_name)) == -1) {
1821 ERROR("network plugin: setsockopt (bind-if): %s",
1822 sstrerror(errno, errbuf, sizeof(errbuf)));
1826 #endif /* HAVE_IF_INDEXTONAME && SO_BINDTODEVICE */
1829 } /* int network_bind_socket */
1831 /* Initialize a sockent structure. `type' must be either `SOCKENT_TYPE_CLIENT'
1832 * or `SOCKENT_TYPE_SERVER' */
1833 static sockent_t *sockent_create(int type) /* {{{ */
1837 if ((type != SOCKENT_TYPE_CLIENT) && (type != SOCKENT_TYPE_SERVER))
1840 se = calloc(1, sizeof(*se));
1850 if (type == SOCKENT_TYPE_SERVER) {
1851 se->data.server.fd = NULL;
1852 se->data.server.fd_num = 0;
1854 se->data.server.security_level = SECURITY_LEVEL_NONE;
1855 se->data.server.auth_file = NULL;
1856 se->data.server.userdb = NULL;
1857 se->data.server.cypher = NULL;
1860 se->data.client.fd = -1;
1861 se->data.client.addr = NULL;
1862 se->data.client.resolve_interval = 0;
1863 se->data.client.next_resolve_reconnect = 0;
1865 se->data.client.security_level = SECURITY_LEVEL_NONE;
1866 se->data.client.username = NULL;
1867 se->data.client.password = NULL;
1868 se->data.client.cypher = NULL;
1873 } /* }}} sockent_t *sockent_create */
1875 static int sockent_init_crypto(sockent_t *se) /* {{{ */
1877 #if HAVE_GCRYPT_H /* {{{ */
1878 if (se->type == SOCKENT_TYPE_CLIENT) {
1879 if (se->data.client.security_level > SECURITY_LEVEL_NONE) {
1880 if (network_init_gcrypt() < 0) {
1881 ERROR("network plugin: Cannot configure client socket with "
1882 "security: Failed to initialize crypto library.");
1886 if ((se->data.client.username == NULL) ||
1887 (se->data.client.password == NULL)) {
1888 ERROR("network plugin: Client socket with "
1889 "security requested, but no "
1890 "credentials are configured.");
1893 gcry_md_hash_buffer(GCRY_MD_SHA256, se->data.client.password_hash,
1894 se->data.client.password,
1895 strlen(se->data.client.password));
1897 } else /* (se->type == SOCKENT_TYPE_SERVER) */
1899 if ((se->data.server.security_level > SECURITY_LEVEL_NONE) &&
1900 (se->data.server.auth_file == NULL)) {
1901 ERROR("network plugin: Server socket with security requested, "
1902 "but no \"AuthFile\" is configured.");
1905 if (se->data.server.auth_file != NULL) {
1906 if (network_init_gcrypt() < 0) {
1907 ERROR("network plugin: Cannot configure server socket with security: "
1908 "Failed to initialize crypto library.");
1912 se->data.server.userdb = fbh_create(se->data.server.auth_file);
1913 if (se->data.server.userdb == NULL) {
1914 ERROR("network plugin: Reading password file \"%s\" failed.",
1915 se->data.server.auth_file);
1920 #endif /* }}} HAVE_GCRYPT_H */
1923 } /* }}} int sockent_init_crypto */
1925 static int sockent_client_disconnect(sockent_t *se) /* {{{ */
1927 struct sockent_client *client;
1929 if ((se == NULL) || (se->type != SOCKENT_TYPE_CLIENT))
1932 client = &se->data.client;
1933 if (client->fd >= 0) /* connected */
1939 sfree(client->addr);
1940 client->addrlen = 0;
1943 } /* }}} int sockent_client_disconnect */
1945 static int sockent_client_connect(sockent_t *se) /* {{{ */
1947 static c_complain_t complaint = C_COMPLAIN_INIT_STATIC;
1949 struct sockent_client *client;
1950 struct addrinfo *ai_list;
1952 _Bool reconnect = 0;
1955 if ((se == NULL) || (se->type != SOCKENT_TYPE_CLIENT))
1958 client = &se->data.client;
1961 if (client->resolve_interval != 0 && client->next_resolve_reconnect < now) {
1962 DEBUG("network plugin: Reconnecting socket, resolve_interval = %lf, "
1963 "next_resolve_reconnect = %lf",
1964 CDTIME_T_TO_DOUBLE(client->resolve_interval),
1965 CDTIME_T_TO_DOUBLE(client->next_resolve_reconnect));
1969 if (client->fd >= 0 && !reconnect) /* already connected and not stale*/
1972 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC,
1973 .ai_flags = AI_ADDRCONFIG,
1974 .ai_protocol = IPPROTO_UDP,
1975 .ai_socktype = SOCK_DGRAM};
1977 status = getaddrinfo(se->node,
1978 (se->service != NULL) ? se->service : NET_DEFAULT_PORT,
1979 &ai_hints, &ai_list);
1982 LOG_ERR, &complaint, "network plugin: getaddrinfo (%s, %s) failed: %s",
1983 (se->node == NULL) ? "(null)" : se->node,
1984 (se->service == NULL) ? "(null)" : se->service, gai_strerror(status));
1987 c_release(LOG_NOTICE, &complaint,
1988 "network plugin: Successfully resolved \"%s\".", se->node);
1991 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
1992 ai_ptr = ai_ptr->ai_next) {
1993 if (client->fd >= 0) /* when we reconnect */
1994 sockent_client_disconnect(se);
1997 socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
1998 if (client->fd < 0) {
2000 ERROR("network plugin: socket(2) failed: %s",
2001 sstrerror(errno, errbuf, sizeof(errbuf)));
2005 client->addr = calloc(1, sizeof(*client->addr));
2006 if (client->addr == NULL) {
2007 ERROR("network plugin: calloc failed.");
2013 assert(sizeof(*client->addr) >= ai_ptr->ai_addrlen);
2014 memcpy(client->addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
2015 client->addrlen = ai_ptr->ai_addrlen;
2017 network_set_ttl(se, ai_ptr);
2018 network_set_interface(se, ai_ptr);
2020 /* We don't open more than one write-socket per
2021 * node/service pair.. */
2025 freeaddrinfo(ai_list);
2029 if (client->resolve_interval > 0)
2030 client->next_resolve_reconnect = now + client->resolve_interval;
2032 } /* }}} int sockent_client_connect */
2034 /* Open the file descriptors for a initialized sockent structure. */
2035 static int sockent_server_listen(sockent_t *se) /* {{{ */
2037 struct addrinfo *ai_list;
2041 const char *service;
2046 assert(se->data.server.fd == NULL);
2047 assert(se->data.server.fd_num == 0);
2050 service = se->service;
2052 if (service == NULL)
2053 service = NET_DEFAULT_PORT;
2055 DEBUG("network plugin: sockent_server_listen: node = %s; service = %s;", node,
2058 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC,
2059 .ai_flags = AI_ADDRCONFIG | AI_PASSIVE,
2060 .ai_protocol = IPPROTO_UDP,
2061 .ai_socktype = SOCK_DGRAM};
2063 status = getaddrinfo(node, service, &ai_hints, &ai_list);
2065 ERROR("network plugin: getaddrinfo (%s, %s) failed: %s",
2066 (se->node == NULL) ? "(null)" : se->node,
2067 (se->service == NULL) ? "(null)" : se->service, gai_strerror(status));
2071 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
2072 ai_ptr = ai_ptr->ai_next) {
2075 tmp = realloc(se->data.server.fd,
2076 sizeof(*tmp) * (se->data.server.fd_num + 1));
2078 ERROR("network plugin: realloc failed.");
2081 se->data.server.fd = tmp;
2082 tmp = se->data.server.fd + se->data.server.fd_num;
2084 *tmp = socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
2087 ERROR("network plugin: socket(2) failed: %s",
2088 sstrerror(errno, errbuf, sizeof(errbuf)));
2092 status = network_bind_socket(*tmp, ai_ptr, se->interface);
2099 se->data.server.fd_num++;
2101 } /* for (ai_list) */
2103 freeaddrinfo(ai_list);
2105 if (se->data.server.fd_num == 0)
2108 } /* }}} int sockent_server_listen */
2110 /* Add a sockent to the global list of sockets */
2111 static int sockent_add(sockent_t *se) /* {{{ */
2113 sockent_t *last_ptr;
2118 if (se->type == SOCKENT_TYPE_SERVER) {
2121 tmp = realloc(listen_sockets_pollfd,
2122 sizeof(*tmp) * (listen_sockets_num + se->data.server.fd_num));
2124 ERROR("network plugin: realloc failed.");
2127 listen_sockets_pollfd = tmp;
2128 tmp = listen_sockets_pollfd + listen_sockets_num;
2130 for (size_t i = 0; i < se->data.server.fd_num; i++) {
2131 memset(tmp + i, 0, sizeof(*tmp));
2132 tmp[i].fd = se->data.server.fd[i];
2133 tmp[i].events = POLLIN | POLLPRI;
2137 listen_sockets_num += se->data.server.fd_num;
2139 if (listen_sockets == NULL) {
2140 listen_sockets = se;
2143 last_ptr = listen_sockets;
2144 } else /* if (se->type == SOCKENT_TYPE_CLIENT) */
2146 if (sending_sockets == NULL) {
2147 sending_sockets = se;
2150 last_ptr = sending_sockets;
2153 while (last_ptr->next != NULL)
2154 last_ptr = last_ptr->next;
2155 last_ptr->next = se;
2158 } /* }}} int sockent_add */
2160 static void *dispatch_thread(void __attribute__((unused)) * arg) /* {{{ */
2163 receive_list_entry_t *ent;
2166 /* Lock and wait for more data to come in */
2167 pthread_mutex_lock(&receive_list_lock);
2168 while ((listen_loop == 0) && (receive_list_head == NULL))
2169 pthread_cond_wait(&receive_list_cond, &receive_list_lock);
2171 /* Remove the head entry and unlock */
2172 ent = receive_list_head;
2174 receive_list_head = ent->next;
2175 receive_list_length--;
2176 pthread_mutex_unlock(&receive_list_lock);
2178 /* Check whether we are supposed to exit. We do NOT check `listen_loop'
2179 * because we dispatch all missing packets before shutting down. */
2183 /* Look for the correct `sockent_t' */
2184 se = listen_sockets;
2185 while (se != NULL) {
2188 for (i = 0; i < se->data.server.fd_num; i++)
2189 if (se->data.server.fd[i] == ent->fd)
2192 if (i < se->data.server.fd_num)
2199 ERROR("network plugin: Got packet from FD %i, but can't "
2200 "find an appropriate socket entry.",
2207 parse_packet(se, ent->data, ent->data_len, /* flags = */ 0,
2208 /* username = */ NULL);
2214 } /* }}} void *dispatch_thread */
2216 static int network_receive(void) /* {{{ */
2218 char buffer[network_config_packet_size];
2223 receive_list_entry_t *private_list_head;
2224 receive_list_entry_t *private_list_tail;
2225 uint64_t private_list_length;
2227 assert(listen_sockets_num > 0);
2229 private_list_head = NULL;
2230 private_list_tail = NULL;
2231 private_list_length = 0;
2233 while (listen_loop == 0) {
2234 status = poll(listen_sockets_pollfd, listen_sockets_num, -1);
2239 ERROR("network plugin: poll(2) failed: %s",
2240 sstrerror(errno, errbuf, sizeof(errbuf)));
2244 for (size_t i = 0; (i < listen_sockets_num) && (status > 0); i++) {
2245 receive_list_entry_t *ent;
2247 if ((listen_sockets_pollfd[i].revents & (POLLIN | POLLPRI)) == 0)
2251 buffer_len = recv(listen_sockets_pollfd[i].fd, buffer, sizeof(buffer),
2253 if (buffer_len < 0) {
2255 status = (errno != 0) ? errno : -1;
2256 ERROR("network plugin: recv(2) failed: %s",
2257 sstrerror(errno, errbuf, sizeof(errbuf)));
2261 stats_octets_rx += ((uint64_t)buffer_len);
2264 /* TODO: Possible performance enhancement: Do not free
2265 * these entries in the dispatch thread but put them in
2266 * another list, so we don't have to allocate more and
2267 * more of these structures. */
2268 ent = calloc(1, sizeof(*ent));
2270 ERROR("network plugin: calloc failed.");
2275 ent->data = malloc(network_config_packet_size);
2276 if (ent->data == NULL) {
2278 ERROR("network plugin: malloc failed.");
2282 ent->fd = listen_sockets_pollfd[i].fd;
2285 memcpy(ent->data, buffer, buffer_len);
2286 ent->data_len = buffer_len;
2288 if (private_list_head == NULL)
2289 private_list_head = ent;
2291 private_list_tail->next = ent;
2292 private_list_tail = ent;
2293 private_list_length++;
2295 /* Do not block here. Blocking here has led to
2296 * insufficient performance in the past. */
2297 if (pthread_mutex_trylock(&receive_list_lock) == 0) {
2298 assert(((receive_list_head == NULL) && (receive_list_length == 0)) ||
2299 ((receive_list_head != NULL) && (receive_list_length != 0)));
2301 if (receive_list_head == NULL)
2302 receive_list_head = private_list_head;
2304 receive_list_tail->next = private_list_head;
2305 receive_list_tail = private_list_tail;
2306 receive_list_length += private_list_length;
2308 pthread_cond_signal(&receive_list_cond);
2309 pthread_mutex_unlock(&receive_list_lock);
2311 private_list_head = NULL;
2312 private_list_tail = NULL;
2313 private_list_length = 0;
2317 } /* for (listen_sockets_pollfd) */
2321 } /* while (listen_loop == 0) */
2323 /* Make sure everything is dispatched before exiting. */
2324 if (private_list_head != NULL) {
2325 pthread_mutex_lock(&receive_list_lock);
2327 if (receive_list_head == NULL)
2328 receive_list_head = private_list_head;
2330 receive_list_tail->next = private_list_head;
2331 receive_list_tail = private_list_tail;
2332 receive_list_length += private_list_length;
2334 pthread_cond_signal(&receive_list_cond);
2335 pthread_mutex_unlock(&receive_list_lock);
2339 } /* }}} int network_receive */
2341 static void *receive_thread(void __attribute__((unused)) * arg) {
2342 return network_receive() ? (void *)1 : (void *)0;
2343 } /* void *receive_thread */
2345 static void network_init_buffer(void) {
2346 memset(send_buffer, 0, network_config_packet_size);
2347 send_buffer_ptr = send_buffer;
2348 send_buffer_fill = 0;
2349 send_buffer_last_update = 0;
2351 memset(&send_buffer_vl, 0, sizeof(send_buffer_vl));
2352 } /* int network_init_buffer */
2354 static void network_send_buffer_plain(sockent_t *se, /* {{{ */
2355 const char *buffer, size_t buffer_size) {
2359 status = sockent_client_connect(se);
2363 status = sendto(se->data.client.fd, buffer, buffer_size,
2364 /* flags = */ 0, (struct sockaddr *)se->data.client.addr,
2365 se->data.client.addrlen);
2369 if ((errno == EINTR) || (errno == EAGAIN))
2372 ERROR("network plugin: sendto failed: %s. Closing sending socket.",
2373 sstrerror(errno, errbuf, sizeof(errbuf)));
2374 sockent_client_disconnect(se);
2380 } /* }}} void network_send_buffer_plain */
2383 #define BUFFER_ADD(p, s) \
2385 memcpy(buffer + buffer_offset, (p), (s)); \
2386 buffer_offset += (s); \
2389 static void network_send_buffer_signed(sockent_t *se, /* {{{ */
2390 const char *in_buffer,
2391 size_t in_buffer_size) {
2392 char buffer[BUFF_SIG_SIZE + in_buffer_size];
2393 size_t buffer_offset;
2394 size_t username_len;
2398 unsigned char *hash;
2401 err = gcry_md_open(&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
2403 ERROR("network plugin: Creating HMAC object failed: %s",
2404 gcry_strerror(err));
2408 err = gcry_md_setkey(hd, se->data.client.password,
2409 strlen(se->data.client.password));
2411 ERROR("network plugin: gcry_md_setkey failed: %s", gcry_strerror(err));
2416 username_len = strlen(se->data.client.username);
2417 if (username_len > (BUFF_SIG_SIZE - PART_SIGNATURE_SHA256_SIZE)) {
2418 ERROR("network plugin: Username too long: %s", se->data.client.username);
2422 memcpy(buffer + PART_SIGNATURE_SHA256_SIZE, se->data.client.username,
2424 memcpy(buffer + PART_SIGNATURE_SHA256_SIZE + username_len, in_buffer,
2427 /* Initialize the `ps' structure. */
2428 part_signature_sha256_t ps = {
2429 .head.type = htons(TYPE_SIGN_SHA256),
2430 .head.length = htons(PART_SIGNATURE_SHA256_SIZE + username_len)};
2432 /* Calculate the hash value. */
2433 gcry_md_write(hd, buffer + PART_SIGNATURE_SHA256_SIZE,
2434 username_len + in_buffer_size);
2435 hash = gcry_md_read(hd, GCRY_MD_SHA256);
2437 ERROR("network plugin: gcry_md_read failed.");
2441 memcpy(ps.hash, hash, sizeof(ps.hash));
2443 /* Add the header */
2446 BUFFER_ADD(&ps.head.type, sizeof(ps.head.type));
2447 BUFFER_ADD(&ps.head.length, sizeof(ps.head.length));
2448 BUFFER_ADD(ps.hash, sizeof(ps.hash));
2450 assert(buffer_offset == PART_SIGNATURE_SHA256_SIZE);
2455 buffer_offset = PART_SIGNATURE_SHA256_SIZE + username_len + in_buffer_size;
2456 network_send_buffer_plain(se, buffer, buffer_offset);
2457 } /* }}} void network_send_buffer_signed */
2459 static void network_send_buffer_encrypted(sockent_t *se, /* {{{ */
2460 const char *in_buffer,
2461 size_t in_buffer_size) {
2462 char buffer[BUFF_SIG_SIZE + in_buffer_size];
2464 size_t buffer_offset;
2466 size_t username_len;
2468 gcry_cipher_hd_t cypher;
2470 /* Initialize the header fields */
2471 part_encryption_aes256_t pea = {.head.type = htons(TYPE_ENCR_AES256),
2472 .username = se->data.client.username};
2474 username_len = strlen(pea.username);
2475 if ((PART_ENCRYPTION_AES256_SIZE + username_len) > BUFF_SIG_SIZE) {
2476 ERROR("network plugin: Username too long: %s", pea.username);
2480 buffer_size = PART_ENCRYPTION_AES256_SIZE + username_len + in_buffer_size;
2481 header_size = PART_ENCRYPTION_AES256_SIZE + username_len - sizeof(pea.hash);
2483 assert(buffer_size <= sizeof(buffer));
2484 DEBUG("network plugin: network_send_buffer_encrypted: "
2485 "buffer_size = %zu;",
2488 pea.head.length = htons(
2489 (uint16_t)(PART_ENCRYPTION_AES256_SIZE + username_len + in_buffer_size));
2490 pea.username_length = htons((uint16_t)username_len);
2492 /* Chose a random initialization vector. */
2493 gcry_randomize((void *)&pea.iv, sizeof(pea.iv), GCRY_STRONG_RANDOM);
2495 /* Create hash of the payload */
2496 gcry_md_hash_buffer(GCRY_MD_SHA1, pea.hash, in_buffer, in_buffer_size);
2498 /* Initialize the buffer */
2500 memset(buffer, 0, sizeof(buffer));
2502 BUFFER_ADD(&pea.head.type, sizeof(pea.head.type));
2503 BUFFER_ADD(&pea.head.length, sizeof(pea.head.length));
2504 BUFFER_ADD(&pea.username_length, sizeof(pea.username_length));
2505 BUFFER_ADD(pea.username, username_len);
2506 BUFFER_ADD(pea.iv, sizeof(pea.iv));
2507 assert(buffer_offset == header_size);
2508 BUFFER_ADD(pea.hash, sizeof(pea.hash));
2509 BUFFER_ADD(in_buffer, in_buffer_size);
2511 assert(buffer_offset == buffer_size);
2513 cypher = network_get_aes256_cypher(se, pea.iv, sizeof(pea.iv),
2514 se->data.client.password);
2518 /* Encrypt the buffer in-place */
2519 err = gcry_cipher_encrypt(cypher, buffer + header_size,
2520 buffer_size - header_size,
2521 /* in = */ NULL, /* in len = */ 0);
2523 ERROR("network plugin: gcry_cipher_encrypt returned: %s",
2524 gcry_strerror(err));
2528 /* Send it out without further modifications */
2529 network_send_buffer_plain(se, buffer, buffer_size);
2530 } /* }}} void network_send_buffer_encrypted */
2532 #endif /* HAVE_GCRYPT_H */
2534 static void network_send_buffer(char *buffer, size_t buffer_len) /* {{{ */
2536 DEBUG("network plugin: network_send_buffer: buffer_len = %zu", buffer_len);
2538 for (sockent_t *se = sending_sockets; se != NULL; se = se->next) {
2540 if (se->data.client.security_level == SECURITY_LEVEL_ENCRYPT)
2541 network_send_buffer_encrypted(se, buffer, buffer_len);
2542 else if (se->data.client.security_level == SECURITY_LEVEL_SIGN)
2543 network_send_buffer_signed(se, buffer, buffer_len);
2544 else /* if (se->data.client.security_level == SECURITY_LEVEL_NONE) */
2545 #endif /* HAVE_GCRYPT_H */
2546 network_send_buffer_plain(se, buffer, buffer_len);
2547 } /* for (sending_sockets) */
2548 } /* }}} void network_send_buffer */
2550 static int add_to_buffer(char *buffer, size_t buffer_size, /* {{{ */
2551 value_list_t *vl_def, const data_set_t *ds,
2552 const value_list_t *vl) {
2553 char *buffer_orig = buffer;
2555 if (strcmp(vl_def->host, vl->host) != 0) {
2556 if (write_part_string(&buffer, &buffer_size, TYPE_HOST, vl->host,
2557 strlen(vl->host)) != 0)
2559 sstrncpy(vl_def->host, vl->host, sizeof(vl_def->host));
2562 if (vl_def->time != vl->time) {
2563 if (write_part_number(&buffer, &buffer_size, TYPE_TIME_HR,
2564 (uint64_t)vl->time))
2566 vl_def->time = vl->time;
2569 if (vl_def->interval != vl->interval) {
2570 if (write_part_number(&buffer, &buffer_size, TYPE_INTERVAL_HR,
2571 (uint64_t)vl->interval))
2573 vl_def->interval = vl->interval;
2576 if (strcmp(vl_def->plugin, vl->plugin) != 0) {
2577 if (write_part_string(&buffer, &buffer_size, TYPE_PLUGIN, vl->plugin,
2578 strlen(vl->plugin)) != 0)
2580 sstrncpy(vl_def->plugin, vl->plugin, sizeof(vl_def->plugin));
2583 if (strcmp(vl_def->plugin_instance, vl->plugin_instance) != 0) {
2584 if (write_part_string(&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE,
2585 vl->plugin_instance,
2586 strlen(vl->plugin_instance)) != 0)
2588 sstrncpy(vl_def->plugin_instance, vl->plugin_instance,
2589 sizeof(vl_def->plugin_instance));
2592 if (strcmp(vl_def->type, vl->type) != 0) {
2593 if (write_part_string(&buffer, &buffer_size, TYPE_TYPE, vl->type,
2594 strlen(vl->type)) != 0)
2596 sstrncpy(vl_def->type, ds->type, sizeof(vl_def->type));
2599 if (strcmp(vl_def->type_instance, vl->type_instance) != 0) {
2600 if (write_part_string(&buffer, &buffer_size, TYPE_TYPE_INSTANCE,
2601 vl->type_instance, strlen(vl->type_instance)) != 0)
2603 sstrncpy(vl_def->type_instance, vl->type_instance,
2604 sizeof(vl_def->type_instance));
2607 if (write_part_values(&buffer, &buffer_size, ds, vl) != 0)
2610 return buffer - buffer_orig;
2611 } /* }}} int add_to_buffer */
2613 static void flush_buffer(void) {
2614 DEBUG("network plugin: flush_buffer: send_buffer_fill = %i",
2617 network_send_buffer(send_buffer, (size_t)send_buffer_fill);
2619 stats_octets_tx += ((uint64_t)send_buffer_fill);
2622 network_init_buffer();
2625 static int network_write(const data_set_t *ds, const value_list_t *vl,
2626 user_data_t __attribute__((unused)) * user_data) {
2629 /* listen_loop is set to non-zero in the shutdown callback, which is
2630 * guaranteed to be called *after* all the write threads have been shut
2632 assert(listen_loop == 0);
2634 if (!check_send_okay(vl)) {
2636 char name[6 * DATA_MAX_NAME_LEN];
2637 FORMAT_VL(name, sizeof(name), vl);
2638 name[sizeof(name) - 1] = 0;
2639 DEBUG("network plugin: network_write: "
2643 /* Counter is not protected by another lock and may be reached by
2644 * multiple threads */
2645 pthread_mutex_lock(&stats_lock);
2646 stats_values_not_sent++;
2647 pthread_mutex_unlock(&stats_lock);
2651 uc_meta_data_add_unsigned_int(vl, "network:time_sent", (uint64_t)vl->time);
2653 pthread_mutex_lock(&send_buffer_lock);
2655 status = add_to_buffer(send_buffer_ptr,
2656 network_config_packet_size -
2657 (send_buffer_fill + BUFF_SIG_SIZE),
2658 &send_buffer_vl, ds, vl);
2660 /* status == bytes added to the buffer */
2661 send_buffer_fill += status;
2662 send_buffer_ptr += status;
2663 send_buffer_last_update = cdtime();
2665 stats_values_sent++;
2669 status = add_to_buffer(send_buffer_ptr,
2670 network_config_packet_size -
2671 (send_buffer_fill + BUFF_SIG_SIZE),
2672 &send_buffer_vl, ds, vl);
2675 send_buffer_fill += status;
2676 send_buffer_ptr += status;
2678 stats_values_sent++;
2683 ERROR("network plugin: Unable to append to the "
2684 "buffer for some weird reason");
2685 } else if ((network_config_packet_size - send_buffer_fill) < 15) {
2689 pthread_mutex_unlock(&send_buffer_lock);
2691 return (status < 0) ? -1 : 0;
2692 } /* int network_write */
2694 static int network_config_set_ttl(const oconfig_item_t *ci) /* {{{ */
2698 if (cf_util_get_int(ci, &tmp) != 0)
2700 else if ((tmp > 0) && (tmp <= 255))
2701 network_config_ttl = tmp;
2703 WARNING("network plugin: The `TimeToLive' must be between 1 and 255.");
2708 } /* }}} int network_config_set_ttl */
2710 static int network_config_set_interface(const oconfig_item_t *ci, /* {{{ */
2714 if (cf_util_get_string_buffer(ci, if_name, sizeof(if_name)) != 0)
2717 *interface = if_nametoindex(if_name);
2719 } /* }}} int network_config_set_interface */
2721 static int network_config_set_buffer_size(const oconfig_item_t *ci) /* {{{ */
2725 if (cf_util_get_int(ci, &tmp) != 0)
2727 else if ((tmp >= 1024) && (tmp <= 65535))
2728 network_config_packet_size = tmp;
2731 "network plugin: The `MaxPacketSize' must be between 1024 and 65535.");
2736 } /* }}} int network_config_set_buffer_size */
2739 static int network_config_set_security_level(oconfig_item_t *ci, /* {{{ */
2742 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
2743 WARNING("network plugin: The `SecurityLevel' config option needs exactly "
2744 "one string argument.");
2748 str = ci->values[0].value.string;
2749 if (strcasecmp("Encrypt", str) == 0)
2750 *retval = SECURITY_LEVEL_ENCRYPT;
2751 else if (strcasecmp("Sign", str) == 0)
2752 *retval = SECURITY_LEVEL_SIGN;
2753 else if (strcasecmp("None", str) == 0)
2754 *retval = SECURITY_LEVEL_NONE;
2756 WARNING("network plugin: Unknown security level: %s.", str);
2761 } /* }}} int network_config_set_security_level */
2762 #endif /* HAVE_GCRYPT_H */
2764 static int network_config_add_listen(const oconfig_item_t *ci) /* {{{ */
2769 if ((ci->values_num < 1) || (ci->values_num > 2) ||
2770 (ci->values[0].type != OCONFIG_TYPE_STRING) ||
2771 ((ci->values_num > 1) && (ci->values[1].type != OCONFIG_TYPE_STRING))) {
2772 ERROR("network plugin: The `%s' config option needs "
2773 "one or two string arguments.",
2778 se = sockent_create(SOCKENT_TYPE_SERVER);
2780 ERROR("network plugin: sockent_create failed.");
2784 se->node = strdup(ci->values[0].value.string);
2785 if (ci->values_num >= 2)
2786 se->service = strdup(ci->values[1].value.string);
2788 for (int i = 0; i < ci->children_num; i++) {
2789 oconfig_item_t *child = ci->children + i;
2792 if (strcasecmp("AuthFile", child->key) == 0)
2793 cf_util_get_string(child, &se->data.server.auth_file);
2794 else if (strcasecmp("SecurityLevel", child->key) == 0)
2795 network_config_set_security_level(child, &se->data.server.security_level);
2797 #endif /* HAVE_GCRYPT_H */
2798 if (strcasecmp("Interface", child->key) == 0)
2799 network_config_set_interface(child, &se->interface);
2801 WARNING("network plugin: Option `%s' is not allowed here.", child->key);
2806 if ((se->data.server.security_level > SECURITY_LEVEL_NONE) &&
2807 (se->data.server.auth_file == NULL)) {
2808 ERROR("network plugin: A security level higher than `none' was "
2809 "requested, but no AuthFile option was given. Cowardly refusing to "
2810 "open this socket!");
2811 sockent_destroy(se);
2814 #endif /* HAVE_GCRYPT_H */
2816 status = sockent_init_crypto(se);
2818 ERROR("network plugin: network_config_add_listen: sockent_init_crypto() "
2820 sockent_destroy(se);
2824 status = sockent_server_listen(se);
2826 ERROR("network plugin: network_config_add_listen: sockent_server_listen "
2828 sockent_destroy(se);
2832 status = sockent_add(se);
2834 ERROR("network plugin: network_config_add_listen: sockent_add failed.");
2835 sockent_destroy(se);
2840 } /* }}} int network_config_add_listen */
2842 static int network_config_add_server(const oconfig_item_t *ci) /* {{{ */
2847 if ((ci->values_num < 1) || (ci->values_num > 2) ||
2848 (ci->values[0].type != OCONFIG_TYPE_STRING) ||
2849 ((ci->values_num > 1) && (ci->values[1].type != OCONFIG_TYPE_STRING))) {
2850 ERROR("network plugin: The `%s' config option needs "
2851 "one or two string arguments.",
2856 se = sockent_create(SOCKENT_TYPE_CLIENT);
2858 ERROR("network plugin: sockent_create failed.");
2862 se->node = strdup(ci->values[0].value.string);
2863 if (ci->values_num >= 2)
2864 se->service = strdup(ci->values[1].value.string);
2866 for (int i = 0; i < ci->children_num; i++) {
2867 oconfig_item_t *child = ci->children + i;
2870 if (strcasecmp("Username", child->key) == 0)
2871 cf_util_get_string(child, &se->data.client.username);
2872 else if (strcasecmp("Password", child->key) == 0)
2873 cf_util_get_string(child, &se->data.client.password);
2874 else if (strcasecmp("SecurityLevel", child->key) == 0)
2875 network_config_set_security_level(child, &se->data.client.security_level);
2877 #endif /* HAVE_GCRYPT_H */
2878 if (strcasecmp("Interface", child->key) == 0)
2879 network_config_set_interface(child, &se->interface);
2880 else if (strcasecmp("ResolveInterval", child->key) == 0)
2881 cf_util_get_cdtime(child, &se->data.client.resolve_interval);
2883 WARNING("network plugin: Option `%s' is not allowed here.", child->key);
2888 if ((se->data.client.security_level > SECURITY_LEVEL_NONE) &&
2889 ((se->data.client.username == NULL) ||
2890 (se->data.client.password == NULL))) {
2891 ERROR("network plugin: A security level higher than `none' was "
2892 "requested, but no Username or Password option was given. "
2893 "Cowardly refusing to open this socket!");
2894 sockent_destroy(se);
2897 #endif /* HAVE_GCRYPT_H */
2899 status = sockent_init_crypto(se);
2901 ERROR("network plugin: network_config_add_server: sockent_init_crypto() "
2903 sockent_destroy(se);
2907 /* No call to sockent_client_connect() here -- it is called from
2908 * network_send_buffer_plain(). */
2910 status = sockent_add(se);
2912 ERROR("network plugin: network_config_add_server: sockent_add failed.");
2913 sockent_destroy(se);
2918 } /* }}} int network_config_add_server */
2920 static int network_config(oconfig_item_t *ci) /* {{{ */
2922 /* The options need to be applied first */
2923 for (int i = 0; i < ci->children_num; i++) {
2924 oconfig_item_t *child = ci->children + i;
2925 if (strcasecmp("TimeToLive", child->key) == 0)
2926 network_config_set_ttl(child);
2929 for (int i = 0; i < ci->children_num; i++) {
2930 oconfig_item_t *child = ci->children + i;
2932 if (strcasecmp("Listen", child->key) == 0)
2933 network_config_add_listen(child);
2934 else if (strcasecmp("Server", child->key) == 0)
2935 network_config_add_server(child);
2936 else if (strcasecmp("TimeToLive", child->key) == 0) {
2937 /* Handled earlier */
2938 } else if (strcasecmp("MaxPacketSize", child->key) == 0)
2939 network_config_set_buffer_size(child);
2940 else if (strcasecmp("Forward", child->key) == 0)
2941 cf_util_get_boolean(child, &network_config_forward);
2942 else if (strcasecmp("ReportStats", child->key) == 0)
2943 cf_util_get_boolean(child, &network_config_stats);
2945 WARNING("network plugin: Option `%s' is not allowed here.", child->key);
2950 } /* }}} int network_config */
2952 static int network_notification(const notification_t *n,
2953 user_data_t __attribute__((unused)) *
2955 char buffer[network_config_packet_size];
2956 char *buffer_ptr = buffer;
2957 size_t buffer_free = sizeof(buffer);
2960 if (!check_send_notify_okay(n))
2963 memset(buffer, 0, sizeof(buffer));
2965 status = write_part_number(&buffer_ptr, &buffer_free, TYPE_TIME_HR,
2970 status = write_part_number(&buffer_ptr, &buffer_free, TYPE_SEVERITY,
2971 (uint64_t)n->severity);
2975 if (strlen(n->host) > 0) {
2976 status = write_part_string(&buffer_ptr, &buffer_free, TYPE_HOST, n->host,
2982 if (strlen(n->plugin) > 0) {
2983 status = write_part_string(&buffer_ptr, &buffer_free, TYPE_PLUGIN,
2984 n->plugin, strlen(n->plugin));
2989 if (strlen(n->plugin_instance) > 0) {
2990 status = write_part_string(&buffer_ptr, &buffer_free, TYPE_PLUGIN_INSTANCE,
2991 n->plugin_instance, strlen(n->plugin_instance));
2996 if (strlen(n->type) > 0) {
2997 status = write_part_string(&buffer_ptr, &buffer_free, TYPE_TYPE, n->type,
3003 if (strlen(n->type_instance) > 0) {
3004 status = write_part_string(&buffer_ptr, &buffer_free, TYPE_TYPE_INSTANCE,
3005 n->type_instance, strlen(n->type_instance));
3010 status = write_part_string(&buffer_ptr, &buffer_free, TYPE_MESSAGE,
3011 n->message, strlen(n->message));
3015 network_send_buffer(buffer, sizeof(buffer) - buffer_free);
3018 } /* int network_notification */
3020 static int network_shutdown(void) {
3023 /* Kill the listening thread */
3024 if (receive_thread_running != 0) {
3025 INFO("network plugin: Stopping receive thread.");
3026 pthread_kill(receive_thread_id, SIGTERM);
3027 pthread_join(receive_thread_id, NULL /* no return value */);
3028 memset(&receive_thread_id, 0, sizeof(receive_thread_id));
3029 receive_thread_running = 0;
3032 /* Shutdown the dispatching thread */
3033 if (dispatch_thread_running != 0) {
3034 INFO("network plugin: Stopping dispatch thread.");
3035 pthread_mutex_lock(&receive_list_lock);
3036 pthread_cond_broadcast(&receive_list_cond);
3037 pthread_mutex_unlock(&receive_list_lock);
3038 pthread_join(dispatch_thread_id, /* ret = */ NULL);
3039 dispatch_thread_running = 0;
3042 sockent_destroy(listen_sockets);
3044 if (send_buffer_fill > 0)
3049 for (sockent_t *se = sending_sockets; se != NULL; se = se->next)
3050 sockent_client_disconnect(se);
3051 sockent_destroy(sending_sockets);
3053 plugin_unregister_config("network");
3054 plugin_unregister_init("network");
3055 plugin_unregister_write("network");
3056 plugin_unregister_shutdown("network");
3059 } /* int network_shutdown */
3061 static int network_stats_read(void) /* {{{ */
3063 derive_t copy_octets_rx;
3064 derive_t copy_octets_tx;
3065 derive_t copy_packets_rx;
3066 derive_t copy_packets_tx;
3067 derive_t copy_values_dispatched;
3068 derive_t copy_values_not_dispatched;
3069 derive_t copy_values_sent;
3070 derive_t copy_values_not_sent;
3071 derive_t copy_receive_list_length;
3072 value_list_t vl = VALUE_LIST_INIT;
3075 copy_octets_rx = stats_octets_rx;
3076 copy_octets_tx = stats_octets_tx;
3077 copy_packets_rx = stats_packets_rx;
3078 copy_packets_tx = stats_packets_tx;
3079 copy_values_dispatched = stats_values_dispatched;
3080 copy_values_not_dispatched = stats_values_not_dispatched;
3081 copy_values_sent = stats_values_sent;
3082 copy_values_not_sent = stats_values_not_sent;
3083 copy_receive_list_length = receive_list_length;
3085 /* Initialize `vl' */
3089 sstrncpy(vl.plugin, "network", sizeof(vl.plugin));
3091 /* Octets received / sent */
3092 vl.values[0].derive = (derive_t)copy_octets_rx;
3093 vl.values[1].derive = (derive_t)copy_octets_tx;
3094 sstrncpy(vl.type, "if_octets", sizeof(vl.type));
3095 plugin_dispatch_values(&vl);
3097 /* Packets received / send */
3098 vl.values[0].derive = (derive_t)copy_packets_rx;
3099 vl.values[1].derive = (derive_t)copy_packets_tx;
3100 sstrncpy(vl.type, "if_packets", sizeof(vl.type));
3101 plugin_dispatch_values(&vl);
3103 /* Values (not) dispatched and (not) send */
3104 sstrncpy(vl.type, "total_values", sizeof(vl.type));
3107 vl.values[0].derive = (derive_t)copy_values_dispatched;
3108 sstrncpy(vl.type_instance, "dispatch-accepted", sizeof(vl.type_instance));
3109 plugin_dispatch_values(&vl);
3111 vl.values[0].derive = (derive_t)copy_values_not_dispatched;
3112 sstrncpy(vl.type_instance, "dispatch-rejected", sizeof(vl.type_instance));
3113 plugin_dispatch_values(&vl);
3115 vl.values[0].derive = (derive_t)copy_values_sent;
3116 sstrncpy(vl.type_instance, "send-accepted", sizeof(vl.type_instance));
3117 plugin_dispatch_values(&vl);
3119 vl.values[0].derive = (derive_t)copy_values_not_sent;
3120 sstrncpy(vl.type_instance, "send-rejected", sizeof(vl.type_instance));
3121 plugin_dispatch_values(&vl);
3123 /* Receive queue length */
3124 vl.values[0].gauge = (gauge_t)copy_receive_list_length;
3125 sstrncpy(vl.type, "queue_length", sizeof(vl.type));
3126 vl.type_instance[0] = 0;
3127 plugin_dispatch_values(&vl);
3130 } /* }}} int network_stats_read */
3132 static int network_init(void) {
3133 static _Bool have_init = 0;
3135 /* Check if we were already initialized. If so, just return - there's
3136 * nothing more to do (for now, that is). */
3141 if (network_config_stats)
3142 plugin_register_read("network", network_stats_read);
3144 plugin_register_shutdown("network", network_shutdown);
3146 send_buffer = malloc(network_config_packet_size);
3147 if (send_buffer == NULL) {
3148 ERROR("network plugin: malloc failed.");
3151 network_init_buffer();
3153 /* setup socket(s) and so on */
3154 if (sending_sockets != NULL) {
3155 plugin_register_write("network", network_write,
3156 /* user_data = */ NULL);
3157 plugin_register_notification("network", network_notification,
3158 /* user_data = */ NULL);
3161 /* If no threads need to be started, return here. */
3162 if ((listen_sockets_num == 0) ||
3163 ((dispatch_thread_running != 0) && (receive_thread_running != 0)))
3166 if (dispatch_thread_running == 0) {
3168 status = plugin_thread_create(&dispatch_thread_id, NULL /* no attributes */,
3169 dispatch_thread, NULL /* no argument */,
3173 ERROR("network: pthread_create failed: %s",
3174 sstrerror(errno, errbuf, sizeof(errbuf)));
3176 dispatch_thread_running = 1;
3180 if (receive_thread_running == 0) {
3182 status = plugin_thread_create(&receive_thread_id, NULL /* no attributes */,
3183 receive_thread, NULL /* no argument */,
3187 ERROR("network: pthread_create failed: %s",
3188 sstrerror(errno, errbuf, sizeof(errbuf)));
3190 receive_thread_running = 1;
3195 } /* int network_init */
3198 * The flush option of the network plugin cannot flush individual identifiers.
3199 * All the values are added to a buffer and sent when the buffer is full, the
3200 * requested value may or may not be in there, it's not worth finding out. We
3201 * just send the buffer if `flush' is called - if the requested value was in
3202 * there, good. If not, well, then there is nothing to flush.. -octo
3204 static int network_flush(cdtime_t timeout,
3205 __attribute__((unused)) const char *identifier,
3206 __attribute__((unused)) user_data_t *user_data) {
3207 pthread_mutex_lock(&send_buffer_lock);
3209 if (send_buffer_fill > 0) {
3211 cdtime_t now = cdtime();
3212 if ((send_buffer_last_update + timeout) > now) {
3213 pthread_mutex_unlock(&send_buffer_lock);
3219 pthread_mutex_unlock(&send_buffer_lock);
3222 } /* int network_flush */
3224 void module_register(void) {
3225 plugin_register_complex_config("network", network_config);
3226 plugin_register_init("network", network_init);
3227 plugin_register_flush("network", network_flush,
3228 /* user_data = */ NULL);
3229 } /* void module_register */