Greenbone Vulnerability Management Libraries  11.0.1
Typedefs | Functions
nvti.h File Reference

Protos and data structures for NVT Information data sets. More...

#include <glib.h>

Go to the source code of this file.

Typedefs

typedef struct nvtpref nvtpref_t
 
typedef struct vtref vtref_t
 The structure for a cross reference of a VT. More...
 
typedef struct nvti nvti_t
 The structure of a information record that corresponds to a NVT. More...
 
typedef GHashTable nvtis_t
 A collection of information records corresponding to NVTs. More...
 

Functions

nvtpref_tnvtpref_new (int, gchar *, gchar *, gchar *)
 Create a new nvtpref structure filled with the given values. More...
 
void nvtpref_free (nvtpref_t *)
 Free memory of a nvtpref structure. More...
 
gchar * nvtpref_name (const nvtpref_t *)
 Get the Name of a NVT Preference. More...
 
gchar * nvtpref_type (const nvtpref_t *)
 Get the Type of a NVT Preference. More...
 
gchar * nvtpref_default (const nvtpref_t *)
 Get the Default of a NVT Preference. More...
 
int nvtpref_id (const nvtpref_t *)
 Get the ID of a NVT Preference. More...
 
vtref_tvtref_new (const gchar *, const gchar *, const gchar *)
 Create a new vtref structure filled with the given values. More...
 
void vtref_free (vtref_t *)
 Free memory of a vtref structure. More...
 
const gchar * vtref_type (const vtref_t *)
 Get the type of a reference. More...
 
const gchar * vtref_id (const vtref_t *)
 Get the id of a reference. More...
 
const gchar * vtref_text (const vtref_t *)
 Get the text of a reference. More...
 
int nvti_add_vtref (nvti_t *, vtref_t *)
 Add a reference to the VT Info. More...
 
guint nvti_vtref_len (const nvti_t *)
 Get the number of references of the NVT. More...
 
vtref_tnvti_vtref (const nvti_t *, guint)
 Get the n'th reference of the NVT. More...
 
nvti_tnvti_new (void)
 Create a new (empty) nvti structure. More...
 
void nvti_free (nvti_t *)
 Free memory of a nvti structure. More...
 
gchar * nvti_oid (const nvti_t *)
 Get the OID string. More...
 
gchar * nvti_name (const nvti_t *)
 Get the name. More...
 
gchar * nvti_summary (const nvti_t *)
 Get the summary. More...
 
gchar * nvti_affected (const nvti_t *)
 Get the text about affected systems. More...
 
gchar * nvti_impact (const nvti_t *)
 Get the text about impact. More...
 
time_t nvti_creation_time (const nvti_t *)
 Get the creation time. More...
 
time_t nvti_modification_time (const nvti_t *)
 Get the modification time. More...
 
gchar * nvti_insight (const nvti_t *)
 Get the text about insight. More...
 
gchar * nvti_refs (const nvti_t *, const gchar *, const char *, guint)
 
gchar * nvti_solution (const nvti_t *)
 Get the solution. More...
 
gchar * nvti_solution_type (const nvti_t *)
 Get the solution type. More...
 
gchar * nvti_tag (const nvti_t *)
 Get the tags. More...
 
gchar * nvti_cvss_base (const nvti_t *)
 Get the CVSS base. More...
 
gchar * nvti_dependencies (const nvti_t *)
 Get the dependencies list. More...
 
gchar * nvti_required_keys (const nvti_t *)
 Get the required keys list. More...
 
gchar * nvti_mandatory_keys (const nvti_t *)
 Get the mandatory keys list. More...
 
gchar * nvti_excluded_keys (const nvti_t *)
 Get the excluded keys list. More...
 
gchar * nvti_required_ports (const nvti_t *)
 Get the required ports list. More...
 
gchar * nvti_required_udp_ports (const nvti_t *)
 Get the required udp ports list. More...
 
gchar * nvti_detection (const nvti_t *)
 Get the text about detection. More...
 
gchar * nvti_qod_type (const nvti_t *)
 Get the QoD type. More...
 
gint nvti_timeout (const nvti_t *)
 Get the timeout for this NVT. More...
 
gint nvti_category (const nvti_t *)
 Get the category for this NVT. More...
 
gchar * nvti_family (const nvti_t *)
 Get the family name. More...
 
guint nvti_pref_len (const nvti_t *)
 Get the number of preferences of the NVT. More...
 
const nvtpref_tnvti_pref (const nvti_t *, guint)
 Get the n'th preferences of the NVT. More...
 
int nvti_set_oid (nvti_t *, const gchar *)
 Set the OID of a NVT Info. More...
 
int nvti_set_name (nvti_t *, const gchar *)
 Set the name of a NVT. More...
 
int nvti_set_summary (nvti_t *, const gchar *)
 Set the summary of a NVT. More...
 
int nvti_set_insight (nvti_t *, const gchar *)
 Set the insight text of a NVT. More...
 
int nvti_set_affected (nvti_t *, const gchar *)
 Set the affected text of a NVT. More...
 
int nvti_set_impact (nvti_t *, const gchar *)
 Set the impact text of a NVT. More...
 
int nvti_set_creation_time (nvti_t *, const time_t)
 Set the creation time of a NVT. More...
 
int nvti_set_modification_time (nvti_t *, const time_t)
 Set the modification time of a NVT. More...
 
int nvti_set_solution (nvti_t *, const gchar *)
 Set the solution of a NVT. More...
 
int nvti_set_solution_type (nvti_t *, const gchar *)
 Set the solution type of a NVT. More...
 
int nvti_add_tag (nvti_t *, const gchar *, const gchar *)
 Add a tag to the NVT tags. The tag names "last_modification" and "creation_date" are treated special: The value is expected to be a timestamp and it is being converted to seconds since epoch before added as a tag value. The tag name "cvss_base" will be ignored and not added. More...
 
int nvti_set_tag (nvti_t *, const gchar *)
 Set the tags of a NVT. More...
 
int nvti_set_cvss_base (nvti_t *, const gchar *)
 Set the CVSS base of an NVT. More...
 
int nvti_set_dependencies (nvti_t *, const gchar *)
 Set the dependencies of a NVT. More...
 
int nvti_set_required_keys (nvti_t *, const gchar *)
 Set the required keys of a NVT. More...
 
int nvti_set_mandatory_keys (nvti_t *, const gchar *)
 Set the mandatory keys of a NVT. More...
 
int nvti_set_excluded_keys (nvti_t *, const gchar *)
 Set the excluded keys of a NVT. More...
 
int nvti_set_required_ports (nvti_t *, const gchar *)
 Set the required ports of a NVT. More...
 
int nvti_set_required_udp_ports (nvti_t *, const gchar *)
 Set the required udp ports of a NVT. More...
 
int nvti_set_detection (nvti_t *, const gchar *)
 Set the detection text of a NVT. More...
 
int nvti_set_qod_type (nvti_t *, const gchar *)
 Set the QoD type of a NVT. More...
 
int nvti_set_timeout (nvti_t *, const gint)
 Set the timeout of a NVT Info. More...
 
int nvti_set_category (nvti_t *, const gint)
 Set the category type of a NVT Info. More...
 
int nvti_set_family (nvti_t *, const gchar *)
 Set the family of a NVT. More...
 
int nvti_add_refs (nvti_t *, const gchar *, const gchar *, const gchar *)
 Add many new vtref from a comma-separated list. More...
 
int nvti_add_required_keys (nvti_t *, const gchar *)
 Add a required key of a NVT. More...
 
int nvti_add_mandatory_keys (nvti_t *, const gchar *)
 Add a mandatory key of a NVT. More...
 
int nvti_add_excluded_keys (nvti_t *, const gchar *)
 Add a excluded key of a NVT. More...
 
int nvti_add_required_ports (nvti_t *, const gchar *)
 Add a required port of a NVT. More...
 
int nvti_add_required_udp_ports (nvti_t *, const gchar *)
 Add a required udp port of a NVT. More...
 
int nvti_add_pref (nvti_t *, nvtpref_t *)
 Add a preference to the NVT Info. More...
 
nvtis_tnvtis_new (void)
 Make a collection of NVT Infos. More...
 
void nvtis_free (nvtis_t *)
 Free a collection of NVT Infos. More...
 
void nvtis_add (nvtis_t *, nvti_t *)
 Add an NVT Info to a collection of NVT Infos. More...
 
nvti_tnvtis_lookup (nvtis_t *, const char *)
 Add an NVT Info to a collection of NVT Infos. More...
 

Detailed Description

Protos and data structures for NVT Information data sets.

This file contains the protos for nvti.c

Typedef Documentation

◆ nvti_t

typedef struct nvti nvti_t

The structure of a information record that corresponds to a NVT.

◆ nvtis_t

typedef GHashTable nvtis_t

A collection of information records corresponding to NVTs.

◆ nvtpref_t

typedef struct nvtpref nvtpref_t

◆ vtref_t

typedef struct vtref vtref_t

The structure for a cross reference of a VT.

Function Documentation

◆ nvti_add_excluded_keys()

int nvti_add_excluded_keys ( nvti_t n,
const gchar *  key 
)

Add a excluded key of a NVT.

Parameters
nThe NVT Info structure.
keyThe excluded key to add. A copy will be created from this.
Returns
0 for success. 1 if n was NULL. 2 if key was NULL.

◆ nvti_add_mandatory_keys()

int nvti_add_mandatory_keys ( nvti_t n,
const gchar *  key 
)

Add a mandatory key of a NVT.

Parameters
nThe NVT Info structure.
keyThe mandatory key to add. A copy will be created from this.
Returns
0 for success. 1 if n was NULL. 2 if key was NULL.

◆ nvti_add_pref()

int nvti_add_pref ( nvti_t n,
nvtpref_t np 
)

Add a preference to the NVT Info.

Parameters
nThe NVT Info structure.
npThe NVT preference to add.
Returns
0 for success. Anything else indicates an error.

◆ nvti_add_refs()

int nvti_add_refs ( nvti_t n,
const gchar *  type,
const gchar *  ref_ids,
const gchar *  ref_text 
)

Add many new vtref from a comma-separated list.

Parameters
nThe NVTI where to add the references.
typeThe type for all references. If NULL, then for ref_ids a syntax is expected that includes the type like "type:id,type:id".
ref_idsA CSV of reference to be added.
ref_textThe optional text accompanying all references.
Returns
0 for success. 1 if n was NULL, 2 if ref_ids was NULL.

◆ nvti_add_required_keys()

int nvti_add_required_keys ( nvti_t n,
const gchar *  key 
)

Add a required key of a NVT.

Parameters
nThe NVT Info structure.
keyThe required key to add. A copy will be created from this.
Returns
0 for success. 1 if n was NULL. 2 if key was NULL.

◆ nvti_add_required_ports()

int nvti_add_required_ports ( nvti_t n,
const gchar *  port 
)

Add a required port of a NVT.

Parameters
nThe NVT Info structure.
portThe required port to add. A copy will be created from this.
Returns
0 for success. 1 if n was NULL. 2 if port was NULL.

◆ nvti_add_required_udp_ports()

int nvti_add_required_udp_ports ( nvti_t n,
const gchar *  port 
)

Add a required udp port of a NVT.

Parameters
nThe NVT Info structure.
portThe required udp port to add. A copy will be created from this.
Returns
0 for success. 1 if n was NULL. 2 if port was NULL.

◆ nvti_add_tag()

int nvti_add_tag ( nvti_t n,
const gchar *  name,
const gchar *  value 
)

Add a tag to the NVT tags. The tag names "last_modification" and "creation_date" are treated special: The value is expected to be a timestamp and it is being converted to seconds since epoch before added as a tag value. The tag name "cvss_base" will be ignored and not added.

Parameters
nThe NVT Info structure.
nameThe tag name. A copy will be created from this.
valueThe tag value. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_add_vtref()

int nvti_add_vtref ( nvti_t vt,
vtref_t ref 
)

Add a reference to the VT Info.

Parameters
vtThe VT Info structure.
refThe VT reference to add.
Returns
0 for success. Anything else indicates an error.

◆ nvti_affected()

gchar* nvti_affected ( const nvti_t n)

Get the text about affected systems.

Parameters
nThe NVT Info structure of which the affected description should be returned.
Returns
The affected string. Don't free this.

◆ nvti_category()

gint nvti_category ( const nvti_t n)

Get the category for this NVT.

Parameters
nThe NVT Info structure of which the category should be returned.
Returns
The category integer code. A value <= 0 indicates it is not set.

◆ nvti_creation_time()

time_t nvti_creation_time ( const nvti_t n)

Get the creation time.

Parameters
nThe NVT Info structure of which the creation time should be returned.
Returns
The creation time in seconds since epoch.

◆ nvti_cvss_base()

gchar* nvti_cvss_base ( const nvti_t n)

Get the CVSS base.

Parameters
nThe NVT Info structure of which the CVSS base should be returned.
Returns
The cvss_base string. Don't free this.

◆ nvti_dependencies()

gchar* nvti_dependencies ( const nvti_t n)

Get the dependencies list.

Parameters
nThe NVT Info structure of which the name should be returned.
Returns
The dependencies string. Don't free this.

◆ nvti_detection()

gchar* nvti_detection ( const nvti_t n)

Get the text about detection.

Parameters
nThe NVT Info structure of which the detection should be returned.
Returns
The detection string. Don't free this.

◆ nvti_excluded_keys()

gchar* nvti_excluded_keys ( const nvti_t n)

Get the excluded keys list.

Parameters
nThe NVT Info structure of which the name should be returned.
Returns
The excluded keys string. Don't free this.

◆ nvti_family()

gchar* nvti_family ( const nvti_t n)

Get the family name.

Parameters
nThe NVT Info structure of which the name should be returned.
Returns
The family name string. Don't free this.

◆ nvti_free()

void nvti_free ( nvti_t n)

Free memory of a nvti structure.

Parameters
nThe structure to be freed.

◆ nvti_impact()

gchar* nvti_impact ( const nvti_t n)

Get the text about impact.

Parameters
nThe NVT Info structure of which the impact description should be returned.
Returns
The impact string. Don't free this.

◆ nvti_insight()

gchar* nvti_insight ( const nvti_t n)

Get the text about insight.

Parameters
nThe NVT Info structure of which the insight description should be returned.
Returns
The insight string. Don't free this.

◆ nvti_mandatory_keys()

gchar* nvti_mandatory_keys ( const nvti_t n)

Get the mandatory keys list.

Parameters
nThe NVT Info structure of which the name should be returned.
Returns
The mandatory keys string. Don't free this.

◆ nvti_modification_time()

time_t nvti_modification_time ( const nvti_t n)

Get the modification time.

Parameters
nThe NVT Info structure of which the modification time should be returned.
Returns
The modification time in seconds since epoch.

◆ nvti_name()

gchar* nvti_name ( const nvti_t n)

Get the name.

Parameters
nThe NVT Info structure of which the name should be returned.
Returns
The name string. Don't free this.

◆ nvti_new()

nvti_t* nvti_new ( void  )

Create a new (empty) nvti structure.

Returns
NULL in case the memory could not be allocated. Else an empty nvti structure which needs to be released using nvti_free . The whole struct is initialized with 0's.

◆ nvti_oid()

gchar* nvti_oid ( const nvti_t n)

Get the OID string.

Parameters
nThe NVT Info structure of which the OID should be returned.
Returns
The OID string. Don't free this.

◆ nvti_pref()

const nvtpref_t* nvti_pref ( const nvti_t n,
guint  p 
)

Get the n'th preferences of the NVT.

Parameters
nThe NVT Info structure.
pThe position of the preference to return.
Returns
The preference. NULL on error.

◆ nvti_pref_len()

guint nvti_pref_len ( const nvti_t n)

Get the number of preferences of the NVT.

Parameters
nThe NVT Info structure.
Returns
The number of preferences.

◆ nvti_qod_type()

gchar* nvti_qod_type ( const nvti_t n)

Get the QoD type.

Parameters
nThe NVT Info structure of which the QoD type should be returned.
Returns
The QoD type as string. Don't free this.

◆ nvti_refs()

gchar* nvti_refs ( const nvti_t ,
const gchar *  ,
const char *  ,
guint   
)

◆ nvti_required_keys()

gchar* nvti_required_keys ( const nvti_t n)

Get the required keys list.

Parameters
nThe NVT Info structure of which the name should be returned.
Returns
The required keys string. Don't free this.

◆ nvti_required_ports()

gchar* nvti_required_ports ( const nvti_t n)

Get the required ports list.

Parameters
nThe NVT Info structure of which the name should be returned.
Returns
The required ports string. Don't free this.

◆ nvti_required_udp_ports()

gchar* nvti_required_udp_ports ( const nvti_t n)

Get the required udp ports list.

Parameters
nThe NVT Info structure of which the name should be returned.
Returns
The required udp ports string. Don't free this.

◆ nvti_set_affected()

int nvti_set_affected ( nvti_t n,
const gchar *  affected 
)

Set the affected text of a NVT.

Parameters
nThe NVT Info structure.
affectedThe affected text to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_category()

int nvti_set_category ( nvti_t n,
const gint  category 
)

Set the category type of a NVT Info.

Parameters
nThe NVT Info structure.
categoryThe category to set. Values <= 0 will indicate it is not set.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_creation_time()

int nvti_set_creation_time ( nvti_t n,
const time_t  creation_time 
)

Set the creation time of a NVT.

Parameters
nThe NVT Info structure.
creation_timeThe creation time to set.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_cvss_base()

int nvti_set_cvss_base ( nvti_t n,
const gchar *  cvss_base 
)

Set the CVSS base of an NVT.

Parameters
nThe NVT Info structure.
cvss_baseThe CVSS base to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_dependencies()

int nvti_set_dependencies ( nvti_t n,
const gchar *  dependencies 
)

Set the dependencies of a NVT.

Parameters
nThe NVT Info structure.
dependenciesThe dependencies to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_detection()

int nvti_set_detection ( nvti_t n,
const gchar *  detection 
)

Set the detection text of a NVT.

Parameters
nThe NVT Info structure.
detectionThe detection text to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_excluded_keys()

int nvti_set_excluded_keys ( nvti_t n,
const gchar *  excluded_keys 
)

Set the excluded keys of a NVT.

Parameters
nThe NVT Info structure.
excluded_keysThe excluded keys to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_family()

int nvti_set_family ( nvti_t n,
const gchar *  family 
)

Set the family of a NVT.

Parameters
nThe NVT Info structure.
familyThe family to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_impact()

int nvti_set_impact ( nvti_t n,
const gchar *  impact 
)

Set the impact text of a NVT.

Parameters
nThe NVT Info structure.
affectedThe impact text to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_insight()

int nvti_set_insight ( nvti_t n,
const gchar *  insight 
)

Set the insight text of a NVT.

Parameters
nThe NVT Info structure.
insightThe insight text to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_mandatory_keys()

int nvti_set_mandatory_keys ( nvti_t n,
const gchar *  mandatory_keys 
)

Set the mandatory keys of a NVT.

Parameters
nThe NVT Info structure.
mandatory_keysThe mandatory keys to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_modification_time()

int nvti_set_modification_time ( nvti_t n,
const time_t  modification_time 
)

Set the modification time of a NVT.

Parameters
nThe NVT Info structure.
modification_timeThe modification time to set.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_name()

int nvti_set_name ( nvti_t n,
const gchar *  name 
)

Set the name of a NVT.

Parameters
nThe NVT Info structure.
nameThe name to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_oid()

int nvti_set_oid ( nvti_t n,
const gchar *  oid 
)

Set the OID of a NVT Info.

Parameters
nThe NVT Info structure.
oidThe OID to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_qod_type()

int nvti_set_qod_type ( nvti_t n,
const gchar *  qod_type 
)

Set the QoD type of a NVT.

Parameters
nThe NVT Info structure.
qod_typeThe QoD type to set. A copy will be created from this. The string is not checked, any string is accepted as type.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_required_keys()

int nvti_set_required_keys ( nvti_t n,
const gchar *  required_keys 
)

Set the required keys of a NVT.

Parameters
nThe NVT Info structure.
required_keysThe required keys to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_required_ports()

int nvti_set_required_ports ( nvti_t n,
const gchar *  required_ports 
)

Set the required ports of a NVT.

Parameters
nThe NVT Info structure.
required_portsThe required ports to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_required_udp_ports()

int nvti_set_required_udp_ports ( nvti_t n,
const gchar *  required_udp_ports 
)

Set the required udp ports of a NVT.

Parameters
nThe NVT Info structure.
required_udp_portsThe required udp ports to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_solution()

int nvti_set_solution ( nvti_t n,
const gchar *  solution 
)

Set the solution of a NVT.

Parameters
nThe NVT Info structure.
solutionThe solution to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_solution_type()

int nvti_set_solution_type ( nvti_t n,
const gchar *  solution_type 
)

Set the solution type of a NVT.

Parameters
nThe NVT Info structure.
solution_typeThe solution type to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_summary()

int nvti_set_summary ( nvti_t n,
const gchar *  summary 
)

Set the summary of a NVT.

Parameters
nThe NVT Info structure.
solutionThe summary to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_tag()

int nvti_set_tag ( nvti_t n,
const gchar *  tag 
)

Set the tags of a NVT.

Parameters
nThe NVT Info structure.
tagThe tags to set. A copy will be created from this.
Returns
0 for success. Anything else indicates an error.

◆ nvti_set_timeout()

int nvti_set_timeout ( nvti_t n,
const gint  timeout 
)

Set the timeout of a NVT Info.

Parameters
nThe NVT Info structure.
timeoutThe timeout to set. Values <= 0 will indicate it is not set.
Returns
0 for success. Anything else indicates an error.

◆ nvti_solution()

gchar* nvti_solution ( const nvti_t n)

Get the solution.

Parameters
nThe NVT Info structure of which the solution should be returned.
Returns
The solution string. Don't free this.

◆ nvti_solution_type()

gchar* nvti_solution_type ( const nvti_t n)

Get the solution type.

Parameters
nThe NVT Info structure of which the solution type should be returned.
Returns
The solution type string. Don't free this.

◆ nvti_summary()

gchar* nvti_summary ( const nvti_t n)

Get the summary.

Parameters
nThe NVT Info structure of which the summary should be returned.
Returns
The summary string. Don't free this.

◆ nvti_tag()

gchar* nvti_tag ( const nvti_t n)

Get the tags.

Parameters
nThe NVT Info structure of which the tags should be returned.
Returns
The tags string. Don't free this.

◆ nvti_timeout()

gint nvti_timeout ( const nvti_t n)

Get the timeout for this NVT.

Parameters
nThe NVT Info structure of which the timeout should be returned.
Returns
The timeout integer number. A value <= 0 indicates it is not set.

◆ nvti_vtref()

vtref_t* nvti_vtref ( const nvti_t n,
guint  p 
)

Get the n'th reference of the NVT.

Parameters
nThe NVT Info structure.
pThe position of the reference to return.
Returns
The reference. NULL on error.

◆ nvti_vtref_len()

guint nvti_vtref_len ( const nvti_t n)

Get the number of references of the NVT.

Parameters
nThe NVT Info structure.
Returns
The number of references.

◆ nvtis_add()

void nvtis_add ( nvtis_t nvtis,
nvti_t nvti 
)

Add an NVT Info to a collection of NVT Infos.

Parameters
nvtisThe collection of NVT Infos.
nvtiThe NVT Info to add.

◆ nvtis_free()

void nvtis_free ( nvtis_t nvtis)

Free a collection of NVT Infos.

Parameters
nvtisThe collection of NVT Infos.

◆ nvtis_lookup()

nvti_t* nvtis_lookup ( nvtis_t nvtis,
const char *  oid 
)

Add an NVT Info to a collection of NVT Infos.

Parameters
nvtisThe collection of NVT Infos.
oidThe OID of the NVT.
Returns
The NVT Info, if found, else NULL.

◆ nvtis_new()

nvtis_t* nvtis_new ( void  )

Make a collection of NVT Infos.

Returns
An empty collection of NVT Infos.

◆ nvtpref_default()

gchar* nvtpref_default ( const nvtpref_t np)

Get the Default of a NVT Preference.

Parameters
npThe NVT Pref structure of which the Default should be returned.
Returns
The default string. Don't free this.

◆ nvtpref_free()

void nvtpref_free ( nvtpref_t np)

Free memory of a nvtpref structure.

Parameters
npThe structure to be freed.

◆ nvtpref_id()

int nvtpref_id ( const nvtpref_t np)

Get the ID of a NVT Preference.

Parameters
npThe NVT Pref structure of which the Name should be returned.
Returns
The ID value.

◆ nvtpref_name()

gchar* nvtpref_name ( const nvtpref_t np)

Get the Name of a NVT Preference.

Parameters
npThe NVT Pref structure of which the Name should be returned.
Returns
The name string. Don't free this.

◆ nvtpref_new()

nvtpref_t* nvtpref_new ( int  id,
gchar *  name,
gchar *  type,
gchar *  dflt 
)

Create a new nvtpref structure filled with the given values.

Parameters
idThe ID to be set.
nameThe name to be set. A copy will created of this.
typeThe type to be set. A copy will created of this.
dfltThe default to be set. A copy will created of this.
Returns
NULL in case the memory could not be allocated. Else a nvtpref structure which needs to be released using nvtpref_free .

◆ nvtpref_type()

gchar* nvtpref_type ( const nvtpref_t np)

Get the Type of a NVT Preference.

Parameters
npThe NVT Pref structure of which the Type should be returned.
Returns
The type string. Don't free this.

◆ vtref_free()

void vtref_free ( vtref_t ref)

Free memory of a vtref structure.

Parameters
refThe structure to be freed.

◆ vtref_id()

const gchar* vtref_id ( const vtref_t r)

Get the id of a reference.

Parameters
rThe VT Reference structure of which the id should be returned.
Returns
The id string. Don't free this.

◆ vtref_new()

vtref_t* vtref_new ( const gchar *  type,
const gchar *  ref_id,
const gchar *  ref_text 
)

Create a new vtref structure filled with the given values.

Parameters
typeThe type to be set.
ref_idThe actual reference to be set.
ref_textThe optional text accompanying a reference.
Returns
NULL in case the memory could not be allocated. Else a vtref structure which needs to be released using vtref_free .

◆ vtref_text()

const gchar* vtref_text ( const vtref_t r)

Get the text of a reference.

Parameters
rThe VT Reference structure of which the id should be returned.
Returns
The id string. Don't free this.

◆ vtref_type()

const gchar* vtref_type ( const vtref_t r)

Get the type of a reference.

Parameters
rThe VT Reference structure of which the type should be returned.
Returns
The type string. Don't free this.