Greenbone Vulnerability Management Libraries
11.0.0
|
Protos and data structures for Hosts collections and single hosts objects. More...
#include <glib.h>
#include <netinet/in.h>
Go to the source code of this file.
Data Structures | |
struct | gvm_host |
The structure for a single host object. More... | |
struct | gvm_vhost |
The structure for a single vhost object. More... | |
struct | gvm_hosts |
The structure for Hosts collection. More... | |
Typedefs | |
typedef struct gvm_host | gvm_host_t |
typedef struct gvm_vhost | gvm_vhost_t |
typedef struct gvm_hosts | gvm_hosts_t |
Functions | |
gvm_hosts_t * | gvm_hosts_new (const gchar *) |
Creates a new gvm_hosts_t structure and the associated hosts objects from the provided hosts_str. More... | |
gvm_hosts_t * | gvm_hosts_new_with_max (const gchar *, unsigned int) |
Creates a new gvm_hosts_t structure and the associated hosts objects from the provided hosts_str. More... | |
gvm_host_t * | gvm_hosts_next (gvm_hosts_t *) |
Gets the next gvm_host_t from a gvm_hosts_t structure. The state of iteration is kept internally within the gvm_hosts structure. More... | |
void | gvm_hosts_free (gvm_hosts_t *) |
Frees memory occupied by an gvm_hosts_t structure. More... | |
void | gvm_hosts_shuffle (gvm_hosts_t *) |
Randomizes the order of the hosts objects in the collection. Not to be used while iterating over the single hosts as it resets the iterator. More... | |
void | gvm_hosts_reverse (gvm_hosts_t *) |
Reverses the order of the hosts objects in the collection. Not to be used while iterating over the single hosts as it resets the iterator. More... | |
GSList * | gvm_hosts_resolve (gvm_hosts_t *) |
Resolves host objects of type name in a hosts collection, replacing hostnames with IPv4 values. Not to be used while iterating over the single hosts as it resets the iterator. More... | |
int | gvm_hosts_exclude (gvm_hosts_t *, const char *) |
Excludes a set of hosts provided as a string from a hosts collection. Not to be used while iterating over the single hosts as it resets the iterator. More... | |
int | gvm_vhosts_exclude (gvm_host_t *, const char *) |
Exclude a list of vhosts from a host's vhosts list. More... | |
int | gvm_hosts_exclude_with_max (gvm_hosts_t *, const char *, unsigned int) |
Excludes a set of hosts provided as a string from a hosts collection. Not to be used while iterating over the single hosts as it resets the iterator. More... | |
char * | gvm_host_reverse_lookup (gvm_host_t *) |
Checks for a host object reverse dns lookup existence. More... | |
int | gvm_hosts_reverse_lookup_only (gvm_hosts_t *) |
Removes hosts that don't reverse-lookup from the hosts collection. Not to be used while iterating over the single hosts as it resets the iterator. More... | |
int | gvm_hosts_reverse_lookup_unify (gvm_hosts_t *) |
Removes hosts duplicates that reverse-lookup to the same value. Not to be used while iterating over the single hosts as it resets the iterator. More... | |
unsigned int | gvm_hosts_count (const gvm_hosts_t *) |
Gets the count of single hosts objects in a hosts collection. More... | |
unsigned int | gvm_hosts_removed (const gvm_hosts_t *) |
Gets the count of single values in hosts string that were removed (duplicates / excluded.) More... | |
int | gvm_host_in_hosts (const gvm_host_t *, const struct in6_addr *, const gvm_hosts_t *) |
Returns whether a host has an equal host in a hosts collection. eg. 192.168.10.1 has an equal in list created from "192.168.10.1-5, 192.168.10.10-20" string while 192.168.10.7 doesn't. More... | |
gchar * | gvm_host_type_str (const gvm_host_t *) |
Gets a host's type in printable format. More... | |
enum host_type | gvm_host_type (const gvm_host_t *) |
Gets a host object's type. More... | |
gchar * | gvm_host_value_str (const gvm_host_t *) |
Gets a host's value in printable format. More... | |
int | gvm_host_resolve (const gvm_host_t *, void *, int) |
Resolves a host object's name to an IPv4 or IPv6 address. Host object should be of type HOST_TYPE_NAME. More... | |
int | gvm_host_get_addr6 (const gvm_host_t *, struct in6_addr *) |
Gives a host object's value as an IPv6 address. If the host type is hostname, it resolves the IPv4 address then gives an IPv4-mapped IPv6 address (eg. ::ffff:192.168.1.1 .) If the host type is IPv4, it gives an IPv4-mapped IPv6 address. If the host's type is IPv6, it gives the value directly. More... | |
void | gvm_host_add_reverse_lookup (gvm_host_t *) |
Add a host's reverse-lookup name to the vhosts list. More... | |
gvm_vhost_t * | gvm_vhost_new (char *, char *) |
Creates a new gvm_vhost_t object. More... | |
int | gvm_get_host_type (const gchar *) |
Determines the host type in a buffer. More... | |
Protos and data structures for Hosts collections and single hosts objects.
This file contains the protos for hosts.c
Definition in file hosts.h.
typedef struct gvm_host gvm_host_t |
typedef struct gvm_hosts gvm_hosts_t |
typedef struct gvm_vhost gvm_vhost_t |
enum host_type |
int gvm_get_host_type | ( | const gchar * | str_stripped | ) |
Determines the host type in a buffer.
[in] | str_stripped | Buffer that contains host definition, could a be hostname, single IPv4 or IPv6, CIDR-expressed block etc,. |
Definition at line 768 of file hosts.c.
References HOST_TYPE_CIDR6_BLOCK, HOST_TYPE_CIDR_BLOCK, HOST_TYPE_IPV4, HOST_TYPE_IPV6, HOST_TYPE_NAME, HOST_TYPE_RANGE6_LONG, HOST_TYPE_RANGE6_SHORT, HOST_TYPE_RANGE_LONG, HOST_TYPE_RANGE_SHORT, is_cidr6_block(), is_cidr_block(), is_hostname(), is_ipv4_address(), is_ipv6_address(), is_long_range6_network(), is_long_range_network(), is_short_range6_network(), and is_short_range_network().
Referenced by gvm_hosts_new_with_max(), gvm_server_open_verify(), and osp_send_command().
void gvm_host_add_reverse_lookup | ( | gvm_host_t * | host | ) |
Add a host's reverse-lookup name to the vhosts list.
[in] | host | The host to which we add the vhost. |
Definition at line 1630 of file hosts.c.
References gvm_host_reverse_lookup(), gvm_vhost_new(), host_name_verify(), HOST_TYPE_NAME, gvm_host::type, and gvm_host::vhosts.
int gvm_host_get_addr6 | ( | const gvm_host_t * | host, |
struct in6_addr * | ip6 | ||
) |
Gives a host object's value as an IPv6 address. If the host type is hostname, it resolves the IPv4 address then gives an IPv4-mapped IPv6 address (eg. ::ffff:192.168.1.1 .) If the host type is IPv4, it gives an IPv4-mapped IPv6 address. If the host's type is IPv6, it gives the value directly.
[in] | host | The host object whose value to get as IPv6. |
[out] | ip6 | Buffer to store the IPv6 address. |
Definition at line 1952 of file hosts.c.
References gvm_host::addr, gvm_host::addr6, gvm_host_resolve(), gvm_host_type(), HOST_TYPE_IPV4, HOST_TYPE_IPV6, HOST_TYPE_NAME, and ipv4_as_ipv6().
Referenced by gvm_host_in_hosts().
int gvm_host_in_hosts | ( | const gvm_host_t * | host, |
const struct in6_addr * | addr, | ||
const gvm_hosts_t * | hosts | ||
) |
Returns whether a host has an equal host in a hosts collection. eg. 192.168.10.1 has an equal in list created from "192.168.10.1-5, 192.168.10.10-20" string while 192.168.10.7 doesn't.
[in] | host | The host object. |
[in] | addr | Optional pointer to ip address. Could be used so that host isn't resolved multiple times when type is HOST_TYPE_NAME. |
[in] | hosts | Hosts collection. |
Definition at line 1793 of file hosts.c.
References gvm_hosts::count, gvm_host_get_addr6(), gvm_host_type(), gvm_host_value_str(), HOST_TYPE_NAME, and gvm_hosts::hosts.
int gvm_host_resolve | ( | const gvm_host_t * | host, |
void * | dst, | ||
int | family | ||
) |
Resolves a host object's name to an IPv4 or IPv6 address. Host object should be of type HOST_TYPE_NAME.
[in] | host | The host object whose name to resolve. |
[out] | dst | Buffer to store resolved address. Size must be at least 4 bytes for AF_INET and 16 bytes for AF_INET6. |
[in] | family | Either AF_INET or AF_INET6. |
Definition at line 1931 of file hosts.c.
References gvm_resolve(), HOST_TYPE_NAME, gvm_host::name, and gvm_host::type.
Referenced by gvm_host_get_addr6().
char* gvm_host_reverse_lookup | ( | gvm_host_t * | host | ) |
Checks for a host object reverse dns lookup existence.
[in] | host | The host to reverse-lookup. |
Definition at line 1546 of file hosts.c.
References gvm_host::addr, gvm_host::addr6, HOST_TYPE_IPV4, HOST_TYPE_IPV6, and gvm_host::type.
Referenced by gvm_host_add_reverse_lookup(), gvm_hosts_reverse_lookup_only(), and gvm_hosts_reverse_lookup_unify().
enum host_type gvm_host_type | ( | const gvm_host_t * | host | ) |
Gets a host object's type.
[in] | host | The host object. |
Definition at line 1843 of file hosts.c.
References gvm_host::type.
Referenced by gvm_host_get_addr6(), and gvm_host_in_hosts().
gchar* gvm_host_type_str | ( | const gvm_host_t * | host | ) |
Gets a host's type in printable format.
[in] | host | The host object. |
Definition at line 1858 of file hosts.c.
References host_type_str, and gvm_host::type.
gchar* gvm_host_value_str | ( | const gvm_host_t * | host | ) |
Gets a host's value in printable format.
[in] | host | The host object. |
Definition at line 1874 of file hosts.c.
References gvm_host::addr, gvm_host::addr6, HOST_TYPE_IPV4, HOST_TYPE_IPV6, HOST_TYPE_NAME, gvm_host::name, and gvm_host::type.
Referenced by gvm_host_in_hosts(), gvm_hosts_deduplicate(), gvm_hosts_exclude_with_max(), and host_name_verify().
unsigned int gvm_hosts_count | ( | const gvm_hosts_t * | hosts | ) |
Gets the count of single hosts objects in a hosts collection.
[in] | hosts | The hosts collection to count hosts of. |
Definition at line 1761 of file hosts.c.
References gvm_hosts::count.
Referenced by gvm_hosts_exclude_with_max().
int gvm_hosts_exclude | ( | gvm_hosts_t * | hosts, |
const char * | excluded_str | ||
) |
Excludes a set of hosts provided as a string from a hosts collection. Not to be used while iterating over the single hosts as it resets the iterator.
[in] | hosts | The hosts collection from which to exclude. |
[in] | excluded_str | String of hosts to exclude. |
Definition at line 1533 of file hosts.c.
References gvm_hosts_exclude_with_max().
int gvm_hosts_exclude_with_max | ( | gvm_hosts_t * | hosts, |
const char * | excluded_str, | ||
unsigned int | max_hosts | ||
) |
Excludes a set of hosts provided as a string from a hosts collection. Not to be used while iterating over the single hosts as it resets the iterator.
[in] | hosts | The hosts collection from which to exclude. |
[in] | excluded_str | String of hosts to exclude. |
[in] | max_hosts | Max number of hosts in hosts_str. 0 means unlimited. |
Uses a hash table in order to exclude hosts in O(N+M) time.
Definition at line 1459 of file hosts.c.
References gvm_hosts::count, gvm_hosts::current, gvm_host_free(), gvm_host_value_str(), gvm_hosts_count(), gvm_hosts_fill_gaps(), gvm_hosts_free(), gvm_hosts_new_with_max(), gvm_hosts::hosts, and gvm_hosts::removed.
Referenced by gvm_hosts_exclude().
void gvm_hosts_free | ( | gvm_hosts_t * | hosts | ) |
Frees memory occupied by an gvm_hosts_t structure.
[in] | hosts | The hosts collection to free. |
Definition at line 1255 of file hosts.c.
References gvm_hosts::count, gvm_host_free(), gvm_hosts::hosts, and gvm_hosts::orig_str.
Referenced by gvm_hosts_exclude_with_max(), and gvm_hosts_new_with_max().
gvm_hosts_t* gvm_hosts_new | ( | const gchar * | hosts_str | ) |
Creates a new gvm_hosts_t structure and the associated hosts objects from the provided hosts_str.
[in] | hosts_str | The hosts string. A copy will be created of this within the returned struct. |
Definition at line 1226 of file hosts.c.
References gvm_hosts_new_with_max().
gvm_hosts_t* gvm_hosts_new_with_max | ( | const gchar * | hosts_str, |
unsigned int | max_hosts | ||
) |
Creates a new gvm_hosts_t structure and the associated hosts objects from the provided hosts_str.
[in] | hosts_str | The hosts string. A copy will be created of this within the returned struct. |
[in] | max_hosts | Max number of hosts in hosts_str. 0 means unlimited. |
Definition at line 1031 of file hosts.c.
References gvm_host::addr, gvm_host::addr6, cidr6_block_ips(), cidr_block_ips(), gvm_hosts::count, gvm_get_host_type(), gvm_host_new(), gvm_hosts_add(), gvm_hosts_deduplicate(), gvm_hosts_free(), gvm_hosts_init(), HOST_TYPE_CIDR6_BLOCK, HOST_TYPE_CIDR_BLOCK, HOST_TYPE_IPV4, HOST_TYPE_IPV6, HOST_TYPE_NAME, HOST_TYPE_RANGE6_LONG, HOST_TYPE_RANGE6_SHORT, HOST_TYPE_RANGE_LONG, HOST_TYPE_RANGE_SHORT, long_range6_network_ips(), long_range_network_ips(), gvm_host::name, gvm_hosts::orig_str, short_range6_network_ips(), short_range_network_ips(), and gvm_host::type.
Referenced by gvm_hosts_exclude_with_max(), and gvm_hosts_new().
gvm_host_t* gvm_hosts_next | ( | gvm_hosts_t * | hosts | ) |
Gets the next gvm_host_t from a gvm_hosts_t structure. The state of iteration is kept internally within the gvm_hosts structure.
[in] | hosts | gvm_hosts_t structure to get next host from. |
Definition at line 1240 of file hosts.c.
References gvm_hosts::count, gvm_hosts::current, and gvm_hosts::hosts.
unsigned int gvm_hosts_removed | ( | const gvm_hosts_t * | hosts | ) |
Gets the count of single values in hosts string that were removed (duplicates / excluded.)
[in] | hosts | The hosts collection. |
Definition at line 1775 of file hosts.c.
References gvm_hosts::removed.
GSList* gvm_hosts_resolve | ( | gvm_hosts_t * | hosts | ) |
Resolves host objects of type name in a hosts collection, replacing hostnames with IPv4 values. Not to be used while iterating over the single hosts as it resets the iterator.
[in] | hosts | The hosts collection from which to exclude. |
Definition at line 1336 of file hosts.c.
References gvm_hosts::count, gvm_hosts::current, gvm_host_free(), gvm_host_new(), gvm_hosts_add(), gvm_hosts_deduplicate(), gvm_hosts_fill_gaps(), gvm_resolve_list(), gvm_vhost_new(), HOST_TYPE_IPV4, HOST_TYPE_IPV6, HOST_TYPE_NAME, gvm_hosts::hosts, gvm_host::name, gvm_hosts::removed, and gvm_host::type.
void gvm_hosts_reverse | ( | gvm_hosts_t * | hosts | ) |
Reverses the order of the hosts objects in the collection. Not to be used while iterating over the single hosts as it resets the iterator.
[in] | hosts | The hosts collection to reverse. |
Definition at line 1310 of file hosts.c.
References gvm_hosts::count, gvm_hosts::current, and gvm_hosts::hosts.
int gvm_hosts_reverse_lookup_only | ( | gvm_hosts_t * | hosts | ) |
Removes hosts that don't reverse-lookup from the hosts collection. Not to be used while iterating over the single hosts as it resets the iterator.
[in] | hosts | The hosts collection to filter. |
Definition at line 1672 of file hosts.c.
References gvm_hosts::count, gvm_hosts::current, gvm_host_free(), gvm_host_reverse_lookup(), gvm_hosts_fill_gaps(), gvm_hosts::hosts, and gvm_hosts::removed.
int gvm_hosts_reverse_lookup_unify | ( | gvm_hosts_t * | hosts | ) |
Removes hosts duplicates that reverse-lookup to the same value. Not to be used while iterating over the single hosts as it resets the iterator.
[in] | hosts | The hosts collection to filter. |
Uses a hash table in order to unify the hosts list in O(N) time.
Definition at line 1711 of file hosts.c.
References gvm_hosts::count, gvm_hosts::current, gvm_host_free(), gvm_host_reverse_lookup(), gvm_hosts_fill_gaps(), gvm_hosts::hosts, and gvm_hosts::removed.
void gvm_hosts_shuffle | ( | gvm_hosts_t * | hosts | ) |
Randomizes the order of the hosts objects in the collection. Not to be used while iterating over the single hosts as it resets the iterator.
[in] | hosts | The hosts collection to shuffle. |
Definition at line 1278 of file hosts.c.
References gvm_hosts::count, gvm_hosts::current, and gvm_hosts::hosts.
gvm_vhost_t* gvm_vhost_new | ( | char * | value, |
char * | source | ||
) |
Creates a new gvm_vhost_t object.
[in] | value | Vhost value. |
[in] | source | Source of hostname. |
Definition at line 829 of file hosts.c.
References gvm_vhost::source, and gvm_vhost::value.
Referenced by gvm_host_add_reverse_lookup(), and gvm_hosts_resolve().
int gvm_vhosts_exclude | ( | gvm_host_t * | host, |
const char * | excluded_str | ||
) |
Exclude a list of vhosts from a host's vhosts list.
[in] | host | The host whose vhosts are to be excluded from. |
[in] | excluded_str | String of hosts to exclude. |
Definition at line 1404 of file hosts.c.
References gvm_vhost_free(), and gvm_host::vhosts.