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 #define GCRYPT_NO_DEPRECATED
45 #define DEBUG(...) printf(__VA_ARGS__)
47 #if GCRYPT_VERSION_NUMBER < 0x010600
48 GCRY_THREAD_OPTION_PTHREAD_IMPL;
51 /* forward declaration because parse_sign_sha256()/parse_encrypt_aes256() and
52 * network_parse() need to call each other. */
53 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
54 lcc_network_parse_options_t const *opts);
56 static int init_gcrypt() {
57 /* http://lists.gnupg.org/pipermail/gcrypt-devel/2003-August/000458.html
58 * Because you can't know in a library whether another library has
59 * already initialized the library */
60 if (gcry_control(GCRYCTL_ANY_INITIALIZATION_P))
63 /* http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html
64 * To ensure thread-safety, it's important to set GCRYCTL_SET_THREAD_CBS
65 * *before* initalizing Libgcrypt with gcry_check_version(), which itself must
66 * be called before any other gcry_* function. GCRYCTL_ANY_INITIALIZATION_P
67 * above doesn't count, as it doesn't implicitly initalize Libgcrypt.
69 * tl;dr: keep all these gry_* statements in this exact order please. */
70 #if GCRYPT_VERSION_NUMBER < 0x010600
71 if (gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread)) {
76 gcry_check_version(NULL);
78 if (gcry_control(GCRYCTL_INIT_SECMEM, 32768)) {
82 gcry_control(GCRYCTL_INITIALIZATION_FINISHED);
91 static int buffer_next(buffer_t *b, void *out, size_t n) {
95 memmove(out, b->data, n);
103 static int buffer_uint16(buffer_t *b, uint16_t *out) {
105 if (buffer_next(b, &tmp, sizeof(tmp)) != 0)
112 #define TYPE_HOST 0x0000
113 #define TYPE_TIME 0x0001
114 #define TYPE_TIME_HR 0x0008
115 #define TYPE_PLUGIN 0x0002
116 #define TYPE_PLUGIN_INSTANCE 0x0003
117 #define TYPE_TYPE 0x0004
118 #define TYPE_TYPE_INSTANCE 0x0005
119 #define TYPE_VALUES 0x0006
120 #define TYPE_INTERVAL 0x0007
121 #define TYPE_INTERVAL_HR 0x0009
122 #define TYPE_SIGN_SHA256 0x0200
123 #define TYPE_ENCR_AES256 0x0210
125 static int parse_int(void *payload, size_t payload_size, uint64_t *out) {
128 if (payload_size != sizeof(tmp))
131 memmove(&tmp, payload, sizeof(tmp));
136 static int parse_string(void *payload, size_t payload_size, char *out,
140 if ((payload_size < 1) || (in[payload_size - 1] != 0) ||
141 (payload_size > out_size))
144 strncpy(out, in, out_size);
148 static int parse_identifier(uint16_t type, void *payload, size_t payload_size,
149 lcc_value_list_t *state) {
150 char buf[LCC_NAME_LEN];
152 if (parse_string(payload, payload_size, buf, sizeof(buf)) != 0)
157 memmove(state->identifier.host, buf, LCC_NAME_LEN);
160 memmove(state->identifier.plugin, buf, LCC_NAME_LEN);
162 case TYPE_PLUGIN_INSTANCE:
163 memmove(state->identifier.plugin_instance, buf, LCC_NAME_LEN);
166 memmove(state->identifier.type, buf, LCC_NAME_LEN);
168 case TYPE_TYPE_INSTANCE:
169 memmove(state->identifier.type_instance, buf, LCC_NAME_LEN);
178 static int parse_time(uint16_t type, void *payload, size_t payload_size,
179 lcc_value_list_t *state) {
181 if (parse_int(payload, payload_size, &tmp))
184 double t = (double)tmp;
189 case TYPE_INTERVAL_HR:
190 state->interval = t / 1073741824.0;
196 state->time = t / 1073741824.0;
205 static double ntohd(double val) /* {{{ */
207 static int config = 0;
223 double d = 8.642135e130;
226 memcpy(b, &d, sizeof(b));
228 if ((b[0] == 0x2f) && (b[1] == 0x25) && (b[2] == 0xc0) && (b[3] == 0xc7) &&
229 (b[4] == 0x43) && (b[5] == 0x2b) && (b[6] == 0x1f) && (b[7] == 0x5b))
230 config = 1; /* need nothing */
231 else if ((b[7] == 0x2f) && (b[6] == 0x25) && (b[5] == 0xc0) &&
232 (b[4] == 0xc7) && (b[3] == 0x43) && (b[2] == 0x2b) &&
233 (b[1] == 0x1f) && (b[0] == 0x5b))
234 config = 2; /* endian flip */
235 else if ((b[4] == 0x2f) && (b[5] == 0x25) && (b[6] == 0xc0) &&
236 (b[7] == 0xc7) && (b[0] == 0x43) && (b[1] == 0x2b) &&
237 (b[2] == 0x1f) && (b[3] == 0x5b))
238 config = 3; /* int swap */
243 if (memcmp((char[]){0, 0, 0, 0, 0, 0, 0xf8, 0x7f}, in.byte, 8) == 0) {
245 } else if (config == 1) {
247 } else if (config == 2) {
249 out.byte[0] = in.byte[7];
250 out.byte[1] = in.byte[6];
251 out.byte[2] = in.byte[5];
252 out.byte[3] = in.byte[4];
253 out.byte[4] = in.byte[3];
254 out.byte[5] = in.byte[2];
255 out.byte[6] = in.byte[1];
256 out.byte[7] = in.byte[0];
257 return (out.floating);
258 } else if (config == 3) {
260 out.byte[0] = in.byte[4];
261 out.byte[1] = in.byte[5];
262 out.byte[2] = in.byte[6];
263 out.byte[3] = in.byte[7];
264 out.byte[4] = in.byte[0];
265 out.byte[5] = in.byte[1];
266 out.byte[6] = in.byte[2];
267 out.byte[7] = in.byte[3];
270 /* If in doubt, just copy the value back to the caller. */
273 } /* }}} double ntohd */
275 static int parse_values(void *payload, size_t payload_size,
276 lcc_value_list_t *state) {
277 buffer_t *b = &(buffer_t){
278 .data = payload, .len = payload_size,
282 if (buffer_uint16(b, &n))
285 if (((size_t)n * 9) != b->len)
288 state->values_len = (size_t)n;
289 state->values = calloc(sizeof(*state->values), state->values_len);
290 state->values_types = calloc(sizeof(*state->values_types), state->values_len);
291 if ((state->values == NULL) || (state->values_types == NULL)) {
293 free(state->values_types);
297 for (uint16_t i = 0; i < n; i++) {
299 if (buffer_next(b, &tmp, sizeof(tmp)))
301 state->values_types[i] = (int)tmp;
304 for (uint16_t i = 0; i < n; i++) {
306 if (buffer_next(b, &tmp, sizeof(tmp)))
309 if (state->values_types[i] == LCC_TYPE_GAUGE) {
314 state->values[i].gauge = ntohd(conv.d);
319 switch (state->values_types[i]) {
320 case LCC_TYPE_COUNTER:
321 state->values[i].counter = (counter_t)tmp;
323 case LCC_TYPE_DERIVE:
324 state->values[i].derive = (derive_t)tmp;
326 case LCC_TYPE_ABSOLUTE:
327 state->values[i].absolute = (absolute_t)tmp;
337 static int verify_sha256(void *payload, size_t payload_size,
338 char const *username, char const *password,
339 uint8_t hash_provided[32]) {
340 gcry_md_hd_t hd = NULL;
342 gcry_error_t err = gcry_md_open(&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
347 err = gcry_md_setkey(hd, password, strlen(password));
353 gcry_md_write(hd, username, strlen(username));
354 gcry_md_write(hd, payload, payload_size);
356 unsigned char *hash_calculated = gcry_md_read(hd, GCRY_MD_SHA256);
357 if (!hash_calculated) {
362 int ret = memcmp(hash_provided, hash_calculated, 32);
365 hash_calculated = NULL;
370 static int parse_sign_sha256(void *signature, size_t signature_len,
371 void *payload, size_t payload_size,
372 lcc_network_parse_options_t const *opts) {
373 if (opts->password_lookup == NULL) {
374 /* The sender signed the packet but we can't verify it. Handle it as if it
375 * were unsigned, i.e. security level NONE. */
376 return network_parse(payload, payload_size, NONE, opts);
379 buffer_t *b = &(buffer_t){
380 .data = signature, .len = signature_len,
384 if (buffer_next(b, hash, sizeof(hash)))
387 char username[b->len + 1];
388 memset(username, 0, sizeof(username));
389 if (buffer_next(b, username, sizeof(username) - 1)) {
393 char const *password = opts->password_lookup(username);
395 return network_parse(payload, payload_size, NONE, opts);
397 int status = verify_sha256(payload, payload_size, username, password, hash);
401 return network_parse(payload, payload_size, SIGN, opts);
404 static int decrypt_aes256(buffer_t *b, void *iv, size_t iv_size,
405 char const *password) {
406 gcry_cipher_hd_t cipher = NULL;
408 if (gcry_cipher_open(&cipher, GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB,
412 uint8_t pwhash[32] = {0};
413 gcry_md_hash_buffer(GCRY_MD_SHA256, pwhash, password, strlen(password));
415 fprintf(stderr, "sizeof(iv) = %zu\n", sizeof(iv));
416 if (gcry_cipher_setkey(cipher, pwhash, sizeof(pwhash)) ||
417 gcry_cipher_setiv(cipher, iv, iv_size) ||
418 gcry_cipher_decrypt(cipher, b->data, b->len, /* in = */ NULL,
419 /* in_size = */ 0)) {
420 gcry_cipher_close(cipher);
424 gcry_cipher_close(cipher);
428 static int parse_encrypt_aes256(void *data, size_t data_size,
429 lcc_network_parse_options_t const *opts) {
430 if (opts->password_lookup == NULL) {
431 /* Without a password source it's (hopefully) impossible to decrypt the
436 buffer_t *b = &(buffer_t){
437 .data = data, .len = data_size,
440 uint16_t username_len;
441 if (buffer_uint16(b, &username_len))
443 if ((size_t)username_len > data_size)
445 char username[((size_t)username_len) + 1];
446 memset(username, 0, sizeof(username));
447 if (buffer_next(b, username, (size_t)username_len))
450 char const *password = opts->password_lookup(username);
455 if (buffer_next(b, iv, sizeof(iv)))
458 int status = decrypt_aes256(b, iv, sizeof(iv), password);
462 uint8_t hash_provided[20];
463 if (buffer_next(b, hash_provided, sizeof(hash_provided))) {
467 uint8_t hash_calculated[20];
468 gcry_md_hash_buffer(GCRY_MD_SHA1, hash_calculated, b->data, b->len);
470 if (memcmp(hash_provided, hash_calculated, sizeof(hash_provided)) != 0) {
474 return network_parse(b->data, b->len, ENCRYPT, opts);
477 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
478 lcc_network_parse_options_t const *opts) {
479 buffer_t *b = &(buffer_t){
480 .data = data, .len = data_size,
483 lcc_value_list_t state = {0};
486 uint16_t type = 0, sz = 0;
487 if (buffer_uint16(b, &type) || buffer_uint16(b, &sz)) {
488 DEBUG("lcc_network_parse(): reading type and/or length failed.\n");
492 if ((sz < 5) || (((size_t)sz - 4) > b->len)) {
493 DEBUG("lcc_network_parse(): invalid 'sz' field: sz = %" PRIu16
501 if (buffer_next(b, payload, sizeof(payload)))
507 case TYPE_PLUGIN_INSTANCE:
509 case TYPE_TYPE_INSTANCE: {
510 if (parse_identifier(type, payload, sizeof(payload), &state)) {
511 DEBUG("lcc_network_parse(): parse_identifier failed.\n");
518 case TYPE_INTERVAL_HR:
521 if (parse_time(type, payload, sizeof(payload), &state)) {
522 DEBUG("lcc_network_parse(): parse_time failed.\n");
529 lcc_value_list_t vl = state;
530 if (parse_values(payload, sizeof(payload), &vl)) {
531 DEBUG("lcc_network_parse(): parse_values failed.\n");
537 /* Write metrics if they have the required security level. */
538 if (sl >= opts->security_level)
539 status = opts->writer(&vl);
542 free(vl.values_types);
549 case TYPE_SIGN_SHA256: {
551 parse_sign_sha256(payload, sizeof(payload), b->data, b->len, opts);
553 DEBUG("lcc_network_parse(): parse_sign_sha256() = %d\n", status);
556 /* parse_sign_sha256, if successful, consumes all remaining data. */
562 case TYPE_ENCR_AES256: {
563 int status = parse_encrypt_aes256(payload, sizeof(payload), opts);
565 DEBUG("lcc_network_parse(): parse_encrypt_aes256() = %d\n", status);
572 DEBUG("lcc_network_parse(): ignoring unknown type %" PRIu16 "\n", type);
581 int lcc_network_parse(void *data, size_t data_size,
582 lcc_network_parse_options_t opts) {
583 if (opts.password_lookup) {
585 if ((status = init_gcrypt())) {
590 return network_parse(data, data_size, NONE, &opts);