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 g_free (addr->priv->scheme);
185 addr->priv->scheme = g_value_dup_string (value);
189 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
196 g_network_address_get_property (GObject *object,
201 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
206 g_value_set_string (value, addr->priv->hostname);
210 g_value_set_uint (value, addr->priv->port);
214 g_value_set_string (value, addr->priv->scheme);
218 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
225 g_network_address_set_addresses (GNetworkAddress *addr,
227 guint64 resolver_serial)
230 GSocketAddress *sockaddr;
232 g_return_if_fail (addresses != NULL && addr->priv->sockaddrs == NULL);
234 for (a = addresses; a; a = a->next)
236 sockaddr = g_inet_socket_address_new (a->data, addr->priv->port);
237 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
238 g_object_unref (a->data);
240 g_list_free (addresses);
241 addr->priv->sockaddrs = g_list_reverse (addr->priv->sockaddrs);
243 addr->priv->resolver_serial = resolver_serial;
247 g_network_address_parse_sockaddr (GNetworkAddress *addr)
249 GSocketAddress *sockaddr;
251 sockaddr = g_inet_socket_address_new_from_string (addr->priv->hostname,
255 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
263 * g_network_address_new:
264 * @hostname: the hostname
267 * Creates a new #GSocketConnectable for connecting to the given
268 * @hostname and @port.
270 * Returns: (transfer full) (type GNetworkAddress): the new #GNetworkAddress
275 g_network_address_new (const gchar *hostname,
278 return g_object_new (G_TYPE_NETWORK_ADDRESS,
279 "hostname", hostname,
285 * g_network_address_parse:
286 * @host_and_port: the hostname and optionally a port
287 * @default_port: the default port if not in @host_and_port
288 * @error: a pointer to a #GError, or %NULL
290 * Creates a new #GSocketConnectable for connecting to the given
291 * @hostname and @port. May fail and return %NULL in case
292 * parsing @host_and_port fails.
294 * @host_and_port may be in any of a number of recognised formats; an IPv6
295 * address, an IPv4 address, or a domain name (in which case a DNS
296 * lookup is performed). Quoting with [] is supported for all address
297 * types. A port override may be specified in the usual way with a
300 * If no port is specified in @host_and_port then @default_port will be
301 * used as the port number to connect to.
303 * In general, @host_and_port is expected to be provided by the user
304 * (allowing them to give the hostname, and a port overide if necessary)
305 * and @default_port is expected to be provided by the application.
307 * (The port component of @host_and_port can also be specified as a
308 * service name rather than as a numeric port, but this functionality
309 * is deprecated, because it depends on the contents of /etc/services,
310 * which is generally quite sparse on platforms other than Linux.)
312 * Returns: (transfer full): the new #GNetworkAddress, or %NULL on error
317 g_network_address_parse (const gchar *host_and_port,
318 guint16 default_port,
321 GSocketConnectable *connectable;
326 g_return_val_if_fail (host_and_port != NULL, NULL);
329 if (host_and_port[0] == '[')
330 /* escaped host part (to allow, eg. "[2001:db8::1]:888") */
334 end = strchr (host_and_port, ']');
337 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
338 _("Hostname '%s' contains '[' but not ']'"), host_and_port);
344 else if (end[1] == ':')
348 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
349 "The ']' character (in hostname '%s') must come at the"
350 " end or be immediately followed by ':' and a port",
355 name = g_strndup (host_and_port + 1, end - host_and_port - 1);
358 else if ((port = strchr (host_and_port, ':')))
359 /* string has a ':' in it */
364 if (strchr (port, ':'))
365 /* more than one ':' in string */
367 /* this is actually an unescaped IPv6 address */
368 name = g_strdup (host_and_port);
372 name = g_strndup (host_and_port, port - host_and_port - 1);
376 /* plain hostname, no port */
377 name = g_strdup (host_and_port);
383 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
384 "If a ':' character is given, it must be followed by a "
385 "port (in hostname '%s').", host_and_port);
390 else if ('0' <= port[0] && port[0] <= '9')
395 value = strtol (port, &end, 10);
396 if (*end != '\0' || value < 0 || value > G_MAXUINT16)
398 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
399 "Invalid numeric port '%s' specified in hostname '%s'",
400 port, host_and_port);
410 struct servent *entry;
412 entry = getservbyname (port, "tcp");
415 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
416 "Unknown service '%s' specified in hostname '%s'",
417 port, host_and_port);
418 #ifdef HAVE_ENDSERVENT
425 portnum = g_ntohs (entry->s_port);
427 #ifdef HAVE_ENDSERVENT
434 /* No port in host_and_port */
435 portnum = default_port;
438 connectable = g_network_address_new (name, portnum);
444 /* Allowed characters outside alphanumeric for unreserved. */
445 #define G_URI_OTHER_UNRESERVED "-._~"
447 /* This or something equivalent will eventually go into glib/guri.h */
449 _g_uri_parse_authority (const char *uri,
455 const char *start, *p, *at, *delim;
458 g_return_val_if_fail (uri != NULL, FALSE);
469 /* From RFC 3986 Decodes:
470 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
471 * hier-part = "//" authority path-abempty
472 * path-abempty = *( "/" segment )
473 * authority = [ userinfo "@" ] host [ ":" port ]
476 /* Check we have a valid scheme */
477 tmp_str = g_uri_parse_scheme (uri);
485 * hier-part = "//" authority path-abempty
488 start = strstr (p, "//");
495 /* check if the @ sign is part of the authority before attempting to
496 * decode the userinfo */
497 delim = strpbrk (start, "/?#[]");
498 at = strchr (start, '@');
499 if (at && delim && at > delim)
505 * userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
506 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
507 * pct-encoded = "%" HEXDIG HEXDIG
520 if (!(g_ascii_isxdigit (p[0]) ||
521 g_ascii_isxdigit (p[1])))
529 /* unreserved / sub-delims / : */
530 if (!(g_ascii_isalnum (c) ||
531 strchr (G_URI_OTHER_UNRESERVED, c) ||
532 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
538 *userinfo = g_strndup (start, p - start - 1);
549 * host = IP-literal / IPv4address / reg-name
550 * reg-name = *( unreserved / pct-encoded / sub-delims )
553 /* If IPv6 or IPvFuture */
556 gboolean has_scope_id = FALSE, has_bad_scope_id = FALSE;
567 if (c == '%' && !has_scope_id)
570 if (p[0] != '2' || p[1] != '5')
571 has_bad_scope_id = TRUE;
575 /* unreserved / sub-delims */
576 if (!(g_ascii_isalnum (c) ||
577 strchr (G_URI_OTHER_UNRESERVED, c) ||
578 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
586 if (has_bad_scope_id)
587 *host = g_strndup (start, p - start - 1);
589 *host = g_uri_unescape_segment (start, p - 1, NULL);
610 if (!(g_ascii_isxdigit (p[0]) ||
611 g_ascii_isxdigit (p[1])))
619 /* unreserved / sub-delims */
620 if (!(g_ascii_isalnum (c) ||
621 strchr (G_URI_OTHER_UNRESERVED, c) ||
622 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c)))
627 *host = g_uri_unescape_segment (start, p - 1, NULL);
647 if (!g_ascii_isdigit (c))
650 tmp = (tmp * 10) + (c - '0');
656 *port = (guint16) tmp;
668 if (userinfo && *userinfo)
678 _g_uri_from_authority (const gchar *protocol,
681 const gchar *userinfo)
685 uri = g_string_new (protocol);
686 g_string_append (uri, "://");
690 g_string_append_uri_escaped (uri, userinfo, G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO, FALSE);
691 g_string_append_c (uri, '@');
694 if (g_hostname_is_non_ascii (host))
696 gchar *ace_encoded = g_hostname_to_ascii (host);
700 g_string_free (uri, TRUE);
703 g_string_append (uri, ace_encoded);
704 g_free (ace_encoded);
706 else if (strchr (host, ':'))
707 g_string_append_printf (uri, "[%s]", host);
709 g_string_append (uri, host);
712 g_string_append_printf (uri, ":%u", port);
714 return g_string_free (uri, FALSE);
718 * g_network_address_parse_uri:
719 * @uri: the hostname and optionally a port
720 * @default_port: The default port if none is found in the URI
721 * @error: a pointer to a #GError, or %NULL
723 * Creates a new #GSocketConnectable for connecting to the given
724 * @uri. May fail and return %NULL in case parsing @uri fails.
726 * Using this rather than g_network_address_new() or
727 * g_network_address_parse() allows #GSocketClient to determine
728 * when to use application-specific proxy protocols.
730 * Returns: (transfer full): the new #GNetworkAddress, or %NULL on error
735 g_network_address_parse_uri (const gchar *uri,
736 guint16 default_port,
739 GSocketConnectable *conn;
744 if (!_g_uri_parse_authority (uri, &hostname, &port, NULL))
746 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
755 scheme = g_uri_parse_scheme (uri);
757 conn = g_object_new (G_TYPE_NETWORK_ADDRESS,
758 "hostname", hostname,
770 * g_network_address_get_hostname:
771 * @addr: a #GNetworkAddress
773 * Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded,
774 * depending on what @addr was created with.
776 * Returns: @addr's hostname
781 g_network_address_get_hostname (GNetworkAddress *addr)
783 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
785 return addr->priv->hostname;
789 * g_network_address_get_port:
790 * @addr: a #GNetworkAddress
792 * Gets @addr's port number
794 * Returns: @addr's port (which may be 0)
799 g_network_address_get_port (GNetworkAddress *addr)
801 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), 0);
803 return addr->priv->port;
807 * g_network_address_get_scheme:
808 * @addr: a #GNetworkAddress
810 * Gets @addr's scheme
812 * Returns: @addr's scheme (%NULL if not built from URI)
817 g_network_address_get_scheme (GNetworkAddress *addr)
819 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
821 return addr->priv->scheme;
824 #define G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (_g_network_address_address_enumerator_get_type ())
825 #define G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, GNetworkAddressAddressEnumerator))
828 GSocketAddressEnumerator parent_instance;
830 GNetworkAddress *addr;
833 } GNetworkAddressAddressEnumerator;
836 GSocketAddressEnumeratorClass parent_class;
838 } GNetworkAddressAddressEnumeratorClass;
840 static GType _g_network_address_address_enumerator_get_type (void);
841 G_DEFINE_TYPE (GNetworkAddressAddressEnumerator, _g_network_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
844 g_network_address_address_enumerator_finalize (GObject *object)
846 GNetworkAddressAddressEnumerator *addr_enum =
847 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (object);
849 g_object_unref (addr_enum->addr);
851 G_OBJECT_CLASS (_g_network_address_address_enumerator_parent_class)->finalize (object);
854 static GSocketAddress *
855 g_network_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
856 GCancellable *cancellable,
859 GNetworkAddressAddressEnumerator *addr_enum =
860 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
861 GSocketAddress *sockaddr;
863 if (addr_enum->addresses == NULL)
865 GNetworkAddress *addr = addr_enum->addr;
866 GResolver *resolver = g_resolver_get_default ();
867 gint64 serial = g_resolver_get_serial (resolver);
869 if (addr->priv->resolver_serial != 0 &&
870 addr->priv->resolver_serial != serial)
872 /* Resolver has reloaded, discard cached addresses */
873 g_list_free_full (addr->priv->sockaddrs, g_object_unref);
874 addr->priv->sockaddrs = NULL;
877 if (!addr->priv->sockaddrs)
878 g_network_address_parse_sockaddr (addr);
879 if (!addr->priv->sockaddrs)
883 addresses = g_resolver_lookup_by_name (resolver,
884 addr->priv->hostname,
888 g_object_unref (resolver);
892 g_network_address_set_addresses (addr, addresses, serial);
895 addr_enum->addresses = addr->priv->sockaddrs;
896 addr_enum->next = addr_enum->addresses;
897 g_object_unref (resolver);
900 if (addr_enum->next == NULL)
903 sockaddr = addr_enum->next->data;
904 addr_enum->next = addr_enum->next->next;
905 return g_object_ref (sockaddr);
909 have_addresses (GNetworkAddressAddressEnumerator *addr_enum,
910 GTask *task, GError *error)
912 GSocketAddress *sockaddr;
914 addr_enum->addresses = addr_enum->addr->priv->sockaddrs;
915 addr_enum->next = addr_enum->addresses;
919 sockaddr = g_object_ref (addr_enum->next->data);
920 addr_enum->next = addr_enum->next->next;
926 g_task_return_error (task, error);
928 g_task_return_pointer (task, sockaddr, g_object_unref);
929 g_object_unref (task);
933 got_addresses (GObject *source_object,
934 GAsyncResult *result,
937 GTask *task = user_data;
938 GNetworkAddressAddressEnumerator *addr_enum = g_task_get_source_object (task);
939 GResolver *resolver = G_RESOLVER (source_object);
941 GError *error = NULL;
943 if (!addr_enum->addr->priv->sockaddrs)
945 addresses = g_resolver_lookup_by_name_finish (resolver, result, &error);
949 g_network_address_set_addresses (addr_enum->addr, addresses,
950 g_resolver_get_serial (resolver));
953 have_addresses (addr_enum, task, error);
957 g_network_address_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
958 GCancellable *cancellable,
959 GAsyncReadyCallback callback,
962 GNetworkAddressAddressEnumerator *addr_enum =
963 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
964 GSocketAddress *sockaddr;
967 task = g_task_new (addr_enum, cancellable, callback, user_data);
969 if (addr_enum->addresses == NULL)
971 GNetworkAddress *addr = addr_enum->addr;
972 GResolver *resolver = g_resolver_get_default ();
973 gint64 serial = g_resolver_get_serial (resolver);
975 if (addr->priv->resolver_serial != 0 &&
976 addr->priv->resolver_serial != serial)
978 /* Resolver has reloaded, discard cached addresses */
979 g_list_free_full (addr->priv->sockaddrs, g_object_unref);
980 addr->priv->sockaddrs = NULL;
983 if (!addr->priv->sockaddrs)
985 if (g_network_address_parse_sockaddr (addr))
986 have_addresses (addr_enum, task, NULL);
989 g_resolver_lookup_by_name_async (resolver,
990 addr->priv->hostname,
992 got_addresses, task);
994 g_object_unref (resolver);
998 addr_enum->addresses = addr->priv->sockaddrs;
999 addr_enum->next = addr_enum->addresses;
1000 g_object_unref (resolver);
1003 if (addr_enum->next)
1005 sockaddr = g_object_ref (addr_enum->next->data);
1006 addr_enum->next = addr_enum->next->next;
1011 g_task_return_pointer (task, sockaddr, g_object_unref);
1012 g_object_unref (task);
1015 static GSocketAddress *
1016 g_network_address_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
1017 GAsyncResult *result,
1020 g_return_val_if_fail (g_task_is_valid (result, enumerator), NULL);
1022 return g_task_propagate_pointer (G_TASK (result), error);
1026 _g_network_address_address_enumerator_init (GNetworkAddressAddressEnumerator *enumerator)
1031 _g_network_address_address_enumerator_class_init (GNetworkAddressAddressEnumeratorClass *addrenum_class)
1033 GObjectClass *object_class = G_OBJECT_CLASS (addrenum_class);
1034 GSocketAddressEnumeratorClass *enumerator_class =
1035 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (addrenum_class);
1037 enumerator_class->next = g_network_address_address_enumerator_next;
1038 enumerator_class->next_async = g_network_address_address_enumerator_next_async;
1039 enumerator_class->next_finish = g_network_address_address_enumerator_next_finish;
1040 object_class->finalize = g_network_address_address_enumerator_finalize;
1043 static GSocketAddressEnumerator *
1044 g_network_address_connectable_enumerate (GSocketConnectable *connectable)
1046 GNetworkAddressAddressEnumerator *addr_enum;
1048 addr_enum = g_object_new (G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, NULL);
1049 addr_enum->addr = g_object_ref (connectable);
1051 return (GSocketAddressEnumerator *)addr_enum;
1054 static GSocketAddressEnumerator *
1055 g_network_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
1057 GNetworkAddress *self = G_NETWORK_ADDRESS (connectable);
1058 GSocketAddressEnumerator *proxy_enum;
1061 uri = _g_uri_from_authority (self->priv->scheme ? self->priv->scheme : "none",
1062 self->priv->hostname,
1066 proxy_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
1067 "connectable", connectable,