1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
3 /* GIO - GLib Input, Output and Streaming Library
5 * Copyright (C) 2008 Red Hat, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
26 #include "gnetworkaddress.h"
27 #include "gasyncresult.h"
28 #include "ginetaddress.h"
29 #include "ginetsocketaddress.h"
30 #include "gnetworkingprivate.h"
31 #include "gproxyaddressenumerator.h"
32 #include "gresolver.h"
34 #include "gsocketaddressenumerator.h"
36 #include "gsocketconnectable.h"
42 * SECTION:gnetworkaddress
43 * @short_description: A GSocketConnectable for resolving hostnames
46 * #GNetworkAddress provides an easy way to resolve a hostname and
47 * then attempt to connect to that host, handling the possibility of
48 * multiple IP addresses and multiple address families.
50 * See #GSocketConnectable for and example of using the connectable
57 * A #GSocketConnectable for resolving a hostname and connecting to
61 struct _GNetworkAddressPrivate {
67 gint64 resolver_serial;
77 static void g_network_address_set_property (GObject *object,
81 static void g_network_address_get_property (GObject *object,
86 static void g_network_address_connectable_iface_init (GSocketConnectableIface *iface);
87 static GSocketAddressEnumerator *g_network_address_connectable_enumerate (GSocketConnectable *connectable);
88 static GSocketAddressEnumerator *g_network_address_connectable_proxy_enumerate (GSocketConnectable *connectable);
90 G_DEFINE_TYPE_WITH_CODE (GNetworkAddress, g_network_address, G_TYPE_OBJECT,
91 G_ADD_PRIVATE (GNetworkAddress)
92 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
93 g_network_address_connectable_iface_init))
96 g_network_address_finalize (GObject *object)
98 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
100 g_free (addr->priv->hostname);
101 g_free (addr->priv->scheme);
103 if (addr->priv->sockaddrs)
107 for (a = addr->priv->sockaddrs; a; a = a->next)
108 g_object_unref (a->data);
109 g_list_free (addr->priv->sockaddrs);
112 G_OBJECT_CLASS (g_network_address_parent_class)->finalize (object);
116 g_network_address_class_init (GNetworkAddressClass *klass)
118 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
120 gobject_class->set_property = g_network_address_set_property;
121 gobject_class->get_property = g_network_address_get_property;
122 gobject_class->finalize = g_network_address_finalize;
124 g_object_class_install_property (gobject_class, PROP_HOSTNAME,
125 g_param_spec_string ("hostname",
127 P_("Hostname to resolve"),
130 G_PARAM_CONSTRUCT_ONLY |
131 G_PARAM_STATIC_STRINGS));
132 g_object_class_install_property (gobject_class, PROP_PORT,
133 g_param_spec_uint ("port",
138 G_PARAM_CONSTRUCT_ONLY |
139 G_PARAM_STATIC_STRINGS));
141 g_object_class_install_property (gobject_class, PROP_SCHEME,
142 g_param_spec_string ("scheme",
147 G_PARAM_CONSTRUCT_ONLY |
148 G_PARAM_STATIC_STRINGS));
152 g_network_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
154 connectable_iface->enumerate = g_network_address_connectable_enumerate;
155 connectable_iface->proxy_enumerate = g_network_address_connectable_proxy_enumerate;
159 g_network_address_init (GNetworkAddress *addr)
161 addr->priv = g_network_address_get_instance_private (addr);
165 g_network_address_set_property (GObject *object,
170 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
175 g_free (addr->priv->hostname);
176 addr->priv->hostname = g_value_dup_string (value);
180 addr->priv->port = g_value_get_uint (value);
184 if (addr->priv->scheme)
185 g_free (addr->priv->scheme);
186 addr->priv->scheme = g_value_dup_string (value);
190 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
197 g_network_address_get_property (GObject *object,
202 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
207 g_value_set_string (value, addr->priv->hostname);
211 g_value_set_uint (value, addr->priv->port);
215 g_value_set_string (value, addr->priv->scheme);
219 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
226 g_network_address_set_addresses (GNetworkAddress *addr,
228 guint64 resolver_serial)
231 GSocketAddress *sockaddr;
233 g_return_if_fail (addresses != NULL && addr->priv->sockaddrs == NULL);
235 for (a = addresses; a; a = a->next)
237 sockaddr = g_inet_socket_address_new (a->data, addr->priv->port);
238 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
239 g_object_unref (a->data);
241 g_list_free (addresses);
242 addr->priv->sockaddrs = g_list_reverse (addr->priv->sockaddrs);
244 addr->priv->resolver_serial = resolver_serial;
248 g_network_address_parse_sockaddr (GNetworkAddress *addr)
250 struct addrinfo hints, *res = NULL;
251 GSocketAddress *sockaddr;
254 memset (&hints, 0, sizeof (hints));
255 hints.ai_socktype = SOCK_STREAM;
256 hints.ai_flags = AI_NUMERICHOST
257 #ifdef AI_NUMERICSERV
261 g_snprintf (port, sizeof (port), "%u", addr->priv->port);
263 if (getaddrinfo (addr->priv->hostname, port, &hints, &res) != 0)
266 sockaddr = g_socket_address_new_from_native (res->ai_addr, res->ai_addrlen);
268 if (!sockaddr || !G_IS_INET_SOCKET_ADDRESS (sockaddr))
271 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
276 * g_network_address_new:
277 * @hostname: the hostname
280 * Creates a new #GSocketConnectable for connecting to the given
281 * @hostname and @port.
283 * Return value: (transfer full) (type GNetworkAddress): the new #GNetworkAddress
288 g_network_address_new (const gchar *hostname,
291 return g_object_new (G_TYPE_NETWORK_ADDRESS,
292 "hostname", hostname,
298 * g_network_address_parse:
299 * @host_and_port: the hostname and optionally a port
300 * @default_port: the default port if not in @host_and_port
301 * @error: a pointer to a #GError, or %NULL
303 * Creates a new #GSocketConnectable for connecting to the given
304 * @hostname and @port. May fail and return %NULL in case
305 * parsing @host_and_port fails.
307 * @host_and_port may be in any of a number of recognised formats; an IPv6
308 * address, an IPv4 address, or a domain name (in which case a DNS
309 * lookup is performed). Quoting with [] is supported for all address
310 * types. A port override may be specified in the usual way with a
313 * If no port is specified in @host_and_port then @default_port will be
314 * used as the port number to connect to.
316 * In general, @host_and_port is expected to be provided by the user
317 * (allowing them to give the hostname, and a port overide if necessary)
318 * and @default_port is expected to be provided by the application.
320 * (The port component of @host_and_port can also be specified as a
321 * service name rather than as a numeric port, but this functionality
322 * is deprecated, because it depends on the contents of /etc/services,
323 * which is generally quite sparse on platforms other than Linux.)
325 * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
330 g_network_address_parse (const gchar *host_and_port,
331 guint16 default_port,
334 GSocketConnectable *connectable;
339 g_return_val_if_fail (host_and_port != NULL, NULL);
342 if (host_and_port[0] == '[')
343 /* escaped host part (to allow, eg. "[2001:db8::1]:888") */
347 end = strchr (host_and_port, ']');
350 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
351 _("Hostname '%s' contains '[' but not ']'"), host_and_port);
357 else if (end[1] == ':')
361 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
362 "The ']' character (in hostname '%s') must come at the"
363 " end or be immediately followed by ':' and a port",
368 name = g_strndup (host_and_port + 1, end - host_and_port - 1);
371 else if ((port = strchr (host_and_port, ':')))
372 /* string has a ':' in it */
377 if (strchr (port, ':'))
378 /* more than one ':' in string */
380 /* this is actually an unescaped IPv6 address */
381 name = g_strdup (host_and_port);
385 name = g_strndup (host_and_port, port - host_and_port - 1);
389 /* plain hostname, no port */
390 name = g_strdup (host_and_port);
396 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
397 "If a ':' character is given, it must be followed by a "
398 "port (in hostname '%s').", host_and_port);
403 else if ('0' <= port[0] && port[0] <= '9')
408 value = strtol (port, &end, 10);
409 if (*end != '\0' || value < 0 || value > G_MAXUINT16)
411 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
412 "Invalid numeric port '%s' specified in hostname '%s'",
413 port, host_and_port);
423 struct servent *entry;
425 entry = getservbyname (port, "tcp");
428 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
429 "Unknown service '%s' specified in hostname '%s'",
430 port, host_and_port);
431 #ifdef HAVE_ENDSERVENT
438 portnum = g_ntohs (entry->s_port);
440 #ifdef HAVE_ENDSERVENT
447 /* No port in host_and_port */
448 portnum = default_port;
451 connectable = g_network_address_new (name, portnum);
457 /* Allowed characters outside alphanumeric for unreserved. */
458 #define G_URI_OTHER_UNRESERVED "-._~"
460 /* This or something equivalent will eventually go into glib/guri.h */
462 _g_uri_parse_authority (const char *uri,
468 const char *start, *p;
471 g_return_val_if_fail (uri != NULL, FALSE);
482 /* From RFC 3986 Decodes:
483 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
484 * hier-part = "//" authority path-abempty
485 * path-abempty = *( "/" segment )
486 * authority = [ userinfo "@" ] host [ ":" port ]
489 /* Check we have a valid scheme */
490 tmp_str = g_uri_parse_scheme (uri);
498 * hier-part = "//" authority path-abempty
501 start = strstr (p, "//");
508 if (strchr (start, '@') != NULL)
511 * userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
512 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
513 * pct-encoded = "%" HEXDIG HEXDIG
526 if (!(g_ascii_isxdigit (p[0]) ||
527 g_ascii_isxdigit (p[1])))
535 /* unreserved / sub-delims / : */
536 if (!(g_ascii_isalnum (c) ||
537 strchr (G_URI_OTHER_UNRESERVED, c) ||
538 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
544 *userinfo = g_strndup (start, p - start - 1);
555 * host = IP-literal / IPv4address / reg-name
556 * reg-name = *( unreserved / pct-encoded / sub-delims )
559 /* If IPv6 or IPvFuture */
562 gboolean has_scope_id = FALSE, has_bad_scope_id = FALSE;
573 if (c == '%' && !has_scope_id)
576 if (p[0] != '2' || p[1] != '5')
577 has_bad_scope_id = TRUE;
581 /* unreserved / sub-delims */
582 if (!(g_ascii_isalnum (c) ||
583 strchr (G_URI_OTHER_UNRESERVED, c) ||
584 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
592 if (has_bad_scope_id)
593 *host = g_strndup (start, p - start - 1);
595 *host = g_uri_unescape_segment (start, p - 1, NULL);
616 if (!(g_ascii_isxdigit (p[0]) ||
617 g_ascii_isxdigit (p[1])))
625 /* unreserved / sub-delims */
626 if (!(g_ascii_isalnum (c) ||
627 strchr (G_URI_OTHER_UNRESERVED, c) ||
628 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c)))
633 *host = g_uri_unescape_segment (start, p - 1, NULL);
653 if (!g_ascii_isdigit (c))
656 tmp = (tmp * 10) + (c - '0');
662 *port = (guint16) tmp;
674 if (userinfo && *userinfo)
684 _g_uri_from_authority (const gchar *protocol,
687 const gchar *userinfo)
691 uri = g_string_new (protocol);
692 g_string_append (uri, "://");
696 g_string_append_uri_escaped (uri, userinfo, G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO, FALSE);
697 g_string_append_c (uri, '@');
700 if (g_hostname_is_non_ascii (host))
702 gchar *ace_encoded = g_hostname_to_ascii (host);
706 g_string_free (uri, TRUE);
709 g_string_append (uri, ace_encoded);
710 g_free (ace_encoded);
712 else if (strchr (host, ':'))
713 g_string_append_printf (uri, "[%s]", host);
715 g_string_append (uri, host);
718 g_string_append_printf (uri, ":%u", port);
720 return g_string_free (uri, FALSE);
724 * g_network_address_parse_uri:
725 * @uri: the hostname and optionally a port
726 * @default_port: The default port if none is found in the URI
727 * @error: a pointer to a #GError, or %NULL
729 * Creates a new #GSocketConnectable for connecting to the given
730 * @uri. May fail and return %NULL in case parsing @uri fails.
732 * Using this rather than g_network_address_new() or
733 * g_network_address_parse() allows #GSocketClient to determine
734 * when to use application-specific proxy protocols.
736 * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
741 g_network_address_parse_uri (const gchar *uri,
742 guint16 default_port,
745 GSocketConnectable *conn;
750 if (!_g_uri_parse_authority (uri, &hostname, &port, NULL))
752 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
761 scheme = g_uri_parse_scheme (uri);
763 conn = g_object_new (G_TYPE_NETWORK_ADDRESS,
764 "hostname", hostname,
776 * g_network_address_get_hostname:
777 * @addr: a #GNetworkAddress
779 * Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded,
780 * depending on what @addr was created with.
782 * Return value: @addr's hostname
787 g_network_address_get_hostname (GNetworkAddress *addr)
789 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
791 return addr->priv->hostname;
795 * g_network_address_get_port:
796 * @addr: a #GNetworkAddress
798 * Gets @addr's port number
800 * Return value: @addr's port (which may be 0)
805 g_network_address_get_port (GNetworkAddress *addr)
807 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), 0);
809 return addr->priv->port;
813 * g_network_address_get_scheme:
814 * @addr: a #GNetworkAddress
816 * Gets @addr's scheme
818 * Return value: @addr's scheme (%NULL if not built from URI)
823 g_network_address_get_scheme (GNetworkAddress *addr)
825 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
827 return addr->priv->scheme;
830 #define G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (_g_network_address_address_enumerator_get_type ())
831 #define G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, GNetworkAddressAddressEnumerator))
834 GSocketAddressEnumerator parent_instance;
836 GNetworkAddress *addr;
839 } GNetworkAddressAddressEnumerator;
842 GSocketAddressEnumeratorClass parent_class;
844 } GNetworkAddressAddressEnumeratorClass;
846 static GType _g_network_address_address_enumerator_get_type (void);
847 G_DEFINE_TYPE (GNetworkAddressAddressEnumerator, _g_network_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
850 g_network_address_address_enumerator_finalize (GObject *object)
852 GNetworkAddressAddressEnumerator *addr_enum =
853 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (object);
855 g_object_unref (addr_enum->addr);
857 G_OBJECT_CLASS (_g_network_address_address_enumerator_parent_class)->finalize (object);
860 static GSocketAddress *
861 g_network_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
862 GCancellable *cancellable,
865 GNetworkAddressAddressEnumerator *addr_enum =
866 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
867 GSocketAddress *sockaddr;
869 if (addr_enum->addresses == NULL)
871 GNetworkAddress *addr = addr_enum->addr;
872 GResolver *resolver = g_resolver_get_default ();
873 gint64 serial = g_resolver_get_serial (resolver);
875 if (addr->priv->resolver_serial != 0 &&
876 addr->priv->resolver_serial != serial)
878 /* Resolver has reloaded, discard cached addresses */
879 g_list_free_full (addr->priv->sockaddrs, g_object_unref);
880 addr->priv->sockaddrs = NULL;
883 if (!addr->priv->sockaddrs)
884 g_network_address_parse_sockaddr (addr);
885 if (!addr->priv->sockaddrs)
889 addresses = g_resolver_lookup_by_name (resolver,
890 addr->priv->hostname,
894 g_object_unref (resolver);
898 g_network_address_set_addresses (addr, addresses, serial);
901 addr_enum->addresses = addr->priv->sockaddrs;
902 addr_enum->next = addr_enum->addresses;
903 g_object_unref (resolver);
906 if (addr_enum->next == NULL)
909 sockaddr = addr_enum->next->data;
910 addr_enum->next = addr_enum->next->next;
911 return g_object_ref (sockaddr);
915 have_addresses (GNetworkAddressAddressEnumerator *addr_enum,
916 GTask *task, GError *error)
918 GSocketAddress *sockaddr;
920 addr_enum->addresses = addr_enum->addr->priv->sockaddrs;
921 addr_enum->next = addr_enum->addresses;
925 sockaddr = g_object_ref (addr_enum->next->data);
926 addr_enum->next = addr_enum->next->next;
932 g_task_return_error (task, error);
934 g_task_return_pointer (task, sockaddr, g_object_unref);
935 g_object_unref (task);
939 got_addresses (GObject *source_object,
940 GAsyncResult *result,
943 GTask *task = user_data;
944 GNetworkAddressAddressEnumerator *addr_enum = g_task_get_source_object (task);
945 GResolver *resolver = G_RESOLVER (source_object);
947 GError *error = NULL;
949 if (!addr_enum->addr->priv->sockaddrs)
951 addresses = g_resolver_lookup_by_name_finish (resolver, result, &error);
955 g_network_address_set_addresses (addr_enum->addr, addresses,
956 g_resolver_get_serial (resolver));
959 have_addresses (addr_enum, task, error);
963 g_network_address_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
964 GCancellable *cancellable,
965 GAsyncReadyCallback callback,
968 GNetworkAddressAddressEnumerator *addr_enum =
969 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
970 GSocketAddress *sockaddr;
973 task = g_task_new (addr_enum, cancellable, callback, user_data);
975 if (addr_enum->addresses == NULL)
977 GNetworkAddress *addr = addr_enum->addr;
978 GResolver *resolver = g_resolver_get_default ();
979 gint64 serial = g_resolver_get_serial (resolver);
981 if (addr->priv->resolver_serial != 0 &&
982 addr->priv->resolver_serial != serial)
984 /* Resolver has reloaded, discard cached addresses */
985 g_list_free_full (addr->priv->sockaddrs, g_object_unref);
986 addr->priv->sockaddrs = NULL;
989 if (!addr->priv->sockaddrs)
991 if (g_network_address_parse_sockaddr (addr))
992 have_addresses (addr_enum, task, NULL);
995 g_resolver_lookup_by_name_async (resolver,
996 addr->priv->hostname,
998 got_addresses, task);
1000 g_object_unref (resolver);
1004 addr_enum->addresses = addr->priv->sockaddrs;
1005 addr_enum->next = addr_enum->addresses;
1006 g_object_unref (resolver);
1009 if (addr_enum->next)
1011 sockaddr = g_object_ref (addr_enum->next->data);
1012 addr_enum->next = addr_enum->next->next;
1017 g_task_return_pointer (task, sockaddr, g_object_unref);
1018 g_object_unref (task);
1021 static GSocketAddress *
1022 g_network_address_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
1023 GAsyncResult *result,
1026 g_return_val_if_fail (g_task_is_valid (result, enumerator), NULL);
1028 return g_task_propagate_pointer (G_TASK (result), error);
1032 _g_network_address_address_enumerator_init (GNetworkAddressAddressEnumerator *enumerator)
1037 _g_network_address_address_enumerator_class_init (GNetworkAddressAddressEnumeratorClass *addrenum_class)
1039 GObjectClass *object_class = G_OBJECT_CLASS (addrenum_class);
1040 GSocketAddressEnumeratorClass *enumerator_class =
1041 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (addrenum_class);
1043 enumerator_class->next = g_network_address_address_enumerator_next;
1044 enumerator_class->next_async = g_network_address_address_enumerator_next_async;
1045 enumerator_class->next_finish = g_network_address_address_enumerator_next_finish;
1046 object_class->finalize = g_network_address_address_enumerator_finalize;
1049 static GSocketAddressEnumerator *
1050 g_network_address_connectable_enumerate (GSocketConnectable *connectable)
1052 GNetworkAddressAddressEnumerator *addr_enum;
1054 addr_enum = g_object_new (G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, NULL);
1055 addr_enum->addr = g_object_ref (connectable);
1057 return (GSocketAddressEnumerator *)addr_enum;
1060 static GSocketAddressEnumerator *
1061 g_network_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
1063 GNetworkAddress *self = G_NETWORK_ADDRESS (connectable);
1064 GSocketAddressEnumerator *proxy_enum;
1067 uri = _g_uri_from_authority (self->priv->scheme ? self->priv->scheme : "none",
1068 self->priv->hostname,
1072 proxy_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
1073 "connectable", connectable,