Base functionality of GSA. More...

#include "gsad_base.h"
#include <openvas/omp/xml.h>
#include <glib.h>
#include <microhttpd.h>
#include <string.h>
#include <sys/wait.h>
#include <errno.h>

Include dependency graph for gsad_base.c:

Go to the source code of this file.

Macros
#define	XSL_PATH "gsad.xsl"
	Location of XSL file. More...

#define	G_LOG_DOMAIN "gsad base"
	GLib log domain. More...

#define	FAIL_HTML
	HTML returned when XSL transform fails. More...

Functions
int	gsad_base_init ()
	Base init. More...

int	gsad_base_cleanup ()
	Base init. More...

int	get_chroot_state ()
	Gets the chroot state. More...

void	set_chroot_state (int state)
	Sets the chroot state. More...

int	get_http_only ()
	Gets the http_only state. More...

void	set_http_only (int state)
	Sets the http_only state. More...

void	vendor_version_set (const gchar *version)
	Set the vendor version. More...

const gchar *	vendor_version_get ()
	Get the vendor version. More...

const gchar *	label_name_get ()
	Get the login label name. More...

int	label_name_set (const gchar *name)
	Set the login label. More...

void	set_language_code (gchar *lang, const gchar language)
	Set language code of user. More...

char *	ctime_r_strip_newline (time_t time, char string)
	Return string from ctime_r with newline replaces with terminator. More...

char *	xsl_transform_with_stylesheet (const char xml_text, const char xsl_stylesheet, cmd_response_data_t *response_data)
	XSL Transformation. More...

char *	xsl_transform (const char xml_text, cmd_response_data_t response_data)
	XSL Transformation. More...

char *	gsad_message (credentials_t credentials, const char title, const char function, int line, const char msg, const char backurl, cmd_response_data_t response_data)
	Handles fatal errors. More...

gchar *	login_xml (const gchar message, const gchar token, const gchar time, const gchar url, const gchar i18n, const gchar guest)
	Generate XML for login page. More...

params_t *	params_new ()
	Make a params. More...

void	params_free (params_t *params)
	Make a params. More...

param_t *	params_get (params_t params, const char name)
	Get param. More...

int	params_given (params_t params, const char name)
	Get whether a param was given at all. More...

const char *	params_value (params_t params, const char name)
	Get value of param. More...

int	params_value_size (params_t params, const char name)
	Get the size of the value of param. More...

const char *	params_original_value (params_t params, const char name)
	Get original value of param, before validation. More...

const char *	params_filename (params_t params, const char name)
	Get filename of param. More...

params_t *	params_values (params_t params, const char name)
	Get values of param. More...

int	params_valid (params_t params, const char name)
	Get whether a param is valid. More...

param_t *	params_add (params_t params, const char name, const char *value)
	Add a param. More...

param_t *	params_append_bin (params_t params, const char name, const char *chunk_data, int chunk_size, int chunk_offset)
	Append binary data to a param. More...

gboolean	params_iterator_next (params_iterator_t iterator, char name, param_t *param)
	Increment a params iterator. More...

Variables
gchar *	vendor_version = NULL
	Version from vendor, or NULL. More...

gchar *	label_name = NULL

Detailed Description

Base functionality of GSA.

Definition in file gsad_base.c.

Macro Definition Documentation

◆ FAIL_HTML

#define FAIL_HTML

Value:

"<html>"                                                               \
 "<body>"                                                               \
 "An internal server error has occurred during XSL transformation."     \
 "</body>"                                                              \
 "</html>"

HTML returned when XSL transform fails.

Definition at line 262 of file gsad_base.c.

◆ G_LOG_DOMAIN

#define G_LOG_DOMAIN "gsad base"

GLib log domain.

Definition at line 62 of file gsad_base.c.

◆ XSL_PATH

#define XSL_PATH "gsad.xsl"

Location of XSL file.

Definition at line 35 of file gsad_base.c.

Function Documentation

◆ ctime_r_strip_newline()

char* ctime_r_strip_newline	(	time_t *	time,
		char *	string
	)

Return string from ctime_r with newline replaces with terminator.

Parameters

[in]	time	Time.
[out]	string	Time string.

Returns: Return from ctime_r applied to time, with newline stripped off.

Definition at line 241 of file gsad_base.c.

 {
   struct tm *tm;
 
   tm = localtime (time);
   if (tm == NULL
       || (strftime (string,
                     199,
                     "%c %Z",
                     tm)
           == 0))
     {
       string[0] = '\0';
       return string;
     }
   return string;
 }

Referenced by gsad_message(), and logout().

Here is the caller graph for this function:

◆ get_chroot_state()

int get_chroot_state ( )

Gets the chroot state.

Returns: The chroot state: 0 = no chroot, 1 = chroot in effect

Definition at line 119 of file gsad_base.c.

 {
   return chroot_state;
 }

References chroot_state.

◆ get_http_only()

int get_http_only ( )

Gets the http_only state.

Returns: The http_only state: 0 = using HTTPS, 1 = HTTP only

Definition at line 141 of file gsad_base.c.

 {
   return http_only;
 }

Referenced by login_xml().

Here is the caller graph for this function:

◆ gsad_base_cleanup()

int gsad_base_cleanup ( )

Base init.

Returns: 0 success, -1 error.

Definition at line 104 of file gsad_base.c.

 {
 #ifdef USE_LIBXSLT
   xsltCleanupGlobals ();
   xmlCleanupParser ();
 #endif
   return 0;
 }

◆ gsad_base_init()

int gsad_base_init ( )

Base init.

Returns: 0 success, 1 XML needs thread support.

Definition at line 87 of file gsad_base.c.

 {
 #ifdef USE_LIBXSLT
   if (!xmlHasFeature (XML_WITH_THREAD))
     return 1;
   /* Required by libxml for thread safety. */
   xmlInitParser ();
 #endif
   return 0;
 }

◆ gsad_message()

char* gsad_message	(	credentials_t *	credentials,
		const char *	title,
		const char *	function,
		int	line,
		const char *	msg,
		const char *	backurl,
		cmd_response_data_t *	response_data
	)

Handles fatal errors.

Todo:: Make it accept formatted strings.

Parameters

[in]	credentials	User authentication information.
[in]	title	The title for the message.
[in]	function	The function in which the error occurred.
[in]	line	The line number at which the error occurred.
[in]	msg	The response message.
[in]	backurl	The URL offered to get back to a sane situation. If NULL, the tasks page is used.
[out]	response_data	Extra data return for the HTTP response.

Returns: An HTML document as a newly allocated string.

Definition at line 467 of file gsad_base.c.

 {
   gchar *xml, *message, *resp;
   const char* xml_flag;
 
   if (credentials && credentials->params)
     xml_flag = params_value (credentials->params, "xml");
   else
     xml_flag = NULL;
 
   if (function)
     {
       message = g_strdup_printf ("<gsad_response>"
                                  "<title>%s: %s:%i (GSA %s)</title>"
                                  "<message>%s</message>"
                                  "<backurl>%s</backurl>"
                                  "<token>%s</token>"
                                  "</gsad_response>",
                                  title,
                                  function,
                                  line,
                                  GSAD_VERSION,
                                  msg,
                                  backurl ? backurl : "/omp?cmd=get_tasks",
                                  credentials ? credentials->token : "");
     }
   else
     {
       message = g_strdup_printf ("<gsad_response>"
                                  "<title>%s (GSA %s)</title>"
                                  "<message>%s</message>"
                                  "<backurl>%s</backurl>"
                                  "<token>%s</token>"
                                  "</gsad_response>",
                                  title,
                                  GSAD_VERSION,
                                  msg,
                                  backurl ? backurl : "/omp?cmd=get_tasks",
                                  credentials ? credentials->token : "");
     }
 
   if (credentials)
     {
       gchar *pre;
       time_t now;
       char ctime_now[200];
 
       now = time (NULL);
       ctime_r_strip_newline (&now, ctime_now);
 
       pre = g_markup_printf_escaped
               ("<envelope>"
                "<version>%s</version>"
                "<vendor_version>%s</vendor_version>"
                "<token>%s</token>"
                "<time>%s</time>"
                "<login>%s</login>"
                "<role>%s</role>"
                "<i18n>%s</i18n>"
                "<charts>%i</charts>"
                "<client_address>%s</client_address>",
                GSAD_VERSION,
                vendor_version_get (),
                credentials->token,
                ctime_now,
                credentials->username,
                credentials->role,
                credentials->language,
                credentials->charts,
                credentials->client_address);
       xml = g_strdup_printf ("%s%s"
                               "<capabilities>%s</capabilities>"
                               "</envelope>",
                               pre,
                               message,
                               credentials->capabilities);
       g_free (pre);
     }
   else
     {
       xml = g_strdup (message);
     }
   g_free (message);
 
   if (xml_flag && strcmp (xml_flag, "0"))
     return xml;
 
   resp = xsl_transform (xml, response_data);
   if (resp == NULL)
     {
       resp = g_strdup ("<html>"
                        "<body>"
                        "An internal server error has occurred during XSL"
                        " transformation."
                        "</body>"
                        "</html>");
       response_data->http_status_code = MHD_HTTP_INTERNAL_SERVER_ERROR;
     }
   g_free (xml);
   return resp;
 }

References credentials_t::capabilities, credentials_t::charts, credentials_t::client_address, ctime_r_strip_newline(), cmd_response_data_t::http_status_code, credentials_t::language, credentials_t::params, params_value(), credentials_t::role, credentials_t::token, credentials_t::username, vendor_version_get(), and xsl_transform().

Referenced by bulk_delete_omp(), clone_omp(), delete_asset_omp(), delete_resource(), download_agent_omp(), download_ca_pub(), download_credential_omp(), download_key_pub(), download_ssl_cert(), edit_alert(), edit_asset(), edit_note(), edit_override(), edit_resource(), edit_scanner(), edit_tag(), edit_target(), empty_trashcan_omp(), export_omp_doc_omp(), export_preference_file_omp(), get_feeds_omp(), get_info(), get_one(), get_protocol_doc_omp(), get_system_reports_omp(), new_note(), new_override(), process_bulk_omp(), resource_action(), restore_omp(), run_wizard_omp(), save_config_family_omp(), save_config_nvt_omp(), save_config_omp(), save_filter_omp(), test_alert_omp(), toggle_tag_omp(), verify_agent_omp(), and verify_report_format_omp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ label_name_get()

const gchar* label_name_get ( )

Get the login label name.

Returns: login label name

Definition at line 186 of file gsad_base.c.

 {
   return label_name;
 }

References label_name.

Referenced by login_xml().

Here is the caller graph for this function:

◆ label_name_set()

int label_name_set ( const gchar * name )

Set the login label.

Parameters

[in] name New login label name.

Returns: 0 on success -1 if name contains invalid characters

Definition at line 199 of file gsad_base.c.

 {
   if (!g_regex_match_simple ("^[a-zA-Z0-9\\-_\\.\\:]+$", name, 0, 0))
     return -1;
 
   g_free (label_name);
   label_name = g_strdup (name);
   return 0;
 }

References label_name.

◆ login_xml()

gchar* login_xml	(	const gchar *	message,
		const gchar *	token,
		const gchar *	time,
		const gchar *	url,
		const gchar *	i18n,
		const gchar *	guest
	)

Generate XML for login page.

Parameters

[in]	message	Login screen message, or NULL.
[out]	token	Token, or NULL.
[out]	time	Time.
[out]	url	URL.
[out]	i18n	i18n language code, or NULL.
[out]	guest	Username for guest login, or NULL.

Returns: Freshly allocated login XML.

Definition at line 584 of file gsad_base.c.

 {
   GString *xml;
   const gchar *label = label_name_get();
 
   xml = g_string_new ("");
   xml_string_append (xml,
                      "<login_page>"
                      "<version>%s</version>"
                      "<vendor_version>%s</vendor_version>"
                      "<token>%s</token>"
                      "<http_only>%d</http_only>"
                      "<time>%s</time>",
                      GSAD_VERSION,
                      vendor_version_get (),
                      token ? token : "",
                      get_http_only (),
                      time);
 
   if (label)
     xml_string_append(xml,
                       "<label>%s</label>",
                       label);
   if (message)
     xml_string_append (xml,
                        "<message>%s</message>",
                        message);
   if (url)
     xml_string_append (xml,
                        "<url>%s</url>",
                        url);
   if (i18n)
     xml_string_append (xml,
                        "<i18n>%s</i18n>",
                        i18n);
   if (guest)
     xml_string_append (xml,
                        "<guest><username>%s</username></guest>",
                        guest);
   g_string_append (xml, "</login_page>");
 
   return g_string_free (xml, FALSE);
 }

References get_http_only(), label_name_get(), and vendor_version_get().

Referenced by logout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ params_add()

param_t* params_add	(	params_t *	params,
		const char *	name,
		const char *	value
	)

Add a param.

Parameters

[in]	params	Params.
[in]	name	Name.
[in]	value	Value. Must be a string.

Definition at line 808 of file gsad_base.c.

 {
   param_t *param;
 
   if (name == NULL)
     name = "";
   if (value == NULL)
     value = "";
 
   param = g_malloc0 (sizeof (param_t));
   param->valid = 0;
   param->valid_utf8 = 0;
   param->value = g_strdup (value);
   param->value_size = strlen (value);
   param->array_len = 0;
   g_hash_table_insert (params, g_strdup (name), param);
   return param;
 }

References param::array_len, param::valid, param::valid_utf8, param::value, and param::value_size.

Referenced by bulk_delete_omp(), delete_asset_omp(), get_info(), params_append_bin(), and process_bulk_omp().

Here is the caller graph for this function:

◆ params_append_bin()

param_t* params_append_bin	(	params_t *	params,
		const char *	name,
		const char *	chunk_data,
		int	chunk_size,
		int	chunk_offset
	)

Append binary data to a param.

Appended data always has an extra NULL terminator.

Parameters

[in]	params	Params.
[in]	name	Name.
[in]	chunk_data	Data to append.
[in]	chunk_size	Number of bytes to copy.
[in]	chunk_offset	Offset in bytes into data from which to start.

Returns: Param appended to, or NULL on memory error.

Definition at line 841 of file gsad_base.c.

 {
   param_t *param;
   char *new_value;
 
   param = params_get (params, name);
 
   if (param == NULL)
     {
       char *value;
 
       value = g_malloc0 (chunk_size + 1);
       memcpy (value + chunk_offset, chunk_data, chunk_size);
 
       param = params_add (params, name, "");
       g_free (param->value);
       param->value = value;
       param->value_size = chunk_size;
       return param;
     }
 
   new_value = realloc (param->value,
                        param->value_size + chunk_size + 1);
   if (new_value == NULL)
     return NULL;
   param->value = new_value;
   memcpy (param->value + chunk_offset,
           chunk_data,
           chunk_size);
   param->value[chunk_offset + chunk_size] = '\0';
   param->value_size += chunk_size;
 
   return param;
 }

References params_add(), params_get(), param::value, and param::value_size.

Here is the call graph for this function:

◆ params_filename()

const char* params_filename	(	params_t *	params,
		const char *	name
	)

Get filename of param.

Parameters

[in]	params	Params.
[in]	name	Name.

Returns: Filename if param present and has a filename, else NULL.

Definition at line 761 of file gsad_base.c.

 {
   param_t *param;
   param = g_hash_table_lookup (params, name);
   return param ? param->filename : NULL;
 }

References param::filename.

Referenced by create_agent_omp().

Here is the caller graph for this function:

◆ params_free()

void params_free ( params_t * params )

Make a params.

Parameters

[in] params Params.

Definition at line 664 of file gsad_base.c.

 {
   if (params)
     g_hash_table_destroy (params);
 }

◆ params_get()

param_t* params_get	(	params_t *	params,
		const char *	name
	)

Get param.

Parameters

[in]	params	Params.
[in]	name	Name.

Returns: Param if present, else NULL.

Definition at line 679 of file gsad_base.c.

 {
   param_t *param;
   param = g_hash_table_lookup (params, name);
   return param;
 }

Referenced by delete_asset_omp(), delete_filter_omp(), delete_resource(), and params_append_bin().

Here is the caller graph for this function:

◆ params_given()

int params_given	(	params_t *	params,
		const char *	name
	)

Get whether a param was given at all.

Parameters

[in]	params	Params.
[in]	name	Name.

Returns: 1 if given, else 0.

Definition at line 695 of file gsad_base.c.

 {
   param_t *param;
   param = g_hash_table_lookup (params, name);
   return param ? 1 : 0;
 }

Referenced by bulk_delete_omp(), create_alert_omp(), create_credential_omp(), create_note_omp(), create_override_omp(), create_permission_omp(), create_permissions_omp(), create_report_omp(), create_scanner_omp(), create_task_omp(), create_user_omp(), delete_asset_omp(), save_alert_omp(), save_auth_omp(), save_credential_omp(), save_note_omp(), save_override_omp(), save_permission_omp(), save_scanner_omp(), save_task_omp(), and save_user_omp().

Here is the caller graph for this function:

◆ params_iterator_next()

gboolean params_iterator_next	(	params_iterator_t *	iterator,
		char **	name,
		param_t **	param
	)

Increment a params iterator.

Parameters

[in]	iterator	Iterator.
[out]	name	Name of param.
[out]	param	Param.

Returns: TRUE if there was a next element, else FALSE.

Definition at line 887 of file gsad_base.c.

 {
   return g_hash_table_iter_next (iterator, (gpointer*) name, (gpointer*) param);
 }

Referenced by bulk_delete_omp(), create_alert_omp(), create_task_omp(), create_user_omp(), member1(), process_bulk_omp(), run_wizard_omp(), save_alert_omp(), save_config_family_omp(), save_config_nvt_omp(), save_report_format_omp(), save_task_omp(), and save_user_omp().

Here is the caller graph for this function:

◆ params_new()

params_t* params_new ( )

Make a params.

Returns: Freshly allocated params. Free with params_free.

Definition at line 653 of file gsad_base.c.

 {
   return g_hash_table_new_full (g_str_hash, g_str_equal, g_free, param_free);
 }

◆ params_original_value()

const char* params_original_value	(	params_t *	params,
		const char *	name
	)

Get original value of param, before validation.

Only set if validation failed.

Parameters

[in]	params	Params.
[in]	name	Name.

Returns: Value if param present, else NULL.

Definition at line 745 of file gsad_base.c.

 {
   param_t *param;
   param = g_hash_table_lookup (params, name);
   return param ? param->original_value : NULL;
 }

References param::original_value.

Referenced by create_note_omp(), create_override_omp(), save_note_omp(), and save_override_omp().

Here is the caller graph for this function:

◆ params_valid()

int params_valid	(	params_t *	params,
		const char *	name
	)

Get whether a param is valid.

Parameters

[in]	params	Params.
[in]	name	Name.

Returns: 1 if param present and valid, else 0.

Definition at line 793 of file gsad_base.c.

 {
   param_t *param;
   param = g_hash_table_lookup (params, name);
   return param ? param->valid : 0;
 }

References param::valid.

Referenced by create_note_omp(), create_override_omp(), create_task_omp(), process_bulk_omp(), save_note_omp(), save_override_omp(), and save_task_omp().

Here is the caller graph for this function:

◆ params_value()

const char* params_value	(	params_t *	params,
		const char *	name
	)

Get value of param.

Parameters

[in]	params	Params.
[in]	name	Name.

Returns: Value if param present, else NULL.

Definition at line 711 of file gsad_base.c.

 {
   param_t *param;
   param = g_hash_table_lookup (params, name);
   return param ? param->value : NULL;
 }

References param::value.

Referenced by auth_settings_omp(), bulk_delete_omp(), clone_omp(), create_agent_omp(), create_alert_omp(), create_asset_omp(), create_config_omp(), create_container_task_omp(), create_credential_omp(), create_filter_omp(), create_group_omp(), create_host_omp(), create_note_omp(), create_override_omp(), create_permission_omp(), create_permissions_omp(), create_port_list_omp(), create_port_range_omp(), create_report_omp(), create_role_omp(), create_scanner_omp(), create_schedule_omp(), create_tag_omp(), create_target_omp(), create_task_omp(), create_user_omp(), cvss_calculator(), dashboard(), delete_asset_omp(), delete_resource(), download_agent_omp(), download_ca_pub(), download_credential_omp(), download_key_pub(), download_ssl_cert(), edit_alert(), edit_asset(), edit_note(), edit_override(), edit_resource(), edit_scanner(), edit_tag(), edit_target(), empty_trashcan_omp(), export_omp_doc_omp(), export_preference_file_omp(), export_resource(), get_aggregate_omp(), get_info(), get_one(), get_system_report_omp(), get_system_reports_omp(), gsad_message(), import_config_omp(), import_port_list_omp(), import_report_format_omp(), logout(), move_task_omp(), new_note(), new_override(), process_bulk_omp(), resource_action(), restore_omp(), run_wizard_omp(), save_agent_omp(), save_alert_omp(), save_asset_omp(), save_auth_omp(), save_chart_preference_omp(), save_config_family_omp(), save_config_nvt_omp(), save_config_omp(), save_container_task_omp(), save_credential_omp(), save_filter_omp(), save_group_omp(), save_my_settings_omp(), save_note_omp(), save_override_omp(), save_permission_omp(), save_port_list_omp(), save_report_format_omp(), save_role_omp(), save_scanner_omp(), save_schedule_omp(), save_tag_omp(), save_target_omp(), save_task_omp(), save_user_omp(), sync_config_omp(), test_alert_omp(), toggle_tag_omp(), verify_agent_omp(), verify_report_format_omp(), and verify_scanner_omp().

Here is the caller graph for this function:

◆ params_value_size()

int params_value_size	(	params_t *	params,
		const char *	name
	)

Get the size of the value of param.

Parameters

[in]	params	Params.
[in]	name	Name.

Returns: Size if param present, else -1.

Definition at line 727 of file gsad_base.c.

 {
   param_t *param;
   param = g_hash_table_lookup (params, name);
   return param ? param->value_size : -1;
 }

References param::value_size.

Referenced by create_agent_omp().

Here is the caller graph for this function:

◆ params_values()

params_t* params_values	(	params_t *	params,
		const char *	name
	)

Get values of param.

Parameters

[in]	params	Params.
[in]	name	Name.

Returns: Values if param present, else NULL.

Definition at line 777 of file gsad_base.c.

 {
   param_t *param;
   param = g_hash_table_lookup (params, name);
   return param ? param->values : NULL;
 }

References param::values.

Referenced by bulk_delete_omp(), create_alert_omp(), create_task_omp(), create_user_omp(), get_aggregate_omp(), process_bulk_omp(), run_wizard_omp(), save_alert_omp(), save_config_family_omp(), save_config_nvt_omp(), save_my_settings_omp(), save_report_format_omp(), save_task_omp(), and save_user_omp().

Here is the caller graph for this function:

◆ set_chroot_state()

void set_chroot_state ( int state )

Sets the chroot state.

Parameters

[in] state The new chroot state.

Definition at line 130 of file gsad_base.c.

 {
   chroot_state = state;
 }

References chroot_state.

◆ set_http_only()

void set_http_only ( int state )

Sets the http_only state.

Parameters

[in] state The new http_only state.

Definition at line 152 of file gsad_base.c.

 {
   http_only = state;
 }

◆ set_language_code()

void set_language_code	(	gchar **	lang,
		const gchar *	language
	)

Set language code of user.

Caller must handle locking.

Parameters

[in]	lang	Language slot. May be a language name or code
[in]	language	User Interface Language.

Definition at line 218 of file gsad_base.c.

 {
   if (language == NULL || strcmp (language, "Browser Language") == 0)
     *lang = NULL;
   else if (strcmp (language, "Chinese") == 0)
     *lang = g_strdup ("zh_CN");
   else if (strcmp (language, "English") == 0)
     *lang = g_strdup ("en");
   else if (strcmp (language, "German") == 0)
     *lang = g_strdup ("de");
   else
     *lang = g_strdup (language);
 }

◆ vendor_version_get()

const gchar* vendor_version_get ( )

Get the vendor version.

Returns: Vendor version.

Definition at line 175 of file gsad_base.c.

 {
   return vendor_version ? vendor_version : "";
 }

References vendor_version.

Referenced by gsad_message(), and login_xml().

Here is the caller graph for this function:

◆ vendor_version_set()

void vendor_version_set ( const gchar * version )

Set the vendor version.

Parameters

[in] version Vendor version.

Definition at line 163 of file gsad_base.c.

 {
   g_free (vendor_version);
   vendor_version = g_strdup (version);
 }

References vendor_version.

◆ xsl_transform()

char* xsl_transform	(	const char *	xml_text,
		cmd_response_data_t *	response_data
	)

XSL Transformation.

Does the transformation from XML to HTML applying omp.xsl.

Parameters

[in]	xml_text	The XML text to transform.
[out]	response_data	Extra data return for the HTTP response.

Returns: HTML output from XSL transformation.

Definition at line 445 of file gsad_base.c.

 {
   return xsl_transform_with_stylesheet (xml_text, XSL_PATH, response_data);
 }

References XSL_PATH, and xsl_transform_with_stylesheet().

Referenced by gsad_message(), and logout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xsl_transform_with_stylesheet()

char* xsl_transform_with_stylesheet	(	const char *	xml_text,
		const char *	xsl_stylesheet,
		cmd_response_data_t *	response_data
	)

XSL Transformation.

Transforms XML by applying a given XSL stylesheet, usually into HTML.

Parameters

[in]	xml_text	The XML text to transform.
[in]	xsl_stylesheet	The file name of the XSL stylesheet to use.
[out]	response_data	Extra data return for the HTTP response.

Returns: HTML output from XSL transformation.

Definition at line 281 of file gsad_base.c.

 {
 #ifdef USE_LIBXSLT
   xsltStylesheetPtr cur = NULL;
   xmlDocPtr doc, res;
   xmlChar *doc_txt_ptr = NULL;
   int doc_txt_len;
 
   g_debug ("xsl stylesheet: [%s]\n", xml_text);
   g_debug ("text to transform: [%s]\n", xml_text);
 
   exsltRegisterAll ();
   register_i18n_ext_module ();
 
   xmlSubstituteEntitiesDefault (1);
   xmlLoadExtDtdDefaultValue = 1;
   cur = xsltParseStylesheetFile ((const xmlChar *) xsl_stylesheet);
   if (cur == NULL)
     {
       g_warning ("Failed to parse stylesheet %s", xsl_stylesheet);
       if (response_data)
         response_data->http_status_code = MHD_HTTP_INTERNAL_SERVER_ERROR;
       return g_strdup (FAIL_HTML);
     }
 
   doc = xmlParseMemory (xml_text, strlen (xml_text));
   if (doc == NULL)
     {
       g_warning ("Failed to parse stylesheet %s", xsl_stylesheet);
       xsltFreeStylesheet (cur);
       if (response_data)
         response_data->http_status_code = MHD_HTTP_INTERNAL_SERVER_ERROR;
       return g_strdup (FAIL_HTML);
     }
 
   res = xsltApplyStylesheet (cur, doc, NULL);
   if (res == NULL)
     {
       g_warning ("Failed to apply stylesheet %s", xsl_stylesheet);
       xsltFreeStylesheet (cur);
       xmlFreeDoc (doc);
       if (response_data)
         response_data->http_status_code = MHD_HTTP_INTERNAL_SERVER_ERROR;
       return g_strdup (FAIL_HTML);
     }
   xmlFreeDoc (doc);
 
   if (xsltSaveResultToString (&doc_txt_ptr, &doc_txt_len, res, cur) < 0)
     {
       g_warning ("Failed to store transformation result.");
       xsltFreeStylesheet (cur);
       xmlFreeDoc (res);
       if (response_data)
         response_data->http_status_code = MHD_HTTP_INTERNAL_SERVER_ERROR;
       return g_strdup (FAIL_HTML);
     }
 
   xsltFreeStylesheet (cur);
   xmlFreeDoc (res);
   malloc_trim (0);
 
   return (char *) doc_txt_ptr;
 #else
   int content_fd;
   gint exit_status;
   gchar **cmd;
   gboolean success = TRUE;
   gchar *standard_out = NULL;
   gchar *standard_err = NULL;
   char content_file[] = "/tmp/gsa_xsl_transform_XXXXXX";
   GError *error;
 
   /* Create a temporary file. */
 
   content_fd = mkstemp (content_file);
   if (content_fd == -1)
     {
       g_warning ("%s: mkstemp: %s\n", __FUNCTION__, strerror (errno));
       return g_strdup (FAIL_HTML);
     }
 
   /* Copy text to temporary file. */
 
   g_debug ("text to transform: [%s]\n", xml_text);
 
   error = NULL;
   g_file_set_contents (content_file, xml_text, strlen (xml_text), &error);
   if (error)
     {
       g_warning ("%s", error->message);
       g_error_free (error);
       unlink (content_file);
       close (content_fd);
       return g_strdup (FAIL_HTML);
     }
 
   /* Run xsltproc on the temporary file. */
 
   cmd = (gchar **) g_malloc (4 * sizeof (gchar *));
   cmd[0] = g_strdup ("xsltproc");
   cmd[1] = g_strdup (xsl_stylesheet);
   cmd[2] = g_strdup (content_file);
   cmd[3] = NULL;
   g_debug ("%s: Spawning in parent dir: %s %s %s\n",
            __FUNCTION__, cmd[0], cmd[1], cmd[2]);
   if ((g_spawn_sync (NULL,
                      cmd,
                      NULL,                  /* Environment. */
                      G_SPAWN_SEARCH_PATH,
                      NULL,                  /* Setup function. */
                      NULL,
                      &standard_out,
                      &standard_err,
                      &exit_status,
                      NULL)
        == FALSE)
       || (WIFEXITED (exit_status) == 0)
       || WEXITSTATUS (exit_status))
     {
       g_debug ("%s: failed to transform the xml: %d (WIF %i, WEX %i)",
                __FUNCTION__,
                exit_status,
                WIFEXITED (exit_status),
                WEXITSTATUS (exit_status));
       g_debug ("%s: stderr: %s\n", __FUNCTION__, standard_err);
       g_debug ("%s: stdout: %s\n", __FUNCTION__, standard_out);
       success = FALSE;
     }
 
   /* Cleanup. */
 
   g_free (cmd[0]);
   g_free (cmd[1]);
   g_free (cmd[2]);
   g_free (cmd);
   g_free (standard_err);
 
   unlink (content_file);
   close (content_fd);
 
   if (success)
     return standard_out;
 
   g_free (standard_out);
 
   if (response_data)
     response_data->http_status_code = MHD_HTTP_INTERNAL_SERVER_ERROR;
   return g_strdup (FAIL_HTML);
 #endif
 }

References FAIL_HTML, cmd_response_data_t::http_status_code, and register_i18n_ext_module().

Referenced by xsl_transform().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ label_name

gchar* label_name = NULL

Definition at line 69 of file gsad_base.c.

Referenced by label_name_get(), and label_name_set().

◆ vendor_version

gchar* vendor_version = NULL

Version from vendor, or NULL.

Definition at line 67 of file gsad_base.c.

Referenced by vendor_version_get(), and vendor_version_set().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FAIL_HTML

◆ G_LOG_DOMAIN

◆ XSL_PATH

Function Documentation

◆ ctime_r_strip_newline()

◆ get_chroot_state()

◆ get_http_only()

◆ gsad_base_cleanup()

◆ gsad_base_init()

◆ gsad_message()

◆ label_name_get()

◆ label_name_set()

◆ login_xml()

◆ params_add()

◆ params_append_bin()

◆ params_filename()

◆ params_free()

◆ params_get()

◆ params_given()

◆ params_iterator_next()

◆ params_new()

◆ params_original_value()

◆ params_valid()

◆ params_value()

◆ params_value_size()

◆ params_values()

◆ set_chroot_state()

◆ set_http_only()

◆ set_language_code()

◆ vendor_version_get()

◆ vendor_version_set()

◆ xsl_transform()

◆ xsl_transform_with_stylesheet()

Variable Documentation

◆ label_name

◆ vendor_version