2 * Copyright 2017 Florian Forster
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * Florian octo Forster <octo at collectd.org>
28 #if !defined(__GNUC__) || !__GNUC__
29 #define __attribute__(x) /**/
32 #include "collectd/lcc_features.h"
33 #include "collectd/network_parse.h"
39 /* for be{16,64}toh */
42 #elif HAVE_SYS_ENDIAN_H
43 #include <sys/endian.h>
46 #define GCRYPT_NO_DEPRECATED
50 #define DEBUG(...) printf(__VA_ARGS__)
52 #if GCRYPT_VERSION_NUMBER < 0x010600
53 GCRY_THREAD_OPTION_PTHREAD_IMPL;
56 /* forward declaration because parse_sign_sha256()/parse_encrypt_aes256() and
57 * network_parse() need to call each other. */
58 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
59 lcc_network_parse_options_t const *opts);
61 static int init_gcrypt() {
62 /* http://lists.gnupg.org/pipermail/gcrypt-devel/2003-August/000458.html
63 * Because you can't know in a library whether another library has
64 * already initialized the library */
65 if (gcry_control(GCRYCTL_ANY_INITIALIZATION_P))
68 /* http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html
69 * To ensure thread-safety, it's important to set GCRYCTL_SET_THREAD_CBS
70 * *before* initalizing Libgcrypt with gcry_check_version(), which itself must
71 * be called before any other gcry_* function. GCRYCTL_ANY_INITIALIZATION_P
72 * above doesn't count, as it doesn't implicitly initalize Libgcrypt.
74 * tl;dr: keep all these gry_* statements in this exact order please. */
75 #if GCRYPT_VERSION_NUMBER < 0x010600
76 if (gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread)) {
81 gcry_check_version(NULL);
83 if (gcry_control(GCRYCTL_INIT_SECMEM, 32768)) {
87 gcry_control(GCRYCTL_INITIALIZATION_FINISHED);
96 static int buffer_next(buffer_t *b, void *out, size_t n) {
100 memmove(out, b->data, n);
108 static int buffer_uint16(buffer_t *b, uint16_t *out) {
110 if (buffer_next(b, &tmp, sizeof(tmp)) != 0)
117 #define TYPE_HOST 0x0000
118 #define TYPE_TIME 0x0001
119 #define TYPE_TIME_HR 0x0008
120 #define TYPE_PLUGIN 0x0002
121 #define TYPE_PLUGIN_INSTANCE 0x0003
122 #define TYPE_TYPE 0x0004
123 #define TYPE_TYPE_INSTANCE 0x0005
124 #define TYPE_VALUES 0x0006
125 #define TYPE_INTERVAL 0x0007
126 #define TYPE_INTERVAL_HR 0x0009
127 #define TYPE_SIGN_SHA256 0x0200
128 #define TYPE_ENCR_AES256 0x0210
130 static int parse_int(void *payload, size_t payload_size, uint64_t *out) {
133 if (payload_size != sizeof(tmp))
136 memmove(&tmp, payload, sizeof(tmp));
141 static int parse_string(void *payload, size_t payload_size, char *out,
145 if ((payload_size < 1) || (in[payload_size - 1] != 0) ||
146 (payload_size > out_size))
149 strncpy(out, in, out_size);
153 static int parse_identifier(uint16_t type, void *payload, size_t payload_size,
154 lcc_value_list_t *state) {
155 char buf[LCC_NAME_LEN];
157 if (parse_string(payload, payload_size, buf, sizeof(buf)) != 0)
162 memmove(state->identifier.host, buf, LCC_NAME_LEN);
165 memmove(state->identifier.plugin, buf, LCC_NAME_LEN);
167 case TYPE_PLUGIN_INSTANCE:
168 memmove(state->identifier.plugin_instance, buf, LCC_NAME_LEN);
171 memmove(state->identifier.type, buf, LCC_NAME_LEN);
173 case TYPE_TYPE_INSTANCE:
174 memmove(state->identifier.type_instance, buf, LCC_NAME_LEN);
183 static int parse_time(uint16_t type, void *payload, size_t payload_size,
184 lcc_value_list_t *state) {
186 if (parse_int(payload, payload_size, &tmp))
189 double t = (double)tmp;
194 case TYPE_INTERVAL_HR:
195 state->interval = t / 1073741824.0;
201 state->time = t / 1073741824.0;
210 static double ntohd(double val) /* {{{ */
212 static int config = 0;
228 double d = 8.642135e130;
231 memcpy(b, &d, sizeof(b));
233 if ((b[0] == 0x2f) && (b[1] == 0x25) && (b[2] == 0xc0) && (b[3] == 0xc7) &&
234 (b[4] == 0x43) && (b[5] == 0x2b) && (b[6] == 0x1f) && (b[7] == 0x5b))
235 config = 1; /* need nothing */
236 else if ((b[7] == 0x2f) && (b[6] == 0x25) && (b[5] == 0xc0) &&
237 (b[4] == 0xc7) && (b[3] == 0x43) && (b[2] == 0x2b) &&
238 (b[1] == 0x1f) && (b[0] == 0x5b))
239 config = 2; /* endian flip */
240 else if ((b[4] == 0x2f) && (b[5] == 0x25) && (b[6] == 0xc0) &&
241 (b[7] == 0xc7) && (b[0] == 0x43) && (b[1] == 0x2b) &&
242 (b[2] == 0x1f) && (b[3] == 0x5b))
243 config = 3; /* int swap */
248 if (memcmp((char[]){0, 0, 0, 0, 0, 0, 0xf8, 0x7f}, in.byte, 8) == 0) {
250 } else if (config == 1) {
252 } else if (config == 2) {
254 out.byte[0] = in.byte[7];
255 out.byte[1] = in.byte[6];
256 out.byte[2] = in.byte[5];
257 out.byte[3] = in.byte[4];
258 out.byte[4] = in.byte[3];
259 out.byte[5] = in.byte[2];
260 out.byte[6] = in.byte[1];
261 out.byte[7] = in.byte[0];
262 return (out.floating);
263 } else if (config == 3) {
265 out.byte[0] = in.byte[4];
266 out.byte[1] = in.byte[5];
267 out.byte[2] = in.byte[6];
268 out.byte[3] = in.byte[7];
269 out.byte[4] = in.byte[0];
270 out.byte[5] = in.byte[1];
271 out.byte[6] = in.byte[2];
272 out.byte[7] = in.byte[3];
275 /* If in doubt, just copy the value back to the caller. */
278 } /* }}} double ntohd */
280 static int parse_values(void *payload, size_t payload_size,
281 lcc_value_list_t *state) {
282 buffer_t *b = &(buffer_t){
283 .data = payload, .len = payload_size,
287 if (buffer_uint16(b, &n))
290 if (((size_t)n * 9) != b->len)
293 state->values_len = (size_t)n;
294 state->values = calloc(sizeof(*state->values), state->values_len);
295 state->values_types = calloc(sizeof(*state->values_types), state->values_len);
296 if ((state->values == NULL) || (state->values_types == NULL)) {
298 free(state->values_types);
302 for (uint16_t i = 0; i < n; i++) {
304 if (buffer_next(b, &tmp, sizeof(tmp)))
306 state->values_types[i] = (int)tmp;
309 for (uint16_t i = 0; i < n; i++) {
311 if (buffer_next(b, &tmp, sizeof(tmp)))
314 if (state->values_types[i] == LCC_TYPE_GAUGE) {
319 state->values[i].gauge = ntohd(conv.d);
324 switch (state->values_types[i]) {
325 case LCC_TYPE_COUNTER:
326 state->values[i].counter = (counter_t)tmp;
328 case LCC_TYPE_DERIVE:
329 state->values[i].derive = (derive_t)tmp;
331 case LCC_TYPE_ABSOLUTE:
332 state->values[i].absolute = (absolute_t)tmp;
342 static int verify_sha256(void *payload, size_t payload_size,
343 char const *username, char const *password,
344 uint8_t hash_provided[32]) {
345 gcry_md_hd_t hd = NULL;
347 gcry_error_t err = gcry_md_open(&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
352 err = gcry_md_setkey(hd, password, strlen(password));
358 gcry_md_write(hd, username, strlen(username));
359 gcry_md_write(hd, payload, payload_size);
361 unsigned char *hash_calculated = gcry_md_read(hd, GCRY_MD_SHA256);
362 if (!hash_calculated) {
367 int ret = memcmp(hash_provided, hash_calculated, 32);
370 hash_calculated = NULL;
375 static int parse_sign_sha256(void *signature, size_t signature_len,
376 void *payload, size_t payload_size,
377 lcc_network_parse_options_t const *opts) {
378 if (opts->password_lookup == NULL) {
379 /* The sender signed the packet but we can't verify it. Handle it as if it
380 * were unsigned, i.e. security level NONE. */
381 return network_parse(payload, payload_size, NONE, opts);
384 buffer_t *b = &(buffer_t){
385 .data = signature, .len = signature_len,
389 if (buffer_next(b, hash, sizeof(hash)))
392 char username[b->len + 1];
393 memset(username, 0, sizeof(username));
394 if (buffer_next(b, username, sizeof(username) - 1)) {
398 char const *password = opts->password_lookup(username);
400 return network_parse(payload, payload_size, NONE, opts);
402 int status = verify_sha256(payload, payload_size, username, password, hash);
406 return network_parse(payload, payload_size, SIGN, opts);
409 static int decrypt_aes256(buffer_t *b, void *iv, size_t iv_size,
410 char const *password) {
411 gcry_cipher_hd_t cipher = NULL;
413 if (gcry_cipher_open(&cipher, GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB,
417 uint8_t pwhash[32] = {0};
418 gcry_md_hash_buffer(GCRY_MD_SHA256, pwhash, password, strlen(password));
420 fprintf(stderr, "sizeof(iv) = %zu\n", sizeof(iv));
421 if (gcry_cipher_setkey(cipher, pwhash, sizeof(pwhash)) ||
422 gcry_cipher_setiv(cipher, iv, iv_size) ||
423 gcry_cipher_decrypt(cipher, b->data, b->len, /* in = */ NULL,
424 /* in_size = */ 0)) {
425 gcry_cipher_close(cipher);
429 gcry_cipher_close(cipher);
433 static int parse_encrypt_aes256(void *data, size_t data_size,
434 lcc_network_parse_options_t const *opts) {
435 if (opts->password_lookup == NULL) {
436 /* Without a password source it's (hopefully) impossible to decrypt the
441 buffer_t *b = &(buffer_t){
442 .data = data, .len = data_size,
445 uint16_t username_len;
446 if (buffer_uint16(b, &username_len))
448 if ((size_t)username_len > data_size)
450 char username[((size_t)username_len) + 1];
451 memset(username, 0, sizeof(username));
452 if (buffer_next(b, username, (size_t)username_len))
455 char const *password = opts->password_lookup(username);
460 if (buffer_next(b, iv, sizeof(iv)))
463 int status = decrypt_aes256(b, iv, sizeof(iv), password);
467 uint8_t hash_provided[20];
468 if (buffer_next(b, hash_provided, sizeof(hash_provided))) {
472 uint8_t hash_calculated[20];
473 gcry_md_hash_buffer(GCRY_MD_SHA1, hash_calculated, b->data, b->len);
475 if (memcmp(hash_provided, hash_calculated, sizeof(hash_provided)) != 0) {
479 return network_parse(b->data, b->len, ENCRYPT, opts);
482 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
483 lcc_network_parse_options_t const *opts) {
484 buffer_t *b = &(buffer_t){
485 .data = data, .len = data_size,
488 lcc_value_list_t state = {0};
491 uint16_t type = 0, sz = 0;
492 if (buffer_uint16(b, &type) || buffer_uint16(b, &sz)) {
493 DEBUG("lcc_network_parse(): reading type and/or length failed.\n");
497 if ((sz < 5) || (((size_t)sz - 4) > b->len)) {
498 DEBUG("lcc_network_parse(): invalid 'sz' field: sz = %" PRIu16
506 if (buffer_next(b, payload, sizeof(payload)))
512 case TYPE_PLUGIN_INSTANCE:
514 case TYPE_TYPE_INSTANCE: {
515 if (parse_identifier(type, payload, sizeof(payload), &state)) {
516 DEBUG("lcc_network_parse(): parse_identifier failed.\n");
523 case TYPE_INTERVAL_HR:
526 if (parse_time(type, payload, sizeof(payload), &state)) {
527 DEBUG("lcc_network_parse(): parse_time failed.\n");
534 lcc_value_list_t vl = state;
535 if (parse_values(payload, sizeof(payload), &vl)) {
536 DEBUG("lcc_network_parse(): parse_values failed.\n");
542 /* Write metrics if they have the required security level. */
543 if (sl >= opts->security_level)
544 status = opts->writer(&vl);
547 free(vl.values_types);
554 case TYPE_SIGN_SHA256: {
556 parse_sign_sha256(payload, sizeof(payload), b->data, b->len, opts);
558 DEBUG("lcc_network_parse(): parse_sign_sha256() = %d\n", status);
561 /* parse_sign_sha256, if successful, consumes all remaining data. */
567 case TYPE_ENCR_AES256: {
568 int status = parse_encrypt_aes256(payload, sizeof(payload), opts);
570 DEBUG("lcc_network_parse(): parse_encrypt_aes256() = %d\n", status);
577 DEBUG("lcc_network_parse(): ignoring unknown type %" PRIu16 "\n", type);
586 int lcc_network_parse(void *data, size_t data_size,
587 lcc_network_parse_options_t opts) {
588 if (opts.password_lookup) {
590 if ((status = init_gcrypt())) {
595 return network_parse(data, data_size, NONE, &opts);