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"
42 /* for be{16,64}toh */
45 #elif HAVE_SYS_ENDIAN_H
46 #include <sys/endian.h>
50 #define GCRYPT_NO_DEPRECATED
55 #define DEBUG(...) printf(__VA_ARGS__)
58 #if GCRYPT_VERSION_NUMBER < 0x010600
59 GCRY_THREAD_OPTION_PTHREAD_IMPL;
63 /* forward declaration because parse_sign_sha256()/parse_encrypt_aes256() and
64 * network_parse() need to call each other. */
65 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
66 lcc_network_parse_options_t const *opts);
69 static int init_gcrypt() {
70 /* http://lists.gnupg.org/pipermail/gcrypt-devel/2003-August/000458.html
71 * Because you can't know in a library whether another library has
72 * already initialized the library */
73 if (gcry_control(GCRYCTL_ANY_INITIALIZATION_P))
76 /* http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html
77 * To ensure thread-safety, it's important to set GCRYCTL_SET_THREAD_CBS
78 * *before* initalizing Libgcrypt with gcry_check_version(), which itself must
79 * be called before any other gcry_* function. GCRYCTL_ANY_INITIALIZATION_P
80 * above doesn't count, as it doesn't implicitly initalize Libgcrypt.
82 * tl;dr: keep all these gry_* statements in this exact order please. */
83 #if GCRYPT_VERSION_NUMBER < 0x010600
84 if (gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread)) {
89 gcry_check_version(NULL);
91 if (gcry_control(GCRYCTL_INIT_SECMEM, 32768)) {
95 gcry_control(GCRYCTL_INITIALIZATION_FINISHED);
105 static int buffer_next(buffer_t *b, void *out, size_t n) {
109 memmove(out, b->data, n);
117 static int buffer_uint16(buffer_t *b, uint16_t *out) {
119 if (buffer_next(b, &tmp, sizeof(tmp)) != 0)
126 #define TYPE_HOST 0x0000
127 #define TYPE_TIME 0x0001
128 #define TYPE_TIME_HR 0x0008
129 #define TYPE_PLUGIN 0x0002
130 #define TYPE_PLUGIN_INSTANCE 0x0003
131 #define TYPE_TYPE 0x0004
132 #define TYPE_TYPE_INSTANCE 0x0005
133 #define TYPE_VALUES 0x0006
134 #define TYPE_INTERVAL 0x0007
135 #define TYPE_INTERVAL_HR 0x0009
136 #define TYPE_SIGN_SHA256 0x0200
137 #define TYPE_ENCR_AES256 0x0210
139 static int parse_int(void *payload, size_t payload_size, uint64_t *out) {
142 if (payload_size != sizeof(tmp))
145 memmove(&tmp, payload, sizeof(tmp));
150 static int parse_string(void *payload, size_t payload_size, char *out,
154 if ((payload_size < 1) || (in[payload_size - 1] != 0) ||
155 (payload_size > out_size))
158 strncpy(out, in, out_size);
162 static int parse_identifier(uint16_t type, void *payload, size_t payload_size,
163 lcc_value_list_t *state) {
164 char buf[LCC_NAME_LEN];
166 if (parse_string(payload, payload_size, buf, sizeof(buf)) != 0)
171 memmove(state->identifier.host, buf, LCC_NAME_LEN);
174 memmove(state->identifier.plugin, buf, LCC_NAME_LEN);
176 case TYPE_PLUGIN_INSTANCE:
177 memmove(state->identifier.plugin_instance, buf, LCC_NAME_LEN);
180 memmove(state->identifier.type, buf, LCC_NAME_LEN);
182 case TYPE_TYPE_INSTANCE:
183 memmove(state->identifier.type_instance, buf, LCC_NAME_LEN);
192 static int parse_time(uint16_t type, void *payload, size_t payload_size,
193 lcc_value_list_t *state) {
195 if (parse_int(payload, payload_size, &tmp))
198 double t = (double)tmp;
203 case TYPE_INTERVAL_HR:
204 state->interval = t / 1073741824.0;
210 state->time = t / 1073741824.0;
219 static double ntohd(double val) /* {{{ */
221 static int config = 0;
237 double d = 8.642135e130;
240 memcpy(b, &d, sizeof(b));
242 if ((b[0] == 0x2f) && (b[1] == 0x25) && (b[2] == 0xc0) && (b[3] == 0xc7) &&
243 (b[4] == 0x43) && (b[5] == 0x2b) && (b[6] == 0x1f) && (b[7] == 0x5b))
244 config = 1; /* need nothing */
245 else if ((b[7] == 0x2f) && (b[6] == 0x25) && (b[5] == 0xc0) &&
246 (b[4] == 0xc7) && (b[3] == 0x43) && (b[2] == 0x2b) &&
247 (b[1] == 0x1f) && (b[0] == 0x5b))
248 config = 2; /* endian flip */
249 else if ((b[4] == 0x2f) && (b[5] == 0x25) && (b[6] == 0xc0) &&
250 (b[7] == 0xc7) && (b[0] == 0x43) && (b[1] == 0x2b) &&
251 (b[2] == 0x1f) && (b[3] == 0x5b))
252 config = 3; /* int swap */
257 if (memcmp((char[]){0, 0, 0, 0, 0, 0, 0xf8, 0x7f}, in.byte, 8) == 0) {
259 } else if (config == 1) {
261 } else if (config == 2) {
263 out.byte[0] = in.byte[7];
264 out.byte[1] = in.byte[6];
265 out.byte[2] = in.byte[5];
266 out.byte[3] = in.byte[4];
267 out.byte[4] = in.byte[3];
268 out.byte[5] = in.byte[2];
269 out.byte[6] = in.byte[1];
270 out.byte[7] = in.byte[0];
271 return (out.floating);
272 } else if (config == 3) {
274 out.byte[0] = in.byte[4];
275 out.byte[1] = in.byte[5];
276 out.byte[2] = in.byte[6];
277 out.byte[3] = in.byte[7];
278 out.byte[4] = in.byte[0];
279 out.byte[5] = in.byte[1];
280 out.byte[6] = in.byte[2];
281 out.byte[7] = in.byte[3];
284 /* If in doubt, just copy the value back to the caller. */
287 } /* }}} double ntohd */
289 static int parse_values(void *payload, size_t payload_size,
290 lcc_value_list_t *state) {
291 buffer_t *b = &(buffer_t){
292 .data = payload, .len = payload_size,
296 if (buffer_uint16(b, &n))
299 if (((size_t)n * 9) != b->len)
302 state->values_len = (size_t)n;
303 state->values = calloc(sizeof(*state->values), state->values_len);
304 state->values_types = calloc(sizeof(*state->values_types), state->values_len);
305 if ((state->values == NULL) || (state->values_types == NULL)) {
309 for (uint16_t i = 0; i < n; i++) {
311 if (buffer_next(b, &tmp, sizeof(tmp)))
313 state->values_types[i] = (int)tmp;
316 for (uint16_t i = 0; i < n; i++) {
318 if (buffer_next(b, &tmp, sizeof(tmp)))
321 if (state->values_types[i] == LCC_TYPE_GAUGE) {
326 state->values[i].gauge = ntohd(conv.d);
331 switch (state->values_types[i]) {
332 case LCC_TYPE_COUNTER:
333 state->values[i].counter = (counter_t)tmp;
335 case LCC_TYPE_DERIVE:
336 state->values[i].derive = (derive_t)tmp;
338 case LCC_TYPE_ABSOLUTE:
339 state->values[i].absolute = (absolute_t)tmp;
350 static int verify_sha256(void *payload, size_t payload_size,
351 char const *username, char const *password,
352 uint8_t hash_provided[32]) {
353 gcry_md_hd_t hd = NULL;
355 gcry_error_t err = gcry_md_open(&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
360 err = gcry_md_setkey(hd, password, strlen(password));
366 gcry_md_write(hd, username, strlen(username));
367 gcry_md_write(hd, payload, payload_size);
369 unsigned char *hash_calculated = gcry_md_read(hd, GCRY_MD_SHA256);
370 if (!hash_calculated) {
375 int ret = memcmp(hash_provided, hash_calculated, 32);
378 hash_calculated = NULL;
382 #else /* !HAVE_GCRYPT_H */
383 static int verify_sha256(void *payload, size_t payload_size,
384 char const *username, char const *password,
385 uint8_t hash_provided[32]) {
390 static int parse_sign_sha256(void *signature, size_t signature_len,
391 void *payload, size_t payload_size,
392 lcc_network_parse_options_t const *opts) {
393 if (opts->password_lookup == NULL) {
394 /* The sender signed the packet but we can't verify it. Handle it as if it
395 * were unsigned, i.e. security level NONE. */
396 return network_parse(payload, payload_size, NONE, opts);
399 buffer_t *b = &(buffer_t){
400 .data = signature, .len = signature_len,
404 if (buffer_next(b, hash, sizeof(hash)))
407 char username[b->len + 1];
408 memset(username, 0, sizeof(username));
409 if (buffer_next(b, username, sizeof(username) - 1)) {
413 char const *password = opts->password_lookup(username);
415 return network_parse(payload, payload_size, NONE, opts);
417 int status = verify_sha256(payload, payload_size, username, password, hash);
421 return network_parse(payload, payload_size, SIGN, opts);
425 static int decrypt_aes256(buffer_t *b, void *iv, size_t iv_size,
426 char const *password) {
427 gcry_cipher_hd_t cipher = NULL;
429 if (gcry_cipher_open(&cipher, GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB,
433 uint8_t pwhash[32] = {0};
434 gcry_md_hash_buffer(GCRY_MD_SHA256, pwhash, password, strlen(password));
436 fprintf(stderr, "sizeof(iv) = %" PRIsz "\n", sizeof(iv));
437 if (gcry_cipher_setkey(cipher, pwhash, sizeof(pwhash)) ||
438 gcry_cipher_setiv(cipher, iv, iv_size) ||
439 gcry_cipher_decrypt(cipher, b->data, b->len, /* in = */ NULL,
440 /* in_size = */ 0)) {
441 gcry_cipher_close(cipher);
445 gcry_cipher_close(cipher);
449 static int parse_encrypt_aes256(void *data, size_t data_size,
450 lcc_network_parse_options_t const *opts) {
451 if (opts->password_lookup == NULL) {
452 /* Without a password source it's (hopefully) impossible to decrypt the
457 buffer_t *b = &(buffer_t){
458 .data = data, .len = data_size,
461 uint16_t username_len;
462 if (buffer_uint16(b, &username_len))
464 if ((size_t)username_len > data_size)
466 char username[((size_t)username_len) + 1];
467 memset(username, 0, sizeof(username));
468 if (buffer_next(b, username, (size_t)username_len))
471 char const *password = opts->password_lookup(username);
476 if (buffer_next(b, iv, sizeof(iv)))
479 int status = decrypt_aes256(b, iv, sizeof(iv), password);
483 uint8_t hash_provided[20];
484 if (buffer_next(b, hash_provided, sizeof(hash_provided))) {
488 uint8_t hash_calculated[20];
489 gcry_md_hash_buffer(GCRY_MD_SHA1, hash_calculated, b->data, b->len);
491 if (memcmp(hash_provided, hash_calculated, sizeof(hash_provided)) != 0) {
495 return network_parse(b->data, b->len, ENCRYPT, opts);
497 #else /* !HAVE_GCRYPT_H */
498 static int parse_encrypt_aes256(void *data, size_t data_size,
499 lcc_network_parse_options_t const *opts) {
504 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
505 lcc_network_parse_options_t const *opts) {
506 buffer_t *b = &(buffer_t){
507 .data = data, .len = data_size,
510 lcc_value_list_t state = {0};
513 uint16_t type = 0, sz = 0;
514 if (buffer_uint16(b, &type) || buffer_uint16(b, &sz)) {
515 DEBUG("lcc_network_parse(): reading type and/or length failed.\n");
519 if ((sz < 5) || (((size_t)sz - 4) > b->len)) {
520 DEBUG("lcc_network_parse(): invalid 'sz' field: sz = %" PRIu16
521 ", b->len = %" PRIsz "\n",
528 if (buffer_next(b, payload, sizeof(payload)))
534 case TYPE_PLUGIN_INSTANCE:
536 case TYPE_TYPE_INSTANCE: {
537 if (parse_identifier(type, payload, sizeof(payload), &state)) {
538 DEBUG("lcc_network_parse(): parse_identifier failed.\n");
545 case TYPE_INTERVAL_HR:
548 if (parse_time(type, payload, sizeof(payload), &state)) {
549 DEBUG("lcc_network_parse(): parse_time failed.\n");
556 lcc_value_list_t vl = state;
557 if (parse_values(payload, sizeof(payload), &vl)) {
559 free(vl.values_types);
560 DEBUG("lcc_network_parse(): parse_values failed.\n");
566 /* Write metrics if they have the required security level. */
567 if (sl >= opts->security_level)
568 status = opts->writer(&vl);
571 free(vl.values_types);
578 case TYPE_SIGN_SHA256: {
580 parse_sign_sha256(payload, sizeof(payload), b->data, b->len, opts);
582 DEBUG("lcc_network_parse(): parse_sign_sha256() = %d\n", status);
585 /* parse_sign_sha256, if successful, consumes all remaining data. */
591 case TYPE_ENCR_AES256: {
592 int status = parse_encrypt_aes256(payload, sizeof(payload), opts);
594 DEBUG("lcc_network_parse(): parse_encrypt_aes256() = %d\n", status);
601 DEBUG("lcc_network_parse(): ignoring unknown type %" PRIu16 "\n", type);
610 int lcc_network_parse(void *data, size_t data_size,
611 lcc_network_parse_options_t opts) {
612 if (opts.password_lookup) {
615 if ((status = init_gcrypt())) {
623 return network_parse(data, data_size, NONE, &opts);