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>
29 #include <arpa/inet.h> /* htons */
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
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) \
86 assert((size) <= (nb)->free); \
87 memcpy((nb)->ptr, (srcptr), (size)); \
88 (nb)->ptr += (size); \
89 (nb)->free -= (size); \
92 #define ADD_STATIC(nb, var) ADD_GENERIC(nb, &(var), sizeof(var));
97 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) \
118 strncpy((dst), (src), (sz)); \
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;
165 uint16_t n = htons(h);
176 hi = (uint32_t)(val >> 32);
177 lo = (uint32_t)(val & 0x00000000FFFFFFFF);
182 return (((uint64_t)lo) << 32) | ((uint64_t)hi);
183 } /* }}} uint64_t htonll */
186 static double htond(double val) /* {{{ */
188 static int config = 0;
200 double d = 8.642135e130;
205 if ((c[0] == 0x2f) && (c[1] == 0x25) && (c[2] == 0xc0) && (c[3] == 0xc7) &&
206 (c[4] == 0x43) && (c[5] == 0x2b) && (c[6] == 0x1f) && (c[7] == 0x5b))
207 config = 1; /* need nothing */
208 else if ((c[7] == 0x2f) && (c[6] == 0x25) && (c[5] == 0xc0) &&
209 (c[4] == 0xc7) && (c[3] == 0x43) && (c[2] == 0x2b) &&
210 (c[1] == 0x1f) && (c[0] == 0x5b))
211 config = 2; /* endian flip */
212 else if ((c[4] == 0x2f) && (c[5] == 0x25) && (c[6] == 0xc0) &&
213 (c[7] == 0xc7) && (c[0] == 0x43) && (c[1] == 0x2b) &&
214 (c[2] == 0x1f) && (c[3] == 0x5b))
215 config = 3; /* int swap */
221 out.byte[0] = out.byte[1] = out.byte[2] = out.byte[3] = 0x00;
222 out.byte[4] = out.byte[5] = 0x00;
226 } else if (config == 1)
228 else if (config == 2) {
230 out.byte[0] = in.byte[7];
231 out.byte[1] = in.byte[6];
232 out.byte[2] = in.byte[5];
233 out.byte[3] = in.byte[4];
234 out.byte[4] = in.byte[3];
235 out.byte[5] = in.byte[2];
236 out.byte[6] = in.byte[1];
237 out.byte[7] = in.byte[0];
239 } else if (config == 3) {
241 out.byte[0] = in.byte[4];
242 out.byte[1] = in.byte[5];
243 out.byte[2] = in.byte[6];
244 out.byte[3] = in.byte[7];
245 out.byte[4] = in.byte[0];
246 out.byte[5] = in.byte[1];
247 out.byte[6] = in.byte[2];
248 out.byte[7] = in.byte[3];
251 /* If in doubt, just copy the value back to the caller. */
254 } /* }}} double htond */
256 static int nb_add_values(char **ret_buffer, /* {{{ */
257 size_t *ret_buffer_len, const lcc_value_list_t *vl) {
258 if ((vl == NULL) || (vl->values_len < 1)) {
267 uint16_t pkg_num_values;
268 uint8_t pkg_values_types[vl->values_len];
269 value_t pkg_values[vl->values_len];
273 packet_len = sizeof(pkg_type) + sizeof(pkg_length) + sizeof(pkg_num_values) +
274 sizeof(pkg_values_types) + sizeof(pkg_values);
276 if (*ret_buffer_len < packet_len)
279 pkg_type = htons(TYPE_VALUES);
280 pkg_length = htons((uint16_t)packet_len);
281 pkg_num_values = htons((uint16_t)vl->values_len);
283 for (size_t i = 0; i < vl->values_len; i++) {
284 pkg_values_types[i] = (uint8_t)vl->values_types[i];
285 switch (vl->values_types[i]) {
286 case LCC_TYPE_COUNTER:
287 pkg_values[i].counter = (counter_t)htonll(vl->values[i].counter);
291 pkg_values[i].gauge = (gauge_t)htond(vl->values[i].gauge);
294 case LCC_TYPE_DERIVE:
295 pkg_values[i].derive = (derive_t)htonll(vl->values[i].derive);
298 case LCC_TYPE_ABSOLUTE:
299 pkg_values[i].absolute = (absolute_t)htonll(vl->values[i].absolute);
304 } /* switch (vl->values_types[i]) */
305 } /* for (vl->values_len) */
308 * Use `memcpy' to write everything to the buffer, because the pointer
309 * may be unaligned and some architectures, such as SPARC, can't handle
312 packet_ptr = *ret_buffer;
314 memcpy(packet_ptr + offset, &pkg_type, sizeof(pkg_type));
315 offset += sizeof(pkg_type);
316 memcpy(packet_ptr + offset, &pkg_length, sizeof(pkg_length));
317 offset += sizeof(pkg_length);
318 memcpy(packet_ptr + offset, &pkg_num_values, sizeof(pkg_num_values));
319 offset += sizeof(pkg_num_values);
320 memcpy(packet_ptr + offset, pkg_values_types, sizeof(pkg_values_types));
321 offset += sizeof(pkg_values_types);
322 memcpy(packet_ptr + offset, pkg_values, sizeof(pkg_values));
323 offset += sizeof(pkg_values);
325 assert(offset == packet_len);
327 *ret_buffer = packet_ptr + packet_len;
328 *ret_buffer_len -= packet_len;
330 } /* }}} int nb_add_values */
332 static int nb_add_number(char **ret_buffer, /* {{{ */
333 size_t *ret_buffer_len, uint16_t type,
344 packet_len = sizeof(pkg_type) + sizeof(pkg_length) + sizeof(pkg_value);
346 if (*ret_buffer_len < packet_len)
349 pkg_type = htons(type);
350 pkg_length = htons((uint16_t)packet_len);
351 pkg_value = htonll(value);
353 packet_ptr = *ret_buffer;
355 memcpy(packet_ptr + offset, &pkg_type, sizeof(pkg_type));
356 offset += sizeof(pkg_type);
357 memcpy(packet_ptr + offset, &pkg_length, sizeof(pkg_length));
358 offset += sizeof(pkg_length);
359 memcpy(packet_ptr + offset, &pkg_value, sizeof(pkg_value));
360 offset += sizeof(pkg_value);
362 assert(offset == packet_len);
364 *ret_buffer = packet_ptr + packet_len;
365 *ret_buffer_len -= packet_len;
367 } /* }}} int nb_add_number */
369 static int nb_add_time(char **ret_buffer, /* {{{ */
370 size_t *ret_buffer_len, uint16_t type, double value) {
371 /* Convert to collectd's "cdtime" representation. */
372 uint64_t cdtime_value = (uint64_t)(value * 1073741824.0);
373 return nb_add_number(ret_buffer, ret_buffer_len, type, cdtime_value);
374 } /* }}} int nb_add_time */
376 static int nb_add_string(char **ret_buffer, /* {{{ */
377 size_t *ret_buffer_len, uint16_t type, const char *str,
387 packet_len = sizeof(pkg_type) + sizeof(pkg_length) + str_len + 1;
388 if (*ret_buffer_len < packet_len)
391 pkg_type = htons(type);
392 pkg_length = htons((uint16_t)packet_len);
394 packet_ptr = *ret_buffer;
396 memcpy(packet_ptr + offset, &pkg_type, sizeof(pkg_type));
397 offset += sizeof(pkg_type);
398 memcpy(packet_ptr + offset, &pkg_length, sizeof(pkg_length));
399 offset += sizeof(pkg_length);
400 memcpy(packet_ptr + offset, str, str_len);
402 memset(packet_ptr + offset, 0, 1);
405 assert(offset == packet_len);
407 *ret_buffer = packet_ptr + packet_len;
408 *ret_buffer_len -= packet_len;
410 } /* }}} int nb_add_string */
412 static int nb_add_value_list(lcc_network_buffer_t *nb, /* {{{ */
413 const lcc_value_list_t *vl) {
414 char *buffer = nb->ptr;
415 size_t buffer_size = nb->free;
417 const lcc_identifier_t *ident_src;
418 lcc_identifier_t *ident_dst;
420 ident_src = &vl->identifier;
421 ident_dst = &nb->state.identifier;
423 if (strcmp(ident_dst->host, ident_src->host) != 0) {
424 if (nb_add_string(&buffer, &buffer_size, TYPE_HOST, ident_src->host,
425 strlen(ident_src->host)) != 0)
427 SSTRNCPY(ident_dst->host, ident_src->host, sizeof(ident_dst->host));
430 if (strcmp(ident_dst->plugin, ident_src->plugin) != 0) {
431 if (nb_add_string(&buffer, &buffer_size, TYPE_PLUGIN, ident_src->plugin,
432 strlen(ident_src->plugin)) != 0)
434 SSTRNCPY(ident_dst->plugin, ident_src->plugin, sizeof(ident_dst->plugin));
437 if (strcmp(ident_dst->plugin_instance, ident_src->plugin_instance) != 0) {
438 if (nb_add_string(&buffer, &buffer_size, TYPE_PLUGIN_INSTANCE,
439 ident_src->plugin_instance,
440 strlen(ident_src->plugin_instance)) != 0)
442 SSTRNCPY(ident_dst->plugin_instance, ident_src->plugin_instance,
443 sizeof(ident_dst->plugin_instance));
446 if (strcmp(ident_dst->type, ident_src->type) != 0) {
447 if (nb_add_string(&buffer, &buffer_size, TYPE_TYPE, ident_src->type,
448 strlen(ident_src->type)) != 0)
450 SSTRNCPY(ident_dst->type, ident_src->type, sizeof(ident_dst->type));
453 if (strcmp(ident_dst->type_instance, ident_src->type_instance) != 0) {
454 if (nb_add_string(&buffer, &buffer_size, TYPE_TYPE_INSTANCE,
455 ident_src->type_instance,
456 strlen(ident_src->type_instance)) != 0)
458 SSTRNCPY(ident_dst->type_instance, ident_src->type_instance,
459 sizeof(ident_dst->type_instance));
462 if (nb->state.time != vl->time) {
463 if (nb_add_time(&buffer, &buffer_size, TYPE_TIME_HR, vl->time))
465 nb->state.time = vl->time;
468 if (nb->state.interval != vl->interval) {
469 if (nb_add_time(&buffer, &buffer_size, TYPE_INTERVAL_HR, vl->interval))
471 nb->state.interval = vl->interval;
474 if (nb_add_values(&buffer, &buffer_size, vl) != 0)
478 nb->free = buffer_size;
480 } /* }}} int nb_add_value_list */
483 static int nb_add_signature(lcc_network_buffer_t *nb) /* {{{ */
491 const size_t hash_length = 32;
493 /* The type, length and username have already been filled in by
494 * "lcc_network_buffer_initialize". All we do here is calculate the hash over
495 * the username and the data and add the hash value to the buffer. */
497 buffer = nb->buffer + PART_SIGNATURE_SHA256_SIZE;
498 assert(nb->size >= (nb->free + PART_SIGNATURE_SHA256_SIZE));
499 buffer_size = nb->size - (nb->free + PART_SIGNATURE_SHA256_SIZE);
502 err = gcry_md_open(&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
506 assert(nb->password != NULL);
507 err = gcry_md_setkey(hd, nb->password, strlen(nb->password));
513 gcry_md_write(hd, buffer, buffer_size);
514 hash = gcry_md_read(hd, GCRY_MD_SHA256);
520 assert(((2 * sizeof(uint16_t)) + hash_length) == PART_SIGNATURE_SHA256_SIZE);
521 memcpy(nb->buffer + (2 * sizeof(uint16_t)), hash, hash_length);
525 } /* }}} int nb_add_signature */
527 static int nb_add_encryption(lcc_network_buffer_t *nb) /* {{{ */
529 size_t package_length;
530 char *encr_ptr; /* pointer to data being encrypted */
533 char *hash_ptr; /* pointer to data being hashed */
540 /* Fill in the package length */
541 package_length = nb->size - nb->free;
542 pkg_length = htons((uint16_t)package_length);
543 memcpy(nb->buffer + 2, &pkg_length, sizeof(pkg_length));
545 /* Calculate what to hash */
546 hash_ptr = nb->buffer + PART_ENCRYPTION_AES256_SIZE;
547 hash_size = package_length - nb->encr_header_len;
549 /* Calculate what to encrypt */
550 encr_ptr = hash_ptr - sizeof(hash);
551 encr_size = hash_size + sizeof(hash);
553 /* Calculate the SHA-1 hash */
554 gcry_md_hash_buffer(GCRY_MD_SHA1, hash, hash_ptr, hash_size);
555 memcpy(encr_ptr, hash, sizeof(hash));
557 if (nb->encr_cypher == NULL) {
558 unsigned char password_hash[32];
560 err = gcry_cipher_open(&nb->encr_cypher, GCRY_CIPHER_AES256,
561 GCRY_CIPHER_MODE_OFB, /* flags = */ 0);
565 /* Calculate our 256bit key used for AES */
566 gcry_md_hash_buffer(GCRY_MD_SHA256, password_hash, nb->password,
567 strlen(nb->password));
569 err = gcry_cipher_setkey(nb->encr_cypher, password_hash,
570 sizeof(password_hash));
572 gcry_cipher_close(nb->encr_cypher);
573 nb->encr_cypher = NULL;
576 } else /* if (nb->encr_cypher != NULL) */
578 gcry_cipher_reset(nb->encr_cypher);
581 /* Set the initialization vector */
582 err = gcry_cipher_setiv(nb->encr_cypher, nb->encr_iv, sizeof(nb->encr_iv));
584 gcry_cipher_close(nb->encr_cypher);
585 nb->encr_cypher = NULL;
589 /* Encrypt the buffer in-place */
590 err = gcry_cipher_encrypt(nb->encr_cypher, encr_ptr, encr_size,
591 /* in = */ NULL, /* in len = */ 0);
593 gcry_cipher_close(nb->encr_cypher);
594 nb->encr_cypher = NULL;
599 } /* }}} int nb_add_encryption */
605 lcc_network_buffer_t *lcc_network_buffer_create(size_t size) /* {{{ */
607 lcc_network_buffer_t *nb;
610 size = LCC_NETWORK_BUFFER_SIZE_DEFAULT;
617 nb = calloc(1, sizeof(*nb));
622 nb->buffer = calloc(1, nb->size);
623 if (nb->buffer == NULL) {
628 nb->ptr = nb->buffer;
636 } /* }}} lcc_network_buffer_t *lcc_network_buffer_create */
638 void lcc_network_buffer_destroy(lcc_network_buffer_t *nb) /* {{{ */
645 } /* }}} void lcc_network_buffer_destroy */
647 int lcc_network_buffer_set_security_level(lcc_network_buffer_t *nb, /* {{{ */
648 lcc_security_level_t level,
649 const char *username,
650 const char *password) {
660 lcc_network_buffer_initialize(nb);
667 username_copy = strdup(username);
668 password_copy = strdup(password);
669 if ((username_copy == NULL) || (password_copy == NULL)) {
677 nb->username = username_copy;
678 nb->password = password_copy;
679 nb->seclevel = level;
681 lcc_network_buffer_initialize(nb);
683 } /* }}} int lcc_network_buffer_set_security_level */
685 int lcc_network_buffer_initialize(lcc_network_buffer_t *nb) /* {{{ */
690 memset(nb->buffer, 0, nb->size);
691 memset(&nb->state, 0, sizeof(nb->state));
692 nb->ptr = nb->buffer;
696 if (nb->seclevel == SIGN) {
698 uint16_t pkg_type = htons(TYPE_SIGN_SHA256);
699 uint16_t pkg_length = PART_SIGNATURE_SHA256_SIZE;
701 assert(nb->username != NULL);
702 username_len = strlen(nb->username);
703 pkg_length = htons(pkg_length + ((uint16_t)username_len));
705 /* Fill in everything but the hash value here. */
706 memcpy(nb->ptr, &pkg_type, sizeof(pkg_type));
707 memcpy(nb->ptr + sizeof(pkg_type), &pkg_length, sizeof(pkg_length));
708 nb->ptr += PART_SIGNATURE_SHA256_SIZE;
709 nb->free -= PART_SIGNATURE_SHA256_SIZE;
711 memcpy(nb->ptr, nb->username, username_len);
712 nb->ptr += username_len;
713 nb->free -= username_len;
714 } else if (nb->seclevel == ENCRYPT) {
715 size_t username_length = strlen(nb->username);
716 uint16_t pkg_type = htons(TYPE_ENCR_AES256);
717 uint16_t pkg_length = 0; /* Filled in in finalize. */
718 uint16_t pkg_user_len = htons((uint16_t)username_length);
719 /* Filled in in finalize. */
722 nb->encr_header_len = username_length;
723 nb->encr_header_len += PART_ENCRYPTION_AES256_SIZE;
725 gcry_randomize((void *)&nb->encr_iv, sizeof(nb->encr_iv),
728 ADD_STATIC(nb, pkg_type);
729 ADD_STATIC(nb, pkg_length);
730 ADD_STATIC(nb, pkg_user_len);
731 ADD_GENERIC(nb, nb->username, username_length);
732 ADD_GENERIC(nb, nb->encr_iv, sizeof(nb->encr_iv));
733 ADD_GENERIC(nb, hash, sizeof(hash));
734 assert((nb->encr_header_len + nb->free) == nb->size);
739 } /* }}} int lcc_network_buffer_initialize */
741 int lcc_network_buffer_finalize(lcc_network_buffer_t *nb) /* {{{ */
747 if (nb->seclevel == SIGN)
748 return nb_add_signature(nb);
749 else if (nb->seclevel == ENCRYPT)
750 return nb_add_encryption(nb);
754 } /* }}} int lcc_network_buffer_finalize */
756 int lcc_network_buffer_add_value(lcc_network_buffer_t *nb, /* {{{ */
757 const lcc_value_list_t *vl) {
760 if ((nb == NULL) || (vl == NULL))
763 status = nb_add_value_list(nb, vl);
765 } /* }}} int lcc_network_buffer_add_value */
767 int lcc_network_buffer_get(lcc_network_buffer_t *nb, /* {{{ */
768 void *buffer, size_t *buffer_size) {
772 if ((nb == NULL) || (buffer_size == NULL))
775 assert(nb->size >= nb->free);
776 sz_required = nb->size - nb->free;
777 sz_available = *buffer_size;
779 *buffer_size = sz_required;
781 memcpy(buffer, nb->buffer,
782 (sz_available < sz_required) ? sz_available : sz_required);
785 } /* }}} int lcc_network_buffer_get */