OpenVAS Libraries  9.0.1
Typedefs | Functions
openvas_wmi_interface.h File Reference

API protos describing the interface of a wmi interface implementation. More...

#include <stdint.h>

Go to the source code of this file.

Typedefs

typedef int WMI_HANDLE
 

Functions

char * wmi_versioninfo (void)
 Return version info for WMI implementation. More...
 
int wmi_connect (int argc, char **argv, WMI_HANDLE *handle)
 Establish connection to a WMI service. More...
 
int wmi_close (WMI_HANDLE)
 Close the connection handle for a WMI service. More...
 
int wmi_query (WMI_HANDLE, const char *, char **)
 Query WMI service using a WQL query. More...
 
int wmi_connect_rsop (int argc, char **argv, WMI_HANDLE *handle)
 Establish connection to a WMI RSOP service. More...
 
int wmi_query_rsop (WMI_HANDLE, const char *, char **)
 WMI RSOP query. More...
 
int wmi_connect_reg (int argc, char **argv, WMI_HANDLE *handle)
 Establish connection to a WMI Registry service. More...
 
int wmi_reg_get_sz (WMI_HANDLE, unsigned int, const char *, const char *, char **)
 Get Registry string value. More...
 
int wmi_reg_enum_value (WMI_HANDLE, unsigned int, const char *, char **)
 Enumerate Registry values. More...
 
int wmi_reg_enum_key (WMI_HANDLE, unsigned int, const char *, char **)
 Enumerate Registry keys. More...
 
int wmi_reg_get_bin_val (WMI_HANDLE, unsigned int, const char *, const char *, char **)
 Get Registry binary value. More...
 
int wmi_reg_get_dword_val (WMI_HANDLE, unsigned int, const char *, const char *, char **)
 Get Registry DWORD value. More...
 
int wmi_reg_get_ex_string_val (WMI_HANDLE, unsigned int, const char *, const char *, char **)
 Get Registry Expanded string value. More...
 
int wmi_reg_get_mul_string_val (WMI_HANDLE, unsigned int, const char *, const char *, char **)
 Get Registry multi-valued strings. More...
 
int wmi_reg_get_qword_val (WMI_HANDLE, unsigned int, const char *, const char *, char **)
 Get Registry QWORD value. More...
 
int wmi_reg_set_dword_val (WMI_HANDLE, const char *, const char *, uint32_t)
 Set Registry DWORD value. More...
 
int wmi_reg_set_qword_val (WMI_HANDLE, const char *, const char *, uint64_t)
 Set Registry QWORD value. More...
 
int wmi_reg_set_ex_string_val (WMI_HANDLE, const char *, const char *, const char *)
 Set Registry Expanded string value. More...
 
int wmi_reg_set_string_val (WMI_HANDLE, const char *, const char *, const char *)
 Set Registry string value. More...
 
int wmi_reg_create_key (WMI_HANDLE, const char *)
 Create Registry Key. More...
 
int wmi_reg_delete_key (WMI_HANDLE, const char *)
 Delete Registry Key. More...
 

Detailed Description

API protos describing the interface of a wmi interface implementation.

This file contains API protos describing the interface of a wmi interface implementation.

Typedef Documentation

◆ WMI_HANDLE

typedef int WMI_HANDLE

Function Documentation

◆ wmi_close()

int wmi_close ( WMI_HANDLE  handle)

Close the connection handle for a WMI service.

Parameters
[in]handle- WMI service connection handle
Returns
, 0 on success, -1 on failure

◆ wmi_connect()

int wmi_connect ( int  argc,
char **  argv,
WMI_HANDLE handle 
)

Establish connection to a WMI service.

Parameters
[out]handle- A connection handle in case of success.
Returns
, 0 on success, -1 on failure

◆ wmi_connect_reg()

int wmi_connect_reg ( int  argc,
char **  argv,
WMI_HANDLE handle 
)

Establish connection to a WMI Registry service.

Parameters
[out]handle- A connection handle in case of success.
Returns
, 0 on success, -1 on failure

◆ wmi_connect_rsop()

int wmi_connect_rsop ( int  argc,
char **  argv,
WMI_HANDLE handle 
)

Establish connection to a WMI RSOP service.

Parameters
[out]handle- A connection handle in case of success.
Returns
, 0 on success, -1 on failure

◆ wmi_query()

int wmi_query ( WMI_HANDLE  handle,
const char *  query,
char **  result 
)

Query WMI service using a WQL query.

Parameters
[in]handle- WMI connection handle
[in]query- The WQL query string
[out]result- Result of query as string
Returns
, 0 on success, -1 on failure

◆ wmi_query_rsop()

int wmi_query_rsop ( WMI_HANDLE  handle,
const char *  query,
char **  res 
)

WMI RSOP query.

Parameters
[in]handle- WMI connection handle
[in]query- WQL RSOP query
[in]res- Registry value to be queried
Returns
, 0 on success, -1 on failure

◆ wmi_reg_create_key()

int wmi_reg_create_key ( WMI_HANDLE  handle,
const char *  key 
)

Create Registry Key.

Parameters
[in]handle- WMI connection handle
[in]key- Registry key need to be created
Returns
, 0 on success, -1 on failure

◆ wmi_reg_delete_key()

int wmi_reg_delete_key ( WMI_HANDLE  handle,
const char *  key 
)

Delete Registry Key.

Parameters
[in]handle- WMI connection handle
[in]key- Registry key need to be Deleted
Returns
, 0 on success, -1 on failure

◆ wmi_reg_enum_key()

int wmi_reg_enum_key ( WMI_HANDLE  handle,
unsigned int  hive,
const char *  key,
char **  res 
)

Enumerate Registry keys.

Parameters
[in]handle- WMI connection handle
[in]hive- Registry hive
[in]key- Registry key
[out]res- Result string
Returns
, 0 on success, -1 on failure

◆ wmi_reg_enum_value()

int wmi_reg_enum_value ( WMI_HANDLE  handle,
unsigned int  hive,
const char *  key,
char **  res 
)

Enumerate Registry values.

Parameters
[in]handle- WMI connection handle
[in]hive- Registry hive
[in]key- Registry key name
[out]res- Result string
Returns
, 0 on success, -1 on failure

◆ wmi_reg_get_bin_val()

int wmi_reg_get_bin_val ( WMI_HANDLE  handle,
unsigned int  hive,
const char *  key,
const char *  val_name,
char **  res 
)

Get Registry binary value.

Parameters
[in]handle- WMI connection handle
[in]hive- Registry hive
[in]key- Registry key containing the value to be queried
[in]val_name- Registry value to be queried
[out]res- Result string
Returns
, 0 on success, -1 on failure

◆ wmi_reg_get_dword_val()

int wmi_reg_get_dword_val ( WMI_HANDLE  handle,
unsigned int  hive,
const char *  key,
const char *  val_name,
char **  res 
)

Get Registry DWORD value.

Parameters
[in]handle- WMI connection handle
[in]hive- Registry hive
[in]key- Registry key containing the value to be queried
[in]val_name- Registry value to be queried
[out]res- Result string
Returns
, 0 on success, -1 on failure

◆ wmi_reg_get_ex_string_val()

int wmi_reg_get_ex_string_val ( WMI_HANDLE  handle,
unsigned int  hive,
const char *  key,
const char *  val_name,
char **  res 
)

Get Registry Expanded string value.

Parameters
[in]handle- WMI connection handle
[in]hive- Registry hive
[in]key- Registry key containing the value to be queried
[in]val_name- Registry value to be queried
[out]res- Result string
Returns
, 0 on success, -1 on failure

◆ wmi_reg_get_mul_string_val()

int wmi_reg_get_mul_string_val ( WMI_HANDLE  handle,
unsigned int  hive,
const char *  key,
const char *  val_name,
char **  res 
)

Get Registry multi-valued strings.

Parameters
[in]handle- WMI connection handle
[in]hive- Registry hive
[in]key- Registry key containing the value to be queried
[in]val_name- Registry value to be queried
[out]res- Result string
Returns
, 0 on success, -1 on failure

◆ wmi_reg_get_qword_val()

int wmi_reg_get_qword_val ( WMI_HANDLE  handle,
unsigned int  hive,
const char *  key,
const char *  val_name,
char **  res 
)

Get Registry QWORD value.

Parameters
[in]handle- WMI connection handle
[in]hive- Registry hive
[in]key- Registry key containing the value to be queried
[in]val_name- Registry value to be queried
[out]res- Result string
Returns
, 0 on success, -1 on failure

◆ wmi_reg_get_sz()

int wmi_reg_get_sz ( WMI_HANDLE  handle,
unsigned int  hive,
const char *  key,
const char *  key_name,
char **  res 
)

Get Registry string value.

Parameters
[in]handle- WMI connection handle
[in]hive- Registry Hive
[in]key- Registry key name
[in]key_name- Registry value name.
[out]res- Result string.
Returns
, 0 on success, -1 on failure

◆ wmi_reg_set_dword_val()

int wmi_reg_set_dword_val ( WMI_HANDLE  handle,
const char *  key,
const char *  val_name,
uint32_t  val 
)

Set Registry DWORD value.

Parameters
[in]handle- WMI connection handle
[in]key- Registry key containing the value to be set
[in]val_name- Registry value to set
Returns
, 0 on success, -1 on failure

◆ wmi_reg_set_ex_string_val()

int wmi_reg_set_ex_string_val ( WMI_HANDLE  handle,
const char *  key,
const char *  val_name,
const char *  val 
)

Set Registry Expanded string value.

Parameters
[in]handle- WMI connection handle
[in]key- Registry key containing the value to be set
[in]val_name- Registry value to set
Returns
, 0 on success, -1 on failure

◆ wmi_reg_set_qword_val()

int wmi_reg_set_qword_val ( WMI_HANDLE  handle,
const char *  key,
const char *  val_name,
uint64_t  val 
)

Set Registry QWORD value.

Parameters
[in]handle- WMI connection handle
[in]key- Registry key containing the value to be set
[in]val_name- Registry value to set
Returns
, 0 on success, -1 on failure

◆ wmi_reg_set_string_val()

int wmi_reg_set_string_val ( WMI_HANDLE  handle,
const char *  key,
const char *  val_name,
const char *  val 
)

Set Registry string value.

Parameters
[in]handle- WMI connection handle
[in]key- Registry key containing the value to be set
[in]val_name- Registry value to set
Returns
, 0 on success, -1 on failure

◆ wmi_versioninfo()

char* wmi_versioninfo ( void  )

Return version info for WMI implementation.

Returns
NULL if this the impementation is a non-functional stub, else a arbitrary string that explains the version of the implementation.