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, write to the
19 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307, USA.
28 #include "gnetworkaddress.h"
29 #include "gasyncresult.h"
30 #include "ginetaddress.h"
31 #include "ginetsocketaddress.h"
32 #include "gnetworkingprivate.h"
33 #include "gproxyaddressenumerator.h"
34 #include "gresolver.h"
35 #include "gsimpleasyncresult.h"
36 #include "gsocketaddressenumerator.h"
38 #include "gsocketconnectable.h"
44 * SECTION:gnetworkaddress
45 * @short_description: A GSocketConnectable for resolving hostnames
48 * #GNetworkAddress provides an easy way to resolve a hostname and
49 * then attempt to connect to that host, handling the possibility of
50 * multiple IP addresses and multiple address families.
52 * See #GSocketConnectable for and example of using the connectable
59 * A #GSocketConnectable for resolving a hostname and connecting to
63 struct _GNetworkAddressPrivate {
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_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
92 g_network_address_connectable_iface_init))
95 g_network_address_finalize (GObject *object)
97 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
99 g_free (addr->priv->hostname);
100 g_free (addr->priv->scheme);
102 if (addr->priv->sockaddrs)
106 for (a = addr->priv->sockaddrs; a; a = a->next)
107 g_object_unref (a->data);
108 g_list_free (addr->priv->sockaddrs);
111 G_OBJECT_CLASS (g_network_address_parent_class)->finalize (object);
115 g_network_address_class_init (GNetworkAddressClass *klass)
117 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
119 g_type_class_add_private (klass, sizeof (GNetworkAddressPrivate));
121 gobject_class->set_property = g_network_address_set_property;
122 gobject_class->get_property = g_network_address_get_property;
123 gobject_class->finalize = g_network_address_finalize;
125 g_object_class_install_property (gobject_class, PROP_HOSTNAME,
126 g_param_spec_string ("hostname",
128 P_("Hostname to resolve"),
131 G_PARAM_CONSTRUCT_ONLY |
132 G_PARAM_STATIC_STRINGS));
133 g_object_class_install_property (gobject_class, PROP_PORT,
134 g_param_spec_uint ("port",
139 G_PARAM_CONSTRUCT_ONLY |
140 G_PARAM_STATIC_STRINGS));
142 g_object_class_install_property (gobject_class, PROP_SCHEME,
143 g_param_spec_string ("scheme",
148 G_PARAM_CONSTRUCT_ONLY |
149 G_PARAM_STATIC_STRINGS));
153 g_network_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
155 connectable_iface->enumerate = g_network_address_connectable_enumerate;
156 connectable_iface->proxy_enumerate = g_network_address_connectable_proxy_enumerate;
160 g_network_address_init (GNetworkAddress *addr)
162 addr->priv = G_TYPE_INSTANCE_GET_PRIVATE (addr, G_TYPE_NETWORK_ADDRESS,
163 GNetworkAddressPrivate);
167 g_network_address_set_property (GObject *object,
172 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
177 g_free (addr->priv->hostname);
178 addr->priv->hostname = g_value_dup_string (value);
182 addr->priv->port = g_value_get_uint (value);
186 if (addr->priv->scheme)
187 g_free (addr->priv->scheme);
188 addr->priv->scheme = g_value_dup_string (value);
192 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
199 g_network_address_get_property (GObject *object,
204 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
209 g_value_set_string (value, addr->priv->hostname);
213 g_value_set_uint (value, addr->priv->port);
217 g_value_set_string (value, addr->priv->scheme);
221 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
228 g_network_address_set_addresses (GNetworkAddress *addr,
232 GSocketAddress *sockaddr;
234 g_return_if_fail (addresses != NULL && addr->priv->sockaddrs == NULL);
236 for (a = addresses; a; a = a->next)
238 sockaddr = g_inet_socket_address_new (a->data, addr->priv->port);
239 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
240 g_object_unref (a->data);
242 g_list_free (addresses);
243 addr->priv->sockaddrs = g_list_reverse (addr->priv->sockaddrs);
247 * g_network_address_new:
248 * @hostname: the hostname
251 * Creates a new #GSocketConnectable for connecting to the given
252 * @hostname and @port.
254 * Return value: (transfer full): the new #GNetworkAddress
259 g_network_address_new (const gchar *hostname,
262 return g_object_new (G_TYPE_NETWORK_ADDRESS,
263 "hostname", hostname,
269 * g_network_address_parse:
270 * @host_and_port: the hostname and optionally a port
271 * @default_port: the default port if not in @host_and_port
272 * @error: a pointer to a #GError, or %NULL
274 * Creates a new #GSocketConnectable for connecting to the given
275 * @hostname and @port. May fail and return %NULL in case
276 * parsing @host_and_port fails.
278 * @host_and_port may be in any of a number of recognised formats; an IPv6
279 * address, an IPv4 address, or a domain name (in which case a DNS
280 * lookup is performed). Quoting with [] is supported for all address
281 * types. A port override may be specified in the usual way with a
282 * colon. Ports may be given as decimal numbers or symbolic names (in
283 * which case an /etc/services lookup is performed).
285 * If no port is specified in @host_and_port then @default_port will be
286 * used as the port number to connect to.
288 * In general, @host_and_port is expected to be provided by the user
289 * (allowing them to give the hostname, and a port overide if necessary)
290 * and @default_port is expected to be provided by the application.
292 * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
297 g_network_address_parse (const gchar *host_and_port,
298 guint16 default_port,
301 GSocketConnectable *connectable;
306 g_return_val_if_fail (host_and_port != NULL, NULL);
309 if (host_and_port[0] == '[')
310 /* escaped host part (to allow, eg. "[2001:db8::1]:888") */
314 end = strchr (host_and_port, ']');
317 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
318 _("Hostname '%s' contains '[' but not ']'"), host_and_port);
324 else if (end[1] == ':')
328 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
329 "The ']' character (in hostname '%s') must come at the"
330 " end or be immediately followed by ':' and a port",
335 name = g_strndup (host_and_port + 1, end - host_and_port - 1);
338 else if ((port = strchr (host_and_port, ':')))
339 /* string has a ':' in it */
344 if (strchr (port, ':'))
345 /* more than one ':' in string */
347 /* this is actually an unescaped IPv6 address */
348 name = g_strdup (host_and_port);
352 name = g_strndup (host_and_port, port - host_and_port - 1);
356 /* plain hostname, no port */
357 name = g_strdup (host_and_port);
363 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
364 "If a ':' character is given, it must be followed by a "
365 "port (in hostname '%s').", host_and_port);
370 else if ('0' <= port[0] && port[0] <= '9')
375 value = strtol (port, &end, 10);
376 if (*end != '\0' || value < 0 || value > G_MAXUINT16)
378 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
379 "Invalid numeric port '%s' specified in hostname '%s'",
380 port, host_and_port);
390 struct servent *entry;
392 entry = getservbyname (port, "tcp");
395 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
396 "Unknown service '%s' specified in hostname '%s'",
397 port, host_and_port);
398 #ifdef HAVE_ENDSERVENT
405 portnum = g_ntohs (entry->s_port);
407 #ifdef HAVE_ENDSERVENT
414 /* No port in host_and_port */
415 portnum = default_port;
418 connectable = g_network_address_new (name, portnum);
424 /* Allowed characters outside alphanumeric for unreserved. */
425 #define G_URI_OTHER_UNRESERVED "-._~"
427 /* This or something equivalent will eventually go into glib/guri.h */
429 _g_uri_parse_authority (const char *uri,
435 const char *start, *p;
438 g_return_val_if_fail (uri != NULL, FALSE);
449 /* From RFC 3986 Decodes:
450 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
451 * hier-part = "//" authority path-abempty
452 * path-abempty = *( "/" segment )
453 * authority = [ userinfo "@" ] host [ ":" port ]
456 /* Check we have a valid scheme */
457 tmp_str = g_uri_parse_scheme (uri);
465 * hier-part = "//" authority path-abempty
468 start = strstr (p, "//");
474 p = strchr (start, '@');
479 * userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
480 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
481 * pct-encoded = "%" HEXDIG HEXDIG
493 if (!(g_ascii_isxdigit (p[0]) ||
494 g_ascii_isxdigit (p[1])))
502 /* unreserved / sub-delims / : */
503 if (!(g_ascii_isalnum(c) ||
504 strchr (G_URI_OTHER_UNRESERVED, c) ||
505 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
511 *userinfo = g_strndup (start, p - start - 1);
522 * host = IP-literal / IPv4address / reg-name
523 * reg-name = *( unreserved / pct-encoded / sub-delims )
526 /* If IPv6 or IPvFuture */
538 /* unreserved / sub-delims */
539 if (!(g_ascii_isalnum(c) ||
540 strchr (G_URI_OTHER_UNRESERVED, c) ||
541 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
563 if (!(g_ascii_isxdigit (p[0]) ||
564 g_ascii_isxdigit (p[1])))
572 /* unreserved / sub-delims */
573 if (!(g_ascii_isalnum(c) ||
574 strchr (G_URI_OTHER_UNRESERVED, c) ||
575 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c)))
581 *host = g_uri_unescape_segment (start, p - 1, NULL);
600 if (!g_ascii_isdigit (c))
603 tmp = (tmp * 10) + (c - '0');
609 *port = (guint16) tmp;
621 if (userinfo && *userinfo)
631 _g_uri_from_authority (const gchar *protocol,
634 const gchar *userinfo)
638 uri = g_string_new (protocol);
639 g_string_append (uri, "://");
643 g_string_append_uri_escaped (uri, userinfo, G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO, FALSE);
644 g_string_append_c (uri, '@');
647 if (g_hostname_is_non_ascii (host))
649 gchar *ace_encoded = g_hostname_to_ascii (host);
653 g_string_free (uri, TRUE);
656 g_string_append (uri, ace_encoded);
657 g_free (ace_encoded);
659 else if (strchr (host, ':'))
660 g_string_append_printf (uri, "[%s]", host);
662 g_string_append (uri, host);
665 g_string_append_printf (uri, ":%u", port);
667 return g_string_free (uri, FALSE);
671 * g_network_address_parse_uri:
672 * @uri: the hostname and optionally a port
673 * @default_port: The default port if none is found in the URI
674 * @error: a pointer to a #GError, or %NULL
676 * Creates a new #GSocketConnectable for connecting to the given
677 * @uri. May fail and return %NULL in case parsing @uri fails.
679 * Using this rather than g_network_address_new() or
680 * g_network_address_parse_host() allows #GSocketClient to determine
681 * when to use application-specific proxy protocols.
683 * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
688 g_network_address_parse_uri (const gchar *uri,
689 guint16 default_port,
692 GSocketConnectable *conn;
697 if (!_g_uri_parse_authority (uri, &hostname, &port, NULL))
699 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
708 scheme = g_uri_parse_scheme (uri);
710 conn = g_object_new (G_TYPE_NETWORK_ADDRESS,
711 "hostname", hostname,
723 * g_network_address_get_hostname:
724 * @addr: a #GNetworkAddress
726 * Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded,
727 * depending on what @addr was created with.
729 * Return value: @addr's hostname
734 g_network_address_get_hostname (GNetworkAddress *addr)
736 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
738 return addr->priv->hostname;
742 * g_network_address_get_port:
743 * @addr: a #GNetworkAddress
745 * Gets @addr's port number
747 * Return value: @addr's port (which may be 0)
752 g_network_address_get_port (GNetworkAddress *addr)
754 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), 0);
756 return addr->priv->port;
760 * g_network_address_get_scheme:
761 * @addr: a #GNetworkAddress
763 * Gets @addr's scheme
765 * Return value: @addr's scheme (%NULL if not built from URI)
770 g_network_address_get_scheme (GNetworkAddress *addr)
772 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
774 return addr->priv->scheme;
777 #define G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (_g_network_address_address_enumerator_get_type ())
778 #define G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, GNetworkAddressAddressEnumerator))
781 GSocketAddressEnumerator parent_instance;
783 GNetworkAddress *addr;
785 } GNetworkAddressAddressEnumerator;
788 GSocketAddressEnumeratorClass parent_class;
790 } GNetworkAddressAddressEnumeratorClass;
792 G_DEFINE_TYPE (GNetworkAddressAddressEnumerator, _g_network_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
795 g_network_address_address_enumerator_finalize (GObject *object)
797 GNetworkAddressAddressEnumerator *addr_enum =
798 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (object);
800 g_object_unref (addr_enum->addr);
802 G_OBJECT_CLASS (_g_network_address_address_enumerator_parent_class)->finalize (object);
805 static GSocketAddress *
806 g_network_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
807 GCancellable *cancellable,
810 GNetworkAddressAddressEnumerator *addr_enum =
811 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
812 GSocketAddress *sockaddr;
814 if (!addr_enum->addr->priv->sockaddrs)
816 GResolver *resolver = g_resolver_get_default ();
819 addresses = g_resolver_lookup_by_name (resolver,
820 addr_enum->addr->priv->hostname,
822 g_object_unref (resolver);
827 g_network_address_set_addresses (addr_enum->addr, addresses);
828 addr_enum->a = addr_enum->addr->priv->sockaddrs;
835 sockaddr = addr_enum->a->data;
836 addr_enum->a = addr_enum->a->next;
837 return g_object_ref (sockaddr);
842 got_addresses (GObject *source_object,
843 GAsyncResult *result,
846 GSimpleAsyncResult *simple = user_data;
847 GNetworkAddressAddressEnumerator *addr_enum =
848 g_simple_async_result_get_op_res_gpointer (simple);
849 GResolver *resolver = G_RESOLVER (source_object);
851 GError *error = NULL;
853 addresses = g_resolver_lookup_by_name_finish (resolver, result, &error);
854 if (!addr_enum->addr->priv->sockaddrs)
858 g_simple_async_result_set_from_error (simple, error);
859 g_error_free (error);
863 g_network_address_set_addresses (addr_enum->addr, addresses);
864 addr_enum->a = addr_enum->addr->priv->sockaddrs;
868 g_error_free (error);
870 g_object_unref (resolver);
872 g_simple_async_result_complete (simple);
873 g_object_unref (simple);
877 g_network_address_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
878 GCancellable *cancellable,
879 GAsyncReadyCallback callback,
882 GNetworkAddressAddressEnumerator *addr_enum =
883 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
884 GSimpleAsyncResult *simple;
886 simple = g_simple_async_result_new (G_OBJECT (enumerator),
888 g_network_address_address_enumerator_next_async);
890 if (!addr_enum->addr->priv->sockaddrs)
892 GResolver *resolver = g_resolver_get_default ();
894 g_simple_async_result_set_op_res_gpointer (simple, g_object_ref (addr_enum), g_object_unref);
895 g_resolver_lookup_by_name_async (resolver,
896 addr_enum->addr->priv->hostname,
898 got_addresses, simple);
902 g_simple_async_result_complete_in_idle (simple);
903 g_object_unref (simple);
907 static GSocketAddress *
908 g_network_address_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
909 GAsyncResult *result,
912 GNetworkAddressAddressEnumerator *addr_enum =
913 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
914 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
915 GSocketAddress *sockaddr;
917 if (g_simple_async_result_propagate_error (simple, error))
919 else if (!addr_enum->a)
923 sockaddr = addr_enum->a->data;
924 addr_enum->a = addr_enum->a->next;
925 return g_object_ref (sockaddr);
930 _g_network_address_address_enumerator_init (GNetworkAddressAddressEnumerator *enumerator)
935 _g_network_address_address_enumerator_class_init (GNetworkAddressAddressEnumeratorClass *addrenum_class)
937 GObjectClass *object_class = G_OBJECT_CLASS (addrenum_class);
938 GSocketAddressEnumeratorClass *enumerator_class =
939 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (addrenum_class);
941 enumerator_class->next = g_network_address_address_enumerator_next;
942 enumerator_class->next_async = g_network_address_address_enumerator_next_async;
943 enumerator_class->next_finish = g_network_address_address_enumerator_next_finish;
944 object_class->finalize = g_network_address_address_enumerator_finalize;
947 static GSocketAddressEnumerator *
948 g_network_address_connectable_enumerate (GSocketConnectable *connectable)
950 GNetworkAddressAddressEnumerator *addr_enum;
952 addr_enum = g_object_new (G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, NULL);
953 addr_enum->addr = g_object_ref (connectable);
955 return (GSocketAddressEnumerator *)addr_enum;
958 static GSocketAddressEnumerator *
959 g_network_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
961 GNetworkAddress *self = G_NETWORK_ADDRESS (connectable);
962 GSocketAddressEnumerator *proxy_enum;
965 uri = _g_uri_from_authority (self->priv->scheme ? self->priv->scheme : "none",
966 self->priv->hostname,
970 proxy_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
971 "connectable", connectable,