1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright 2011 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library 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 GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
26 #include "ginetaddressmask.h"
27 #include "ginetaddress.h"
28 #include "ginitable.h"
30 #include "gioenumtypes.h"
34 * SECTION:ginetaddressmask
35 * @short_description: An IPv4/IPv6 address mask
37 * #GInetAddressMask represents a range of IPv4 or IPv6 addresses
38 * described by a base address and a length indicating how many bits
39 * of the base address are relevant for matching purposes. These are
40 * often given in string form. Eg, "10.0.0.0/8", or "fe80::/10".
46 * A combination of an IPv4 or IPv6 base address and a length,
47 * representing a range of IP addresses.
52 static void g_inet_address_mask_initable_iface_init (GInitableIface *iface);
54 G_DEFINE_TYPE_WITH_CODE (GInetAddressMask, g_inet_address_mask, G_TYPE_OBJECT,
55 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE,
56 g_inet_address_mask_initable_iface_init));
58 struct _GInetAddressMaskPrivate
73 g_inet_address_mask_set_property (GObject *object,
78 GInetAddressMask *mask = G_INET_ADDRESS_MASK (object);
84 g_object_unref (mask->priv->addr);
85 mask->priv->addr = g_value_dup_object (value);
89 mask->priv->length = g_value_get_uint (value);
93 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
100 g_inet_address_mask_get_property (GObject *object,
105 GInetAddressMask *mask = G_INET_ADDRESS_MASK (object);
110 g_value_set_enum (value, g_inet_address_get_family (mask->priv->addr));
114 g_value_set_object (value, mask->priv->addr);
118 g_value_set_uint (value, mask->priv->length);
122 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
127 g_inet_address_mask_class_init (GInetAddressMaskClass *klass)
129 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
131 g_type_class_add_private (klass, sizeof (GInetAddressMaskPrivate));
133 gobject_class->set_property = g_inet_address_mask_set_property;
134 gobject_class->get_property = g_inet_address_mask_get_property;
136 g_object_class_install_property (gobject_class, PROP_FAMILY,
137 g_param_spec_enum ("family",
138 P_("Address family"),
139 P_("The address family (IPv4 or IPv6)"),
140 G_TYPE_SOCKET_FAMILY,
141 G_SOCKET_FAMILY_INVALID,
143 G_PARAM_STATIC_STRINGS));
144 g_object_class_install_property (gobject_class, PROP_ADDRESS,
145 g_param_spec_object ("address",
147 P_("The base address"),
150 G_PARAM_STATIC_STRINGS));
151 g_object_class_install_property (gobject_class, PROP_LENGTH,
152 g_param_spec_uint ("length",
154 P_("The prefix length"),
157 G_PARAM_STATIC_STRINGS));
161 g_inet_address_mask_initable_init (GInitable *initable,
162 GCancellable *cancellable,
165 GInetAddressMask *mask = G_INET_ADDRESS_MASK (initable);
166 guint addrlen, nbytes, nbits;
170 if (!mask->priv->addr)
172 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
173 _("No address specified"));
177 addrlen = g_inet_address_get_native_size (mask->priv->addr);
178 if (mask->priv->length > addrlen * 8)
180 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
181 _("Length %u is too long for address"),
186 /* Make sure all the bits after @length are 0 */
187 bytes = g_inet_address_to_bytes (mask->priv->addr);
190 nbytes = mask->priv->length / 8;
194 nbits = mask->priv->length % 8;
197 if (bytes[0] & (0xFF >> nbits))
213 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
214 _("Address has bits set beyond prefix length"));
222 g_inet_address_mask_initable_iface_init (GInitableIface *iface)
224 iface->init = g_inet_address_mask_initable_init;
228 g_inet_address_mask_init (GInetAddressMask *mask)
230 mask->priv = G_TYPE_INSTANCE_GET_PRIVATE (mask,
231 G_TYPE_INET_ADDRESS_MASK,
232 GInetAddressMaskPrivate);
236 * g_inet_address_mask_new:
237 * @addr: a #GInetAddress
238 * @length: number of bits of @addr to use
239 * @error: return location for #GError, or %NULL
241 * Creates a new #GInetAddressMask representing all addresses whose
242 * first @length bits match @addr.
244 * Returns: a new #GInetAddressMask, or %NULL on error
249 g_inet_address_mask_new (GInetAddress *addr,
253 return g_initable_new (G_TYPE_INET_ADDRESS_MASK, NULL, error,
260 * g_inet_address_mask_new_from_string:
261 * @mask_string: an IP address or address/length string
262 * @error: return location for #GError, or %NULL
264 * Parses @mask_string as an IP address and (optional) length, and
265 * creates a new #GInetAddressMask. The length, if present, is
266 * delimited by a "/". If it is not present, then the length is
267 * assumed to be the full length of the address.
269 * Returns: a new #GInetAddressMask corresponding to @string, or %NULL
275 g_inet_address_mask_new_from_string (const gchar *mask_string,
278 GInetAddressMask *mask;
283 slash = strchr (mask_string, '/');
286 gchar *address, *end;
288 length = strtoul (slash + 1, &end, 10);
289 if (*end || !*(slash + 1))
292 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
293 _("Could not parse '%s' as IP address mask"),
298 address = g_strndup (mask_string, slash - mask_string);
299 addr = g_inet_address_new_from_string (address);
307 addr = g_inet_address_new_from_string (mask_string);
311 length = g_inet_address_get_native_size (addr) * 8;
314 mask = g_inet_address_mask_new (addr, length, error);
315 g_object_unref (addr);
321 * g_inet_address_mask_to_string:
322 * @mask: a #GInetAddressMask
324 * Converts @mask back to its corresponding string form.
326 * Return value: a string corresponding to @mask.
331 g_inet_address_mask_to_string (GInetAddressMask *mask)
333 gchar *addr_string, *mask_string;
335 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask), NULL);
337 addr_string = g_inet_address_to_string (mask->priv->addr);
339 if (mask->priv->length == (g_inet_address_get_native_size (mask->priv->addr) * 8))
342 mask_string = g_strdup_printf ("%s/%u", addr_string, mask->priv->length);
343 g_free (addr_string);
349 * g_inet_address_mask_get_family:
350 * @mask: a #GInetAddressMask
352 * Gets the #GSocketFamily of @mask's address
354 * Return value: the #GSocketFamily of @mask's address
359 g_inet_address_mask_get_family (GInetAddressMask *mask)
361 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask), G_SOCKET_FAMILY_INVALID);
363 return g_inet_address_get_family (mask->priv->addr);
367 * g_inet_address_mask_get_address:
368 * @mask: a #GInetAddressMask
370 * Gets @mask's base address
372 * Return value: (transfer none): @mask's base address
377 g_inet_address_mask_get_address (GInetAddressMask *mask)
379 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask), NULL);
381 return mask->priv->addr;
385 * g_inet_address_mask_get_length:
386 * @mask: a #GInetAddressMask
388 * Gets @mask's length
390 * Return value: @mask's length
395 g_inet_address_mask_get_length (GInetAddressMask *mask)
397 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask), 0);
399 return mask->priv->length;
403 * g_inet_address_mask_matches:
404 * @mask: a #GInetAddressMask
405 * @address: a #GInetAddress
407 * Tests if @address falls within the range described by @mask.
409 * Return value: whether @address falls within the range described by
415 g_inet_address_mask_matches (GInetAddressMask *mask,
416 GInetAddress *address)
418 const guint8 *maskbytes, *addrbytes;
421 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask), FALSE);
422 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
424 if (g_inet_address_get_family (mask->priv->addr) !=
425 g_inet_address_get_family (address))
428 if (mask->priv->length == 0)
431 maskbytes = g_inet_address_to_bytes (mask->priv->addr);
432 addrbytes = g_inet_address_to_bytes (address);
434 nbytes = mask->priv->length / 8;
435 if (nbytes != 0 && memcmp (maskbytes, addrbytes, nbytes) != 0)
438 nbits = mask->priv->length % 8;
442 return maskbytes[nbytes] == (addrbytes[nbytes] & (0xFF << (8 - nbits)));
447 * g_inet_address_mask_equal:
448 * @mask: a #GInetAddressMask
449 * @mask2: another #GInetAddressMask
451 * Tests if @mask and @mask2 are the same mask.
453 * Return value: whether @mask and @mask2 are the same mask
458 g_inet_address_mask_equal (GInetAddressMask *mask,
459 GInetAddressMask *mask2)
461 return ((mask->priv->length == mask2->priv->length) &&
462 g_inet_address_equal (mask->priv->addr, mask2->priv->addr));