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_dispose (GObject
*object
)
129 GInetAddressMask
*mask
= G_INET_ADDRESS_MASK (object
);
131 g_clear_object (&mask
->priv
->addr
);
133 G_OBJECT_CLASS (g_inet_address_mask_parent_class
)->dispose (object
);
137 g_inet_address_mask_class_init (GInetAddressMaskClass
*klass
)
139 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
141 g_type_class_add_private (klass
, sizeof (GInetAddressMaskPrivate
));
143 gobject_class
->set_property
= g_inet_address_mask_set_property
;
144 gobject_class
->get_property
= g_inet_address_mask_get_property
;
145 gobject_class
->dispose
= g_inet_address_mask_dispose
;
147 g_object_class_install_property (gobject_class
, PROP_FAMILY
,
148 g_param_spec_enum ("family",
149 P_("Address family"),
150 P_("The address family (IPv4 or IPv6)"),
151 G_TYPE_SOCKET_FAMILY
,
152 G_SOCKET_FAMILY_INVALID
,
154 G_PARAM_STATIC_STRINGS
));
155 g_object_class_install_property (gobject_class
, PROP_ADDRESS
,
156 g_param_spec_object ("address",
158 P_("The base address"),
161 G_PARAM_STATIC_STRINGS
));
162 g_object_class_install_property (gobject_class
, PROP_LENGTH
,
163 g_param_spec_uint ("length",
165 P_("The prefix length"),
168 G_PARAM_STATIC_STRINGS
));
172 g_inet_address_mask_initable_init (GInitable
*initable
,
173 GCancellable
*cancellable
,
176 GInetAddressMask
*mask
= G_INET_ADDRESS_MASK (initable
);
177 guint addrlen
, nbytes
, nbits
;
181 if (!mask
->priv
->addr
)
183 g_set_error_literal (error
, G_IO_ERROR
, G_IO_ERROR_INVALID_ARGUMENT
,
184 _("No address specified"));
188 addrlen
= g_inet_address_get_native_size (mask
->priv
->addr
);
189 if (mask
->priv
->length
> addrlen
* 8)
191 g_set_error (error
, G_IO_ERROR
, G_IO_ERROR_INVALID_ARGUMENT
,
192 _("Length %u is too long for address"),
197 /* Make sure all the bits after @length are 0 */
198 bytes
= g_inet_address_to_bytes (mask
->priv
->addr
);
201 nbytes
= mask
->priv
->length
/ 8;
205 nbits
= mask
->priv
->length
% 8;
208 if (bytes
[0] & (0xFF >> nbits
))
224 g_set_error_literal (error
, G_IO_ERROR
, G_IO_ERROR_INVALID_ARGUMENT
,
225 _("Address has bits set beyond prefix length"));
233 g_inet_address_mask_initable_iface_init (GInitableIface
*iface
)
235 iface
->init
= g_inet_address_mask_initable_init
;
239 g_inet_address_mask_init (GInetAddressMask
*mask
)
241 mask
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (mask
,
242 G_TYPE_INET_ADDRESS_MASK
,
243 GInetAddressMaskPrivate
);
247 * g_inet_address_mask_new:
248 * @addr: a #GInetAddress
249 * @length: number of bits of @addr to use
250 * @error: return location for #GError, or %NULL
252 * Creates a new #GInetAddressMask representing all addresses whose
253 * first @length bits match @addr.
255 * Returns: a new #GInetAddressMask, or %NULL on error
260 g_inet_address_mask_new (GInetAddress
*addr
,
264 return g_initable_new (G_TYPE_INET_ADDRESS_MASK
, NULL
, error
,
271 * g_inet_address_mask_new_from_string:
272 * @mask_string: an IP address or address/length string
273 * @error: return location for #GError, or %NULL
275 * Parses @mask_string as an IP address and (optional) length, and
276 * creates a new #GInetAddressMask. The length, if present, is
277 * delimited by a "/". If it is not present, then the length is
278 * assumed to be the full length of the address.
280 * Returns: a new #GInetAddressMask corresponding to @string, or %NULL
286 g_inet_address_mask_new_from_string (const gchar
*mask_string
,
289 GInetAddressMask
*mask
;
294 slash
= strchr (mask_string
, '/');
297 gchar
*address
, *end
;
299 length
= strtoul (slash
+ 1, &end
, 10);
300 if (*end
|| !*(slash
+ 1))
303 g_set_error (error
, G_IO_ERROR
, G_IO_ERROR_INVALID_ARGUMENT
,
304 _("Could not parse '%s' as IP address mask"),
309 address
= g_strndup (mask_string
, slash
- mask_string
);
310 addr
= g_inet_address_new_from_string (address
);
318 addr
= g_inet_address_new_from_string (mask_string
);
322 length
= g_inet_address_get_native_size (addr
) * 8;
325 mask
= g_inet_address_mask_new (addr
, length
, error
);
326 g_object_unref (addr
);
332 * g_inet_address_mask_to_string:
333 * @mask: a #GInetAddressMask
335 * Converts @mask back to its corresponding string form.
337 * Return value: a string corresponding to @mask.
342 g_inet_address_mask_to_string (GInetAddressMask
*mask
)
344 gchar
*addr_string
, *mask_string
;
346 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask
), NULL
);
348 addr_string
= g_inet_address_to_string (mask
->priv
->addr
);
350 if (mask
->priv
->length
== (g_inet_address_get_native_size (mask
->priv
->addr
) * 8))
353 mask_string
= g_strdup_printf ("%s/%u", addr_string
, mask
->priv
->length
);
354 g_free (addr_string
);
360 * g_inet_address_mask_get_family:
361 * @mask: a #GInetAddressMask
363 * Gets the #GSocketFamily of @mask's address
365 * Return value: the #GSocketFamily of @mask's address
370 g_inet_address_mask_get_family (GInetAddressMask
*mask
)
372 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask
), G_SOCKET_FAMILY_INVALID
);
374 return g_inet_address_get_family (mask
->priv
->addr
);
378 * g_inet_address_mask_get_address:
379 * @mask: a #GInetAddressMask
381 * Gets @mask's base address
383 * Return value: (transfer none): @mask's base address
388 g_inet_address_mask_get_address (GInetAddressMask
*mask
)
390 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask
), NULL
);
392 return mask
->priv
->addr
;
396 * g_inet_address_mask_get_length:
397 * @mask: a #GInetAddressMask
399 * Gets @mask's length
401 * Return value: @mask's length
406 g_inet_address_mask_get_length (GInetAddressMask
*mask
)
408 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask
), 0);
410 return mask
->priv
->length
;
414 * g_inet_address_mask_matches:
415 * @mask: a #GInetAddressMask
416 * @address: a #GInetAddress
418 * Tests if @address falls within the range described by @mask.
420 * Return value: whether @address falls within the range described by
426 g_inet_address_mask_matches (GInetAddressMask
*mask
,
427 GInetAddress
*address
)
429 const guint8
*maskbytes
, *addrbytes
;
432 g_return_val_if_fail (G_IS_INET_ADDRESS_MASK (mask
), FALSE
);
433 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
435 if (g_inet_address_get_family (mask
->priv
->addr
) !=
436 g_inet_address_get_family (address
))
439 if (mask
->priv
->length
== 0)
442 maskbytes
= g_inet_address_to_bytes (mask
->priv
->addr
);
443 addrbytes
= g_inet_address_to_bytes (address
);
445 nbytes
= mask
->priv
->length
/ 8;
446 if (nbytes
!= 0 && memcmp (maskbytes
, addrbytes
, nbytes
) != 0)
449 nbits
= mask
->priv
->length
% 8;
453 return maskbytes
[nbytes
] == (addrbytes
[nbytes
] & (0xFF << (8 - nbits
)));
458 * g_inet_address_mask_equal:
459 * @mask: a #GInetAddressMask
460 * @mask2: another #GInetAddressMask
462 * Tests if @mask and @mask2 are the same mask.
464 * Return value: whether @mask and @mask2 are the same mask
469 g_inet_address_mask_equal (GInetAddressMask
*mask
,
470 GInetAddressMask
*mask2
)
472 return ((mask
->priv
->length
== mask2
->priv
->length
) &&
473 g_inet_address_equal (mask
->priv
->addr
, mask2
->priv
->addr
));