1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
|
/* SPDX-FileCopyrightText: 2023 Greenbone AG
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "ipc_openvas.h"
#include <json-glib/json-glib.h>
#undef G_LOG_DOMAIN
/**
* @brief GLib logging domain.
*/
#define G_LOG_DOMAIN "lib misc"
// Data types definitions
// ipc_hostname is used to send / retrieve new hostnames.
struct ipc_hostname
{
char *source; // source value
char *hostname; // hostname value
size_t source_len; // length of source
size_t hostname_len; // length of hostname
};
typedef struct ipc_hostname ipc_hostname_t;
// ipc_user_agent is used to send / retrieve the User-Agent.
struct ipc_user_agent
{
char *user_agent; // user_agent value
size_t user_agent_len; // length of user_agent
};
typedef struct ipc_user_agent ipc_user_agent_t;
// ipc_lsc is used to send / retrieve the table driven LSC data.
struct ipc_lsc
{
gboolean data_ready; // flag indicating that lsc data is in the kb
};
typedef struct ipc_lsc ipc_lsc_t;
// ipc_data is used to send / retrieve a given data of the union member
struct ipc_data
{
enum ipc_data_type type;
union
{
ipc_user_agent_t *ipc_user_agent;
ipc_hostname_t *ipc_hostname;
ipc_lsc_t *ipc_lsc;
};
};
// Functions to access the structures
/**
* @brief Get the data type in data
*
* @param data Structure containing the data and data type
*
* @Return The corresponding ipc_data_type, IPC_DT_ERROR on error.
*/
enum ipc_data_type
ipc_get_data_type_from_data (ipc_data_t *data)
{
if (data != NULL)
return data->type;
return IPC_DT_ERROR;
}
/**
* @brief Get the hostname from IPC data
*
* @param data Data structure of IPC_DT_HOSNAME type.
*
* @Return a string containing the hostname, NULL on error.
*/
gchar *
ipc_get_hostname_from_data (ipc_data_t *data)
{
if (data == NULL || (ipc_get_data_type_from_data (data) != IPC_DT_HOSTNAME))
return NULL;
return data->ipc_hostname->hostname;
}
/**
* @brief Get the vhost hostname source from IPC data.
*
* @param data Data structure of IPC_DT_HOSNAME type.
*
* @Return a string containing the vhost hostname source, NULL on error.
*/
gchar *
ipc_get_hostname_source_from_data (ipc_data_t *data)
{
if (data == NULL || (ipc_get_data_type_from_data (data) != IPC_DT_HOSTNAME))
return NULL;
return data->ipc_hostname->source;
}
/**
* @brief Get the User-Agent from IPC data
*
* @param data Data structure of IPC_DT_USER_AGENT type.
*
* @Return a string containing the User-Agent, NULL on error.
*/
gchar *
ipc_get_user_agent_from_data (ipc_data_t *data)
{
if (data == NULL || (ipc_get_data_type_from_data (data) != IPC_DT_USER_AGENT))
return NULL;
return data->ipc_user_agent->user_agent;
}
/**
* @brief Get the package list from LSC IPC data
*
* @param data Data structure of IPC_DT_LSC type.
*
* @Return True if the data is ready for running with LSC, False otherwise.
*/
gboolean
ipc_get_lsc_data_ready_flag (ipc_data_t *data)
{
if (data == NULL || (ipc_get_data_type_from_data (data) != IPC_DT_LSC))
return FALSE;
return data->ipc_lsc->data_ready;
}
// Hostname
/**
* @brief initializes ipc_data for a hostname data.
*
* @param source the source of the hostname
* @param hostname the name of the host
*
* @return a heap initialized ipc_data or NULL on failure.
*/
ipc_data_t *
ipc_data_type_from_hostname (const char *source, size_t source_len,
const char *hostname, size_t hostname_len)
{
ipc_data_t *data = NULL;
ipc_hostname_t *hnd = NULL;
if (source == NULL || hostname == NULL)
return NULL;
if ((data = calloc (1, sizeof (*data))) == NULL)
return NULL;
data->type = IPC_DT_HOSTNAME;
if ((hnd = calloc (1, sizeof (*hnd))) == NULL)
goto failure_exit;
hnd->hostname = g_strdup (hostname);
hnd->source = g_strdup (source);
hnd->hostname_len = hostname_len;
hnd->source_len = source_len;
data->ipc_hostname = hnd;
return data;
failure_exit:
free (data);
return NULL;
}
/**
* @brief Free ipc_hostname_t data
*
* @param data The hostname data structure to be free()'ed
*/
static void
ipc_hostname_destroy (ipc_hostname_t *data)
{
if (data == NULL)
return;
g_free (data->hostname);
g_free (data->source);
g_free (data);
}
// User-Agent
/**
* @brief initializes ipc_data for the User-Agent.
*
* @param user_agent The User-Agent
* @param user_agent_len Length of the user agent string.
*
* @return a heap initialized ipc_data or NULL on failure.
*/
ipc_data_t *
ipc_data_type_from_user_agent (const char *user_agent, size_t user_agent_len)
{
ipc_data_t *data = NULL;
ipc_user_agent_t *uad = NULL;
gchar *ua_str = NULL;
if (user_agent == NULL)
return NULL;
if ((data = calloc (1, sizeof (*data))) == NULL)
return NULL;
data->type = IPC_DT_USER_AGENT;
if ((uad = calloc (1, sizeof (*uad))) == NULL)
goto failure_exit;
ua_str = g_strdup (user_agent);
uad->user_agent = ua_str;
uad->user_agent_len = user_agent_len;
data->ipc_user_agent = uad;
return data;
failure_exit:
free (data);
return NULL;
}
/**
* @brief Free a user agent data structure
*
* @param data The user agent data structure to be free()'ed
*/
static void
ipc_user_agent_destroy (ipc_user_agent_t *data)
{
if (data == NULL)
return;
g_free (data->user_agent);
g_free (data);
}
// Table driven LSC
/**
* @brief initializes ipc_data for the table driven LSC.
*
* @param os_release The OS release
*
* @return a heap initialized ipc_data or NULL on failure.
*/
ipc_data_t *
ipc_data_type_from_lsc (gboolean data_ready)
{
ipc_data_t *data = NULL;
ipc_lsc_t *lscd = NULL;
if (data_ready != FALSE && data_ready != TRUE)
return NULL;
if ((data = calloc (1, sizeof (*data))) == NULL)
return NULL;
data->type = IPC_DT_LSC;
if ((lscd = calloc (1, sizeof (*lscd))) == NULL)
goto failure_exit;
lscd->data_ready = data_ready;
data->ipc_lsc = lscd;
return data;
failure_exit:
free (data);
return NULL;
}
/**
* @brief Free a LSC data structure
*
* @param data The lsc data structure to be free()'ed
*/
static void
ipc_lsc_destroy (ipc_lsc_t *data)
{
g_free (data);
}
// General IPC data functios
/**
* @brief destroys ipc_data.
*
* @param data the ipc_data to be destroyed.
*
*/
void
ipc_data_destroy (ipc_data_t **data)
{
if (*data == NULL)
return;
switch ((*data)->type)
{
case IPC_DT_HOSTNAME:
ipc_hostname_destroy ((*data)->ipc_hostname);
break;
case IPC_DT_USER_AGENT:
ipc_user_agent_destroy ((*data)->ipc_user_agent);
break;
case IPC_DT_LSC:
ipc_lsc_destroy ((*data)->ipc_lsc);
break;
case IPC_DT_ERROR:
case IPC_DT_NO_DATA:
break;
}
g_free (*data);
*data = NULL;
}
/**
* @brief transforms ipc_data to a json string
*
* @param data the ipc_data to be transformed.
*
* @return a heap allocated achar array containing the json or NULL on failure.
*/
const char *
ipc_data_to_json (ipc_data_t *data)
{
JsonBuilder *builder;
JsonGenerator *gen;
JsonNode *root;
gchar *json_str;
ipc_hostname_t *hn = NULL;
ipc_user_agent_t *ua = NULL;
ipc_lsc_t *lsc = NULL;
enum ipc_data_type type = IPC_DT_ERROR;
if (data == NULL)
return NULL;
if ((type = ipc_get_data_type_from_data (data)) == IPC_DT_ERROR)
return NULL;
builder = json_builder_new ();
json_builder_begin_object (builder);
json_builder_set_member_name (builder, "type");
builder = json_builder_add_int_value (builder, type);
switch (type)
{
case IPC_DT_HOSTNAME:
hn = data->ipc_hostname;
json_builder_set_member_name (builder, "source");
builder = json_builder_add_string_value (builder, hn->source);
json_builder_set_member_name (builder, "hostname");
builder = json_builder_add_string_value (builder, hn->hostname);
break;
case IPC_DT_USER_AGENT:
ua = data->ipc_user_agent;
json_builder_set_member_name (builder, "user-agent");
builder = json_builder_add_string_value (builder, ua->user_agent);
break;
case IPC_DT_LSC:
lsc = data->ipc_lsc;
json_builder_set_member_name (builder, "data_ready");
builder = json_builder_add_boolean_value (builder, lsc->data_ready);
break;
default:
g_warning ("%s: Unknown data type %d.", __func__, type);
}
json_builder_end_object (builder);
gen = json_generator_new ();
root = json_builder_get_root (builder);
json_generator_set_root (gen, root);
json_str = json_generator_to_data (gen, NULL);
json_node_free (root);
g_object_unref (gen);
g_object_unref (builder);
if (json_str == NULL)
g_warning ("%s: Error while creating JSON.", __func__);
return json_str;
}
/**
* @brief transforms json string to a ipc_data struct
*
* @param json the json representation to be transformed.
* @param len the length of the json representation
*
* @return a heap allocated ipc_data or NULL on failure.
*/
ipc_data_t *
ipc_data_from_json (const char *json, size_t len)
{
JsonParser *parser = NULL;
JsonReader *reader = NULL;
GError *err = NULL;
ipc_data_t *ret = NULL;
ipc_user_agent_t *ua;
ipc_hostname_t *hn;
ipc_lsc_t *lsc;
enum ipc_data_type type = IPC_DT_ERROR;
if ((ret = calloc (1, sizeof (*ret))) == NULL)
goto cleanup;
/* Initialize the type with error.
* Usefull for cleanup, in case of parser error. */
ret->type = type;
parser = json_parser_new ();
if (!json_parser_load_from_data (parser, json, len, &err))
{
goto cleanup;
}
reader = json_reader_new (json_parser_get_root (parser));
if (!json_reader_read_member (reader, "type"))
{
goto cleanup;
}
type = json_reader_get_int_value (reader);
ret->type = type;
json_reader_end_member (reader);
switch (type)
{
case IPC_DT_ERROR:
case IPC_DT_NO_DATA:
goto cleanup;
case IPC_DT_HOSTNAME:
if ((hn = calloc (1, sizeof (*hn))) == NULL)
goto cleanup;
if (!json_reader_read_member (reader, "hostname"))
{
g_free (hn);
goto cleanup;
}
hn->hostname = g_strdup (json_reader_get_string_value (reader));
hn->hostname_len = strlen (hn->hostname);
json_reader_end_member (reader);
if (!json_reader_read_member (reader, "source"))
{
ipc_hostname_destroy (hn);
goto cleanup;
}
hn->source = g_strdup (json_reader_get_string_value (reader));
hn->source_len = strlen (hn->source);
json_reader_end_member (reader);
ret->ipc_hostname = hn;
break;
case IPC_DT_USER_AGENT:
if ((ua = calloc (1, sizeof (*ua))) == NULL)
goto cleanup;
if (!json_reader_read_member (reader, "user-agent"))
{
g_free (ua);
goto cleanup;
}
ua->user_agent = g_strdup (json_reader_get_string_value (reader));
ua->user_agent_len = strlen (ua->user_agent);
json_reader_end_member (reader);
ret->ipc_user_agent = ua;
break;
case IPC_DT_LSC:
if ((lsc = calloc (1, sizeof (*lsc))) == NULL)
goto cleanup;
if (!json_reader_read_member (reader, "data_ready"))
{
goto cleanup;
}
lsc->data_ready = json_reader_get_boolean_value (reader);
json_reader_end_member (reader);
ret->ipc_lsc = lsc;
break;
}
cleanup:
if (reader)
g_object_unref (reader);
g_object_unref (parser);
if (err != NULL)
{
g_warning ("%s: Unable to parse json (%s). Reason: %s", __func__, json,
err->message);
if (ret != NULL)
ipc_data_destroy (&ret);
}
return ret;
}
|