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>
30 #if !defined(__GNUC__) || !__GNUC__
31 #define __attribute__(x) /**/
34 #include "collectd/lcc_features.h"
35 #include "collectd/network_parse.h"
41 /* for be{16,64}toh */
44 #elif HAVE_SYS_ENDIAN_H
45 #include <sys/endian.h>
48 #define GCRYPT_NO_DEPRECATED
52 #define DEBUG(...) printf(__VA_ARGS__)
54 #if GCRYPT_VERSION_NUMBER < 0x010600
55 GCRY_THREAD_OPTION_PTHREAD_IMPL;
58 /* forward declaration because parse_sign_sha256()/parse_encrypt_aes256() and
59 * network_parse() need to call each other. */
60 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
61 lcc_network_parse_options_t const *opts);
63 static int init_gcrypt() {
64 /* http://lists.gnupg.org/pipermail/gcrypt-devel/2003-August/000458.html
65 * Because you can't know in a library whether another library has
66 * already initialized the library */
67 if (gcry_control(GCRYCTL_ANY_INITIALIZATION_P))
70 /* http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html
71 * To ensure thread-safety, it's important to set GCRYCTL_SET_THREAD_CBS
72 * *before* initalizing Libgcrypt with gcry_check_version(), which itself must
73 * be called before any other gcry_* function. GCRYCTL_ANY_INITIALIZATION_P
74 * above doesn't count, as it doesn't implicitly initalize Libgcrypt.
76 * tl;dr: keep all these gry_* statements in this exact order please. */
77 #if GCRYPT_VERSION_NUMBER < 0x010600
78 if (gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread)) {
83 gcry_check_version(NULL);
85 if (gcry_control(GCRYCTL_INIT_SECMEM, 32768)) {
89 gcry_control(GCRYCTL_INITIALIZATION_FINISHED);
98 static int buffer_next(buffer_t *b, void *out, size_t n) {
102 memmove(out, b->data, n);
110 static int buffer_uint16(buffer_t *b, uint16_t *out) {
112 if (buffer_next(b, &tmp, sizeof(tmp)) != 0)
119 #define TYPE_HOST 0x0000
120 #define TYPE_TIME 0x0001
121 #define TYPE_TIME_HR 0x0008
122 #define TYPE_PLUGIN 0x0002
123 #define TYPE_PLUGIN_INSTANCE 0x0003
124 #define TYPE_TYPE 0x0004
125 #define TYPE_TYPE_INSTANCE 0x0005
126 #define TYPE_VALUES 0x0006
127 #define TYPE_INTERVAL 0x0007
128 #define TYPE_INTERVAL_HR 0x0009
129 #define TYPE_SIGN_SHA256 0x0200
130 #define TYPE_ENCR_AES256 0x0210
132 static int parse_int(void *payload, size_t payload_size, uint64_t *out) {
135 if (payload_size != sizeof(tmp))
138 memmove(&tmp, payload, sizeof(tmp));
143 static int parse_string(void *payload, size_t payload_size, char *out,
147 if ((payload_size < 1) || (in[payload_size - 1] != 0) ||
148 (payload_size > out_size))
151 strncpy(out, in, out_size);
155 static int parse_identifier(uint16_t type, void *payload, size_t payload_size,
156 lcc_value_list_t *state) {
157 char buf[LCC_NAME_LEN];
159 if (parse_string(payload, payload_size, buf, sizeof(buf)) != 0)
164 memmove(state->identifier.host, buf, LCC_NAME_LEN);
167 memmove(state->identifier.plugin, buf, LCC_NAME_LEN);
169 case TYPE_PLUGIN_INSTANCE:
170 memmove(state->identifier.plugin_instance, buf, LCC_NAME_LEN);
173 memmove(state->identifier.type, buf, LCC_NAME_LEN);
175 case TYPE_TYPE_INSTANCE:
176 memmove(state->identifier.type_instance, buf, LCC_NAME_LEN);
185 static int parse_time(uint16_t type, void *payload, size_t payload_size,
186 lcc_value_list_t *state) {
188 if (parse_int(payload, payload_size, &tmp))
191 double t = (double)tmp;
196 case TYPE_INTERVAL_HR:
197 state->interval = t / 1073741824.0;
203 state->time = t / 1073741824.0;
212 static double ntohd(double val) /* {{{ */
214 static int config = 0;
230 double d = 8.642135e130;
233 memcpy(b, &d, sizeof(b));
235 if ((b[0] == 0x2f) && (b[1] == 0x25) && (b[2] == 0xc0) && (b[3] == 0xc7) &&
236 (b[4] == 0x43) && (b[5] == 0x2b) && (b[6] == 0x1f) && (b[7] == 0x5b))
237 config = 1; /* need nothing */
238 else if ((b[7] == 0x2f) && (b[6] == 0x25) && (b[5] == 0xc0) &&
239 (b[4] == 0xc7) && (b[3] == 0x43) && (b[2] == 0x2b) &&
240 (b[1] == 0x1f) && (b[0] == 0x5b))
241 config = 2; /* endian flip */
242 else if ((b[4] == 0x2f) && (b[5] == 0x25) && (b[6] == 0xc0) &&
243 (b[7] == 0xc7) && (b[0] == 0x43) && (b[1] == 0x2b) &&
244 (b[2] == 0x1f) && (b[3] == 0x5b))
245 config = 3; /* int swap */
250 if (memcmp((char[]){0, 0, 0, 0, 0, 0, 0xf8, 0x7f}, in.byte, 8) == 0) {
252 } else if (config == 1) {
254 } else if (config == 2) {
256 out.byte[0] = in.byte[7];
257 out.byte[1] = in.byte[6];
258 out.byte[2] = in.byte[5];
259 out.byte[3] = in.byte[4];
260 out.byte[4] = in.byte[3];
261 out.byte[5] = in.byte[2];
262 out.byte[6] = in.byte[1];
263 out.byte[7] = in.byte[0];
264 return (out.floating);
265 } else if (config == 3) {
267 out.byte[0] = in.byte[4];
268 out.byte[1] = in.byte[5];
269 out.byte[2] = in.byte[6];
270 out.byte[3] = in.byte[7];
271 out.byte[4] = in.byte[0];
272 out.byte[5] = in.byte[1];
273 out.byte[6] = in.byte[2];
274 out.byte[7] = in.byte[3];
277 /* If in doubt, just copy the value back to the caller. */
280 } /* }}} double ntohd */
282 static int parse_values(void *payload, size_t payload_size,
283 lcc_value_list_t *state) {
284 buffer_t *b = &(buffer_t){
285 .data = payload, .len = payload_size,
289 if (buffer_uint16(b, &n))
292 if (((size_t)n * 9) != b->len)
295 state->values_len = (size_t)n;
296 state->values = calloc(sizeof(*state->values), state->values_len);
297 state->values_types = calloc(sizeof(*state->values_types), state->values_len);
298 if ((state->values == NULL) || (state->values_types == NULL)) {
300 free(state->values_types);
304 for (uint16_t i = 0; i < n; i++) {
306 if (buffer_next(b, &tmp, sizeof(tmp)))
308 state->values_types[i] = (int)tmp;
311 for (uint16_t i = 0; i < n; i++) {
313 if (buffer_next(b, &tmp, sizeof(tmp)))
316 if (state->values_types[i] == LCC_TYPE_GAUGE) {
321 state->values[i].gauge = ntohd(conv.d);
326 switch (state->values_types[i]) {
327 case LCC_TYPE_COUNTER:
328 state->values[i].counter = (counter_t)tmp;
330 case LCC_TYPE_DERIVE:
331 state->values[i].derive = (derive_t)tmp;
333 case LCC_TYPE_ABSOLUTE:
334 state->values[i].absolute = (absolute_t)tmp;
344 static int verify_sha256(void *payload, size_t payload_size,
345 char const *username, char const *password,
346 uint8_t hash_provided[32]) {
347 gcry_md_hd_t hd = NULL;
349 gcry_error_t err = gcry_md_open(&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
354 err = gcry_md_setkey(hd, password, strlen(password));
360 gcry_md_write(hd, username, strlen(username));
361 gcry_md_write(hd, payload, payload_size);
363 unsigned char *hash_calculated = gcry_md_read(hd, GCRY_MD_SHA256);
364 if (!hash_calculated) {
369 int ret = memcmp(hash_provided, hash_calculated, 32);
372 hash_calculated = NULL;
377 static int parse_sign_sha256(void *signature, size_t signature_len,
378 void *payload, size_t payload_size,
379 lcc_network_parse_options_t const *opts) {
380 if (opts->password_lookup == NULL) {
381 /* The sender signed the packet but we can't verify it. Handle it as if it
382 * were unsigned, i.e. security level NONE. */
383 return network_parse(payload, payload_size, NONE, opts);
386 buffer_t *b = &(buffer_t){
387 .data = signature, .len = signature_len,
391 if (buffer_next(b, hash, sizeof(hash)))
394 char username[b->len + 1];
395 memset(username, 0, sizeof(username));
396 if (buffer_next(b, username, sizeof(username) - 1)) {
400 char const *password = opts->password_lookup(username);
402 return network_parse(payload, payload_size, NONE, opts);
404 int status = verify_sha256(payload, payload_size, username, password, hash);
408 return network_parse(payload, payload_size, SIGN, opts);
411 static int decrypt_aes256(buffer_t *b, void *iv, size_t iv_size,
412 char const *password) {
413 gcry_cipher_hd_t cipher = NULL;
415 if (gcry_cipher_open(&cipher, GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB,
419 uint8_t pwhash[32] = {0};
420 gcry_md_hash_buffer(GCRY_MD_SHA256, pwhash, password, strlen(password));
422 fprintf(stderr, "sizeof(iv) = %zu\n", sizeof(iv));
423 if (gcry_cipher_setkey(cipher, pwhash, sizeof(pwhash)) ||
424 gcry_cipher_setiv(cipher, iv, iv_size) ||
425 gcry_cipher_decrypt(cipher, b->data, b->len, /* in = */ NULL,
426 /* in_size = */ 0)) {
427 gcry_cipher_close(cipher);
431 gcry_cipher_close(cipher);
435 static int parse_encrypt_aes256(void *data, size_t data_size,
436 lcc_network_parse_options_t const *opts) {
437 if (opts->password_lookup == NULL) {
438 /* Without a password source it's (hopefully) impossible to decrypt the
443 buffer_t *b = &(buffer_t){
444 .data = data, .len = data_size,
447 uint16_t username_len;
448 if (buffer_uint16(b, &username_len))
450 if ((size_t)username_len > data_size)
452 char username[((size_t)username_len) + 1];
453 memset(username, 0, sizeof(username));
454 if (buffer_next(b, username, (size_t)username_len))
457 char const *password = opts->password_lookup(username);
462 if (buffer_next(b, iv, sizeof(iv)))
465 int status = decrypt_aes256(b, iv, sizeof(iv), password);
469 uint8_t hash_provided[20];
470 if (buffer_next(b, hash_provided, sizeof(hash_provided))) {
474 uint8_t hash_calculated[20];
475 gcry_md_hash_buffer(GCRY_MD_SHA1, hash_calculated, b->data, b->len);
477 if (memcmp(hash_provided, hash_calculated, sizeof(hash_provided)) != 0) {
481 return network_parse(b->data, b->len, ENCRYPT, opts);
484 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
485 lcc_network_parse_options_t const *opts) {
486 buffer_t *b = &(buffer_t){
487 .data = data, .len = data_size,
490 lcc_value_list_t state = {0};
493 uint16_t type = 0, sz = 0;
494 if (buffer_uint16(b, &type) || buffer_uint16(b, &sz)) {
495 DEBUG("lcc_network_parse(): reading type and/or length failed.\n");
499 if ((sz < 5) || (((size_t)sz - 4) > b->len)) {
500 DEBUG("lcc_network_parse(): invalid 'sz' field: sz = %" PRIu16
508 if (buffer_next(b, payload, sizeof(payload)))
514 case TYPE_PLUGIN_INSTANCE:
516 case TYPE_TYPE_INSTANCE: {
517 if (parse_identifier(type, payload, sizeof(payload), &state)) {
518 DEBUG("lcc_network_parse(): parse_identifier failed.\n");
525 case TYPE_INTERVAL_HR:
528 if (parse_time(type, payload, sizeof(payload), &state)) {
529 DEBUG("lcc_network_parse(): parse_time failed.\n");
536 lcc_value_list_t vl = state;
537 if (parse_values(payload, sizeof(payload), &vl)) {
538 DEBUG("lcc_network_parse(): parse_values failed.\n");
544 /* Write metrics if they have the required security level. */
545 if (sl >= opts->security_level)
546 status = opts->writer(&vl);
549 free(vl.values_types);
556 case TYPE_SIGN_SHA256: {
558 parse_sign_sha256(payload, sizeof(payload), b->data, b->len, opts);
560 DEBUG("lcc_network_parse(): parse_sign_sha256() = %d\n", status);
563 /* parse_sign_sha256, if successful, consumes all remaining data. */
569 case TYPE_ENCR_AES256: {
570 int status = parse_encrypt_aes256(payload, sizeof(payload), opts);
572 DEBUG("lcc_network_parse(): parse_encrypt_aes256() = %d\n", status);
579 DEBUG("lcc_network_parse(): ignoring unknown type %" PRIu16 "\n", type);
588 int lcc_network_parse(void *data, size_t data_size,
589 lcc_network_parse_options_t opts) {
590 if (opts.password_lookup) {
592 if ((status = init_gcrypt())) {
597 return network_parse(data, data_size, NONE, &opts);