1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
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.1 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, see <http://www.gnu.org/licenses/>.
18 * Authors: Christian Kellner <gicmo@gnome.org>
19 * Samuel Cormier-Iijima <sciyoshi@gmail.com>
28 #include "ginetaddress.h"
30 #include "gioenumtypes.h"
32 #include "gnetworkingprivate.h"
35 /* Ensure Windows XP runtime compatibility, while using
36 * inet_pton() and inet_ntop() if available
38 #include "gwin32networking.h"
41 struct _GInetAddressPrivate
51 * SECTION:ginetaddress
52 * @short_description: An IPv4/IPv6 address
55 * #GInetAddress represents an IPv4 or IPv6 internet address. Use
56 * g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to
57 * look up the #GInetAddress for a hostname. Use
58 * g_resolver_lookup_by_address() or
59 * g_resolver_lookup_by_address_async() to look up the hostname for a
62 * To actually connect to a remote host, you will need a
63 * #GInetSocketAddress (which includes a #GInetAddress as well as a
70 * An IPv4 or IPv6 internet address.
73 G_DEFINE_TYPE_WITH_CODE (GInetAddress
, g_inet_address
, G_TYPE_OBJECT
,
74 G_ADD_PRIVATE (GInetAddress
)
75 g_networking_init ();)
88 PROP_IS_MC_LINK_LOCAL
,
89 PROP_IS_MC_NODE_LOCAL
,
91 PROP_IS_MC_SITE_LOCAL
,
95 g_inet_address_set_property (GObject
*object
,
100 GInetAddress
*address
= G_INET_ADDRESS (object
);
105 address
->priv
->family
= g_value_get_enum (value
);
109 memcpy (&address
->priv
->addr
, g_value_get_pointer (value
),
110 address
->priv
->family
== AF_INET
?
111 sizeof (address
->priv
->addr
.ipv4
) :
112 sizeof (address
->priv
->addr
.ipv6
));
116 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
123 g_inet_address_get_property (GObject
*object
,
128 GInetAddress
*address
= G_INET_ADDRESS (object
);
133 g_value_set_enum (value
, address
->priv
->family
);
137 g_value_set_pointer (value
, &address
->priv
->addr
);
141 g_value_set_boolean (value
, g_inet_address_get_is_any (address
));
144 case PROP_IS_LOOPBACK
:
145 g_value_set_boolean (value
, g_inet_address_get_is_loopback (address
));
148 case PROP_IS_LINK_LOCAL
:
149 g_value_set_boolean (value
, g_inet_address_get_is_link_local (address
));
152 case PROP_IS_SITE_LOCAL
:
153 g_value_set_boolean (value
, g_inet_address_get_is_site_local (address
));
156 case PROP_IS_MULTICAST
:
157 g_value_set_boolean (value
, g_inet_address_get_is_multicast (address
));
160 case PROP_IS_MC_GLOBAL
:
161 g_value_set_boolean (value
, g_inet_address_get_is_mc_global (address
));
164 case PROP_IS_MC_LINK_LOCAL
:
165 g_value_set_boolean (value
, g_inet_address_get_is_mc_link_local (address
));
168 case PROP_IS_MC_NODE_LOCAL
:
169 g_value_set_boolean (value
, g_inet_address_get_is_mc_node_local (address
));
172 case PROP_IS_MC_ORG_LOCAL
:
173 g_value_set_boolean (value
, g_inet_address_get_is_mc_org_local (address
));
176 case PROP_IS_MC_SITE_LOCAL
:
177 g_value_set_boolean (value
, g_inet_address_get_is_mc_site_local (address
));
181 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
186 g_inet_address_class_init (GInetAddressClass
*klass
)
188 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
190 gobject_class
->set_property
= g_inet_address_set_property
;
191 gobject_class
->get_property
= g_inet_address_get_property
;
193 g_object_class_install_property (gobject_class
, PROP_FAMILY
,
194 g_param_spec_enum ("family",
195 P_("Address family"),
196 P_("The address family (IPv4 or IPv6)"),
197 G_TYPE_SOCKET_FAMILY
,
198 G_SOCKET_FAMILY_INVALID
,
200 G_PARAM_CONSTRUCT_ONLY
|
201 G_PARAM_STATIC_STRINGS
));
203 g_object_class_install_property (gobject_class
, PROP_BYTES
,
204 g_param_spec_pointer ("bytes",
206 P_("The raw address data"),
208 G_PARAM_CONSTRUCT_ONLY
|
209 G_PARAM_STATIC_STRINGS
));
212 * GInetAddress:is-any:
214 * Whether this is the "any" address for its family.
215 * See g_inet_address_get_is_any().
219 g_object_class_install_property (gobject_class
, PROP_IS_ANY
,
220 g_param_spec_boolean ("is-any",
222 P_("Whether this is the \"any\" address for its family"),
225 G_PARAM_STATIC_STRINGS
));
228 * GInetAddress:is-link-local:
230 * Whether this is a link-local address.
231 * See g_inet_address_get_is_link_local().
235 g_object_class_install_property (gobject_class
, PROP_IS_LINK_LOCAL
,
236 g_param_spec_boolean ("is-link-local",
238 P_("Whether this is a link-local address"),
241 G_PARAM_STATIC_STRINGS
));
244 * GInetAddress:is-loopback:
246 * Whether this is the loopback address for its family.
247 * See g_inet_address_get_is_loopback().
251 g_object_class_install_property (gobject_class
, PROP_IS_LOOPBACK
,
252 g_param_spec_boolean ("is-loopback",
254 P_("Whether this is the loopback address for its family"),
257 G_PARAM_STATIC_STRINGS
));
260 * GInetAddress:is-site-local:
262 * Whether this is a site-local address.
263 * See g_inet_address_get_is_loopback().
267 g_object_class_install_property (gobject_class
, PROP_IS_SITE_LOCAL
,
268 g_param_spec_boolean ("is-site-local",
270 P_("Whether this is a site-local address"),
273 G_PARAM_STATIC_STRINGS
));
276 * GInetAddress:is-multicast:
278 * Whether this is a multicast address.
279 * See g_inet_address_get_is_multicast().
283 g_object_class_install_property (gobject_class
, PROP_IS_MULTICAST
,
284 g_param_spec_boolean ("is-multicast",
286 P_("Whether this is a multicast address"),
289 G_PARAM_STATIC_STRINGS
));
292 * GInetAddress:is-mc-global:
294 * Whether this is a global multicast address.
295 * See g_inet_address_get_is_mc_global().
299 g_object_class_install_property (gobject_class
, PROP_IS_MC_GLOBAL
,
300 g_param_spec_boolean ("is-mc-global",
301 P_("Is multicast global"),
302 P_("Whether this is a global multicast address"),
305 G_PARAM_STATIC_STRINGS
));
309 * GInetAddress:is-mc-link-local:
311 * Whether this is a link-local multicast address.
312 * See g_inet_address_get_is_mc_link_local().
316 g_object_class_install_property (gobject_class
, PROP_IS_MC_LINK_LOCAL
,
317 g_param_spec_boolean ("is-mc-link-local",
318 P_("Is multicast link-local"),
319 P_("Whether this is a link-local multicast address"),
322 G_PARAM_STATIC_STRINGS
));
325 * GInetAddress:is-mc-node-local:
327 * Whether this is a node-local multicast address.
328 * See g_inet_address_get_is_mc_node_local().
332 g_object_class_install_property (gobject_class
, PROP_IS_MC_NODE_LOCAL
,
333 g_param_spec_boolean ("is-mc-node-local",
334 P_("Is multicast node-local"),
335 P_("Whether this is a node-local multicast address"),
338 G_PARAM_STATIC_STRINGS
));
341 * GInetAddress:is-mc-org-local:
343 * Whether this is an organization-local multicast address.
344 * See g_inet_address_get_is_mc_org_local().
348 g_object_class_install_property (gobject_class
, PROP_IS_MC_ORG_LOCAL
,
349 g_param_spec_boolean ("is-mc-org-local",
350 P_("Is multicast org-local"),
351 P_("Whether this is an organization-local multicast address"),
354 G_PARAM_STATIC_STRINGS
));
357 * GInetAddress:is-mc-site-local:
359 * Whether this is a site-local multicast address.
360 * See g_inet_address_get_is_mc_site_local().
364 g_object_class_install_property (gobject_class
, PROP_IS_MC_SITE_LOCAL
,
365 g_param_spec_boolean ("is-mc-site-local",
366 P_("Is multicast site-local"),
367 P_("Whether this is a site-local multicast address"),
370 G_PARAM_STATIC_STRINGS
));
374 g_inet_address_init (GInetAddress
*address
)
376 address
->priv
= g_inet_address_get_instance_private (address
);
380 * g_inet_address_new_from_string:
381 * @string: a string representation of an IP address
383 * Parses @string as an IP address and creates a new #GInetAddress.
385 * Returns: a new #GInetAddress corresponding to @string, or %NULL if
386 * @string could not be parsed.
387 * Free the returned object with g_object_unref().
392 g_inet_address_new_from_string (const gchar
*string
)
394 struct in_addr in_addr
;
395 struct in6_addr in6_addr
;
397 g_return_val_if_fail (string
!= NULL
, NULL
);
399 /* If this GInetAddress is the first networking-related object to be
400 * created, then we won't have called g_networking_init() yet at
403 g_networking_init ();
405 if (inet_pton (AF_INET
, string
, &in_addr
) > 0)
406 return g_inet_address_new_from_bytes ((guint8
*)&in_addr
, AF_INET
);
407 else if (inet_pton (AF_INET6
, string
, &in6_addr
) > 0)
408 return g_inet_address_new_from_bytes ((guint8
*)&in6_addr
, AF_INET6
);
413 #define G_INET_ADDRESS_FAMILY_IS_VALID(family) ((family) == AF_INET || (family) == AF_INET6)
416 * g_inet_address_new_from_bytes:
417 * @bytes: (array) (element-type guint8): raw address data
418 * @family: the address family of @bytes
420 * Creates a new #GInetAddress from the given @family and @bytes.
421 * @bytes should be 4 bytes for %G_SOCKET_FAMILY_IPV4 and 16 bytes for
422 * %G_SOCKET_FAMILY_IPV6.
424 * Returns: a new #GInetAddress corresponding to @family and @bytes.
425 * Free the returned object with g_object_unref().
430 g_inet_address_new_from_bytes (const guint8
*bytes
,
431 GSocketFamily family
)
433 g_return_val_if_fail (G_INET_ADDRESS_FAMILY_IS_VALID (family
), NULL
);
435 return g_object_new (G_TYPE_INET_ADDRESS
,
442 * g_inet_address_new_loopback:
443 * @family: the address family
445 * Creates a #GInetAddress for the loopback address for @family.
447 * Returns: a new #GInetAddress corresponding to the loopback address
449 * Free the returned object with g_object_unref().
454 g_inet_address_new_loopback (GSocketFamily family
)
456 g_return_val_if_fail (G_INET_ADDRESS_FAMILY_IS_VALID (family
), NULL
);
458 if (family
== AF_INET
)
460 guint8 addr
[4] = {127, 0, 0, 1};
462 return g_inet_address_new_from_bytes (addr
, family
);
465 return g_inet_address_new_from_bytes (in6addr_loopback
.s6_addr
, family
);
469 * g_inet_address_new_any:
470 * @family: the address family
472 * Creates a #GInetAddress for the "any" address (unassigned/"don't
473 * care") for @family.
475 * Returns: a new #GInetAddress corresponding to the "any" address
477 * Free the returned object with g_object_unref().
482 g_inet_address_new_any (GSocketFamily family
)
484 g_return_val_if_fail (G_INET_ADDRESS_FAMILY_IS_VALID (family
), NULL
);
486 if (family
== AF_INET
)
488 guint8 addr
[4] = {0, 0, 0, 0};
490 return g_inet_address_new_from_bytes (addr
, family
);
493 return g_inet_address_new_from_bytes (in6addr_any
.s6_addr
, family
);
498 * g_inet_address_to_string:
499 * @address: a #GInetAddress
501 * Converts @address to string form.
503 * Returns: a representation of @address as a string, which should be
509 g_inet_address_to_string (GInetAddress
*address
)
511 gchar buffer
[INET6_ADDRSTRLEN
];
513 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), NULL
);
515 if (address
->priv
->family
== AF_INET
)
516 inet_ntop (AF_INET
, &address
->priv
->addr
.ipv4
, buffer
, sizeof (buffer
));
518 inet_ntop (AF_INET6
, &address
->priv
->addr
.ipv6
, buffer
, sizeof (buffer
));
520 return g_strdup (buffer
);
524 * g_inet_address_to_bytes: (skip)
525 * @address: a #GInetAddress
527 * Gets the raw binary address data from @address.
529 * Returns: a pointer to an internal array of the bytes in @address,
530 * which should not be modified, stored, or freed. The size of this
531 * array can be gotten with g_inet_address_get_native_size().
536 g_inet_address_to_bytes (GInetAddress
*address
)
538 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), NULL
);
540 return (guint8
*)&address
->priv
->addr
;
544 * g_inet_address_get_native_size:
545 * @address: a #GInetAddress
547 * Gets the size of the native raw binary address for @address. This
548 * is the size of the data that you get from g_inet_address_to_bytes().
550 * Returns: the number of bytes used for the native version of @address.
555 g_inet_address_get_native_size (GInetAddress
*address
)
557 if (address
->priv
->family
== AF_INET
)
558 return sizeof (address
->priv
->addr
.ipv4
);
559 return sizeof (address
->priv
->addr
.ipv6
);
563 * g_inet_address_get_family:
564 * @address: a #GInetAddress
566 * Gets @address's family
568 * Returns: @address's family
573 g_inet_address_get_family (GInetAddress
*address
)
575 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
577 return address
->priv
->family
;
581 * g_inet_address_get_is_any:
582 * @address: a #GInetAddress
584 * Tests whether @address is the "any" address for its family.
586 * Returns: %TRUE if @address is the "any" address for its family.
591 g_inet_address_get_is_any (GInetAddress
*address
)
593 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
595 if (address
->priv
->family
== AF_INET
)
597 guint32 addr4
= g_ntohl (address
->priv
->addr
.ipv4
.s_addr
);
599 return addr4
== INADDR_ANY
;
602 return IN6_IS_ADDR_UNSPECIFIED (&address
->priv
->addr
.ipv6
);
606 * g_inet_address_get_is_loopback:
607 * @address: a #GInetAddress
609 * Tests whether @address is the loopback address for its family.
611 * Returns: %TRUE if @address is the loopback address for its family.
616 g_inet_address_get_is_loopback (GInetAddress
*address
)
618 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
620 if (address
->priv
->family
== AF_INET
)
622 guint32 addr4
= g_ntohl (address
->priv
->addr
.ipv4
.s_addr
);
625 return ((addr4
& 0xff000000) == 0x7f000000);
628 return IN6_IS_ADDR_LOOPBACK (&address
->priv
->addr
.ipv6
);
632 * g_inet_address_get_is_link_local:
633 * @address: a #GInetAddress
635 * Tests whether @address is a link-local address (that is, if it
636 * identifies a host on a local network that is not connected to the
639 * Returns: %TRUE if @address is a link-local address.
644 g_inet_address_get_is_link_local (GInetAddress
*address
)
646 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
648 if (address
->priv
->family
== AF_INET
)
650 guint32 addr4
= g_ntohl (address
->priv
->addr
.ipv4
.s_addr
);
653 return ((addr4
& 0xffff0000) == 0xa9fe0000);
656 return IN6_IS_ADDR_LINKLOCAL (&address
->priv
->addr
.ipv6
);
660 * g_inet_address_get_is_site_local:
661 * @address: a #GInetAddress
663 * Tests whether @address is a site-local address such as 10.0.0.1
664 * (that is, the address identifies a host on a local network that can
665 * not be reached directly from the Internet, but which may have
666 * outgoing Internet connectivity via a NAT or firewall).
668 * Returns: %TRUE if @address is a site-local address.
673 g_inet_address_get_is_site_local (GInetAddress
*address
)
675 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
677 if (address
->priv
->family
== AF_INET
)
679 guint32 addr4
= g_ntohl (address
->priv
->addr
.ipv4
.s_addr
);
681 /* 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16 */
682 return ((addr4
& 0xff000000) == 0x0a000000 ||
683 (addr4
& 0xfff00000) == 0xac100000 ||
684 (addr4
& 0xffff0000) == 0xc0a80000);
687 return IN6_IS_ADDR_SITELOCAL (&address
->priv
->addr
.ipv6
);
691 * g_inet_address_get_is_multicast:
692 * @address: a #GInetAddress
694 * Tests whether @address is a multicast address.
696 * Returns: %TRUE if @address is a multicast address.
701 g_inet_address_get_is_multicast (GInetAddress
*address
)
703 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
705 if (address
->priv
->family
== AF_INET
)
707 guint32 addr4
= g_ntohl (address
->priv
->addr
.ipv4
.s_addr
);
709 return IN_MULTICAST (addr4
);
712 return IN6_IS_ADDR_MULTICAST (&address
->priv
->addr
.ipv6
);
716 * g_inet_address_get_is_mc_global:
717 * @address: a #GInetAddress
719 * Tests whether @address is a global multicast address.
721 * Returns: %TRUE if @address is a global multicast address.
726 g_inet_address_get_is_mc_global (GInetAddress
*address
)
728 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
730 if (address
->priv
->family
== AF_INET
)
733 return IN6_IS_ADDR_MC_GLOBAL (&address
->priv
->addr
.ipv6
);
737 * g_inet_address_get_is_mc_link_local:
738 * @address: a #GInetAddress
740 * Tests whether @address is a link-local multicast address.
742 * Returns: %TRUE if @address is a link-local multicast address.
747 g_inet_address_get_is_mc_link_local (GInetAddress
*address
)
749 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
751 if (address
->priv
->family
== AF_INET
)
754 return IN6_IS_ADDR_MC_LINKLOCAL (&address
->priv
->addr
.ipv6
);
758 * g_inet_address_get_is_mc_node_local:
759 * @address: a #GInetAddress
761 * Tests whether @address is a node-local multicast address.
763 * Returns: %TRUE if @address is a node-local multicast address.
768 g_inet_address_get_is_mc_node_local (GInetAddress
*address
)
770 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
772 if (address
->priv
->family
== AF_INET
)
775 return IN6_IS_ADDR_MC_NODELOCAL (&address
->priv
->addr
.ipv6
);
779 * g_inet_address_get_is_mc_org_local:
780 * @address: a #GInetAddress
782 * Tests whether @address is an organization-local multicast address.
784 * Returns: %TRUE if @address is an organization-local multicast address.
789 g_inet_address_get_is_mc_org_local (GInetAddress
*address
)
791 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
793 if (address
->priv
->family
== AF_INET
)
796 return IN6_IS_ADDR_MC_ORGLOCAL (&address
->priv
->addr
.ipv6
);
800 * g_inet_address_get_is_mc_site_local:
801 * @address: a #GInetAddress
803 * Tests whether @address is a site-local multicast address.
805 * Returns: %TRUE if @address is a site-local multicast address.
810 g_inet_address_get_is_mc_site_local (GInetAddress
*address
)
812 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
814 if (address
->priv
->family
== AF_INET
)
817 return IN6_IS_ADDR_MC_SITELOCAL (&address
->priv
->addr
.ipv6
);
821 * g_inet_address_equal:
822 * @address: A #GInetAddress.
823 * @other_address: Another #GInetAddress.
825 * Checks if two #GInetAddress instances are equal, e.g. the same address.
827 * Returns: %TRUE if @address and @other_address are equal, %FALSE otherwise.
832 g_inet_address_equal (GInetAddress
*address
,
833 GInetAddress
*other_address
)
835 g_return_val_if_fail (G_IS_INET_ADDRESS (address
), FALSE
);
836 g_return_val_if_fail (G_IS_INET_ADDRESS (other_address
), FALSE
);
838 if (g_inet_address_get_family (address
) != g_inet_address_get_family (other_address
))
841 if (memcmp (g_inet_address_to_bytes (address
),
842 g_inet_address_to_bytes (other_address
),
843 g_inet_address_get_native_size (address
)) != 0)