2 * collectd - src/libcollectdclient/network_buffer.c
3 * Copyright (C) 2010-2012 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 */
40 # if defined __APPLE__
41 /* default xcode compiler throws warnings even when deprecated functionality
42 * is not used. -Werror breaks the build because of erroneous warnings.
43 * http://stackoverflow.com/questions/10556299/compiler-warnings-with-libgcrypt-v1-5-0/12830209#12830209
45 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
47 /* FreeBSD's copy of libgcrypt extends the existing GCRYPT_NO_DEPRECATED
48 * to properly hide all deprecated functionality.
49 * http://svnweb.freebsd.org/ports/head/security/libgcrypt/files/patch-src__gcrypt.h.in
51 # define GCRYPT_NO_DEPRECATED
53 # if defined __APPLE__
54 /* Re enable deprecation warnings */
55 # pragma GCC diagnostic warning "-Wdeprecated-declarations"
57 GCRY_THREAD_OPTION_PTHREAD_IMPL;
60 #include "collectd/network_buffer.h"
62 #define TYPE_HOST 0x0000
63 #define TYPE_TIME 0x0001
64 #define TYPE_TIME_HR 0x0008
65 #define TYPE_PLUGIN 0x0002
66 #define TYPE_PLUGIN_INSTANCE 0x0003
67 #define TYPE_TYPE 0x0004
68 #define TYPE_TYPE_INSTANCE 0x0005
69 #define TYPE_VALUES 0x0006
70 #define TYPE_INTERVAL 0x0007
71 #define TYPE_INTERVAL_HR 0x0009
73 /* Types to transmit notifications */
74 #define TYPE_MESSAGE 0x0100
75 #define TYPE_SEVERITY 0x0101
77 #define TYPE_SIGN_SHA256 0x0200
78 #define TYPE_ENCR_AES256 0x0210
80 #define PART_SIGNATURE_SHA256_SIZE 36
81 #define PART_ENCRYPTION_AES256_SIZE 42
83 #define ADD_GENERIC(nb,srcptr,size) do { \
84 assert ((size) <= (nb)->free); \
85 memcpy ((nb)->ptr, (srcptr), (size)); \
86 (nb)->ptr += (size); \
87 (nb)->free -= (size); \
90 #define ADD_STATIC(nb,var) \
91 ADD_GENERIC(nb,&(var),sizeof(var));
96 struct lcc_network_buffer_s
101 lcc_value_list_t state;
105 lcc_security_level_t seclevel;
110 gcry_cipher_hd_t encr_cypher;
111 size_t encr_header_len;
116 #define SSTRNCPY(dst,src,sz) do { \
117 strncpy ((dst), (src), (sz)); \
118 (dst)[(sz) - 1] = 0; \
124 static _Bool have_gcrypt (void) /* {{{ */
126 static _Bool result = 0;
127 static _Bool need_init = 1;
134 gcry_control (GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
136 if (!gcry_check_version (GCRYPT_VERSION))
139 gcry_control (GCRYCTL_INIT_SECMEM, 32768, 0);
140 gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
147 } /* }}} _Bool have_gcrypt */
150 static uint64_t htonll (uint64_t val) /* {{{ */
152 static int config = 0;
160 uint16_t n = htons (h);
171 hi = (uint32_t) (val >> 32);
172 lo = (uint32_t) (val & 0x00000000FFFFFFFF);
177 return ((((uint64_t) lo) << 32) | ((uint64_t) hi));
178 } /* }}} uint64_t htonll */
181 static double htond (double val) /* {{{ */
183 static int config = 0;
185 union { uint8_t byte[8]; double floating; } in;
186 union { uint8_t byte[8]; double floating; } out;
190 double d = 8.642135e130;
195 if ((c[0] == 0x2f) && (c[1] == 0x25)
196 && (c[2] == 0xc0) && (c[3] == 0xc7)
197 && (c[4] == 0x43) && (c[5] == 0x2b)
198 && (c[6] == 0x1f) && (c[7] == 0x5b))
199 config = 1; /* need nothing */
200 else if ((c[7] == 0x2f) && (c[6] == 0x25)
201 && (c[5] == 0xc0) && (c[4] == 0xc7)
202 && (c[3] == 0x43) && (c[2] == 0x2b)
203 && (c[1] == 0x1f) && (c[0] == 0x5b))
204 config = 2; /* endian flip */
205 else if ((c[4] == 0x2f) && (c[5] == 0x25)
206 && (c[6] == 0xc0) && (c[7] == 0xc7)
207 && (c[0] == 0x43) && (c[1] == 0x2b)
208 && (c[2] == 0x1f) && (c[3] == 0x5b))
209 config = 3; /* int swap */
216 out.byte[0] = out.byte[1] = out.byte[2] = out.byte[3] = 0x00;
217 out.byte[4] = out.byte[5] = 0x00;
220 return (out.floating);
222 else if (config == 1)
224 else if (config == 2)
227 out.byte[0] = in.byte[7];
228 out.byte[1] = in.byte[6];
229 out.byte[2] = in.byte[5];
230 out.byte[3] = in.byte[4];
231 out.byte[4] = in.byte[3];
232 out.byte[5] = in.byte[2];
233 out.byte[6] = in.byte[1];
234 out.byte[7] = in.byte[0];
235 return (out.floating);
237 else if (config == 3)
240 out.byte[0] = in.byte[4];
241 out.byte[1] = in.byte[5];
242 out.byte[2] = in.byte[6];
243 out.byte[3] = in.byte[7];
244 out.byte[4] = in.byte[0];
245 out.byte[5] = in.byte[1];
246 out.byte[6] = in.byte[2];
247 out.byte[7] = in.byte[3];
248 return (out.floating);
252 /* If in doubt, just copy the value back to the caller. */
255 } /* }}} double htond */
257 static int nb_add_values (char **ret_buffer, /* {{{ */
258 size_t *ret_buffer_len,
259 const lcc_value_list_t *vl)
266 uint16_t pkg_num_values;
267 uint8_t pkg_values_types[vl->values_len];
268 value_t pkg_values[vl->values_len];
273 packet_len = sizeof (pkg_type) + sizeof (pkg_length)
274 + sizeof (pkg_num_values)
275 + sizeof (pkg_values_types)
276 + sizeof (pkg_values);
278 if (*ret_buffer_len < packet_len)
281 pkg_type = htons (TYPE_VALUES);
282 pkg_length = htons ((uint16_t) packet_len);
283 pkg_num_values = htons ((uint16_t) vl->values_len);
285 for (i = 0; i < vl->values_len; i++)
287 pkg_values_types[i] = (uint8_t) vl->values_types[i];
288 switch (vl->values_types[i])
290 case LCC_TYPE_COUNTER:
291 pkg_values[i].counter = (counter_t) htonll (vl->values[i].counter);
295 pkg_values[i].gauge = (gauge_t) htond (vl->values[i].gauge);
298 case LCC_TYPE_DERIVE:
299 pkg_values[i].derive = (derive_t) htonll (vl->values[i].derive);
302 case LCC_TYPE_ABSOLUTE:
303 pkg_values[i].absolute = (absolute_t) htonll (vl->values[i].absolute);
308 } /* switch (vl->values_types[i]) */
309 } /* for (vl->values_len) */
312 * Use `memcpy' to write everything to the buffer, because the pointer
313 * may be unaligned and some architectures, such as SPARC, can't handle
316 packet_ptr = *ret_buffer;
318 memcpy (packet_ptr + offset, &pkg_type, sizeof (pkg_type));
319 offset += sizeof (pkg_type);
320 memcpy (packet_ptr + offset, &pkg_length, sizeof (pkg_length));
321 offset += sizeof (pkg_length);
322 memcpy (packet_ptr + offset, &pkg_num_values, sizeof (pkg_num_values));
323 offset += sizeof (pkg_num_values);
324 memcpy (packet_ptr + offset, pkg_values_types, sizeof (pkg_values_types));
325 offset += sizeof (pkg_values_types);
326 memcpy (packet_ptr + offset, pkg_values, sizeof (pkg_values));
327 offset += sizeof (pkg_values);
329 assert (offset == packet_len);
331 *ret_buffer = packet_ptr + packet_len;
332 *ret_buffer_len -= packet_len;
334 } /* }}} int nb_add_values */
336 static int nb_add_number (char **ret_buffer, /* {{{ */
337 size_t *ret_buffer_len,
338 uint16_t type, uint64_t value)
349 packet_len = sizeof (pkg_type)
350 + sizeof (pkg_length)
351 + sizeof (pkg_value);
353 if (*ret_buffer_len < packet_len)
356 pkg_type = htons (type);
357 pkg_length = htons ((uint16_t) packet_len);
358 pkg_value = htonll (value);
360 packet_ptr = *ret_buffer;
362 memcpy (packet_ptr + offset, &pkg_type, sizeof (pkg_type));
363 offset += sizeof (pkg_type);
364 memcpy (packet_ptr + offset, &pkg_length, sizeof (pkg_length));
365 offset += sizeof (pkg_length);
366 memcpy (packet_ptr + offset, &pkg_value, sizeof (pkg_value));
367 offset += sizeof (pkg_value);
369 assert (offset == packet_len);
371 *ret_buffer = packet_ptr + packet_len;
372 *ret_buffer_len -= packet_len;
374 } /* }}} int nb_add_number */
376 static int nb_add_time (char **ret_buffer, /* {{{ */
377 size_t *ret_buffer_len,
378 uint16_t type, double value)
380 /* Convert to collectd's "cdtime" representation. */
381 uint64_t cdtime_value = (uint64_t) (value * 1073741824.0);
382 return (nb_add_number (ret_buffer, ret_buffer_len, type, cdtime_value));
383 } /* }}} int nb_add_time */
385 static int nb_add_string (char **ret_buffer, /* {{{ */
386 size_t *ret_buffer_len,
387 uint16_t type, const char *str, size_t str_len)
397 packet_len = sizeof (pkg_type)
398 + sizeof (pkg_length)
400 if (*ret_buffer_len < packet_len)
403 pkg_type = htons (type);
404 pkg_length = htons ((uint16_t) packet_len);
406 packet_ptr = *ret_buffer;
408 memcpy (packet_ptr + offset, &pkg_type, sizeof (pkg_type));
409 offset += sizeof (pkg_type);
410 memcpy (packet_ptr + offset, &pkg_length, sizeof (pkg_length));
411 offset += sizeof (pkg_length);
412 memcpy (packet_ptr + offset, str, str_len);
414 memset (packet_ptr + offset, 0, 1);
417 assert (offset == packet_len);
419 *ret_buffer = packet_ptr + packet_len;
420 *ret_buffer_len -= packet_len;
422 } /* }}} int nb_add_string */
424 static int nb_add_value_list (lcc_network_buffer_t *nb, /* {{{ */
425 const lcc_value_list_t *vl)
427 char *buffer = nb->ptr;
428 size_t buffer_size = nb->free;
430 const lcc_identifier_t *ident_src;
431 lcc_identifier_t *ident_dst;
433 ident_src = &vl->identifier;
434 ident_dst = &nb->state.identifier;
436 if (strcmp (ident_dst->host, ident_src->host) != 0)
438 if (nb_add_string (&buffer, &buffer_size, TYPE_HOST,
439 ident_src->host, strlen (ident_src->host)) != 0)
441 SSTRNCPY (ident_dst->host, ident_src->host, sizeof (ident_dst->host));
444 if (strcmp (ident_dst->plugin, ident_src->plugin) != 0)
446 if (nb_add_string (&buffer, &buffer_size, TYPE_PLUGIN,
447 ident_src->plugin, strlen (ident_src->plugin)) != 0)
449 SSTRNCPY (ident_dst->plugin, ident_src->plugin,
450 sizeof (ident_dst->plugin));
453 if (strcmp (ident_dst->plugin_instance,
454 ident_src->plugin_instance) != 0)
456 if (nb_add_string (&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE,
457 ident_src->plugin_instance,
458 strlen (ident_src->plugin_instance)) != 0)
460 SSTRNCPY (ident_dst->plugin_instance, ident_src->plugin_instance,
461 sizeof (ident_dst->plugin_instance));
464 if (strcmp (ident_dst->type, ident_src->type) != 0)
466 if (nb_add_string (&buffer, &buffer_size, TYPE_TYPE,
467 ident_src->type, strlen (ident_src->type)) != 0)
469 SSTRNCPY (ident_dst->type, ident_src->type, sizeof (ident_dst->type));
472 if (strcmp (ident_dst->type_instance,
473 ident_src->type_instance) != 0)
475 if (nb_add_string (&buffer, &buffer_size, TYPE_TYPE_INSTANCE,
476 ident_src->type_instance,
477 strlen (ident_src->type_instance)) != 0)
479 SSTRNCPY (ident_dst->type_instance, ident_src->type_instance,
480 sizeof (ident_dst->type_instance));
483 if (nb->state.time != vl->time)
485 if (nb_add_time (&buffer, &buffer_size, TYPE_TIME_HR, vl->time))
487 nb->state.time = vl->time;
490 if (nb->state.interval != vl->interval)
492 if (nb_add_time (&buffer, &buffer_size, TYPE_INTERVAL_HR, vl->interval))
494 nb->state.interval = vl->interval;
497 if (nb_add_values (&buffer, &buffer_size, vl) != 0)
501 nb->free = buffer_size;
503 } /* }}} int nb_add_value_list */
506 static int nb_add_signature (lcc_network_buffer_t *nb) /* {{{ */
514 const size_t hash_length = 32;
516 /* The type, length and username have already been filled in by
517 * "lcc_network_buffer_initialize". All we do here is calculate the hash over
518 * the username and the data and add the hash value to the buffer. */
520 buffer = nb->buffer + PART_SIGNATURE_SHA256_SIZE;
521 assert (nb->size >= (nb->free + PART_SIGNATURE_SHA256_SIZE));
522 buffer_size = nb->size - (nb->free + PART_SIGNATURE_SHA256_SIZE);
525 err = gcry_md_open (&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
529 assert (nb->password != NULL);
530 err = gcry_md_setkey (hd, nb->password, strlen (nb->password));
537 gcry_md_write (hd, buffer, buffer_size);
538 hash = gcry_md_read (hd, GCRY_MD_SHA256);
545 assert (((2 * sizeof (uint16_t)) + hash_length) == PART_SIGNATURE_SHA256_SIZE);
546 memcpy (nb->buffer + (2 * sizeof (uint16_t)), hash, hash_length);
550 } /* }}} int nb_add_signature */
552 static int nb_add_encryption (lcc_network_buffer_t *nb) /* {{{ */
554 size_t package_length;
555 char *encr_ptr; /* pointer to data being encrypted */
558 char *hash_ptr; /* pointer to data being hashed */
565 /* Fill in the package length */
566 package_length = nb->size - nb->free;
567 pkg_length = htons ((uint16_t) package_length);
568 memcpy (nb->buffer + 2, &pkg_length, sizeof (pkg_length));
570 /* Calculate what to hash */
571 hash_ptr = nb->buffer + PART_ENCRYPTION_AES256_SIZE;
572 hash_size = package_length - nb->encr_header_len;
574 /* Calculate what to encrypt */
575 encr_ptr = hash_ptr - sizeof (hash);
576 encr_size = hash_size + sizeof (hash);
578 /* Calculate the SHA-1 hash */
579 gcry_md_hash_buffer (GCRY_MD_SHA1, hash, hash_ptr, hash_size);
580 memcpy (encr_ptr, hash, sizeof (hash));
582 if (nb->encr_cypher == NULL)
584 unsigned char password_hash[32];
586 err = gcry_cipher_open (&nb->encr_cypher,
587 GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB, /* flags = */ 0);
591 /* Calculate our 256bit key used for AES */
592 gcry_md_hash_buffer (GCRY_MD_SHA256, password_hash,
593 nb->password, strlen (nb->password));
595 err = gcry_cipher_setkey (nb->encr_cypher,
596 password_hash, sizeof (password_hash));
599 gcry_cipher_close (nb->encr_cypher);
600 nb->encr_cypher = NULL;
604 else /* if (nb->encr_cypher != NULL) */
606 gcry_cipher_reset (nb->encr_cypher);
609 /* Set the initialization vector */
610 err = gcry_cipher_setiv (nb->encr_cypher,
611 nb->encr_iv, sizeof (nb->encr_iv));
614 gcry_cipher_close (nb->encr_cypher);
615 nb->encr_cypher = NULL;
619 /* Encrypt the buffer in-place */
620 err = gcry_cipher_encrypt (nb->encr_cypher,
622 /* in = */ NULL, /* in len = */ 0);
625 gcry_cipher_close (nb->encr_cypher);
626 nb->encr_cypher = NULL;
631 } /* }}} int nb_add_encryption */
637 lcc_network_buffer_t *lcc_network_buffer_create (size_t size) /* {{{ */
639 lcc_network_buffer_t *nb;
642 size = LCC_NETWORK_BUFFER_SIZE_DEFAULT;
650 nb = malloc (sizeof (*nb));
653 memset (nb, 0, sizeof (*nb));
656 nb->buffer = malloc (nb->size);
657 if (nb->buffer == NULL)
662 memset (nb->buffer, 0, nb->size);
664 nb->ptr = nb->buffer;
672 } /* }}} lcc_network_buffer_t *lcc_network_buffer_create */
674 void lcc_network_buffer_destroy (lcc_network_buffer_t *nb) /* {{{ */
681 } /* }}} void lcc_network_buffer_destroy */
683 int lcc_network_buffer_set_security_level (lcc_network_buffer_t *nb, /* {{{ */
684 lcc_security_level_t level,
685 const char *username, const char *password)
697 lcc_network_buffer_initialize (nb);
704 username_copy = strdup (username);
705 password_copy = strdup (password);
706 if ((username_copy == NULL) || (password_copy == NULL))
708 free (username_copy);
709 free (password_copy);
715 nb->username = username_copy;
716 nb->password = password_copy;
717 nb->seclevel = level;
719 lcc_network_buffer_initialize (nb);
721 } /* }}} int lcc_network_buffer_set_security_level */
723 int lcc_network_buffer_initialize (lcc_network_buffer_t *nb) /* {{{ */
728 memset (nb->buffer, 0, nb->size);
729 memset (&nb->state, 0, sizeof (nb->state));
730 nb->ptr = nb->buffer;
734 if (nb->seclevel == SIGN)
737 uint16_t pkg_type = htons (TYPE_SIGN_SHA256);
738 uint16_t pkg_length = PART_SIGNATURE_SHA256_SIZE;
740 assert (nb->username != NULL);
741 username_len = strlen (nb->username);
742 pkg_length = htons (pkg_length + ((uint16_t) username_len));
744 /* Fill in everything but the hash value here. */
745 memcpy (nb->ptr, &pkg_type, sizeof (pkg_type));
746 memcpy (nb->ptr + sizeof (pkg_type), &pkg_length, sizeof (pkg_length));
747 nb->ptr += PART_SIGNATURE_SHA256_SIZE;
748 nb->free -= PART_SIGNATURE_SHA256_SIZE;
750 memcpy (nb->ptr, nb->username, username_len);
751 nb->ptr += username_len;
752 nb->free -= username_len;
754 else if (nb->seclevel == ENCRYPT)
756 size_t username_length = strlen (nb->username);
757 uint16_t pkg_type = htons (TYPE_ENCR_AES256);
758 uint16_t pkg_length = 0; /* Filled in in finalize. */
759 uint16_t pkg_user_len = htons ((uint16_t) username_length);
762 nb->encr_header_len = username_length;
763 nb->encr_header_len += PART_ENCRYPTION_AES256_SIZE;
765 gcry_randomize ((void *) &nb->encr_iv, sizeof (nb->encr_iv),
768 /* Filled in in finalize. */
769 memset (hash, 0, sizeof (hash));
771 ADD_STATIC (nb, pkg_type);
772 ADD_STATIC (nb, pkg_length);
773 ADD_STATIC (nb, pkg_user_len);
774 ADD_GENERIC (nb, nb->username, username_length);
775 ADD_GENERIC (nb, nb->encr_iv, sizeof (nb->encr_iv));
776 ADD_GENERIC (nb, hash, sizeof (hash));
777 assert ((nb->encr_header_len + nb->free) == nb->size);
782 } /* }}} int lcc_network_buffer_initialize */
784 int lcc_network_buffer_finalize (lcc_network_buffer_t *nb) /* {{{ */
790 if (nb->seclevel == SIGN)
791 nb_add_signature (nb);
792 else if (nb->seclevel == ENCRYPT)
793 nb_add_encryption (nb);
797 } /* }}} int lcc_network_buffer_finalize */
799 int lcc_network_buffer_add_value (lcc_network_buffer_t *nb, /* {{{ */
800 const lcc_value_list_t *vl)
804 if ((nb == NULL) || (vl == NULL))
807 status = nb_add_value_list (nb, vl);
809 } /* }}} int lcc_network_buffer_add_value */
811 int lcc_network_buffer_get (lcc_network_buffer_t *nb, /* {{{ */
812 void *buffer, size_t *buffer_size)
817 if ((nb == NULL) || (buffer_size == NULL))
820 assert (nb->size >= nb->free);
821 sz_required = nb->size - nb->free;
822 sz_available = *buffer_size;
824 *buffer_size = sz_required;
826 memcpy (buffer, nb->buffer,
827 (sz_available < sz_required) ? sz_available : sz_required);
830 } /* }}} int lcc_network_buffer_get */
832 /* vim: set sw=2 sts=2 et fdm=marker : */