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 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.
20 * Authors: Christian Kellner <gicmo@gnome.org>
21 * Samuel Cormier-Iijima <sciyoshi@gmail.com>
30 #include "ginetaddress.h"
32 #include "gioenumtypes.h"
34 #include "gnetworkingprivate.h"
39 * SECTION:ginetaddress
40 * @short_description: An IPv4/IPv6 address
42 * #GInetAddress represents an IPv4 or IPv6 internet address. Use
43 * g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to
44 * look up the #GInetAddress for a hostname. Use
45 * g_resolver_lookup_by_address() or
46 * g_resolver_lookup_by_address_async() to look up the hostname for a
49 * To actually connect to a remote host, you will need a
50 * #GInetSocketAddress (which includes a #GInetAddress as well as a
57 * An IPv4 or IPv6 internet address.
60 /* Networking initialization function, called from inside the g_once of
61 * g_inet_address_get_type()
64 _g_networking_init (void)
68 if (WSAStartup (MAKEWORD (2, 0), &wsadata) != 0)
69 g_error ("Windows Sockets could not be initialized");
73 G_DEFINE_TYPE_WITH_CODE (GInetAddress, g_inet_address, G_TYPE_OBJECT,
74 _g_networking_init ();)
76 struct _GInetAddressPrivate
96 PROP_IS_MC_LINK_LOCAL,
97 PROP_IS_MC_NODE_LOCAL,
99 PROP_IS_MC_SITE_LOCAL,
103 g_inet_address_set_property (GObject *object,
108 GInetAddress *address = G_INET_ADDRESS (object);
113 address->priv->family = g_value_get_enum (value);
117 memcpy (&address->priv->addr, g_value_get_pointer (value),
118 address->priv->family == AF_INET ?
119 sizeof (address->priv->addr.ipv4) :
120 sizeof (address->priv->addr.ipv6));
124 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
131 g_inet_address_get_property (GObject *object,
136 GInetAddress *address = G_INET_ADDRESS (object);
141 g_value_set_enum (value, address->priv->family);
145 g_value_set_pointer (value, &address->priv->addr);
149 g_value_set_boolean (value, g_inet_address_get_is_any (address));
152 case PROP_IS_LOOPBACK:
153 g_value_set_boolean (value, g_inet_address_get_is_loopback (address));
156 case PROP_IS_LINK_LOCAL:
157 g_value_set_boolean (value, g_inet_address_get_is_link_local (address));
160 case PROP_IS_SITE_LOCAL:
161 g_value_set_boolean (value, g_inet_address_get_is_site_local (address));
164 case PROP_IS_MULTICAST:
165 g_value_set_boolean (value, g_inet_address_get_is_multicast (address));
168 case PROP_IS_MC_GLOBAL:
169 g_value_set_boolean (value, g_inet_address_get_is_mc_global (address));
172 case PROP_IS_MC_LINK_LOCAL:
173 g_value_set_boolean (value, g_inet_address_get_is_mc_link_local (address));
176 case PROP_IS_MC_NODE_LOCAL:
177 g_value_set_boolean (value, g_inet_address_get_is_mc_node_local (address));
180 case PROP_IS_MC_ORG_LOCAL:
181 g_value_set_boolean (value, g_inet_address_get_is_mc_org_local (address));
184 case PROP_IS_MC_SITE_LOCAL:
185 g_value_set_boolean (value, g_inet_address_get_is_mc_site_local (address));
189 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
194 g_inet_address_class_init (GInetAddressClass *klass)
196 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
198 g_type_class_add_private (klass, sizeof (GInetAddressPrivate));
200 gobject_class->set_property = g_inet_address_set_property;
201 gobject_class->get_property = g_inet_address_get_property;
203 g_object_class_install_property (gobject_class, PROP_FAMILY,
204 g_param_spec_enum ("family",
205 P_("Address family"),
206 P_("The address family (IPv4 or IPv6)"),
207 G_TYPE_SOCKET_FAMILY,
208 G_SOCKET_FAMILY_INVALID,
210 G_PARAM_CONSTRUCT_ONLY |
211 G_PARAM_STATIC_STRINGS));
213 g_object_class_install_property (gobject_class, PROP_BYTES,
214 g_param_spec_pointer ("bytes",
216 P_("The raw address data"),
218 G_PARAM_CONSTRUCT_ONLY |
219 G_PARAM_STATIC_STRINGS));
222 * GInetAddress:is-any:
224 * Whether this is the "any" address for its family.
225 * See g_inet_address_get_is_any().
229 g_object_class_install_property (gobject_class, PROP_IS_ANY,
230 g_param_spec_boolean ("is-any",
232 P_("Whether this is the \"any\" address for its family"),
235 G_PARAM_STATIC_STRINGS));
238 * GInetAddress:is-link-local:
240 * Whether this is a link-local address.
241 * See g_inet_address_get_is_link_local().
245 g_object_class_install_property (gobject_class, PROP_IS_LINK_LOCAL,
246 g_param_spec_boolean ("is-link-local",
248 P_("Whether this is a link-local address"),
251 G_PARAM_STATIC_STRINGS));
254 * GInetAddress:is-loopback:
256 * Whether this is the loopback address for its family.
257 * See g_inet_address_get_is_loopback().
261 g_object_class_install_property (gobject_class, PROP_IS_LOOPBACK,
262 g_param_spec_boolean ("is-loopback",
264 P_("Whether this is the loopback address for its family"),
267 G_PARAM_STATIC_STRINGS));
270 * GInetAddress:is-site-local:
272 * Whether this is a site-local address.
273 * See g_inet_address_get_is_loopback().
277 g_object_class_install_property (gobject_class, PROP_IS_SITE_LOCAL,
278 g_param_spec_boolean ("is-site-local",
280 P_("Whether this is a site-local address"),
283 G_PARAM_STATIC_STRINGS));
286 * GInetAddress:is-multicast:
288 * Whether this is a multicast address.
289 * See g_inet_address_get_is_multicast().
293 g_object_class_install_property (gobject_class, PROP_IS_MULTICAST,
294 g_param_spec_boolean ("is-multicast",
296 P_("Whether this is a multicast address"),
299 G_PARAM_STATIC_STRINGS));
302 * GInetAddress:is-mc-global:
304 * Whether this is a global multicast address.
305 * See g_inet_address_get_is_mc_global().
309 g_object_class_install_property (gobject_class, PROP_IS_MC_GLOBAL,
310 g_param_spec_boolean ("is-mc-global",
311 P_("Is multicast global"),
312 P_("Whether this is a global multicast address"),
315 G_PARAM_STATIC_STRINGS));
319 * GInetAddress:is-mc-link-local:
321 * Whether this is a link-local multicast address.
322 * See g_inet_address_get_is_mc_link_local().
326 g_object_class_install_property (gobject_class, PROP_IS_MC_LINK_LOCAL,
327 g_param_spec_boolean ("is-mc-link-local",
328 P_("Is multicast link-local"),
329 P_("Whether this is a link-local multicast address"),
332 G_PARAM_STATIC_STRINGS));
335 * GInetAddress:is-mc-node-local:
337 * Whether this is a node-local multicast address.
338 * See g_inet_address_get_is_mc_node_local().
342 g_object_class_install_property (gobject_class, PROP_IS_MC_NODE_LOCAL,
343 g_param_spec_boolean ("is-mc-node-local",
344 P_("Is multicast node-local"),
345 P_("Whether this is a node-local multicast address"),
348 G_PARAM_STATIC_STRINGS));
351 * GInetAddress:is-mc-org-local:
353 * Whether this is an organization-local multicast address.
354 * See g_inet_address_get_is_mc_org_local().
358 g_object_class_install_property (gobject_class, PROP_IS_MC_ORG_LOCAL,
359 g_param_spec_boolean ("is-mc-org-local",
360 P_("Is multicast org-local"),
361 P_("Whether this is an organization-local multicast address"),
364 G_PARAM_STATIC_STRINGS));
367 * GInetAddress:is-mc-site-local:
369 * Whether this is a site-local multicast address.
370 * See g_inet_address_get_is_mc_site_local().
374 g_object_class_install_property (gobject_class, PROP_IS_MC_SITE_LOCAL,
375 g_param_spec_boolean ("is-mc-site-local",
376 P_("Is multicast site-local"),
377 P_("Whether this is a site-local multicast address"),
380 G_PARAM_STATIC_STRINGS));
384 g_inet_address_init (GInetAddress *address)
386 address->priv = G_TYPE_INSTANCE_GET_PRIVATE (address,
388 GInetAddressPrivate);
392 * g_inet_address_new_from_string:
393 * @string: a string representation of an IP address
395 * Parses @string as an IP address and creates a new #GInetAddress.
397 * Returns: a new #GInetAddress corresponding to @string, or %NULL if
398 * @string could not be parsed.
403 g_inet_address_new_from_string (const gchar *string)
407 struct sockaddr_storage sa;
408 struct sockaddr_in *sin = (struct sockaddr_in *)&sa;
409 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)&sa;
411 #else /* !G_OS_WIN32 */
412 struct in_addr in_addr;
413 struct in6_addr in6_addr;
416 /* Make sure _g_networking_init() has been called */
417 type = g_inet_address_get_type ();
420 memset (&sa, 0, sizeof (sa));
422 if (WSAStringToAddress ((LPTSTR) string, AF_INET, NULL, (LPSOCKADDR) &sa, &len) == 0)
423 return g_inet_address_new_from_bytes ((guint8 *)&sin->sin_addr, AF_INET);
424 else if (WSAStringToAddress ((LPTSTR) string, AF_INET6, NULL, (LPSOCKADDR) &sa, &len) == 0)
425 return g_inet_address_new_from_bytes ((guint8 *)&sin6->sin6_addr, AF_INET6);
427 #else /* !G_OS_WIN32 */
429 if (inet_pton (AF_INET, string, &in_addr) > 0)
430 return g_inet_address_new_from_bytes ((guint8 *)&in_addr, AF_INET);
431 else if (inet_pton (AF_INET6, string, &in6_addr) > 0)
432 return g_inet_address_new_from_bytes ((guint8 *)&in6_addr, AF_INET6);
438 #define G_INET_ADDRESS_FAMILY_IS_VALID(family) ((family) == AF_INET || (family) == AF_INET6)
441 * g_inet_address_new_from_bytes:
442 * @bytes: raw address data
443 * @family: the address family of @bytes
445 * Creates a new #GInetAddress from the given @family and @bytes.
446 * @bytes should be 4 bytes for %G_INET_ADDRESS_IPV4 and 16 bytes for
447 * %G_INET_ADDRESS_IPV6.
449 * Returns: a new #GInetAddress corresponding to @family and @bytes.
454 g_inet_address_new_from_bytes (const guint8 *bytes,
455 GSocketFamily family)
457 g_return_val_if_fail (G_INET_ADDRESS_FAMILY_IS_VALID (family), NULL);
459 return g_object_new (G_TYPE_INET_ADDRESS,
466 * g_inet_address_new_loopback:
467 * @family: the address family
469 * Creates a #GInetAddress for the loopback address for @family.
471 * Returns: a new #GInetAddress corresponding to the loopback address
477 g_inet_address_new_loopback (GSocketFamily family)
479 g_return_val_if_fail (G_INET_ADDRESS_FAMILY_IS_VALID (family), NULL);
481 if (family == AF_INET)
483 guint8 addr[4] = {127, 0, 0, 1};
485 return g_inet_address_new_from_bytes (addr, family);
488 return g_inet_address_new_from_bytes (in6addr_loopback.s6_addr, family);
492 * g_inet_address_new_any:
493 * @family: the address family
495 * Creates a #GInetAddress for the "any" address (unassigned/"don't
496 * care") for @family.
498 * Returns: a new #GInetAddress corresponding to the "any" address
504 g_inet_address_new_any (GSocketFamily family)
506 g_return_val_if_fail (G_INET_ADDRESS_FAMILY_IS_VALID (family), NULL);
508 if (family == AF_INET)
510 guint8 addr[4] = {0, 0, 0, 0};
512 return g_inet_address_new_from_bytes (addr, family);
515 return g_inet_address_new_from_bytes (in6addr_any.s6_addr, family);
520 * g_inet_address_to_string:
521 * @address: a #GInetAddress
523 * Converts @address to string form.
525 * Returns: a representation of @address as a string, which should be
531 g_inet_address_to_string (GInetAddress *address)
533 gchar buffer[INET6_ADDRSTRLEN];
535 DWORD buflen = sizeof (buffer), addrlen;
536 struct sockaddr_storage sa;
537 struct sockaddr_in *sin = (struct sockaddr_in *)&sa;
538 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)&sa;
541 g_return_val_if_fail (G_IS_INET_ADDRESS (address), NULL);
544 sa.ss_family = address->priv->family;
545 if (address->priv->family == AF_INET)
547 addrlen = sizeof (*sin);
548 memcpy (&sin->sin_addr, &address->priv->addr.ipv4,
549 sizeof (sin->sin_addr));
554 addrlen = sizeof (*sin6);
555 memcpy (&sin6->sin6_addr, &address->priv->addr.ipv6,
556 sizeof (sin6->sin6_addr));
559 if (WSAAddressToString ((LPSOCKADDR) &sa, addrlen, NULL, buffer, &buflen) != 0)
562 #else /* !G_OS_WIN32 */
564 if (address->priv->family == AF_INET)
565 inet_ntop (AF_INET, &address->priv->addr.ipv4, buffer, sizeof (buffer));
567 inet_ntop (AF_INET6, &address->priv->addr.ipv6, buffer, sizeof (buffer));
570 return g_strdup (buffer);
574 * g_inet_address_to_bytes:
575 * @address: a #GInetAddress
577 * Gets the raw binary address data from @address.
579 * Returns: a pointer to an internal array of the bytes in @address,
580 * which should not be modified, stored, or freed. The size of this
581 * array can be gotten with g_inet_address_get_native_size().
586 g_inet_address_to_bytes (GInetAddress *address)
588 g_return_val_if_fail (G_IS_INET_ADDRESS (address), NULL);
590 return (guint8 *)&address->priv->addr;
594 * g_inet_address_get_native_size:
595 * @address: a #GInetAddress
597 * Gets the size of the native raw binary address for @address. This
598 * is the size of the data that you get from g_inet_address_to_bytes().
600 * Returns: the number of bytes used for the native version of @address.
605 g_inet_address_get_native_size (GInetAddress *address)
607 if (address->priv->family == AF_INET)
608 return sizeof (address->priv->addr.ipv4);
609 return sizeof (address->priv->addr.ipv6);
613 * g_inet_address_get_family:
614 * @address: a #GInetAddress
616 * Gets @address's family
618 * Returns: @address's family
623 g_inet_address_get_family (GInetAddress *address)
625 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
627 return address->priv->family;
631 * g_inet_address_get_is_any:
632 * @address: a #GInetAddress
634 * Tests whether @address is the "any" address for its family.
636 * Returns: %TRUE if @address is the "any" address for its family.
641 g_inet_address_get_is_any (GInetAddress *address)
643 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
645 if (address->priv->family == AF_INET)
647 guint32 addr4 = g_ntohl (address->priv->addr.ipv4.s_addr);
649 return addr4 == INADDR_ANY;
652 return IN6_IS_ADDR_UNSPECIFIED (&address->priv->addr.ipv6);
656 * g_inet_address_get_is_loopback:
657 * @address: a #GInetAddress
659 * Tests whether @address is the loopback address for its family.
661 * Returns: %TRUE if @address is the loopback address for its family.
666 g_inet_address_get_is_loopback (GInetAddress *address)
668 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
670 if (address->priv->family == AF_INET)
672 guint32 addr4 = g_ntohl (address->priv->addr.ipv4.s_addr);
675 return ((addr4 & 0xff000000) == 0x7f000000);
678 return IN6_IS_ADDR_LOOPBACK (&address->priv->addr.ipv6);
682 * g_inet_address_get_is_link_local:
683 * @address: a #GInetAddress
685 * Tests whether @address is a link-local address (that is, if it
686 * identifies a host on a local network that is not connected to the
689 * Returns: %TRUE if @address is a link-local address.
694 g_inet_address_get_is_link_local (GInetAddress *address)
696 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
698 if (address->priv->family == AF_INET)
700 guint32 addr4 = g_ntohl (address->priv->addr.ipv4.s_addr);
703 return ((addr4 & 0xffff0000) == 0xa9fe0000);
706 return IN6_IS_ADDR_LINKLOCAL (&address->priv->addr.ipv6);
710 * g_inet_address_get_is_site_local:
711 * @address: a #GInetAddress
713 * Tests whether @address is a site-local address such as 10.0.0.1
714 * (that is, the address identifies a host on a local network that can
715 * not be reached directly from the Internet, but which may have
716 * outgoing Internet connectivity via a NAT or firewall).
718 * Returns: %TRUE if @address is a site-local address.
723 g_inet_address_get_is_site_local (GInetAddress *address)
725 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
727 if (address->priv->family == AF_INET)
729 guint32 addr4 = g_ntohl (address->priv->addr.ipv4.s_addr);
731 /* 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16 */
732 return ((addr4 & 0xff000000) == 0x0a000000 ||
733 (addr4 & 0xfff00000) == 0xac100000 ||
734 (addr4 & 0xffff0000) == 0xc0a80000);
737 return IN6_IS_ADDR_SITELOCAL (&address->priv->addr.ipv6);
741 * g_inet_address_get_is_multicast:
742 * @address: a #GInetAddress
744 * Tests whether @address is a multicast address.
746 * Returns: %TRUE if @address is a multicast address.
751 g_inet_address_get_is_multicast (GInetAddress *address)
753 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
755 if (address->priv->family == AF_INET)
757 guint32 addr4 = g_ntohl (address->priv->addr.ipv4.s_addr);
759 return IN_MULTICAST (addr4);
762 return IN6_IS_ADDR_MULTICAST (&address->priv->addr.ipv6);
766 * g_inet_address_get_is_mc_global:
767 * @address: a #GInetAddress
769 * Tests whether @address is a global multicast address.
771 * Returns: %TRUE if @address is a global multicast address.
776 g_inet_address_get_is_mc_global (GInetAddress *address)
778 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
780 if (address->priv->family == AF_INET)
783 return IN6_IS_ADDR_MC_GLOBAL (&address->priv->addr.ipv6);
787 * g_inet_address_get_is_mc_link_local:
788 * @address: a #GInetAddress
790 * Tests whether @address is a link-local multicast address.
792 * Returns: %TRUE if @address is a link-local multicast address.
797 g_inet_address_get_is_mc_link_local (GInetAddress *address)
799 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
801 if (address->priv->family == AF_INET)
804 return IN6_IS_ADDR_MC_LINKLOCAL (&address->priv->addr.ipv6);
808 * g_inet_address_get_is_mc_node_local:
809 * @address: a #GInetAddress
811 * Tests whether @address is a node-local multicast address.
813 * Returns: %TRUE if @address is a node-local multicast address.
818 g_inet_address_get_is_mc_node_local (GInetAddress *address)
820 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
822 if (address->priv->family == AF_INET)
825 return IN6_IS_ADDR_MC_NODELOCAL (&address->priv->addr.ipv6);
829 * g_inet_address_get_is_mc_org_local:
830 * @address: a #GInetAddress
832 * Tests whether @address is an organization-local multicast address.
834 * Returns: %TRUE if @address is an organization-local multicast address.
839 g_inet_address_get_is_mc_org_local (GInetAddress *address)
841 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
843 if (address->priv->family == AF_INET)
846 return IN6_IS_ADDR_MC_ORGLOCAL (&address->priv->addr.ipv6);
850 * g_inet_address_get_is_mc_site_local:
851 * @address: a #GInetAddress
853 * Tests whether @address is a site-local multicast address.
855 * Returns: %TRUE if @address is a site-local multicast address.
860 g_inet_address_get_is_mc_site_local (GInetAddress *address)
862 g_return_val_if_fail (G_IS_INET_ADDRESS (address), FALSE);
864 if (address->priv->family == AF_INET)
867 return IN6_IS_ADDR_MC_SITELOCAL (&address->priv->addr.ipv6);
870 #define __G_INET_ADDRESS_C__
871 #include "gioaliasdef.c"