user_agent.c File Reference

Functions to set and get the User-Agent. More...

#include "user_agent.h"
#include "ipc_openvas.h"
#include "plugutils.h"
#include "vendorversion.h"
#include <glib.h>
#include <gvm/base/prefs.h>

Include dependency graph for user_agent.c:

Go to the source code of this file.

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

Functions
static int	send_user_agent_via_ipc (struct ipc_context *ipc_context)
static void	user_agent_create (void)
	Create and set the global User-Agent variable.
gchar *	user_agent_set (const gchar *ua)
	Set user-agent.
int	user_agent_get (struct ipc_context *ipc_context, char **useragent)
	Get user-agent.

Variables
static gchar *	user_agent = NULL
	user-agent, or NULL.

Detailed Description

Functions to set and get the User-Agent.

Definition in file user_agent.c.

Macro Definition Documentation

G_LOG_DOMAIN

#define G_LOG_DOMAIN   "lib misc"

GLib logging domain.

Definition at line 24 of file user_agent.c.

Function Documentation

send_user_agent_via_ipc()

int send_user_agent_via_ipc ( struct ipc_context * ipc_context )

static

Definition at line 32 of file user_agent.c.

{
  struct ipc_data *ua = NULL;
  const char *json = NULL;
  int ret = 0;
  ua = ipc_data_type_from_user_agent (user_agent, strlen (user_agent));
  json = ipc_data_to_json (ua);
  ipc_data_destroy (&ua);
  ret = ipc_send (ipc_context, IPC_MAIN, json, strlen (json));
  if (-1 == ret)
    {
      g_warning ("Unable to send %s to host process", user_agent);
    }
  return ret;
}

References ipc_data_destroy(), ipc_data_to_json(), ipc_data_type_from_user_agent(), IPC_MAIN, ipc_send(), and user_agent.

Referenced by user_agent_get().

Here is the call graph for this function:

Here is the caller graph for this function:

user_agent_create()

void user_agent_create ( void )

static

Create and set the global User-Agent variable.

@description Gets the User-Agent from the globals_settings.nasl script preferences. If it is not set, it uses the Vendor version. In case that there is no Vendor version, it creates one with a fix string and the nasl library version.

Definition at line 57 of file user_agent.c.

{
  gchar *ua = NULL;
 
  ua = get_plugin_preference ("1.3.6.1.4.1.25623.1.0.12288", "HTTP User-Agent",
                              -1);
  if (!ua || strlen (g_strstrip (ua)) == 0)
    {
      g_free (ua);
      if (!vendor_version_get () || *vendor_version_get () == '\0')
        ua = g_strdup_printf ("Mozilla/5.0 [en] (X11, U; OpenVAS-VT %s)",
                              OPENVAS_MISC_VERSION);
      else
        ua = g_strdup_printf ("Mozilla/5.0 [en] (X11, U; %s)",
                              vendor_version_get ());
    }
 
  user_agent = ua;
}

References get_plugin_preference(), user_agent, and vendor_version_get().

Referenced by user_agent_get().

Here is the call graph for this function:

Here is the caller graph for this function:

user_agent_get()

int user_agent_get	(	struct ipc_context *	ipc_context,
		char **	useragent )

Get user-agent.

param[in] ipc_context IPC context for sending data to the parent process param[out] useragent the user agent if any set or an empty string.

Returns

0 on success, -1 on error when sending the message, -2 if the context does not exists

Definition at line 114 of file user_agent.c.

{
  int ret = 0;
  if (!user_agent || user_agent[0] == '\0')
    {
      user_agent_create ();
      ret = send_user_agent_via_ipc (ipc_context);
    }
 
  *useragent = user_agent ? g_strdup (user_agent) : "";
  return ret;
}

References send_user_agent_via_ipc(), user_agent, and user_agent_create().

Referenced by _http2_req(), and _http_req().

Here is the call graph for this function:

Here is the caller graph for this function:

user_agent_set()

gchar * user_agent_set

(

const gchar *

ua

)

Set user-agent.

Set the global user agent. This function overwrite the existing UA. Null or empty string are not allowed.

Parameters

[in]

ua

user-agent to be set.

Return the old User-Agent. It must be free by the caller

Definition at line 89 of file user_agent.c.

{
  gchar *ua_aux = NULL;
 
  ua_aux = g_strdup (user_agent);
 
  if (ua != NULL && ua[0] != '\0')
    {
      g_free (user_agent);
      user_agent = g_strdup (ua);
    }
 
  return ua_aux;
}

References user_agent.

Referenced by process_ipc_data().

Here is the caller graph for this function:

Variable Documentation

user_agent

gchar* user_agent = NULL

static

user-agent, or NULL.

Definition at line 29 of file user_agent.c.

Referenced by ipc_data_type_from_user_agent(), ipc_get_lsc_os_release_from_data(), send_user_agent_via_ipc(), user_agent_create(), user_agent_get(), and user_agent_set().