Greenbone Vulnerability Management Libraries  21.4.2
hosts.h
Go to the documentation of this file.
1 /* Copyright (C) 2013-2021 Greenbone Networks GmbH
2  *
3  * SPDX-License-Identifier: GPL-2.0-or-later
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
28 #ifndef _GVM_HOSTS_H
29 #define _GVM_HOSTS_H
30 
31 #include <glib.h> /* for gchar, GList */
32 #include <netinet/in.h> /* for in6_addr, in_addr */
33 
34 /* Static values */
35 
37 {
38  HOST_TYPE_NAME = 0, /* Hostname eg. foo */
39  HOST_TYPE_IPV4, /* eg. 192.168.1.1 */
40  HOST_TYPE_CIDR_BLOCK, /* eg. 192.168.15.0/24 */
41  HOST_TYPE_RANGE_SHORT, /* eg. 192.168.15.10-20 */
42  HOST_TYPE_RANGE_LONG, /* eg. 192.168.15.10-192.168.18.3 */
43  HOST_TYPE_IPV6, /* eg. ::1 */
44  HOST_TYPE_CIDR6_BLOCK, /* eg. ::ffee/120 */
45  HOST_TYPE_RANGE6_LONG, /* eg. ::1:200:7-::1:205:500 */
46  HOST_TYPE_RANGE6_SHORT, /* eg. ::1-fe10 */
47  HOST_TYPE_MAX /* Boundary checking. */
48 };
49 
50 /* Typedefs */
51 typedef struct gvm_host gvm_host_t;
52 typedef struct gvm_vhost gvm_vhost_t;
53 typedef struct gvm_hosts gvm_hosts_t;
54 
55 /* Data structures. */
56 
63 struct gvm_host
64 {
65  union
66  {
67  gchar *name;
68  struct in_addr addr;
69  struct in6_addr addr6;
70  };
71  enum host_type type;
72  GSList *vhosts;
73 };
74 
78 struct gvm_vhost
79 {
80  char *value;
81  char *source;
82 };
83 
90 struct gvm_hosts
91 {
92  gchar *orig_str;
94  size_t max_size;
95  size_t current;
96  size_t count;
97  size_t removed;
98  size_t duplicated;
99 };
100 
101 /* Function prototypes. */
102 
103 /* gvm_hosts_t related */
104 
105 gvm_hosts_t *
106 gvm_hosts_new (const gchar *);
107 
108 gvm_hosts_t *
109 gvm_hosts_new_with_max (const gchar *, unsigned int);
110 
111 gvm_host_t *
113 
114 void
116 
117 void
119 
120 void
122 
123 void
125 
126 void
128 
129 GSList *
131 
132 int
133 gvm_hosts_exclude (gvm_hosts_t *, const char *);
134 
135 int
136 gvm_vhosts_exclude (gvm_host_t *, const char *);
137 
138 int
139 gvm_hosts_exclude_with_max (gvm_hosts_t *, const char *, unsigned int);
140 
141 char *
143 
144 int
146 
147 int
149 
150 unsigned int
151 gvm_hosts_count (const gvm_hosts_t *);
152 
153 unsigned int
155 
156 unsigned int
158 
159 /* gvm_host_t related */
160 
161 gvm_host_t *
162 gvm_host_from_str (const gchar *hosts_str);
163 
164 int
165 gvm_host_in_hosts (const gvm_host_t *, const struct in6_addr *,
166  const gvm_hosts_t *);
167 
168 gvm_host_t *
169 gvm_host_find_in_hosts (const gvm_host_t *, const struct in6_addr *,
170  const gvm_hosts_t *);
171 
172 gchar *
173 gvm_host_type_str (const gvm_host_t *);
174 
175 enum host_type
176 gvm_host_type (const gvm_host_t *);
177 
178 gchar *
180 
181 int
182 gvm_host_resolve (const gvm_host_t *, void *, int);
183 
184 int
185 gvm_host_get_addr6 (const gvm_host_t *, struct in6_addr *);
186 
187 void
189 
190 void gvm_host_free (gpointer);
191 
192 /* Miscellaneous functions */
193 
194 gvm_vhost_t *
195 gvm_vhost_new (char *, char *);
196 
197 int
198 gvm_get_host_type (const gchar *);
199 
200 #endif /* not _GVM_HOSTS_H */
gchar * gvm_host_value_str(const gvm_host_t *)
Gets a host's value in printable format.
Definition: hosts.c:2050
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 ...
Definition: hosts.c:1368
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.
Definition: hosts.c:1283
void gvm_hosts_add(gvm_hosts_t *, gvm_host_t *)
Inserts a host object at the end of a hosts collection.
Definition: hosts.c:953
char * gvm_host_reverse_lookup(gvm_host_t *)
Checks for a host object reverse dns lookup existence.
Definition: hosts.c:1688
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...
Definition: hosts.c:2002
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 si...
Definition: hosts.c:1400
gvm_vhost_t * gvm_vhost_new(char *, char *)
Creates a new gvm_vhost_t object.
Definition: hosts.c:884
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 with...
Definition: hosts.c:1297
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 ...
Definition: hosts.c:1623
host_type
Definition: hosts.h:37
@ HOST_TYPE_RANGE_SHORT
Definition: hosts.h:41
@ HOST_TYPE_RANGE6_SHORT
Definition: hosts.h:46
@ HOST_TYPE_RANGE_LONG
Definition: hosts.h:42
@ HOST_TYPE_RANGE6_LONG
Definition: hosts.h:45
@ HOST_TYPE_NAME
Definition: hosts.h:38
@ HOST_TYPE_IPV6
Definition: hosts.h:43
@ HOST_TYPE_CIDR6_BLOCK
Definition: hosts.h:44
@ HOST_TYPE_MAX
Definition: hosts.h:47
@ HOST_TYPE_IPV4
Definition: hosts.h:39
@ HOST_TYPE_CIDR_BLOCK
Definition: hosts.h:40
unsigned int gvm_hosts_removed(const gvm_hosts_t *)
Gets the count of single values in hosts string that were removed (duplicates / excluded....
Definition: hosts.c:1917
int gvm_vhosts_exclude(gvm_host_t *, const char *)
Exclude a list of vhosts from a host's vhosts list.
Definition: hosts.c:1494
void gvm_host_add_reverse_lookup(gvm_host_t *)
Add a host's reverse-lookup name to the vhosts list.
Definition: hosts.c:1772
void gvm_hosts_move_current_host_to_end(gvm_hosts_t *)
Move the current gvm_host_t from a gvm_hosts_t structure to the end of the hosts list.
Definition: hosts.c:1315
gvm_host_t * gvm_host_find_in_hosts(const gvm_host_t *, const struct in6_addr *, const gvm_hosts_t *)
Find the gvm_host_t from a gvm_hosts_t structure.
Definition: hosts.c:1947
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 ove...
Definition: hosts.c:1814
GSList * gvm_hosts_resolve(gvm_hosts_t *)
Resolves host objects of type name in a hosts collection, replacing hostnames with IPv4 values....
Definition: hosts.c:1426
unsigned int gvm_hosts_count(const gvm_hosts_t *)
Gets the count of single hosts objects in a hosts collection.
Definition: hosts.c:1903
void gvm_hosts_free(gvm_hosts_t *)
Frees memory occupied by an gvm_hosts_t structure.
Definition: hosts.c:1345
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 ad...
Definition: hosts.c:2128
int gvm_get_host_type(const gchar *)
Determines the host type in a buffer.
Definition: hosts.c:823
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 ...
Definition: hosts.c:1549
gvm_host_t * gvm_host_from_str(const gchar *hosts_str)
Creates a new gvm_host_t from a host string.
Definition: hosts.c:1639
gchar * gvm_host_type_str(const gvm_host_t *)
Gets a host's type in printable format.
Definition: hosts.c:2034
void gvm_host_free(gpointer)
Frees the memory occupied by an gvm_host_t object.
Definition: hosts.c:932
unsigned int gvm_hosts_duplicated(const gvm_hosts_t *)
Gets the count of single values in hosts string that were duplicated and therefore removed from the l...
Definition: hosts.c:1931
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 t...
Definition: hosts.c:1853
enum host_type gvm_host_type(const gvm_host_t *)
Gets a host object's type.
Definition: hosts.c:2019
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_NAM...
Definition: hosts.c:2107
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.
Definition: hosts.c:1088
The structure for a single host object.
Definition: hosts.h:64
struct in6_addr addr6
Definition: hosts.h:69
gchar * name
Definition: hosts.h:67
GSList * vhosts
Definition: hosts.h:72
struct in_addr addr
Definition: hosts.h:68
enum host_type type
Definition: hosts.h:71
The structure for Hosts collection.
Definition: hosts.h:91
size_t max_size
Definition: hosts.h:94
size_t removed
Definition: hosts.h:97
gchar * orig_str
Definition: hosts.h:92
size_t duplicated
Definition: hosts.h:98
size_t current
Definition: hosts.h:95
size_t count
Definition: hosts.h:96
gvm_host_t ** hosts
Definition: hosts.h:93
The structure for a single vhost object.
Definition: hosts.h:79
char * value
Definition: hosts.h:80
char * source
Definition: hosts.h:81