#include "table_driven_lsc.h"
#include "base/networking.h"
#include "kb_cache.h"
#include "plugutils.h"
#include <ctype.h>
#include <curl/curl.h>
#include <gnutls/gnutls.h>
#include <gvm/base/prefs.h>
#include <gvm/util/mqtt.h>
#include <gvm/util/uuidutils.h>
#include <json-glib/json-glib.h>
#include <stddef.h>

Data Structures
struct	notus_info
	Struct to hold necessary information to call and run notus. More...
struct	string
	Define a string struct for storing the response. More...

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

Typedefs
typedef struct notus_info *	notus_info_t

Functions
void	set_lsc_flag (void)
	Set lsc_flag to 1.
int	lsc_has_run (void)
	Get lsc_flag value.
static JsonBuilder *	add_packages_str_to_list (JsonBuilder builder, const gchar packages)
	Split the package list string and creates a json array.
static gchar *	make_table_driven_lsc_info_json_str (const char scan_id, const char ip_str, const char hostname, const char os_release, const char *package_list)
	Build a json object with data necessary to start a table drive LSC.
static gchar *	get_status_of_table_driven_lsc_from_json (const char scan_id, const char host_ip, const char *json, int len)
	Get the status of table driven lsc from json object.
static notus_info_t	init_notus_info (const char *server)
	Initialize a notus info struct and stores the server URL.
static void	free_notus_info (notus_info_t notusdata)
	Free notus info structure.
static char *	help_tolower (char *s)
	helper function to lower case
static gchar *	make_package_list_as_json_str (const char *packages)
	Build a json array from the package list to start a table drive LSC.
static int	parse_server (notus_info_t *notusdata)
	Parse the server URL.
static advisories_t *	advisories_new_notus ()
	Initialize a new advisories struct with 100 slots.
static advisories_t *	advisories_new_skiron ()
	Initialize a new advisories struct with 100 slots.
static void	advisories_add (advisories_t advisories_list, advisory_t notus_advisory)
	Initialize a new advisories struct with 100 slots.
static advisory_t *	advisory_new (char *oid)
	Initialize a new notus_advisory.
static skiron_advisory_t *	skiron_advisory_new (char oid, char message)
static void	advisory_add_vuln_pkg (advisory_t adv, vuln_pkg_t vuln)
	Add a new vulnerability to the notus_advisory.
static void	advisory_free (advisory_t *notus_advisory)
	Free()'s an notus_advisory.
void	advisories_free (advisories_t *advisories)
	Free()'s an advisories.
static vuln_pkg_t *	vulnerable_pkg_new (const char pkg_name, const char install_version, enum fixed_type type, char item1, char item2)
	Creates a new Vulnerable packages which belongs to an notus_advisory.
static advisories_t *	lsc_process_response_notus (JsonReader *reader)
static advisories_t *	lsc_process_response_skiron (JsonReader *reader)
advisories_t *	lsc_process_response (const gchar *resp, const size_t len)
	Process a json object which contains advisories and vulnerable packages.
static void	init_string (struct string *s)
	Initialize the string struct to hold the response.
static size_t	response_callback_fn (void ptr, size_t size, size_t nmemb, void struct_string)
	Call back function to stored the response.
static long	send_request (notus_info_t notusdata, const char os, const char pkg_list, char **response)
	Send a request to the server.
char *	lsc_get_response (const char pkg_list, const char os)
	Sent the installed package list and OS to notus.
static int	call_rs_notus (const char ip_str, const char hostname, const char pkg_list, const char os)
	Call notus and stores the results.
int	run_table_driven_lsc (const char scan_id, const char ip_str, const char hostname, const char package_list, const char *os_release)
	Publish the necessary data to start a Table driven LSC scan.

Variables
static int	lsc_flag = 0
	LSC ran or didn't 0 didn't run. 1 ran.

Macro Definition Documentation

◆ G_LOG_DOMAIN

#define G_LOG_DOMAIN "lib misc"

GLib logging domain.

◆ RSNOTUS

#define RSNOTUS

Typedef Documentation

◆ notus_info_t

typedef struct notus_info* notus_info_t

Function Documentation

◆ add_packages_str_to_list()

JsonBuilder * add_packages_str_to_list	(	JsonBuilder *	builder,
		const gchar *	packages )

static

Split the package list string and creates a json array.

JSON result consists of scan_id, message type, host ip, hostname, port together with proto, OID, result message and uri.

Parameters

	[in/out]	builder The Json builder to add the array to.
[in]	packages	The installed package list as string

Returns: JSON builder including the package list as array.

◆ advisories_add()

void advisories_add	(	advisories_t *	advisories_list,
		advisory_t *	notus_advisory )

static

Initialize a new advisories struct with 100 slots.

Parameters

advisories_list[in/out]	An advisories holder to add new advisories into.
notus_advisory[in]	the new notus_advisory to add in the list

◆ advisories_free()

void advisories_free ( advisories_t * advisories )

Free()'s an advisories.

Parameters

notus_advisory The advisories holder to be free()'ed. It free()'s all advisories members.

◆ advisories_new_notus()

advisories_t * advisories_new_notus ( )

static

Initialize a new advisories struct with 100 slots.

Returns: initialized advisories_t struct. It must be free by the caller with advisories_free()

◆ advisories_new_skiron()

advisories_t * advisories_new_skiron ( )

static

Initialize a new advisories struct with 100 slots.

Returns: initialized advisories_t struct. It must be free by the caller with advisories_free()

◆ advisory_add_vuln_pkg()

void advisory_add_vuln_pkg	(	advisory_t *	adv,
		vuln_pkg_t *	vuln )

static

Add a new vulnerability to the notus_advisory.

@description Each notus_advisory can have multiple vulnerable packages This structure can hold up to 100 packages.

Parameters

adv[in/out]	The notus_advisory to add the vulnerable package into
vuln[in]	The vulnerable package to add.

◆ advisory_free()

void advisory_free ( advisory_t * notus_advisory )

static

Free()'s an notus_advisory.

Parameters

notus_advisory The notus_advisory to be free()'ed. It free()'s all vulnerable packages that belong to this notus_advisory.

◆ advisory_new()

advisory_t * advisory_new ( char * oid )

static

Initialize a new notus_advisory.

Parameters

oid	The notus_advisory's OID

Returns: initialized advisory_t struct

◆ call_rs_notus()

int call_rs_notus	(	const char *	ip_str,
		const char *	hostname,
		const char *	pkg_list,
		const char *	os )

static

Call notus and stores the results.

Parameters

ip_str	Target's IP address.
hostname	Target's hostname.
pkg_list	List of packages installed in the target. The packages are "\n" separated.
os	Name of the target's operating system.

Returns: Count of stored results. -1 on error.

◆ free_notus_info()

void free_notus_info ( notus_info_t notusdata )

static

Free notus info structure.

Parameters

notusdata The data to free()

◆ get_status_of_table_driven_lsc_from_json()

gchar * get_status_of_table_driven_lsc_from_json	(	const char *	scan_id,
		const char *	host_ip,
		const char *	json,
		int	len )

static

Get the status of table driven lsc from json object.

Checks for the corresponding status inside the JSON. If the status does not belong the the scan or host, NULL is returned instead. NULL is also returned if message JSON cannot be parsed correctly. Return value has to be freed by caller.

Parameters

scan_id	id of scan
host_ip	ip of host
json	json to get information from
len	length of json

Returns: gchar* Status of table driven lsc or NULL

◆ help_tolower()

char * help_tolower ( char * s )

static

helper function to lower case

Parameters

s	the string to lower case

Returns: pointer to the modified string.

◆ init_notus_info()

notus_info_t init_notus_info ( const char * server )

static

Initialize a notus info struct and stores the server URL.

Parameters

server Original server to store and to get the info from

Returns: the initialized struct. NULL on error.

◆ init_string()

void init_string ( struct string * s )

static

Initialize the string struct to hold the response.

Parameters

s[in/out] The string struct to be initialized

◆ lsc_get_response()

char * lsc_get_response	(	const char *	pkg_list,
		const char *	os )

Sent the installed package list and OS to notus.

Parameters

pkg_list	Installed package list
os	The target's OS

Returns: String containing the server response or NULL Must be free()'ed by the caller.

◆ lsc_has_run()

int lsc_has_run ( void )

Get lsc_flag value.

◆ lsc_process_response()

advisories_t * lsc_process_response	(	const gchar *	resp,
		const size_t	len )

Process a json object which contains advisories and vulnerable packages.

@description This is the body string in response get from an openvasd server

Parameters

resp	String containing the json object to be processed.
len	String length.

Returns: a advisories_t struct containing all advisories and vulnerable packages. After usage must be free()'ed with advisories_free().

◆ lsc_process_response_notus()

advisories_t * lsc_process_response_notus ( JsonReader * reader )

static

◆ lsc_process_response_skiron()

advisories_t * lsc_process_response_skiron ( JsonReader * reader )

static

◆ make_package_list_as_json_str()

gchar * make_package_list_as_json_str ( const char * packages )

static

Build a json array from the package list to start a table drive LSC.

Parameters

packages The installed package list in the target system to be evaluated

Returns: String in json format on success. Must be freed by caller. NULL on error.

◆ make_table_driven_lsc_info_json_str()

gchar * make_table_driven_lsc_info_json_str	(	const char *	scan_id,
		const char *	ip_str,
		const char *	hostname,
		const char *	os_release,
		const char *	package_list )

static

Build a json object with data necessary to start a table drive LSC.

JSON result consists of scan_id, message type, host ip, hostname, port together with proto, OID, result message and uri.

Parameters

scan_id	Scan Id.
ip_str	IP string of host.
hostname	Name of host.
os_release	OS release
package_list	The installed package list in the target system to be evaluated

Returns: JSON string on success. Must be freed by caller. NULL on error.

◆ parse_server()

int parse_server ( notus_info_t * notusdata )

static

Parse the server URL.

Parameters

[in] server String containing the server URL Valid is http://example.com:1234 or https://example.com.1234. @notusdata[out] Structure to store information from the URL

Returns: 0 on success, -1 on error.

◆ response_callback_fn()

size_t response_callback_fn	(	void *	ptr,
		size_t	size,
		size_t	nmemb,
		void *	struct_string )

static

Call back function to stored the response.

@description The function signature is the necessary to work with libcurl. It stores the response in s. It reallocate memory if necessary.

◆ run_table_driven_lsc()

int run_table_driven_lsc	(	const char *	scan_id,
		const char *	ip_str,
		const char *	hostname,
		const char *	package_list,
		const char *	os_release )

Publish the necessary data to start a Table driven LSC scan.

If the gather-package-list.nasl plugin was launched, and it generated a valid package list for a supported OS, the table driven LSC scan which is subscribed to the topic will perform a scan an publish the the results to be handle by the sensor/client.

Parameters

scan_id	Scan Id.
kb
ip_str	IP string of host.
hostname	Name of host.

Returns: 0 on success, less than 0 on error.

◆ send_request()

long send_request	(	notus_info_t	notusdata,
		const char *	os,
		const char *	pkg_list,
		char **	response )

static

Send a request to the server.

Parameters

[in]	notusdata	Structure containing information necessary for the request
[in]	os	Target's operative system. Necessary for the URL path part.
[in]	pkg_list	The package list installed in the target, to be checked
[out]	response	The string containing the results in json format.

Returns: the http code or -1 on error

◆ set_lsc_flag()

void set_lsc_flag ( void )

Set lsc_flag to 1.

◆ skiron_advisory_new()

skiron_advisory_t * skiron_advisory_new	(	char *	oid,
		char *	message )

static

◆ vulnerable_pkg_new()

vuln_pkg_t * vulnerable_pkg_new	(	const char *	pkg_name,
		const char *	install_version,
		enum fixed_type	type,
		char *	item1,
		char *	item2 )

static

Creates a new Vulnerable packages which belongs to an notus_advisory.

Parameters

pkg_name
install_version
type	Data type specifying how the fixed version is stored. Can be RANGE or SINGLE
item1	Depending on the type is the "version" for SINGLE type, or the "less than" for RANGE type
item2	Depending on the type is the "specifier" for SINGLE type, or the "greater than" for RANGE type

Returns: a vulnerable packages struct. Members are a copy of the passed parameters. They must be free separately.

Variable Documentation

◆ lsc_flag

int lsc_flag = 0

static

LSC ran or didn't 0 didn't run. 1 ran.

Data Structures

Macros

Typedefs

Functions

Variables

Macro Definition Documentation

◆ G_LOG_DOMAIN

◆ RSNOTUS

Typedef Documentation

◆ notus_info_t

Function Documentation

◆ add_packages_str_to_list()

◆ advisories_add()

◆ advisories_free()

◆ advisories_new_notus()

◆ advisories_new_skiron()

◆ advisory_add_vuln_pkg()

◆ advisory_free()

◆ advisory_new()

◆ call_rs_notus()

◆ free_notus_info()

◆ get_status_of_table_driven_lsc_from_json()

◆ help_tolower()

◆ init_notus_info()

◆ init_string()

◆ lsc_get_response()

◆ lsc_has_run()

◆ lsc_process_response()

◆ lsc_process_response_notus()

◆ lsc_process_response_skiron()

◆ make_package_list_as_json_str()

◆ make_table_driven_lsc_info_json_str()

◆ parse_server()

◆ response_callback_fn()

◆ run_table_driven_lsc()

◆ send_request()

◆ set_lsc_flag()

◆ skiron_advisory_new()

◆ vulnerable_pkg_new()

Variable Documentation

◆ lsc_flag