2 * collectd - src/libcollectdclient/network_buffer.c
3 * Copyright (C) 2010-2015 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>
34 #include <arpa/inet.h> /* htons */
39 # if defined __APPLE__
40 /* default xcode compiler throws warnings even when deprecated functionality
41 * is not used. -Werror breaks the build because of erroneous warnings.
42 * http://stackoverflow.com/questions/10556299/compiler-warnings-with-libgcrypt-v1-5-0/12830209#12830209
44 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
46 /* FreeBSD's copy of libgcrypt extends the existing GCRYPT_NO_DEPRECATED
47 * to properly hide all deprecated functionality.
48 * http://svnweb.freebsd.org/ports/head/security/libgcrypt/files/patch-src__gcrypt.h.in
50 # define GCRYPT_NO_DEPRECATED
52 # if defined __APPLE__
53 /* Re enable deprecation warnings */
54 # pragma GCC diagnostic warning "-Wdeprecated-declarations"
56 # if GCRYPT_VERSION_NUMBER < 0x010600
57 GCRY_THREAD_OPTION_PTHREAD_IMPL;
61 #include "collectd/network_buffer.h"
63 #define TYPE_HOST 0x0000
64 #define TYPE_TIME 0x0001
65 #define TYPE_TIME_HR 0x0008
66 #define TYPE_PLUGIN 0x0002
67 #define TYPE_PLUGIN_INSTANCE 0x0003
68 #define TYPE_TYPE 0x0004
69 #define TYPE_TYPE_INSTANCE 0x0005
70 #define TYPE_VALUES 0x0006
71 #define TYPE_INTERVAL 0x0007
72 #define TYPE_INTERVAL_HR 0x0009
74 /* Types to transmit notifications */
75 #define TYPE_MESSAGE 0x0100
76 #define TYPE_SEVERITY 0x0101
78 #define TYPE_SIGN_SHA256 0x0200
79 #define TYPE_ENCR_AES256 0x0210
81 #define PART_SIGNATURE_SHA256_SIZE 36
82 #define PART_ENCRYPTION_AES256_SIZE 42
84 #define ADD_GENERIC(nb,srcptr,size) do { \
85 assert ((size) <= (nb)->free); \
86 memcpy ((nb)->ptr, (srcptr), (size)); \
87 (nb)->ptr += (size); \
88 (nb)->free -= (size); \
91 #define ADD_STATIC(nb,var) \
92 ADD_GENERIC(nb,&(var),sizeof(var));
97 struct lcc_network_buffer_s
102 lcc_value_list_t state;
106 lcc_security_level_t seclevel;
111 gcry_cipher_hd_t encr_cypher;
112 size_t encr_header_len;
117 #define SSTRNCPY(dst,src,sz) do { \
118 strncpy ((dst), (src), (sz)); \
119 (dst)[(sz) - 1] = 0; \
125 static _Bool have_gcrypt (void) /* {{{ */
127 static _Bool result = 0;
128 static _Bool need_init = 1;
135 # if GCRYPT_VERSION_NUMBER < 0x010600
136 if (gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread))
140 if (!gcry_check_version (GCRYPT_VERSION))
143 if (!gcry_control (GCRYCTL_INIT_SECMEM, 32768, 0))
146 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
153 } /* }}} _Bool have_gcrypt */
156 static uint64_t htonll (uint64_t val) /* {{{ */
158 static int config = 0;
166 uint16_t n = htons (h);
177 hi = (uint32_t) (val >> 32);
178 lo = (uint32_t) (val & 0x00000000FFFFFFFF);
183 return ((((uint64_t) lo) << 32) | ((uint64_t) hi));
184 } /* }}} uint64_t htonll */
187 static double htond (double val) /* {{{ */
189 static int config = 0;
191 union { uint8_t byte[8]; double floating; } in;
192 union { uint8_t byte[8]; double floating; } out;
196 double d = 8.642135e130;
201 if ((c[0] == 0x2f) && (c[1] == 0x25)
202 && (c[2] == 0xc0) && (c[3] == 0xc7)
203 && (c[4] == 0x43) && (c[5] == 0x2b)
204 && (c[6] == 0x1f) && (c[7] == 0x5b))
205 config = 1; /* need nothing */
206 else if ((c[7] == 0x2f) && (c[6] == 0x25)
207 && (c[5] == 0xc0) && (c[4] == 0xc7)
208 && (c[3] == 0x43) && (c[2] == 0x2b)
209 && (c[1] == 0x1f) && (c[0] == 0x5b))
210 config = 2; /* endian flip */
211 else if ((c[4] == 0x2f) && (c[5] == 0x25)
212 && (c[6] == 0xc0) && (c[7] == 0xc7)
213 && (c[0] == 0x43) && (c[1] == 0x2b)
214 && (c[2] == 0x1f) && (c[3] == 0x5b))
215 config = 3; /* int swap */
222 out.byte[0] = out.byte[1] = out.byte[2] = out.byte[3] = 0x00;
223 out.byte[4] = out.byte[5] = 0x00;
226 return (out.floating);
228 else if (config == 1)
230 else if (config == 2)
233 out.byte[0] = in.byte[7];
234 out.byte[1] = in.byte[6];
235 out.byte[2] = in.byte[5];
236 out.byte[3] = in.byte[4];
237 out.byte[4] = in.byte[3];
238 out.byte[5] = in.byte[2];
239 out.byte[6] = in.byte[1];
240 out.byte[7] = in.byte[0];
241 return (out.floating);
243 else if (config == 3)
246 out.byte[0] = in.byte[4];
247 out.byte[1] = in.byte[5];
248 out.byte[2] = in.byte[6];
249 out.byte[3] = in.byte[7];
250 out.byte[4] = in.byte[0];
251 out.byte[5] = in.byte[1];
252 out.byte[6] = in.byte[2];
253 out.byte[7] = in.byte[3];
254 return (out.floating);
258 /* If in doubt, just copy the value back to the caller. */
261 } /* }}} double htond */
263 static int nb_add_values (char **ret_buffer, /* {{{ */
264 size_t *ret_buffer_len,
265 const lcc_value_list_t *vl)
272 uint16_t pkg_num_values;
273 uint8_t pkg_values_types[vl->values_len];
274 value_t pkg_values[vl->values_len];
279 packet_len = sizeof (pkg_type) + sizeof (pkg_length)
280 + sizeof (pkg_num_values)
281 + sizeof (pkg_values_types)
282 + sizeof (pkg_values);
284 if (*ret_buffer_len < packet_len)
287 pkg_type = htons (TYPE_VALUES);
288 pkg_length = htons ((uint16_t) packet_len);
289 pkg_num_values = htons ((uint16_t) vl->values_len);
291 for (i = 0; i < vl->values_len; i++)
293 pkg_values_types[i] = (uint8_t) vl->values_types[i];
294 switch (vl->values_types[i])
296 case LCC_TYPE_COUNTER:
297 pkg_values[i].counter = (counter_t) htonll (vl->values[i].counter);
301 pkg_values[i].gauge = (gauge_t) htond (vl->values[i].gauge);
304 case LCC_TYPE_DERIVE:
305 pkg_values[i].derive = (derive_t) htonll (vl->values[i].derive);
308 case LCC_TYPE_ABSOLUTE:
309 pkg_values[i].absolute = (absolute_t) htonll (vl->values[i].absolute);
314 } /* switch (vl->values_types[i]) */
315 } /* for (vl->values_len) */
318 * Use `memcpy' to write everything to the buffer, because the pointer
319 * may be unaligned and some architectures, such as SPARC, can't handle
322 packet_ptr = *ret_buffer;
324 memcpy (packet_ptr + offset, &pkg_type, sizeof (pkg_type));
325 offset += sizeof (pkg_type);
326 memcpy (packet_ptr + offset, &pkg_length, sizeof (pkg_length));
327 offset += sizeof (pkg_length);
328 memcpy (packet_ptr + offset, &pkg_num_values, sizeof (pkg_num_values));
329 offset += sizeof (pkg_num_values);
330 memcpy (packet_ptr + offset, pkg_values_types, sizeof (pkg_values_types));
331 offset += sizeof (pkg_values_types);
332 memcpy (packet_ptr + offset, pkg_values, sizeof (pkg_values));
333 offset += sizeof (pkg_values);
335 assert (offset == packet_len);
337 *ret_buffer = packet_ptr + packet_len;
338 *ret_buffer_len -= packet_len;
340 } /* }}} int nb_add_values */
342 static int nb_add_number (char **ret_buffer, /* {{{ */
343 size_t *ret_buffer_len,
344 uint16_t type, uint64_t value)
355 packet_len = sizeof (pkg_type)
356 + sizeof (pkg_length)
357 + sizeof (pkg_value);
359 if (*ret_buffer_len < packet_len)
362 pkg_type = htons (type);
363 pkg_length = htons ((uint16_t) packet_len);
364 pkg_value = htonll (value);
366 packet_ptr = *ret_buffer;
368 memcpy (packet_ptr + offset, &pkg_type, sizeof (pkg_type));
369 offset += sizeof (pkg_type);
370 memcpy (packet_ptr + offset, &pkg_length, sizeof (pkg_length));
371 offset += sizeof (pkg_length);
372 memcpy (packet_ptr + offset, &pkg_value, sizeof (pkg_value));
373 offset += sizeof (pkg_value);
375 assert (offset == packet_len);
377 *ret_buffer = packet_ptr + packet_len;
378 *ret_buffer_len -= packet_len;
380 } /* }}} int nb_add_number */
382 static int nb_add_time (char **ret_buffer, /* {{{ */
383 size_t *ret_buffer_len,
384 uint16_t type, double value)
386 /* Convert to collectd's "cdtime" representation. */
387 uint64_t cdtime_value = (uint64_t) (value * 1073741824.0);
388 return (nb_add_number (ret_buffer, ret_buffer_len, type, cdtime_value));
389 } /* }}} int nb_add_time */
391 static int nb_add_string (char **ret_buffer, /* {{{ */
392 size_t *ret_buffer_len,
393 uint16_t type, const char *str, size_t str_len)
403 packet_len = sizeof (pkg_type)
404 + sizeof (pkg_length)
406 if (*ret_buffer_len < packet_len)
409 pkg_type = htons (type);
410 pkg_length = htons ((uint16_t) packet_len);
412 packet_ptr = *ret_buffer;
414 memcpy (packet_ptr + offset, &pkg_type, sizeof (pkg_type));
415 offset += sizeof (pkg_type);
416 memcpy (packet_ptr + offset, &pkg_length, sizeof (pkg_length));
417 offset += sizeof (pkg_length);
418 memcpy (packet_ptr + offset, str, str_len);
420 memset (packet_ptr + offset, 0, 1);
423 assert (offset == packet_len);
425 *ret_buffer = packet_ptr + packet_len;
426 *ret_buffer_len -= packet_len;
428 } /* }}} int nb_add_string */
430 static int nb_add_value_list (lcc_network_buffer_t *nb, /* {{{ */
431 const lcc_value_list_t *vl)
433 char *buffer = nb->ptr;
434 size_t buffer_size = nb->free;
436 const lcc_identifier_t *ident_src;
437 lcc_identifier_t *ident_dst;
439 ident_src = &vl->identifier;
440 ident_dst = &nb->state.identifier;
442 if (strcmp (ident_dst->host, ident_src->host) != 0)
444 if (nb_add_string (&buffer, &buffer_size, TYPE_HOST,
445 ident_src->host, strlen (ident_src->host)) != 0)
447 SSTRNCPY (ident_dst->host, ident_src->host, sizeof (ident_dst->host));
450 if (strcmp (ident_dst->plugin, ident_src->plugin) != 0)
452 if (nb_add_string (&buffer, &buffer_size, TYPE_PLUGIN,
453 ident_src->plugin, strlen (ident_src->plugin)) != 0)
455 SSTRNCPY (ident_dst->plugin, ident_src->plugin,
456 sizeof (ident_dst->plugin));
459 if (strcmp (ident_dst->plugin_instance,
460 ident_src->plugin_instance) != 0)
462 if (nb_add_string (&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE,
463 ident_src->plugin_instance,
464 strlen (ident_src->plugin_instance)) != 0)
466 SSTRNCPY (ident_dst->plugin_instance, ident_src->plugin_instance,
467 sizeof (ident_dst->plugin_instance));
470 if (strcmp (ident_dst->type, ident_src->type) != 0)
472 if (nb_add_string (&buffer, &buffer_size, TYPE_TYPE,
473 ident_src->type, strlen (ident_src->type)) != 0)
475 SSTRNCPY (ident_dst->type, ident_src->type, sizeof (ident_dst->type));
478 if (strcmp (ident_dst->type_instance,
479 ident_src->type_instance) != 0)
481 if (nb_add_string (&buffer, &buffer_size, TYPE_TYPE_INSTANCE,
482 ident_src->type_instance,
483 strlen (ident_src->type_instance)) != 0)
485 SSTRNCPY (ident_dst->type_instance, ident_src->type_instance,
486 sizeof (ident_dst->type_instance));
489 if (nb->state.time != vl->time)
491 if (nb_add_time (&buffer, &buffer_size, TYPE_TIME_HR, vl->time))
493 nb->state.time = vl->time;
496 if (nb->state.interval != vl->interval)
498 if (nb_add_time (&buffer, &buffer_size, TYPE_INTERVAL_HR, vl->interval))
500 nb->state.interval = vl->interval;
503 if (nb_add_values (&buffer, &buffer_size, vl) != 0)
507 nb->free = buffer_size;
509 } /* }}} int nb_add_value_list */
512 static int nb_add_signature (lcc_network_buffer_t *nb) /* {{{ */
520 const size_t hash_length = 32;
522 /* The type, length and username have already been filled in by
523 * "lcc_network_buffer_initialize". All we do here is calculate the hash over
524 * the username and the data and add the hash value to the buffer. */
526 buffer = nb->buffer + PART_SIGNATURE_SHA256_SIZE;
527 assert (nb->size >= (nb->free + PART_SIGNATURE_SHA256_SIZE));
528 buffer_size = nb->size - (nb->free + PART_SIGNATURE_SHA256_SIZE);
531 err = gcry_md_open (&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
535 assert (nb->password != NULL);
536 err = gcry_md_setkey (hd, nb->password, strlen (nb->password));
543 gcry_md_write (hd, buffer, buffer_size);
544 hash = gcry_md_read (hd, GCRY_MD_SHA256);
551 assert (((2 * sizeof (uint16_t)) + hash_length) == PART_SIGNATURE_SHA256_SIZE);
552 memcpy (nb->buffer + (2 * sizeof (uint16_t)), hash, hash_length);
556 } /* }}} int nb_add_signature */
558 static int nb_add_encryption (lcc_network_buffer_t *nb) /* {{{ */
560 size_t package_length;
561 char *encr_ptr; /* pointer to data being encrypted */
564 char *hash_ptr; /* pointer to data being hashed */
571 /* Fill in the package length */
572 package_length = nb->size - nb->free;
573 pkg_length = htons ((uint16_t) package_length);
574 memcpy (nb->buffer + 2, &pkg_length, sizeof (pkg_length));
576 /* Calculate what to hash */
577 hash_ptr = nb->buffer + PART_ENCRYPTION_AES256_SIZE;
578 hash_size = package_length - nb->encr_header_len;
580 /* Calculate what to encrypt */
581 encr_ptr = hash_ptr - sizeof (hash);
582 encr_size = hash_size + sizeof (hash);
584 /* Calculate the SHA-1 hash */
585 gcry_md_hash_buffer (GCRY_MD_SHA1, hash, hash_ptr, hash_size);
586 memcpy (encr_ptr, hash, sizeof (hash));
588 if (nb->encr_cypher == NULL)
590 unsigned char password_hash[32];
592 err = gcry_cipher_open (&nb->encr_cypher,
593 GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB, /* flags = */ 0);
597 /* Calculate our 256bit key used for AES */
598 gcry_md_hash_buffer (GCRY_MD_SHA256, password_hash,
599 nb->password, strlen (nb->password));
601 err = gcry_cipher_setkey (nb->encr_cypher,
602 password_hash, sizeof (password_hash));
605 gcry_cipher_close (nb->encr_cypher);
606 nb->encr_cypher = NULL;
610 else /* if (nb->encr_cypher != NULL) */
612 gcry_cipher_reset (nb->encr_cypher);
615 /* Set the initialization vector */
616 err = gcry_cipher_setiv (nb->encr_cypher,
617 nb->encr_iv, sizeof (nb->encr_iv));
620 gcry_cipher_close (nb->encr_cypher);
621 nb->encr_cypher = NULL;
625 /* Encrypt the buffer in-place */
626 err = gcry_cipher_encrypt (nb->encr_cypher,
628 /* in = */ NULL, /* in len = */ 0);
631 gcry_cipher_close (nb->encr_cypher);
632 nb->encr_cypher = NULL;
637 } /* }}} int nb_add_encryption */
643 lcc_network_buffer_t *lcc_network_buffer_create (size_t size) /* {{{ */
645 lcc_network_buffer_t *nb;
648 size = LCC_NETWORK_BUFFER_SIZE_DEFAULT;
656 nb = calloc (1, sizeof (*nb));
661 nb->buffer = calloc (1, nb->size);
662 if (nb->buffer == NULL)
668 nb->ptr = nb->buffer;
676 } /* }}} lcc_network_buffer_t *lcc_network_buffer_create */
678 void lcc_network_buffer_destroy (lcc_network_buffer_t *nb) /* {{{ */
685 } /* }}} void lcc_network_buffer_destroy */
687 int lcc_network_buffer_set_security_level (lcc_network_buffer_t *nb, /* {{{ */
688 lcc_security_level_t level,
689 const char *username, const char *password)
701 lcc_network_buffer_initialize (nb);
708 username_copy = strdup (username);
709 password_copy = strdup (password);
710 if ((username_copy == NULL) || (password_copy == NULL))
712 free (username_copy);
713 free (password_copy);
719 nb->username = username_copy;
720 nb->password = password_copy;
721 nb->seclevel = level;
723 lcc_network_buffer_initialize (nb);
725 } /* }}} int lcc_network_buffer_set_security_level */
727 int lcc_network_buffer_initialize (lcc_network_buffer_t *nb) /* {{{ */
732 memset (nb->buffer, 0, nb->size);
733 memset (&nb->state, 0, sizeof (nb->state));
734 nb->ptr = nb->buffer;
738 if (nb->seclevel == SIGN)
741 uint16_t pkg_type = htons (TYPE_SIGN_SHA256);
742 uint16_t pkg_length = PART_SIGNATURE_SHA256_SIZE;
744 assert (nb->username != NULL);
745 username_len = strlen (nb->username);
746 pkg_length = htons (pkg_length + ((uint16_t) username_len));
748 /* Fill in everything but the hash value here. */
749 memcpy (nb->ptr, &pkg_type, sizeof (pkg_type));
750 memcpy (nb->ptr + sizeof (pkg_type), &pkg_length, sizeof (pkg_length));
751 nb->ptr += PART_SIGNATURE_SHA256_SIZE;
752 nb->free -= PART_SIGNATURE_SHA256_SIZE;
754 memcpy (nb->ptr, nb->username, username_len);
755 nb->ptr += username_len;
756 nb->free -= username_len;
758 else if (nb->seclevel == ENCRYPT)
760 size_t username_length = strlen (nb->username);
761 uint16_t pkg_type = htons (TYPE_ENCR_AES256);
762 uint16_t pkg_length = 0; /* Filled in in finalize. */
763 uint16_t pkg_user_len = htons ((uint16_t) username_length);
764 /* Filled in in finalize. */
765 char hash[20] = { 0 };
767 nb->encr_header_len = username_length;
768 nb->encr_header_len += PART_ENCRYPTION_AES256_SIZE;
770 gcry_randomize ((void *) &nb->encr_iv, sizeof (nb->encr_iv),
773 ADD_STATIC (nb, pkg_type);
774 ADD_STATIC (nb, pkg_length);
775 ADD_STATIC (nb, pkg_user_len);
776 ADD_GENERIC (nb, nb->username, username_length);
777 ADD_GENERIC (nb, nb->encr_iv, sizeof (nb->encr_iv));
778 ADD_GENERIC (nb, hash, sizeof (hash));
779 assert ((nb->encr_header_len + nb->free) == nb->size);
784 } /* }}} int lcc_network_buffer_initialize */
786 int lcc_network_buffer_finalize (lcc_network_buffer_t *nb) /* {{{ */
792 if (nb->seclevel == SIGN)
793 return nb_add_signature (nb);
794 else if (nb->seclevel == ENCRYPT)
795 return nb_add_encryption (nb);
799 } /* }}} int lcc_network_buffer_finalize */
801 int lcc_network_buffer_add_value (lcc_network_buffer_t *nb, /* {{{ */
802 const lcc_value_list_t *vl)
806 if ((nb == NULL) || (vl == NULL))
809 status = nb_add_value_list (nb, vl);
811 } /* }}} int lcc_network_buffer_add_value */
813 int lcc_network_buffer_get (lcc_network_buffer_t *nb, /* {{{ */
814 void *buffer, size_t *buffer_size)
819 if ((nb == NULL) || (buffer_size == NULL))
822 assert (nb->size >= nb->free);
823 sz_required = nb->size - nb->free;
824 sz_available = *buffer_size;
826 *buffer_size = sz_required;
828 memcpy (buffer, nb->buffer,
829 (sz_available < sz_required) ? sz_available : sz_required);
832 } /* }}} int lcc_network_buffer_get */
834 /* vim: set sw=2 sts=2 et fdm=marker : */