1
0
mirror of https://github.com/netdata/netdata.git synced 2021-06-06 23:03:21 +03:00
Files
netdata/aclk/aclk_util.c
vkalintiris b8cd2bdc50 Remove unecessary relative paths when including headers. (#11124)
Currently, we add the repository's top-level dir in the compiler's
header search path. This means that code in every top-level directory
within the repo can include headers sibling top-level directories.

This patch makes header inclusion consistent when it comes to files
that are included from sibling top-level directories within the repo.
2021-05-24 17:44:50 +03:00

541 lines
15 KiB
C

// SPDX-License-Identifier: GPL-3.0-or-later
#include "aclk_util.h"
#include <stdio.h>
#include "daemon/common.h"
// CentOS 7 has older version that doesn't define this
// same goes for MacOS
#ifndef UUID_STR_LEN
#define UUID_STR_LEN 37
#endif
aclk_encoding_type_t aclk_encoding_type_t_from_str(const char *str) {
if (!strcmp(str, "json")) {
return ACLK_ENC_JSON;
}
if (!strcmp(str, "proto")) {
return ACLK_ENC_PROTO;
}
return ACLK_ENC_UNKNOWN;
}
aclk_transport_type_t aclk_transport_type_t_from_str(const char *str) {
if (!strcmp(str, "MQTTv3")) {
return ACLK_TRP_MQTT_3_1_1;
}
if (!strcmp(str, "MQTTv5")) {
return ACLK_TRP_MQTT_5;
}
return ACLK_TRP_UNKNOWN;
}
void aclk_transport_desc_t_destroy(aclk_transport_desc_t *trp_desc) {
freez(trp_desc->endpoint);
}
void aclk_env_t_destroy(aclk_env_t *env) {
freez(env->auth_endpoint);
if (env->transports) {
for (size_t i = 0; i < env->transport_count; i++) {
if(env->transports[i]) {
aclk_transport_desc_t_destroy(env->transports[i]);
env->transports[i] = NULL;
}
}
freez(env->transports);
}
if (env->capabilities) {
for (size_t i = 0; i < env->capability_count; i++)
freez(env->capabilities[i]);
freez(env->capabilities);
}
}
#ifdef ACLK_LOG_CONVERSATION_DIR
volatile int aclk_conversation_log_counter = 0;
#if !defined(HAVE_C___ATOMIC) || defined(NETDATA_NO_ATOMIC_INSTRUCTIONS)
netdata_mutex_t aclk_conversation_log_mutex = NETDATA_MUTEX_INITIALIZER;
int aclk_get_conv_log_next()
{
int ret;
netdata_mutex_lock(&aclk_conversation_log_mutex);
ret = aclk_conversation_log_counter++;
netdata_mutex_unlock(&aclk_conversation_log_mutex);
return ret;
}
#endif
#endif
#define ACLK_TOPIC_PREFIX "/agent/"
struct aclk_topic {
enum aclk_topics topic_id;
// as received from cloud - we keep this for
// eventual topic list update when claim_id changes
char *topic_recvd;
// constructed topic
char *topic;
};
// This helps to cache finalized topics (assembled with claim_id)
// to not have to alloc or create buffer and construct topic every
// time message is sent as in old ACLK
static struct aclk_topic **aclk_topic_cache = NULL;
static size_t aclk_topic_cache_items = 0;
void free_topic_cache(void)
{
if (aclk_topic_cache) {
for (size_t i = 0; i < aclk_topic_cache_items; i++) {
freez(aclk_topic_cache[i]->topic);
freez(aclk_topic_cache[i]->topic_recvd);
freez(aclk_topic_cache[i]);
}
freez(aclk_topic_cache);
aclk_topic_cache = NULL;
aclk_topic_cache_items = 0;
}
}
#define JSON_TOPIC_KEY_TOPIC "topic"
#define JSON_TOPIC_KEY_NAME "name"
struct topic_name {
enum aclk_topics id;
// cloud name - how is it called
// in answer to /password endpoint
const char *name;
} topic_names[] = {
{ .id = ACLK_TOPICID_CHART, .name = "chart" },
{ .id = ACLK_TOPICID_ALARMS, .name = "alarms" },
{ .id = ACLK_TOPICID_METADATA, .name = "meta" },
{ .id = ACLK_TOPICID_COMMAND, .name = "inbox-cmd" },
{ .id = ACLK_TOPICID_UNKNOWN, .name = NULL }
};
enum aclk_topics compulsory_topics[] = {
ACLK_TOPICID_CHART,
ACLK_TOPICID_ALARMS,
ACLK_TOPICID_METADATA,
ACLK_TOPICID_COMMAND,
ACLK_TOPICID_UNKNOWN
};
static enum aclk_topics topic_name_to_id(const char *name) {
struct topic_name *topic = topic_names;
while (topic->name) {
if (!strcmp(topic->name, name)) {
return topic->id;
}
topic++;
}
return ACLK_TOPICID_UNKNOWN;
}
static const char *topic_id_to_name(enum aclk_topics tid) {
struct topic_name *topic = topic_names;
while (topic->name) {
if (topic->id == tid)
return topic->name;
topic++;
}
return "unknown";
}
#define CLAIM_ID_REPLACE_TAG "#{claim_id}"
static void topic_generate_final(struct aclk_topic *t) {
char *dest;
char *replace_tag = strstr(t->topic_recvd, CLAIM_ID_REPLACE_TAG);
if (!replace_tag)
return;
rrdhost_aclk_state_lock(localhost);
if (unlikely(!localhost->aclk_state.claimed_id)) {
error("This should never be called if agent not claimed");
rrdhost_aclk_state_unlock(localhost);
return;
}
t->topic = mallocz(strlen(t->topic_recvd) + 1 - strlen(CLAIM_ID_REPLACE_TAG) + strlen(localhost->aclk_state.claimed_id));
memcpy(t->topic, t->topic_recvd, replace_tag - t->topic_recvd);
dest = t->topic + (replace_tag - t->topic_recvd);
memcpy(dest, localhost->aclk_state.claimed_id, strlen(localhost->aclk_state.claimed_id));
dest += strlen(localhost->aclk_state.claimed_id);
rrdhost_aclk_state_unlock(localhost);
replace_tag += strlen(CLAIM_ID_REPLACE_TAG);
strcpy(dest, replace_tag);
dest += strlen(replace_tag);
*dest = 0;
}
static int topic_cache_add_topic(struct json_object *json, struct aclk_topic *topic)
{
struct json_object_iterator it;
struct json_object_iterator itEnd;
it = json_object_iter_begin(json);
itEnd = json_object_iter_end(json);
while (!json_object_iter_equal(&it, &itEnd)) {
if (!strcmp(json_object_iter_peek_name(&it), JSON_TOPIC_KEY_NAME)) {
if (json_object_get_type(json_object_iter_peek_value(&it)) != json_type_string) {
error("topic dictionary key \"" JSON_TOPIC_KEY_NAME "\" is expected to be json_type_string");
return 1;
}
topic->topic_id = topic_name_to_id(json_object_get_string(json_object_iter_peek_value(&it)));
if (topic->topic_id == ACLK_TOPICID_UNKNOWN) {
info("topic dictionary has unknown topic name \"%s\"", json_object_get_string(json_object_iter_peek_value(&it)));
}
json_object_iter_next(&it);
continue;
}
if (!strcmp(json_object_iter_peek_name(&it), JSON_TOPIC_KEY_TOPIC)) {
if (json_object_get_type(json_object_iter_peek_value(&it)) != json_type_string) {
error("topic dictionary key \"" JSON_TOPIC_KEY_TOPIC "\" is expected to be json_type_string");
return 1;
}
topic->topic_recvd = strdupz(json_object_get_string(json_object_iter_peek_value(&it)));
json_object_iter_next(&it);
continue;
}
error("topic dictionary has Unknown/Unexpected key \"%s\" in topic description. Ignoring!", json_object_iter_peek_name(&it));
json_object_iter_next(&it);
}
if (!topic->topic_recvd) {
error("topic dictionary Missig compulsory key %s", JSON_TOPIC_KEY_TOPIC);
return 1;
}
topic_generate_final(topic);
aclk_topic_cache_items++;
return 0;
}
int aclk_generate_topic_cache(struct json_object *json)
{
json_object *obj;
size_t array_size = json_object_array_length(json);
if (!array_size) {
error("Empty topic list!");
return 1;
}
if (aclk_topic_cache)
free_topic_cache();
aclk_topic_cache = callocz(array_size, sizeof(struct aclk_topic *));
for (size_t i = 0; i < array_size; i++) {
obj = json_object_array_get_idx(json, i);
if (json_object_get_type(obj) != json_type_object) {
error("expected json_type_object");
return 1;
}
aclk_topic_cache[i] = callocz(1, sizeof(struct aclk_topic));
if (topic_cache_add_topic(obj, aclk_topic_cache[i])) {
error("failed to parse topic @idx=%d", (int)i);
return 1;
}
}
for (int i = 0; compulsory_topics[i] != ACLK_TOPICID_UNKNOWN; i++) {
if (!aclk_get_topic(compulsory_topics[i])) {
error("missing compulsory topic \"%s\" in password response from cloud", topic_id_to_name(compulsory_topics[i]));
return 1;
}
}
return 0;
}
/*
* Build a topic based on sub_topic and final_topic
* if the sub topic starts with / assume that is an absolute topic
*
*/
const char *aclk_get_topic(enum aclk_topics topic)
{
if (!aclk_topic_cache) {
error("Topic cache not initialized");
return NULL;
}
for (size_t i = 0; i < aclk_topic_cache_items; i++) {
if (aclk_topic_cache[i]->topic_id == topic)
return aclk_topic_cache[i]->topic;
}
error("Unknown topic");
return NULL;
}
/*
* TBEB with randomness
*
* @param reset 1 - to reset the delay,
* 0 - to advance a step and calculate sleep time in ms
* @param min, max in seconds
* @returns delay in ms
*
*/
unsigned long int aclk_tbeb_delay(int reset, int base, unsigned long int min, unsigned long int max) {
static int attempt = -1;
if (reset) {
attempt = -1;
return 0;
}
attempt++;
if (attempt == 0) {
srandom(time(NULL));
return 0;
}
unsigned long int delay = pow(base, attempt - 1);
delay *= MSEC_PER_SEC;
delay += (random() % (MAX(1000, delay/2)));
if (delay <= min * MSEC_PER_SEC)
return min;
if (delay >= max * MSEC_PER_SEC)
return max;
return delay;
}
#define ACLK_PROXY_PROTO_ADDR_SEPARATOR "://"
#define ACLK_PROXY_ENV "env"
#define ACLK_PROXY_CONFIG_VAR "proxy"
struct {
ACLK_PROXY_TYPE type;
const char *url_str;
} supported_proxy_types[] = {
{ .type = PROXY_TYPE_SOCKS5, .url_str = "socks5" ACLK_PROXY_PROTO_ADDR_SEPARATOR },
{ .type = PROXY_TYPE_SOCKS5, .url_str = "socks5h" ACLK_PROXY_PROTO_ADDR_SEPARATOR },
{ .type = PROXY_TYPE_HTTP, .url_str = "http" ACLK_PROXY_PROTO_ADDR_SEPARATOR },
{ .type = PROXY_TYPE_UNKNOWN, .url_str = NULL },
};
const char *aclk_proxy_type_to_s(ACLK_PROXY_TYPE *type)
{
switch (*type) {
case PROXY_DISABLED:
return "disabled";
case PROXY_TYPE_HTTP:
return "HTTP";
case PROXY_TYPE_SOCKS5:
return "SOCKS";
default:
return "Unknown";
}
}
static inline ACLK_PROXY_TYPE aclk_find_proxy(const char *string)
{
int i = 0;
while (supported_proxy_types[i].url_str) {
if (!strncmp(supported_proxy_types[i].url_str, string, strlen(supported_proxy_types[i].url_str)))
return supported_proxy_types[i].type;
i++;
}
return PROXY_TYPE_UNKNOWN;
}
ACLK_PROXY_TYPE aclk_verify_proxy(const char *string)
{
if (!string)
return PROXY_TYPE_UNKNOWN;
while (*string == 0x20 && *string!=0) // Help coverity (compiler will remove)
string++;
if (!*string)
return PROXY_TYPE_UNKNOWN;
return aclk_find_proxy(string);
}
// helper function to censor user&password
// for logging purposes
void safe_log_proxy_censor(char *proxy)
{
size_t length = strlen(proxy);
char *auth = proxy + length - 1;
char *cur;
while ((auth >= proxy) && (*auth != '@'))
auth--;
//if not found or @ is first char do nothing
if (auth <= proxy)
return;
cur = strstr(proxy, ACLK_PROXY_PROTO_ADDR_SEPARATOR);
if (!cur)
cur = proxy;
else
cur += strlen(ACLK_PROXY_PROTO_ADDR_SEPARATOR);
while (cur < auth) {
*cur = 'X';
cur++;
}
}
static inline void safe_log_proxy_error(char *str, const char *proxy)
{
char *log = strdupz(proxy);
safe_log_proxy_censor(log);
error("%s Provided Value:\"%s\"", str, log);
freez(log);
}
static inline int check_socks_enviroment(const char **proxy)
{
char *tmp = getenv("socks_proxy");
if (!tmp)
return 1;
if (aclk_verify_proxy(tmp) == PROXY_TYPE_SOCKS5) {
*proxy = tmp;
return 0;
}
safe_log_proxy_error(
"Environment var \"socks_proxy\" defined but of unknown format. Supported syntax: \"socks5[h]://[user:pass@]host:ip\".",
tmp);
return 1;
}
static inline int check_http_enviroment(const char **proxy)
{
char *tmp = getenv("http_proxy");
if (!tmp)
return 1;
if (aclk_verify_proxy(tmp) == PROXY_TYPE_HTTP) {
*proxy = tmp;
return 0;
}
safe_log_proxy_error(
"Environment var \"http_proxy\" defined but of unknown format. Supported syntax: \"http[s]://[user:pass@]host:ip\".",
tmp);
return 1;
}
const char *aclk_lws_wss_get_proxy_setting(ACLK_PROXY_TYPE *type)
{
const char *proxy = config_get(CONFIG_SECTION_CLOUD, ACLK_PROXY_CONFIG_VAR, ACLK_PROXY_ENV);
*type = PROXY_DISABLED;
if (strcmp(proxy, "none") == 0)
return proxy;
if (strcmp(proxy, ACLK_PROXY_ENV) == 0) {
if (check_socks_enviroment(&proxy) == 0) {
#ifdef LWS_WITH_SOCKS5
*type = PROXY_TYPE_SOCKS5;
return proxy;
#else
safe_log_proxy_error("socks_proxy environment variable set to use SOCKS5 proxy "
"but Libwebsockets used doesn't have SOCKS5 support built in. "
"Ignoring and checking for other options.",
proxy);
#endif
}
if (check_http_enviroment(&proxy) == 0)
*type = PROXY_TYPE_HTTP;
return proxy;
}
*type = aclk_verify_proxy(proxy);
#ifndef LWS_WITH_SOCKS5
if (*type == PROXY_TYPE_SOCKS5) {
safe_log_proxy_error(
"Config var \"" ACLK_PROXY_CONFIG_VAR
"\" set to use SOCKS5 proxy but Libwebsockets used is built without support for SOCKS proxy. ACLK will be disabled.",
proxy);
}
#endif
if (*type == PROXY_TYPE_UNKNOWN) {
*type = PROXY_DISABLED;
safe_log_proxy_error(
"Config var \"" ACLK_PROXY_CONFIG_VAR
"\" defined but of unknown format. Supported syntax: \"socks5[h]://[user:pass@]host:ip\".",
proxy);
}
return proxy;
}
// helper function to read settings only once (static)
// as claiming, challenge/response and ACLK
// read the same thing, no need to parse again
const char *aclk_get_proxy(ACLK_PROXY_TYPE *type)
{
static const char *proxy = NULL;
static ACLK_PROXY_TYPE proxy_type = PROXY_NOT_SET;
if (proxy_type == PROXY_NOT_SET)
proxy = aclk_lws_wss_get_proxy_setting(&proxy_type);
*type = proxy_type;
return proxy;
}
#define HTTP_PROXY_PREFIX "http://"
void aclk_set_proxy(char **ohost, int *port, enum mqtt_wss_proxy_type *type)
{
ACLK_PROXY_TYPE pt;
const char *ptr = aclk_get_proxy(&pt);
char *tmp;
char *host;
if (pt != PROXY_TYPE_HTTP)
return;
*port = 0;
if (!strncmp(ptr, HTTP_PROXY_PREFIX, strlen(HTTP_PROXY_PREFIX)))
ptr += strlen(HTTP_PROXY_PREFIX);
if ((tmp = strchr(ptr, '@')))
ptr = tmp;
if ((tmp = strchr(ptr, '/'))) {
host = mallocz((tmp - ptr) + 1);
memcpy(host, ptr, (tmp - ptr));
host[tmp - ptr] = 0;
} else
host = strdupz(ptr);
if ((tmp = strchr(host, ':'))) {
*tmp = 0;
tmp++;
*port = atoi(tmp);
}
if (*port <= 0 || *port > 65535)
*port = 8080;
*ohost = host;
if (type)
*type = MQTT_WSS_PROXY_HTTP;
}