ipc_openvas.c File Reference

#include "ipc_openvas.h"
#include <json-glib/json-glib.h>

Include dependency graph for ipc_openvas.c:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ipc_hostname
struct	ipc_user_agent
struct	ipc_lsc
struct	ipc_data

Macros
#define	G_LOG_DOMAIN   "lib misc"
	GLib logging domain.

Typedefs
typedef struct ipc_hostname	ipc_hostname_t
typedef struct ipc_user_agent	ipc_user_agent_t
typedef struct ipc_lsc	ipc_lsc_t

Functions
enum ipc_data_type	ipc_get_data_type_from_data (ipc_data_t *data)
	Get the data type in data.
gchar *	ipc_get_hostname_from_data (ipc_data_t *data)
	Get the hostname from IPC data.
gchar *	ipc_get_hostname_source_from_data (ipc_data_t *data)
	Get the vhost hostname source from IPC data.
gchar *	ipc_get_user_agent_from_data (ipc_data_t *data)
	Get the User-Agent from IPC data.
gboolean	ipc_get_lsc_data_ready_flag (ipc_data_t *data)
	Get the package list from LSC IPC data.
ipc_data_t *	ipc_data_type_from_hostname (const char *source, size_t source_len, const char *hostname, size_t hostname_len)
	initializes ipc_data for a hostname data.
static void	ipc_hostname_destroy (ipc_hostname_t *data)
	Free ipc_hostname_t data.
ipc_data_t *	ipc_data_type_from_user_agent (const char *user_agent, size_t user_agent_len)
	initializes ipc_data for the User-Agent.
static void	ipc_user_agent_destroy (ipc_user_agent_t *data)
	Free a user agent data structure.
ipc_data_t *	ipc_data_type_from_lsc (gboolean data_ready)
	initializes ipc_data for the table driven LSC.
static void	ipc_lsc_destroy (ipc_lsc_t *data)
	Free a LSC data structure.
void	ipc_data_destroy (ipc_data_t **data)
	destroys ipc_data.
const char *	ipc_data_to_json (ipc_data_t *data)
	transforms ipc_data to a json string
ipc_data_t *	ipc_data_from_json (const char *json, size_t len)
	transforms json string to a ipc_data struct

Macro Definition Documentation

G_LOG_DOMAIN

#define G_LOG_DOMAIN   "lib misc"

GLib logging domain.

Definition at line 13 of file ipc_openvas.c.

Typedef Documentation

ipc_hostname_t

typedef struct ipc_hostname ipc_hostname_t

Definition at line 26 of file ipc_openvas.c.

ipc_lsc_t

typedef struct ipc_lsc ipc_lsc_t

Definition at line 43 of file ipc_openvas.c.

ipc_user_agent_t

typedef struct ipc_user_agent ipc_user_agent_t

Definition at line 35 of file ipc_openvas.c.

Function Documentation

ipc_data_destroy()

void ipc_data_destroy

(

ipc_data_t **

data

)

destroys ipc_data.

Parameters

data	the ipc_data to be destroyed.

Definition at line 294 of file ipc_openvas.c.

{
  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;
}

References IPC_DT_ERROR, IPC_DT_HOSTNAME, IPC_DT_LSC, IPC_DT_NO_DATA, IPC_DT_USER_AGENT, ipc_hostname_destroy(), ipc_lsc_destroy(), and ipc_user_agent_destroy().

Referenced by add_hostname(), Ensure(), Ensure(), Ensure(), ipc_data_from_json(), nasl_update_table_driven_lsc_data(), process_ipc_data(), and send_user_agent_via_ipc().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_data_from_json()

ipc_data_t * ipc_data_from_json	(	const char *	json,
		size_t	len )

transforms json string to a ipc_data struct

Parameters

json	the json representation to be transformed.
len	the length of the json representation

Returns

a heap allocated ipc_data or NULL on failure.

Definition at line 400 of file ipc_openvas.c.

{
  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;
}

References ipc_lsc::data_ready, ipc_hostname::hostname, ipc_hostname::hostname_len, ipc_data_destroy(), IPC_DT_ERROR, IPC_DT_HOSTNAME, IPC_DT_LSC, IPC_DT_NO_DATA, IPC_DT_USER_AGENT, ipc_data::ipc_hostname, ipc_hostname_destroy(), ipc_data::ipc_lsc, ipc_data::ipc_user_agent, len, ipc_hostname::source, ipc_hostname::source_len, ipc_data::type, ipc_user_agent::user_agent, and ipc_user_agent::user_agent_len.

Referenced by Ensure(), Ensure(), Ensure(), Ensure(), and process_ipc_data().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_data_to_json()

const char * ipc_data_to_json

(

ipc_data_t *

data

)

transforms ipc_data to a json string

Parameters

data	the ipc_data to be transformed.

Returns

a heap allocated achar array containing the json or NULL on failure.

Definition at line 325 of file ipc_openvas.c.

{
  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;
}

References ipc_lsc::data_ready, ipc_hostname::hostname, IPC_DT_ERROR, IPC_DT_HOSTNAME, IPC_DT_LSC, IPC_DT_USER_AGENT, ipc_get_data_type_from_data(), ipc_data::ipc_hostname, ipc_data::ipc_lsc, ipc_data::ipc_user_agent, ipc_hostname::source, and ipc_user_agent::user_agent.

Referenced by add_hostname(), Ensure(), Ensure(), nasl_update_table_driven_lsc_data(), and send_user_agent_via_ipc().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_data_type_from_hostname()

ipc_data_t * ipc_data_type_from_hostname	(	const char *	source,
		size_t	source_len,
		const char *	hostname,
		size_t	hostname_len )

initializes ipc_data for a hostname data.

Parameters

source	the source of the hostname
hostname	the name of the host

Returns

a heap initialized ipc_data or NULL on failure.

Definition at line 149 of file ipc_openvas.c.

{
  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;
}

References free(), hostname, ipc_hostname::hostname, ipc_hostname::hostname_len, IPC_DT_HOSTNAME, ipc_data::ipc_hostname, ipc_hostname::source, ipc_hostname::source_len, and ipc_data::type.

Referenced by add_hostname(), and Ensure().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_data_type_from_lsc()

ipc_data_t * ipc_data_type_from_lsc

(

gboolean

data_ready

)

initializes ipc_data for the table driven LSC.

Parameters

os_release

The OS release

Returns

a heap initialized ipc_data or NULL on failure.

Definition at line 250 of file ipc_openvas.c.

{
  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;
}

References ipc_lsc::data_ready, free(), IPC_DT_LSC, ipc_data::ipc_lsc, and ipc_data::type.

Referenced by nasl_update_table_driven_lsc_data().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_data_type_from_user_agent()

ipc_data_t * ipc_data_type_from_user_agent	(	const char *	user_agent,
		size_t	user_agent_len )

initializes ipc_data for the User-Agent.

Parameters

user_agent	The User-Agent
user_agent_len	Length of the user agent string.

Returns

a heap initialized ipc_data or NULL on failure.

Definition at line 198 of file ipc_openvas.c.

{
  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;
}

References free(), IPC_DT_USER_AGENT, ipc_data::ipc_user_agent, ipc_data::type, ipc_user_agent::user_agent, user_agent, and ipc_user_agent::user_agent_len.

Referenced by Ensure(), and send_user_agent_via_ipc().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_get_data_type_from_data()

enum ipc_data_type ipc_get_data_type_from_data

(

ipc_data_t *

data

)

Get the data type in data.

Parameters

data	Structure containing the data and data type

@Return The corresponding ipc_data_type, IPC_DT_ERROR on error.

Definition at line 67 of file ipc_openvas.c.

{
  if (data != NULL)
    return data->type;
  return IPC_DT_ERROR;
}

References IPC_DT_ERROR, and ipc_data::type.

Referenced by Ensure(), ipc_data_to_json(), ipc_get_hostname_from_data(), ipc_get_hostname_source_from_data(), ipc_get_lsc_data_ready_flag(), ipc_get_user_agent_from_data(), and process_ipc_data().

Here is the caller graph for this function:

ipc_get_hostname_from_data()

gchar * ipc_get_hostname_from_data

(

ipc_data_t *

data

)

Get the hostname from IPC data.

Parameters

data	Data structure of IPC_DT_HOSNAME type.

@Return a string containing the hostname, NULL on error.

Definition at line 82 of file ipc_openvas.c.

{
  if (data == NULL || (ipc_get_data_type_from_data (data) != IPC_DT_HOSTNAME))
    return NULL;
 
  return data->ipc_hostname->hostname;
}

References ipc_hostname::hostname, IPC_DT_HOSTNAME, ipc_get_data_type_from_data(), and ipc_data::ipc_hostname.

Referenced by Ensure(), Ensure(), Ensure(), and process_ipc_data().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_get_hostname_source_from_data()

gchar * ipc_get_hostname_source_from_data

(

ipc_data_t *

data

)

Get the vhost hostname source from IPC data.

Parameters

data	Data structure of IPC_DT_HOSNAME type.

@Return a string containing the vhost hostname source, NULL on error.

Definition at line 98 of file ipc_openvas.c.

{
  if (data == NULL || (ipc_get_data_type_from_data (data) != IPC_DT_HOSTNAME))
    return NULL;
 
  return data->ipc_hostname->source;
}

References IPC_DT_HOSTNAME, ipc_get_data_type_from_data(), ipc_data::ipc_hostname, and ipc_hostname::source.

Referenced by Ensure(), Ensure(), Ensure(), and process_ipc_data().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_get_lsc_data_ready_flag()

gboolean ipc_get_lsc_data_ready_flag

(

ipc_data_t *

data

)

Get the package list from LSC IPC data.

Parameters

data	Data structure of IPC_DT_LSC type.

@Return True if the data is ready for running with LSC, False otherwise.

Definition at line 130 of file ipc_openvas.c.

{
  if (data == NULL || (ipc_get_data_type_from_data (data) != IPC_DT_LSC))
    return FALSE;
 
  return data->ipc_lsc->data_ready;
}

References ipc_lsc::data_ready, IPC_DT_LSC, ipc_get_data_type_from_data(), and ipc_data::ipc_lsc.

Referenced by process_ipc_data().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_get_user_agent_from_data()

gchar * ipc_get_user_agent_from_data

(

ipc_data_t *

data

)

Get the User-Agent from IPC data.

Parameters

data	Data structure of IPC_DT_USER_AGENT type.

@Return a string containing the User-Agent, NULL on error.

Definition at line 114 of file ipc_openvas.c.

{
  if (data == NULL || (ipc_get_data_type_from_data (data) != IPC_DT_USER_AGENT))
    return NULL;
 
  return data->ipc_user_agent->user_agent;
}

References IPC_DT_USER_AGENT, ipc_get_data_type_from_data(), ipc_data::ipc_user_agent, and ipc_user_agent::user_agent.

Referenced by Ensure(), Ensure(), and process_ipc_data().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_hostname_destroy()

void ipc_hostname_destroy ( ipc_hostname_t * data )

static

Free ipc_hostname_t data.

Parameters

data	The hostname data structure to be free()'ed

Definition at line 178 of file ipc_openvas.c.

{
  if (data == NULL)
    return;
  g_free (data->hostname);
  g_free (data->source);
  g_free (data);
}

References ipc_hostname::hostname, and ipc_hostname::source.

Referenced by ipc_data_destroy(), and ipc_data_from_json().

Here is the caller graph for this function:

ipc_lsc_destroy()

void ipc_lsc_destroy ( ipc_lsc_t * data )

static

Free a LSC data structure.

Parameters

data	The lsc data structure to be free()'ed

Definition at line 280 of file ipc_openvas.c.

{
  g_free (data);
}

Referenced by ipc_data_destroy().

Here is the caller graph for this function:

ipc_user_agent_destroy()

void ipc_user_agent_destroy ( ipc_user_agent_t * data )

static

Free a user agent data structure.

Parameters

data	The user agent data structure to be free()'ed

Definition at line 232 of file ipc_openvas.c.

{
  if (data == NULL)
    return;
  g_free (data->user_agent);
  g_free (data);
}

References ipc_user_agent::user_agent.

Referenced by ipc_data_destroy().

Here is the caller graph for this function: