2 * collectd - src/libcollectdclient/network_buffer.c
3 * Copyright (C) 2010-2014 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
44 #include <arpa/inet.h> /* htons */
50 # if defined __APPLE__
51 /* default xcode compiler throws warnings even when deprecated functionality
52 * is not used. -Werror breaks the build because of erroneous warnings.
53 * http://stackoverflow.com/questions/10556299/compiler-warnings-with-libgcrypt-v1-5-0/12830209#12830209
55 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
57 /* FreeBSD's copy of libgcrypt extends the existing GCRYPT_NO_DEPRECATED
58 * to properly hide all deprecated functionality.
59 * http://svnweb.freebsd.org/ports/head/security/libgcrypt/files/patch-src__gcrypt.h.in
61 # define GCRYPT_NO_DEPRECATED
63 # if defined __APPLE__
64 /* Re enable deprecation warnings */
65 # pragma GCC diagnostic warning "-Wdeprecated-declarations"
67 GCRY_THREAD_OPTION_PTHREAD_IMPL;
72 #include "collectd/network_buffer.h"
74 #define TYPE_HOST 0x0000
75 #define TYPE_TIME 0x0001
76 #define TYPE_TIME_HR 0x0008
77 #define TYPE_PLUGIN 0x0002
78 #define TYPE_PLUGIN_INSTANCE 0x0003
79 #define TYPE_TYPE 0x0004
80 #define TYPE_TYPE_INSTANCE 0x0005
81 #define TYPE_VALUES 0x0006
82 #define TYPE_INTERVAL 0x0007
83 #define TYPE_INTERVAL_HR 0x0009
85 /* Types to transmit notifications */
86 #define TYPE_MESSAGE 0x0100
87 #define TYPE_SEVERITY 0x0101
89 #define TYPE_SIGN_SHA256 0x0200
90 #define TYPE_ENCR_AES256 0x0210
92 #define PART_SIGNATURE_SHA256_SIZE 36
93 #define PART_ENCRYPTION_AES256_SIZE 42
99 #define ADD_GENERIC(nb,srcptr,size) do { \
100 assert ((size) <= (nb)->free); \
101 memcpy ((nb)->ptr, (srcptr), (size)); \
102 (nb)->ptr += (size); \
103 (nb)->free -= (size); \
106 #define ADD_STATIC(nb,var) \
107 ADD_GENERIC(nb,&(var),sizeof(var));
112 struct lcc_network_buffer_s
117 lcc_value_list_t state;
121 lcc_security_level_t seclevel;
126 gcry_cipher_hd_t encr_cypher;
127 size_t encr_header_len;
132 #define SSTRNCPY(dst,src,sz) do { \
133 strncpy ((dst), (src), (sz)); \
134 (dst)[(sz) - 1] = 0; \
140 static _Bool have_gcrypt (void) /* {{{ */
142 static _Bool result = 0;
143 static _Bool need_init = 1;
150 gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
152 if (!gcry_check_version (GCRYPT_VERSION))
155 gcry_control (GCRYCTL_INIT_SECMEM, 32768, 0);
156 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
163 } /* }}} _Bool have_gcrypt */
166 static uint64_t htonll (uint64_t val) /* {{{ */
168 static int config = 0;
176 uint16_t n = htons (h);
187 hi = (uint32_t) (val >> 32);
188 lo = (uint32_t) (val & 0x00000000FFFFFFFF);
193 return ((((uint64_t) lo) << 32) | ((uint64_t) hi));
194 } /* }}} uint64_t htonll */
197 static double htond (double val) /* {{{ */
199 static int config = 0;
201 union { uint8_t byte[8]; double floating; } in;
202 union { uint8_t byte[8]; double floating; } out;
206 double d = 8.642135e130;
211 if ((c[0] == 0x2f) && (c[1] == 0x25)
212 && (c[2] == 0xc0) && (c[3] == 0xc7)
213 && (c[4] == 0x43) && (c[5] == 0x2b)
214 && (c[6] == 0x1f) && (c[7] == 0x5b))
215 config = 1; /* need nothing */
216 else if ((c[7] == 0x2f) && (c[6] == 0x25)
217 && (c[5] == 0xc0) && (c[4] == 0xc7)
218 && (c[3] == 0x43) && (c[2] == 0x2b)
219 && (c[1] == 0x1f) && (c[0] == 0x5b))
220 config = 2; /* endian flip */
221 else if ((c[4] == 0x2f) && (c[5] == 0x25)
222 && (c[6] == 0xc0) && (c[7] == 0xc7)
223 && (c[0] == 0x43) && (c[1] == 0x2b)
224 && (c[2] == 0x1f) && (c[3] == 0x5b))
225 config = 3; /* int swap */
232 out.byte[0] = out.byte[1] = out.byte[2] = out.byte[3] = 0x00;
233 out.byte[4] = out.byte[5] = 0x00;
236 return (out.floating);
238 else if (config == 1)
240 else if (config == 2)
243 out.byte[0] = in.byte[7];
244 out.byte[1] = in.byte[6];
245 out.byte[2] = in.byte[5];
246 out.byte[3] = in.byte[4];
247 out.byte[4] = in.byte[3];
248 out.byte[5] = in.byte[2];
249 out.byte[6] = in.byte[1];
250 out.byte[7] = in.byte[0];
251 return (out.floating);
253 else if (config == 3)
256 out.byte[0] = in.byte[4];
257 out.byte[1] = in.byte[5];
258 out.byte[2] = in.byte[6];
259 out.byte[3] = in.byte[7];
260 out.byte[4] = in.byte[0];
261 out.byte[5] = in.byte[1];
262 out.byte[6] = in.byte[2];
263 out.byte[7] = in.byte[3];
264 return (out.floating);
268 /* If in doubt, just copy the value back to the caller. */
271 } /* }}} double htond */
273 static int nb_add_values (char **ret_buffer, /* {{{ */
274 size_t *ret_buffer_len,
275 const lcc_value_list_t *vl)
282 uint16_t pkg_num_values;
283 uint8_t pkg_values_types[vl->values_len];
284 value_t pkg_values[vl->values_len];
289 packet_len = sizeof (pkg_type) + sizeof (pkg_length)
290 + sizeof (pkg_num_values)
291 + sizeof (pkg_values_types)
292 + sizeof (pkg_values);
294 if (*ret_buffer_len < packet_len)
297 pkg_type = htons (TYPE_VALUES);
298 pkg_length = htons ((uint16_t) packet_len);
299 pkg_num_values = htons ((uint16_t) vl->values_len);
301 for (i = 0; i < vl->values_len; i++)
303 pkg_values_types[i] = (uint8_t) vl->values_types[i];
304 switch (vl->values_types[i])
306 case LCC_TYPE_COUNTER:
307 pkg_values[i].counter = (counter_t) htonll (vl->values[i].counter);
311 pkg_values[i].gauge = (gauge_t) htond (vl->values[i].gauge);
314 case LCC_TYPE_DERIVE:
315 pkg_values[i].derive = (derive_t) htonll (vl->values[i].derive);
318 case LCC_TYPE_ABSOLUTE:
319 pkg_values[i].absolute = (absolute_t) htonll (vl->values[i].absolute);
324 } /* switch (vl->values_types[i]) */
325 } /* for (vl->values_len) */
328 * Use `memcpy' to write everything to the buffer, because the pointer
329 * may be unaligned and some architectures, such as SPARC, can't handle
332 packet_ptr = *ret_buffer;
334 memcpy (packet_ptr + offset, &pkg_type, sizeof (pkg_type));
335 offset += sizeof (pkg_type);
336 memcpy (packet_ptr + offset, &pkg_length, sizeof (pkg_length));
337 offset += sizeof (pkg_length);
338 memcpy (packet_ptr + offset, &pkg_num_values, sizeof (pkg_num_values));
339 offset += sizeof (pkg_num_values);
340 memcpy (packet_ptr + offset, pkg_values_types, sizeof (pkg_values_types));
341 offset += sizeof (pkg_values_types);
342 memcpy (packet_ptr + offset, pkg_values, sizeof (pkg_values));
343 offset += sizeof (pkg_values);
345 assert (offset == packet_len);
347 *ret_buffer = packet_ptr + packet_len;
348 *ret_buffer_len -= packet_len;
350 } /* }}} int nb_add_values */
352 static int nb_add_number (char **ret_buffer, /* {{{ */
353 size_t *ret_buffer_len,
354 uint16_t type, uint64_t value)
365 packet_len = sizeof (pkg_type)
366 + sizeof (pkg_length)
367 + sizeof (pkg_value);
369 if (*ret_buffer_len < packet_len)
372 pkg_type = htons (type);
373 pkg_length = htons ((uint16_t) packet_len);
374 pkg_value = htonll (value);
376 packet_ptr = *ret_buffer;
378 memcpy (packet_ptr + offset, &pkg_type, sizeof (pkg_type));
379 offset += sizeof (pkg_type);
380 memcpy (packet_ptr + offset, &pkg_length, sizeof (pkg_length));
381 offset += sizeof (pkg_length);
382 memcpy (packet_ptr + offset, &pkg_value, sizeof (pkg_value));
383 offset += sizeof (pkg_value);
385 assert (offset == packet_len);
387 *ret_buffer = packet_ptr + packet_len;
388 *ret_buffer_len -= packet_len;
390 } /* }}} int nb_add_number */
392 static int nb_add_time (char **ret_buffer, /* {{{ */
393 size_t *ret_buffer_len,
394 uint16_t type, double value)
396 /* Convert to collectd's "cdtime" representation. */
397 uint64_t cdtime_value = (uint64_t) (value * 1073741824.0);
398 return (nb_add_number (ret_buffer, ret_buffer_len, type, cdtime_value));
399 } /* }}} int nb_add_time */
401 static int nb_add_string (char **ret_buffer, /* {{{ */
402 size_t *ret_buffer_len,
403 uint16_t type, const char *str, size_t str_len)
413 packet_len = sizeof (pkg_type)
414 + sizeof (pkg_length)
416 if (*ret_buffer_len < packet_len)
419 pkg_type = htons (type);
420 pkg_length = htons ((uint16_t) packet_len);
422 packet_ptr = *ret_buffer;
424 memcpy (packet_ptr + offset, &pkg_type, sizeof (pkg_type));
425 offset += sizeof (pkg_type);
426 memcpy (packet_ptr + offset, &pkg_length, sizeof (pkg_length));
427 offset += sizeof (pkg_length);
428 memcpy (packet_ptr + offset, str, str_len);
430 memset (packet_ptr + offset, 0, 1);
433 assert (offset == packet_len);
435 *ret_buffer = packet_ptr + packet_len;
436 *ret_buffer_len -= packet_len;
438 } /* }}} int nb_add_string */
440 static int nb_add_value_list (lcc_network_buffer_t *nb, /* {{{ */
441 const lcc_value_list_t *vl)
443 char *buffer = nb->ptr;
444 size_t buffer_size = nb->free;
446 const lcc_identifier_t *ident_src;
447 lcc_identifier_t *ident_dst;
449 ident_src = &vl->identifier;
450 ident_dst = &nb->state.identifier;
452 if (strcmp (ident_dst->host, ident_src->host) != 0)
454 if (nb_add_string (&buffer, &buffer_size, TYPE_HOST,
455 ident_src->host, strlen (ident_src->host)) != 0)
457 SSTRNCPY (ident_dst->host, ident_src->host, sizeof (ident_dst->host));
460 if (strcmp (ident_dst->plugin, ident_src->plugin) != 0)
462 if (nb_add_string (&buffer, &buffer_size, TYPE_PLUGIN,
463 ident_src->plugin, strlen (ident_src->plugin)) != 0)
465 SSTRNCPY (ident_dst->plugin, ident_src->plugin,
466 sizeof (ident_dst->plugin));
469 if (strcmp (ident_dst->plugin_instance,
470 ident_src->plugin_instance) != 0)
472 if (nb_add_string (&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE,
473 ident_src->plugin_instance,
474 strlen (ident_src->plugin_instance)) != 0)
476 SSTRNCPY (ident_dst->plugin_instance, ident_src->plugin_instance,
477 sizeof (ident_dst->plugin_instance));
480 if (strcmp (ident_dst->type, ident_src->type) != 0)
482 if (nb_add_string (&buffer, &buffer_size, TYPE_TYPE,
483 ident_src->type, strlen (ident_src->type)) != 0)
485 SSTRNCPY (ident_dst->type, ident_src->type, sizeof (ident_dst->type));
488 if (strcmp (ident_dst->type_instance,
489 ident_src->type_instance) != 0)
491 if (nb_add_string (&buffer, &buffer_size, TYPE_TYPE_INSTANCE,
492 ident_src->type_instance,
493 strlen (ident_src->type_instance)) != 0)
495 SSTRNCPY (ident_dst->type_instance, ident_src->type_instance,
496 sizeof (ident_dst->type_instance));
499 if (nb->state.time != vl->time)
501 if (nb_add_time (&buffer, &buffer_size, TYPE_TIME_HR, vl->time))
503 nb->state.time = vl->time;
506 if (nb->state.interval != vl->interval)
508 if (nb_add_time (&buffer, &buffer_size, TYPE_INTERVAL_HR, vl->interval))
510 nb->state.interval = vl->interval;
513 if (nb_add_values (&buffer, &buffer_size, vl) != 0)
517 nb->free = buffer_size;
519 } /* }}} int nb_add_value_list */
521 /* TODO: Add encryption for Windows */
523 static int nb_add_signature (lcc_network_buffer_t *nb) /* {{{ */
531 const size_t hash_length = 32;
533 /* The type, length and username have already been filled in by
534 * "lcc_network_buffer_initialize". All we do here is calculate the hash over
535 * the username and the data and add the hash value to the buffer. */
537 buffer = nb->buffer + PART_SIGNATURE_SHA256_SIZE;
538 assert (nb->size >= (nb->free + PART_SIGNATURE_SHA256_SIZE));
539 buffer_size = nb->size - (nb->free + PART_SIGNATURE_SHA256_SIZE);
542 err = gcry_md_open (&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
546 assert (nb->password != NULL);
547 err = gcry_md_setkey (hd, nb->password, strlen (nb->password));
554 gcry_md_write (hd, buffer, buffer_size);
555 hash = gcry_md_read (hd, GCRY_MD_SHA256);
562 assert (((2 * sizeof (uint16_t)) + hash_length) == PART_SIGNATURE_SHA256_SIZE);
563 memcpy (nb->buffer + (2 * sizeof (uint16_t)), hash, hash_length);
567 } /* }}} int nb_add_signature */
569 static int nb_add_encryption (lcc_network_buffer_t *nb) /* {{{ */
571 size_t package_length;
572 char *encr_ptr; /* pointer to data being encrypted */
575 char *hash_ptr; /* pointer to data being hashed */
582 /* Fill in the package length */
583 package_length = nb->size - nb->free;
584 pkg_length = htons ((uint16_t) package_length);
585 memcpy (nb->buffer + 2, &pkg_length, sizeof (pkg_length));
587 /* Calculate what to hash */
588 hash_ptr = nb->buffer + PART_ENCRYPTION_AES256_SIZE;
589 hash_size = package_length - nb->encr_header_len;
591 /* Calculate what to encrypt */
592 encr_ptr = hash_ptr - sizeof (hash);
593 encr_size = hash_size + sizeof (hash);
595 /* Calculate the SHA-1 hash */
596 gcry_md_hash_buffer (GCRY_MD_SHA1, hash, hash_ptr, hash_size);
597 memcpy (encr_ptr, hash, sizeof (hash));
599 if (nb->encr_cypher == NULL)
601 unsigned char password_hash[32];
603 err = gcry_cipher_open (&nb->encr_cypher,
604 GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB, /* flags = */ 0);
608 /* Calculate our 256bit key used for AES */
609 gcry_md_hash_buffer (GCRY_MD_SHA256, password_hash,
610 nb->password, strlen (nb->password));
612 err = gcry_cipher_setkey (nb->encr_cypher,
613 password_hash, sizeof (password_hash));
616 gcry_cipher_close (nb->encr_cypher);
617 nb->encr_cypher = NULL;
621 else /* if (nb->encr_cypher != NULL) */
623 gcry_cipher_reset (nb->encr_cypher);
626 /* Set the initialization vector */
627 err = gcry_cipher_setiv (nb->encr_cypher,
628 nb->encr_iv, sizeof (nb->encr_iv));
631 gcry_cipher_close (nb->encr_cypher);
632 nb->encr_cypher = NULL;
636 /* Encrypt the buffer in-place */
637 err = gcry_cipher_encrypt (nb->encr_cypher,
639 /* in = */ NULL, /* in len = */ 0);
642 gcry_cipher_close (nb->encr_cypher);
643 nb->encr_cypher = NULL;
648 } /* }}} int nb_add_encryption */
654 lcc_network_buffer_t *lcc_network_buffer_create (size_t size) /* {{{ */
656 lcc_network_buffer_t *nb;
659 size = LCC_NETWORK_BUFFER_SIZE_DEFAULT;
667 nb = malloc (sizeof (*nb));
670 memset (nb, 0, sizeof (*nb));
673 nb->buffer = malloc (nb->size);
674 if (nb->buffer == NULL)
679 memset (nb->buffer, 0, nb->size);
681 nb->ptr = nb->buffer;
689 } /* }}} lcc_network_buffer_t *lcc_network_buffer_create */
691 void lcc_network_buffer_destroy (lcc_network_buffer_t *nb) /* {{{ */
698 } /* }}} void lcc_network_buffer_destroy */
700 int lcc_network_buffer_set_security_level (lcc_network_buffer_t *nb, /* {{{ */
701 lcc_security_level_t level,
702 const char *username, const char *password)
714 lcc_network_buffer_initialize (nb);
721 username_copy = strdup (username);
722 password_copy = strdup (password);
723 if ((username_copy == NULL) || (password_copy == NULL))
725 free (username_copy);
726 free (password_copy);
732 nb->username = username_copy;
733 nb->password = password_copy;
734 nb->seclevel = level;
736 lcc_network_buffer_initialize (nb);
738 } /* }}} int lcc_network_buffer_set_security_level */
740 int lcc_network_buffer_initialize (lcc_network_buffer_t *nb) /* {{{ */
745 memset (nb->buffer, 0, nb->size);
746 memset (&nb->state, 0, sizeof (nb->state));
747 nb->ptr = nb->buffer;
751 if (nb->seclevel == SIGN)
754 uint16_t pkg_type = htons (TYPE_SIGN_SHA256);
755 uint16_t pkg_length = PART_SIGNATURE_SHA256_SIZE;
757 assert (nb->username != NULL);
758 username_len = strlen (nb->username);
759 pkg_length = htons (pkg_length + ((uint16_t) username_len));
761 /* Fill in everything but the hash value here. */
762 memcpy (nb->ptr, &pkg_type, sizeof (pkg_type));
763 memcpy (nb->ptr + sizeof (pkg_type), &pkg_length, sizeof (pkg_length));
764 nb->ptr += PART_SIGNATURE_SHA256_SIZE;
765 nb->free -= PART_SIGNATURE_SHA256_SIZE;
767 memcpy (nb->ptr, nb->username, username_len);
768 nb->ptr += username_len;
769 nb->free -= username_len;
771 else if (nb->seclevel == ENCRYPT)
773 size_t username_length = strlen (nb->username);
774 uint16_t pkg_type = htons (TYPE_ENCR_AES256);
775 uint16_t pkg_length = 0; /* Filled in in finalize. */
776 uint16_t pkg_user_len = htons ((uint16_t) username_length);
779 nb->encr_header_len = username_length;
780 nb->encr_header_len += PART_ENCRYPTION_AES256_SIZE;
782 gcry_randomize ((void *) &nb->encr_iv, sizeof (nb->encr_iv),
785 /* Filled in in finalize. */
786 memset (hash, 0, sizeof (hash));
788 ADD_STATIC (nb, pkg_type);
789 ADD_STATIC (nb, pkg_length);
790 ADD_STATIC (nb, pkg_user_len);
791 ADD_GENERIC (nb, nb->username, username_length);
792 ADD_GENERIC (nb, nb->encr_iv, sizeof (nb->encr_iv));
793 ADD_GENERIC (nb, hash, sizeof (hash));
794 assert ((nb->encr_header_len + nb->free) == nb->size);
799 } /* }}} int lcc_network_buffer_initialize */
801 int lcc_network_buffer_finalize (lcc_network_buffer_t *nb) /* {{{ */
807 if (nb->seclevel == SIGN)
808 nb_add_signature (nb);
809 else if (nb->seclevel == ENCRYPT)
810 nb_add_encryption (nb);
814 } /* }}} int lcc_network_buffer_finalize */
816 int lcc_network_buffer_add_value (lcc_network_buffer_t *nb, /* {{{ */
817 const lcc_value_list_t *vl)
821 if ((nb == NULL) || (vl == NULL))
824 status = nb_add_value_list (nb, vl);
826 } /* }}} int lcc_network_buffer_add_value */
828 int lcc_network_buffer_get (lcc_network_buffer_t *nb, /* {{{ */
829 void *buffer, size_t *buffer_size)
834 if ((nb == NULL) || (buffer_size == NULL))
837 assert (nb->size >= nb->free);
838 sz_required = nb->size - nb->free;
839 sz_available = *buffer_size;
841 *buffer_size = sz_required;
843 memcpy (buffer, nb->buffer,
844 (sz_available < sz_required) ? sz_available : sz_required);
847 } /* }}} int lcc_network_buffer_get */
849 /* vim: set sw=2 sts=2 et fdm=marker : */