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 GCRY_THREAD_OPTION_PTHREAD_IMPL;
49 /* forward declaration because parse_sign_sha256()/parse_encrypt_aes256() and
50 * network_parse() need to call each other. */
51 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
52 lcc_network_parse_options_t const *opts);
54 static int init_gcrypt() {
55 /* http://lists.gnupg.org/pipermail/gcrypt-devel/2003-August/000458.html
56 * Because you can't know in a library whether another library has
57 * already initialized the library */
58 if (gcry_control(GCRYCTL_ANY_INITIALIZATION_P))
61 /* http://www.gnupg.org/documentation/manuals/gcrypt/Multi_002dThreading.html
62 * To ensure thread-safety, it's important to set GCRYCTL_SET_THREAD_CBS
63 * *before* initalizing Libgcrypt with gcry_check_version(), which itself must
64 * be called before any other gcry_* function. GCRYCTL_ANY_INITIALIZATION_P
65 * above doesn't count, as it doesn't implicitly initalize Libgcrypt.
67 * tl;dr: keep all these gry_* statements in this exact order please. */
68 #if GCRYPT_VERSION_NUMBER < 0x010600
69 if (gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread)) {
74 gcry_check_version(NULL);
76 if (gcry_control(GCRYCTL_INIT_SECMEM, 32768)) {
80 gcry_control(GCRYCTL_INITIALIZATION_FINISHED);
89 static int buffer_next(buffer_t *b, void *out, size_t n) {
93 memmove(out, b->data, n);
101 static int buffer_uint16(buffer_t *b, uint16_t *out) {
103 if (buffer_next(b, &tmp, sizeof(tmp)) != 0)
110 #define TYPE_HOST 0x0000
111 #define TYPE_TIME 0x0001
112 #define TYPE_TIME_HR 0x0008
113 #define TYPE_PLUGIN 0x0002
114 #define TYPE_PLUGIN_INSTANCE 0x0003
115 #define TYPE_TYPE 0x0004
116 #define TYPE_TYPE_INSTANCE 0x0005
117 #define TYPE_VALUES 0x0006
118 #define TYPE_INTERVAL 0x0007
119 #define TYPE_INTERVAL_HR 0x0009
120 #define TYPE_SIGN_SHA256 0x0200
121 #define TYPE_ENCR_AES256 0x0210
123 static int parse_int(void *payload, size_t payload_size, uint64_t *out) {
126 if (payload_size != sizeof(tmp))
129 memmove(&tmp, payload, sizeof(tmp));
134 static int parse_string(void *payload, size_t payload_size, char *out,
138 if ((payload_size < 1) || (in[payload_size - 1] != 0) ||
139 (payload_size > out_size))
142 strncpy(out, in, out_size);
146 static int parse_identifier(uint16_t type, void *payload, size_t payload_size,
147 lcc_value_list_t *state) {
148 char buf[LCC_NAME_LEN];
150 if (parse_string(payload, payload_size, buf, sizeof(buf)) != 0)
155 memmove(state->identifier.host, buf, LCC_NAME_LEN);
158 memmove(state->identifier.plugin, buf, LCC_NAME_LEN);
160 case TYPE_PLUGIN_INSTANCE:
161 memmove(state->identifier.plugin_instance, buf, LCC_NAME_LEN);
164 memmove(state->identifier.type, buf, LCC_NAME_LEN);
166 case TYPE_TYPE_INSTANCE:
167 memmove(state->identifier.type_instance, buf, LCC_NAME_LEN);
176 static int parse_time(uint16_t type, void *payload, size_t payload_size,
177 lcc_value_list_t *state) {
179 if (parse_int(payload, payload_size, &tmp))
182 double t = (double)tmp;
187 case TYPE_INTERVAL_HR:
188 state->interval = t / 1073741824.0;
194 state->time = t / 1073741824.0;
203 static double ntohd(double val) /* {{{ */
205 static int config = 0;
221 double d = 8.642135e130;
224 memcpy(b, &d, sizeof(b));
226 if ((b[0] == 0x2f) && (b[1] == 0x25) && (b[2] == 0xc0) && (b[3] == 0xc7) &&
227 (b[4] == 0x43) && (b[5] == 0x2b) && (b[6] == 0x1f) && (b[7] == 0x5b))
228 config = 1; /* need nothing */
229 else if ((b[7] == 0x2f) && (b[6] == 0x25) && (b[5] == 0xc0) &&
230 (b[4] == 0xc7) && (b[3] == 0x43) && (b[2] == 0x2b) &&
231 (b[1] == 0x1f) && (b[0] == 0x5b))
232 config = 2; /* endian flip */
233 else if ((b[4] == 0x2f) && (b[5] == 0x25) && (b[6] == 0xc0) &&
234 (b[7] == 0xc7) && (b[0] == 0x43) && (b[1] == 0x2b) &&
235 (b[2] == 0x1f) && (b[3] == 0x5b))
236 config = 3; /* int swap */
241 if (memcmp((char[]){0, 0, 0, 0, 0, 0, 0xf8, 0x7f}, in.byte, 8) == 0) {
243 } else if (config == 1) {
245 } else if (config == 2) {
247 out.byte[0] = in.byte[7];
248 out.byte[1] = in.byte[6];
249 out.byte[2] = in.byte[5];
250 out.byte[3] = in.byte[4];
251 out.byte[4] = in.byte[3];
252 out.byte[5] = in.byte[2];
253 out.byte[6] = in.byte[1];
254 out.byte[7] = in.byte[0];
255 return (out.floating);
256 } else if (config == 3) {
258 out.byte[0] = in.byte[4];
259 out.byte[1] = in.byte[5];
260 out.byte[2] = in.byte[6];
261 out.byte[3] = in.byte[7];
262 out.byte[4] = in.byte[0];
263 out.byte[5] = in.byte[1];
264 out.byte[6] = in.byte[2];
265 out.byte[7] = in.byte[3];
268 /* If in doubt, just copy the value back to the caller. */
271 } /* }}} double ntohd */
273 static int parse_values(void *payload, size_t payload_size,
274 lcc_value_list_t *state) {
275 buffer_t *b = &(buffer_t){
276 .data = payload, .len = payload_size,
280 if (buffer_uint16(b, &n))
283 if (((size_t)n * 9) != b->len)
286 state->values_len = (size_t)n;
287 state->values = calloc(sizeof(*state->values), state->values_len);
288 state->values_types = calloc(sizeof(*state->values_types), state->values_len);
289 if ((state->values == NULL) || (state->values_types == NULL)) {
291 free(state->values_types);
295 for (uint16_t i = 0; i < n; i++) {
297 if (buffer_next(b, &tmp, sizeof(tmp)))
299 state->values_types[i] = (int)tmp;
302 for (uint16_t i = 0; i < n; i++) {
304 if (buffer_next(b, &tmp, sizeof(tmp)))
307 if (state->values_types[i] == LCC_TYPE_GAUGE) {
312 state->values[i].gauge = ntohd(conv.d);
317 switch (state->values_types[i]) {
318 case LCC_TYPE_COUNTER:
319 state->values[i].counter = (counter_t)tmp;
321 case LCC_TYPE_DERIVE:
322 state->values[i].derive = (derive_t)tmp;
324 case LCC_TYPE_ABSOLUTE:
325 state->values[i].absolute = (absolute_t)tmp;
335 static int verify_sha256(void *payload, size_t payload_size,
336 char const *username, char const *password,
337 uint8_t hash_provided[32]) {
338 gcry_md_hd_t hd = NULL;
340 gcry_error_t err = gcry_md_open(&hd, GCRY_MD_SHA256, GCRY_MD_FLAG_HMAC);
342 /* TODO(octo): use gcry_strerror(err) to create an error string. */
346 err = gcry_md_setkey(hd, password, strlen(password));
352 gcry_md_write(hd, username, strlen(username));
353 gcry_md_write(hd, payload, payload_size);
355 unsigned char *hash_calculated = gcry_md_read(hd, GCRY_MD_SHA256);
356 if (!hash_calculated) {
361 int ret = memcmp(hash_provided, hash_calculated, 32);
364 hash_calculated = NULL;
369 static int parse_sign_sha256(void *signature, size_t signature_len,
370 void *payload, size_t payload_size,
371 lcc_network_parse_options_t const *opts) {
372 if (opts->password_lookup == NULL) {
373 /* TODO(octo): print warning */
374 return network_parse(payload, payload_size, NONE, opts);
377 buffer_t *b = &(buffer_t){
378 .data = signature, .len = signature_len,
382 if (buffer_next(b, hash, sizeof(hash)))
385 char username[b->len + 1];
386 memset(username, 0, sizeof(username));
387 if (buffer_next(b, username, sizeof(username) - 1)) {
391 char const *password = opts->password_lookup(username);
393 return network_parse(payload, payload_size, NONE, opts);
395 int status = verify_sha256(payload, payload_size, username, password, hash);
399 return network_parse(payload, payload_size, SIGN, opts);
402 static int decrypt_aes256(buffer_t *b, void *iv, size_t iv_size,
403 char const *password) {
404 gcry_cipher_hd_t cipher = NULL;
406 if (gcry_cipher_open(&cipher, GCRY_CIPHER_AES256, GCRY_CIPHER_MODE_OFB,
410 uint8_t pwhash[32] = {0};
411 gcry_md_hash_buffer(GCRY_MD_SHA256, pwhash, password, strlen(password));
413 fprintf(stderr, "sizeof(iv) = %zu\n", sizeof(iv));
414 if (gcry_cipher_setkey(cipher, pwhash, sizeof(pwhash)) ||
415 gcry_cipher_setiv(cipher, iv, iv_size) ||
416 gcry_cipher_decrypt(cipher, b->data, b->len, /* in = */ NULL,
417 /* in_size = */ 0)) {
418 gcry_cipher_close(cipher);
422 gcry_cipher_close(cipher);
426 static int parse_encrypt_aes256(void *data, size_t data_size,
427 lcc_network_parse_options_t const *opts) {
428 if (opts->password_lookup == NULL) {
429 /* TODO(octo): print warning */
433 buffer_t *b = &(buffer_t){
434 .data = data, .len = data_size,
437 uint16_t username_len;
438 if (buffer_uint16(b, &username_len))
440 if ((size_t)username_len > data_size)
442 char username[((size_t)username_len) + 1];
443 memset(username, 0, sizeof(username));
444 if (buffer_next(b, username, (size_t)username_len))
447 char const *password = opts->password_lookup(username);
452 if (buffer_next(b, iv, sizeof(iv)))
455 int status = decrypt_aes256(b, iv, sizeof(iv), password);
459 uint8_t hash_provided[20];
460 if (buffer_next(b, hash_provided, sizeof(hash_provided))) {
464 uint8_t hash_calculated[20];
465 gcry_md_hash_buffer(GCRY_MD_SHA1, hash_calculated, b->data, b->len);
467 if (memcmp(hash_provided, hash_calculated, sizeof(hash_provided)) != 0) {
471 return network_parse(b->data, b->len, ENCRYPT, opts);
474 static int network_parse(void *data, size_t data_size, lcc_security_level_t sl,
475 lcc_network_parse_options_t const *opts) {
476 buffer_t *b = &(buffer_t){
477 .data = data, .len = data_size,
480 lcc_value_list_t state = {0};
483 uint16_t type = 0, sz = 0;
484 if (buffer_uint16(b, &type) || buffer_uint16(b, &sz)) {
485 DEBUG("lcc_network_parse(): reading type and/or length failed.\n");
489 if ((sz < 5) || (((size_t)sz - 4) > b->len)) {
490 DEBUG("lcc_network_parse(): invalid 'sz' field: sz = %" PRIu16
498 if (buffer_next(b, payload, sizeof(payload)))
504 case TYPE_PLUGIN_INSTANCE:
506 case TYPE_TYPE_INSTANCE: {
507 if (parse_identifier(type, payload, sizeof(payload), &state)) {
508 DEBUG("lcc_network_parse(): parse_identifier failed.\n");
515 case TYPE_INTERVAL_HR:
518 if (parse_time(type, payload, sizeof(payload), &state)) {
519 DEBUG("lcc_network_parse(): parse_time failed.\n");
526 lcc_value_list_t vl = state;
527 if (parse_values(payload, sizeof(payload), &vl)) {
528 DEBUG("lcc_network_parse(): parse_values failed.\n");
532 /* TODO(octo): skip if current_security_level < required_security_level */
534 int status = opts->writer(&vl);
537 free(vl.values_types);
544 case TYPE_SIGN_SHA256: {
546 parse_sign_sha256(payload, sizeof(payload), b->data, b->len, opts);
548 DEBUG("lcc_network_parse(): parse_sign_sha256() = %d\n", status);
551 /* parse_sign_sha256, if successful, consumes all remaining data. */
557 case TYPE_ENCR_AES256: {
558 int status = parse_encrypt_aes256(payload, sizeof(payload), opts);
560 DEBUG("lcc_network_parse(): parse_encrypt_aes256() = %d\n", status);
567 DEBUG("lcc_network_parse(): ignoring unknown type %" PRIu16 "\n", type);
576 int lcc_network_parse(void *data, size_t data_size,
577 lcc_network_parse_options_t opts) {
578 if (opts.password_lookup) {
580 if ((status = init_gcrypt())) {
585 return network_parse(data, data_size, NONE, &opts);