X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gio%2Fgsocketclient.c;h=2cd98932fcf4832093f517b046766dd0a06ce2ec;hb=853692bdfd9f8a87aed70d21f643dc13b57c92d1;hp=7064fc8306a8e76d4e9e5b526334b3cce0862316;hpb=73ca8b47540d005d5227c03aac143d6780da654c;p=platform%2Fupstream%2Fglib.git diff --git a/gio/gsocketclient.c b/gio/gsocketclient.c index 7064fc8..2cd9893 100644 --- a/gio/gsocketclient.c +++ b/gio/gsocketclient.c @@ -14,9 +14,7 @@ * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General - * Public License along with this library; if not, write to the - * Free Software Foundation, Inc., 59 Temple Place, Suite 330, - * Boston, MA 02111-1307, USA. + * Public License along with this library; if not, see . * * Authors: Ryan Lortie * Alexander Larsson @@ -32,18 +30,23 @@ #include #include #include +#include #include #include -#include -#include +#include #include #include #include #include #include #include +#include #include #include +#include +#include +#include +#include #include "glibintl.h" @@ -53,10 +56,10 @@ * @include: gio/gio.h * @see_also: #GSocketConnection, #GSocketListener * - * #GSocketClient is a high-level utility class for connecting to a - * network host using a connection oriented socket type. + * #GSocketClient is a lightweight high-level utility class for connecting to + * a network host using a connection oriented socket type. * - * You create a #GSocketClient object, set any options you want, then + * You create a #GSocketClient object, set any options you want, and then * call a sync or async connect operation, which returns a #GSocketConnection * subclass on success. * @@ -64,11 +67,20 @@ * the underlying socket that is in use. For instance, for a TCP/IP connection * it will be a #GTcpConnection. * + * As #GSocketClient is a lightweight object, you don't need to cache it. You + * can just create a new one any time you need one. + * * Since: 2.22 */ -G_DEFINE_TYPE (GSocketClient, g_socket_client, G_TYPE_OBJECT); +enum +{ + EVENT, + LAST_SIGNAL +}; + +static guint signals[LAST_SIGNAL] = { 0 }; enum { @@ -79,6 +91,9 @@ enum PROP_LOCAL_ADDRESS, PROP_TIMEOUT, PROP_ENABLE_PROXY, + PROP_TLS, + PROP_TLS_VALIDATION_FLAGS, + PROP_PROXY_RESOLVER }; struct _GSocketClientPrivate @@ -90,8 +105,13 @@ struct _GSocketClientPrivate guint timeout; gboolean enable_proxy; GHashTable *app_proxies; + gboolean tls; + GTlsCertificateFlags tls_validation_flags; + GProxyResolver *proxy_resolver; }; +G_DEFINE_TYPE_WITH_PRIVATE (GSocketClient, g_socket_client, G_TYPE_OBJECT) + static GSocket * create_socket (GSocketClient *client, GSocketAddress *dest_address, @@ -132,7 +152,7 @@ create_socket (GSocketClient *client, return socket; } -gboolean +static gboolean can_use_proxy (GSocketClient *client) { GSocketClientPrivate *priv = client->priv; @@ -142,11 +162,43 @@ can_use_proxy (GSocketClient *client) } static void +clarify_connect_error (GError *error, + GSocketConnectable *connectable, + GSocketAddress *address) +{ + const char *name; + char *tmp_name = NULL; + + if (G_IS_PROXY_ADDRESS (address)) + { + name = tmp_name = g_inet_address_to_string (g_inet_socket_address_get_address (G_INET_SOCKET_ADDRESS (address))); + + g_prefix_error (&error, _("Could not connect to proxy server %s: "), name); + } + else + { + if (G_IS_NETWORK_ADDRESS (connectable)) + name = g_network_address_get_hostname (G_NETWORK_ADDRESS (connectable)); + else if (G_IS_NETWORK_SERVICE (connectable)) + name = g_network_service_get_domain (G_NETWORK_SERVICE (connectable)); + else if (G_IS_INET_SOCKET_ADDRESS (connectable)) + name = tmp_name = g_inet_address_to_string (g_inet_socket_address_get_address (G_INET_SOCKET_ADDRESS (connectable))); + else + name = NULL; + + if (name) + g_prefix_error (&error, _("Could not connect to %s: "), name); + else + g_prefix_error (&error, _("Could not connect: ")); + } + + g_free (tmp_name); +} + +static void g_socket_client_init (GSocketClient *client) { - client->priv = G_TYPE_INSTANCE_GET_PRIVATE (client, - G_TYPE_SOCKET_CLIENT, - GSocketClientPrivate); + client->priv = g_socket_client_get_instance_private (client); client->priv->type = G_SOCKET_TYPE_STREAM; client->priv->app_proxies = g_hash_table_new_full (g_str_hash, g_str_equal, @@ -175,11 +227,10 @@ g_socket_client_finalize (GObject *object) { GSocketClient *client = G_SOCKET_CLIENT (object); - if (client->priv->local_address) - g_object_unref (client->priv->local_address); + g_clear_object (&client->priv->local_address); + g_clear_object (&client->priv->proxy_resolver); - if (G_OBJECT_CLASS (g_socket_client_parent_class)->finalize) - (*G_OBJECT_CLASS (g_socket_client_parent_class)->finalize) (object); + G_OBJECT_CLASS (g_socket_client_parent_class)->finalize (object); g_hash_table_unref (client->priv->app_proxies); } @@ -218,6 +269,18 @@ g_socket_client_get_property (GObject *object, g_value_set_boolean (value, client->priv->enable_proxy); break; + case PROP_TLS: + g_value_set_boolean (value, g_socket_client_get_tls (client)); + break; + + case PROP_TLS_VALIDATION_FLAGS: + g_value_set_flags (value, g_socket_client_get_tls_validation_flags (client)); + break; + + case PROP_PROXY_RESOLVER: + g_value_set_object (value, g_socket_client_get_proxy_resolver (client)); + break; + default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); } @@ -257,6 +320,18 @@ g_socket_client_set_property (GObject *object, g_socket_client_set_enable_proxy (client, g_value_get_boolean (value)); break; + case PROP_TLS: + g_socket_client_set_tls (client, g_value_get_boolean (value)); + break; + + case PROP_TLS_VALIDATION_FLAGS: + g_socket_client_set_tls_validation_flags (client, g_value_get_flags (value)); + break; + + case PROP_PROXY_RESOLVER: + g_socket_client_set_proxy_resolver (client, g_value_get_object (value)); + break; + default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); } @@ -401,7 +476,7 @@ g_socket_client_set_protocol (GSocketClient *client, * * See g_socket_client_set_local_address() for details. * - * Returns: (transfer none): a #GSocketAddres or %NULL. don't free + * Returns: (transfer none): a #GSocketAddress or %NULL. Do not free. * * Since: 2.22 */ @@ -414,13 +489,13 @@ g_socket_client_get_local_address (GSocketClient *client) /** * g_socket_client_set_local_address: * @client: a #GSocketClient. - * @address: a #GSocketAddress, or %NULL + * @address: (allow-none): a #GSocketAddress, or %NULL * * Sets the local address of the socket client. * The sockets created by this object will bound to the * specified address (if not %NULL) before connecting. * - * This is useful if you want to ensure the the local + * This is useful if you want to ensure that the local * side of the connection is on a specific port, or on * a specific interface. * @@ -511,6 +586,8 @@ g_socket_client_get_enable_proxy (GSocketClient *client) * #GProxyResolver to determine if a proxy protocol such as SOCKS is * needed, and automatically do the necessary proxy negotiation. * + * See also g_socket_client_set_proxy_resolver(). + * * Since: 2.26 */ void @@ -525,17 +602,237 @@ g_socket_client_set_enable_proxy (GSocketClient *client, g_object_notify (G_OBJECT (client), "enable-proxy"); } +/** + * g_socket_client_get_tls: + * @client: a #GSocketClient. + * + * Gets whether @client creates TLS connections. See + * g_socket_client_set_tls() for details. + * + * Returns: whether @client uses TLS + * + * Since: 2.28 + */ +gboolean +g_socket_client_get_tls (GSocketClient *client) +{ + return client->priv->tls; +} + +/** + * g_socket_client_set_tls: + * @client: a #GSocketClient. + * @tls: whether to use TLS + * + * Sets whether @client creates TLS (aka SSL) connections. If @tls is + * %TRUE, @client will wrap its connections in a #GTlsClientConnection + * and perform a TLS handshake when connecting. + * + * Note that since #GSocketClient must return a #GSocketConnection, + * but #GTlsClientConnection is not a #GSocketConnection, this + * actually wraps the resulting #GTlsClientConnection in a + * #GTcpWrapperConnection when returning it. You can use + * g_tcp_wrapper_connection_get_base_io_stream() on the return value + * to extract the #GTlsClientConnection. + * + * If you need to modify the behavior of the TLS handshake (eg, by + * setting a client-side certificate to use, or connecting to the + * #GTlsConnection::accept-certificate signal), you can connect to + * @client's #GSocketClient::event signal and wait for it to be + * emitted with %G_SOCKET_CLIENT_TLS_HANDSHAKING, which will give you + * a chance to see the #GTlsClientConnection before the handshake + * starts. + * + * Since: 2.28 + */ +void +g_socket_client_set_tls (GSocketClient *client, + gboolean tls) +{ + tls = !!tls; + if (tls == client->priv->tls) + return; + + client->priv->tls = tls; + g_object_notify (G_OBJECT (client), "tls"); +} + +/** + * g_socket_client_get_tls_validation_flags: + * @client: a #GSocketClient. + * + * Gets the TLS validation flags used creating TLS connections via + * @client. + * + * Returns: the TLS validation flags + * + * Since: 2.28 + */ +GTlsCertificateFlags +g_socket_client_get_tls_validation_flags (GSocketClient *client) +{ + return client->priv->tls_validation_flags; +} + +/** + * g_socket_client_set_tls_validation_flags: + * @client: a #GSocketClient. + * @flags: the validation flags + * + * Sets the TLS validation flags used when creating TLS connections + * via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. + * + * Since: 2.28 + */ +void +g_socket_client_set_tls_validation_flags (GSocketClient *client, + GTlsCertificateFlags flags) +{ + if (client->priv->tls_validation_flags != flags) + { + client->priv->tls_validation_flags = flags; + g_object_notify (G_OBJECT (client), "tls-validation-flags"); + } +} + +/** + * g_socket_client_get_proxy_resolver: + * @client: a #GSocketClient. + * + * Gets the #GProxyResolver being used by @client. Normally, this will + * be the resolver returned by g_proxy_resolver_get_default(), but you + * can override it with g_socket_client_set_proxy_resolver(). + * + * Returns: (transfer none): The #GProxyResolver being used by + * @client. + * + * Since: 2.36 + */ +GProxyResolver * +g_socket_client_get_proxy_resolver (GSocketClient *client) +{ + if (client->priv->proxy_resolver) + return client->priv->proxy_resolver; + else + return g_proxy_resolver_get_default (); +} + +/** + * g_socket_client_set_proxy_resolver: + * @client: a #GSocketClient. + * @proxy_resolver: (allow-none): a #GProxyResolver, or %NULL for the + * default. + * + * Overrides the #GProxyResolver used by @client. You can call this if + * you want to use specific proxies, rather than using the system + * default proxy settings. + * + * Note that whether or not the proxy resolver is actually used + * depends on the setting of #GSocketClient:enable-proxy, which is not + * changed by this function (but which is %TRUE by default) + * + * Since: 2.36 + */ +void +g_socket_client_set_proxy_resolver (GSocketClient *client, + GProxyResolver *proxy_resolver) +{ + /* We have to be careful to avoid calling + * g_proxy_resolver_get_default() until we're sure we need it, + * because trying to load the default proxy resolver module will + * break some test programs that aren't expecting it (eg, + * tests/gsettings). + */ + + if (client->priv->proxy_resolver) + g_object_unref (client->priv->proxy_resolver); + + client->priv->proxy_resolver = proxy_resolver; + + if (client->priv->proxy_resolver) + g_object_ref (client->priv->proxy_resolver); +} + static void g_socket_client_class_init (GSocketClientClass *class) { GObjectClass *gobject_class = G_OBJECT_CLASS (class); - g_type_class_add_private (class, sizeof (GSocketClientPrivate)); - gobject_class->finalize = g_socket_client_finalize; gobject_class->set_property = g_socket_client_set_property; gobject_class->get_property = g_socket_client_get_property; + /** + * GSocketClient::event: + * @client: the #GSocketClient + * @event: the event that is occurring + * @connectable: the #GSocketConnectable that @event is occurring on + * @connection: the current representation of the connection + * + * Emitted when @client's activity on @connectable changes state. + * Among other things, this can be used to provide progress + * information about a network connection in the UI. The meanings of + * the different @event values are as follows: + * + * - %G_SOCKET_CLIENT_RESOLVING: @client is about to look up @connectable + * in DNS. @connection will be %NULL. + * + * - %G_SOCKET_CLIENT_RESOLVED: @client has successfully resolved + * @connectable in DNS. @connection will be %NULL. + * + * - %G_SOCKET_CLIENT_CONNECTING: @client is about to make a connection + * to a remote host; either a proxy server or the destination server + * itself. @connection is the #GSocketConnection, which is not yet + * connected. Since GLib 2.40, you can access the remote + * address via g_socket_connection_get_remote_address(). + * + * - %G_SOCKET_CLIENT_CONNECTED: @client has successfully connected + * to a remote host. @connection is the connected #GSocketConnection. + * + * - %G_SOCKET_CLIENT_PROXY_NEGOTIATING: @client is about to negotiate + * with a proxy to get it to connect to @connectable. @connection is + * the #GSocketConnection to the proxy server. + * + * - %G_SOCKET_CLIENT_PROXY_NEGOTIATED: @client has negotiated a + * connection to @connectable through a proxy server. @connection is + * the stream returned from g_proxy_connect(), which may or may not + * be a #GSocketConnection. + * + * - %G_SOCKET_CLIENT_TLS_HANDSHAKING: @client is about to begin a TLS + * handshake. @connection is a #GTlsClientConnection. + * + * - %G_SOCKET_CLIENT_TLS_HANDSHAKED: @client has successfully completed + * the TLS handshake. @connection is a #GTlsClientConnection. + * + * - %G_SOCKET_CLIENT_COMPLETE: @client has either successfully connected + * to @connectable (in which case @connection is the #GSocketConnection + * that it will be returning to the caller) or has failed (in which + * case @connection is %NULL and the client is about to return an error). + * + * Each event except %G_SOCKET_CLIENT_COMPLETE may be emitted + * multiple times (or not at all) for a given connectable (in + * particular, if @client ends up attempting to connect to more than + * one address). However, if @client emits the #GSocketClient::event + * signal at all for a given connectable, that it will always emit + * it with %G_SOCKET_CLIENT_COMPLETE when it is done. + * + * Note that there may be additional #GSocketClientEvent values in + * the future; unrecognized @event values should be ignored. + * + * Since: 2.32 + */ + signals[EVENT] = + g_signal_new (I_("event"), + G_TYPE_FROM_CLASS (gobject_class), + G_SIGNAL_RUN_LAST, + G_STRUCT_OFFSET (GSocketClientClass, event), + NULL, NULL, + NULL, + G_TYPE_NONE, 3, + G_TYPE_SOCKET_CLIENT_EVENT, + G_TYPE_SOCKET_CONNECTABLE, + G_TYPE_IO_STREAM); + g_object_class_install_property (gobject_class, PROP_FAMILY, g_param_spec_enum ("family", P_("Socket family"), @@ -593,16 +890,59 @@ g_socket_client_class_init (GSocketClientClass *class) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); + g_object_class_install_property (gobject_class, PROP_TLS, + g_param_spec_boolean ("tls", + P_("TLS"), + P_("Whether to create TLS connections"), + FALSE, + G_PARAM_CONSTRUCT | + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); + g_object_class_install_property (gobject_class, PROP_TLS_VALIDATION_FLAGS, + g_param_spec_flags ("tls-validation-flags", + P_("TLS validation flags"), + P_("TLS validation flags to use"), + G_TYPE_TLS_CERTIFICATE_FLAGS, + G_TLS_CERTIFICATE_VALIDATE_ALL, + G_PARAM_CONSTRUCT | + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); + + /** + * GSocketClient:proxy-resolver: + * + * The proxy resolver to use + * + * Since: 2.36 + */ + g_object_class_install_property (gobject_class, PROP_PROXY_RESOLVER, + g_param_spec_object ("proxy-resolver", + P_("Proxy resolver"), + P_("The proxy resolver to use"), + G_TYPE_PROXY_RESOLVER, + G_PARAM_CONSTRUCT | + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); +} + +static void +g_socket_client_emit_event (GSocketClient *client, + GSocketClientEvent event, + GSocketConnectable *connectable, + GIOStream *connection) +{ + g_signal_emit (client, signals[EVENT], 0, + event, connectable, connection); } /** * g_socket_client_connect: * @client: a #GSocketClient. * @connectable: a #GSocketConnectable specifying the remote address. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: #GError for error reporting, or %NULL to ignore. * - * Tries to resolve the @connectable and make a network connection to it.. + * Tries to resolve the @connectable and make a network connection to it. * * Upon a successful connection, a new #GSocketConnection is constructed * and returned. The caller owns this new object and must drop their @@ -612,7 +952,7 @@ g_socket_client_class_init (GSocketClientClass *class) * the underlying socket that is used. For instance, for a TCP/IP connection * it will be a #GTcpConnection. * - * The socket created will be the same family as the the address that the + * The socket created will be the same family as the address that the * @connectable resolves to, unless family is set with g_socket_client_set_family() * or indirectly via g_socket_client_set_local_address(). The socket type * defaults to %G_SOCKET_TYPE_STREAM but can be set with @@ -631,21 +971,32 @@ g_socket_client_connect (GSocketClient *client, GCancellable *cancellable, GError **error) { - GSocketConnection *connection = NULL; + GIOStream *connection = NULL; GSocketAddressEnumerator *enumerator = NULL; GError *last_error, *tmp_error; last_error = NULL; if (can_use_proxy (client)) - enumerator = g_socket_connectable_proxy_enumerate (connectable); + { + enumerator = g_socket_connectable_proxy_enumerate (connectable); + if (client->priv->proxy_resolver && + G_IS_PROXY_ADDRESS_ENUMERATOR (enumerator)) + { + g_object_set (G_OBJECT (enumerator), + "proxy-resolver", client->priv->proxy_resolver, + NULL); + } + } else enumerator = g_socket_connectable_enumerate (connectable); while (connection == NULL) { GSocketAddress *address = NULL; + gboolean application_proxy = FALSE; GSocket *socket; + gboolean using_proxy; if (g_cancellable_is_cancelled (cancellable)) { @@ -655,6 +1006,8 @@ g_socket_client_connect (GSocketClient *client, } tmp_error = NULL; + g_socket_client_emit_event (client, G_SOCKET_CLIENT_RESOLVING, + connectable, NULL); address = g_socket_address_enumerator_next (enumerator, cancellable, &tmp_error); @@ -674,22 +1027,40 @@ g_socket_client_connect (GSocketClient *client, _("Unknown error on connect")); break; } + g_socket_client_emit_event (client, G_SOCKET_CLIENT_RESOLVED, + connectable, NULL); + + using_proxy = (G_IS_PROXY_ADDRESS (address) && + client->priv->enable_proxy); /* clear error from previous attempt */ g_clear_error (&last_error); socket = create_socket (client, address, &last_error); - if (socket != NULL) + if (socket == NULL) { - if (g_socket_connect (socket, address, cancellable, &last_error)) - connection = g_socket_connection_factory_create_connection (socket); + g_object_unref (address); + continue; + } - g_object_unref (socket); + connection = (GIOStream *)g_socket_connection_factory_create_connection (socket); + g_socket_connection_set_cached_remote_address ((GSocketConnection*)connection, address); + g_socket_client_emit_event (client, G_SOCKET_CLIENT_CONNECTING, connectable, connection); + + if (g_socket_connection_connect (G_SOCKET_CONNECTION (connection), + address, cancellable, &last_error)) + { + g_socket_connection_set_cached_remote_address ((GSocketConnection*)connection, NULL); + g_socket_client_emit_event (client, G_SOCKET_CLIENT_CONNECTED, connectable, connection); + } + else + { + clarify_connect_error (last_error, connectable, address); + g_object_unref (connection); + connection = NULL; } - if (connection && - G_IS_PROXY_ADDRESS (address) && - client->priv->enable_proxy) + if (connection && using_proxy) { GProxyAddress *proxy_addr = G_PROXY_ADDRESS (address); const gchar *protocol; @@ -708,39 +1079,27 @@ g_socket_client_connect (GSocketClient *client, g_set_error_literal (&last_error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, - _("Trying to proxy over non-TCP connection is not supported.")); + _("Proxying over a non-TCP connection is not supported.")); g_object_unref (connection); connection = NULL; } else if (proxy) { - GIOStream *io_stream; - GTcpConnection *old_connection = G_TCP_CONNECTION (connection); - - io_stream = g_proxy_connect (proxy, - G_IO_STREAM (old_connection), - proxy_addr, - cancellable, - &last_error); - - if (io_stream) - { - if (G_IS_SOCKET_CONNECTION (io_stream)) - connection = G_SOCKET_CONNECTION (g_object_ref (io_stream)); - else - connection = _g_proxy_connection_new (old_connection, - io_stream); - - g_object_unref (io_stream); - } - else - { - connection = NULL; - } - - g_object_unref (old_connection); + GIOStream *proxy_connection; + + g_socket_client_emit_event (client, G_SOCKET_CLIENT_PROXY_NEGOTIATING, connectable, connection); + proxy_connection = g_proxy_connect (proxy, + connection, + proxy_addr, + cancellable, + &last_error); + g_object_unref (connection); + connection = proxy_connection; g_object_unref (proxy); + + if (connection) + g_socket_client_emit_event (client, G_SOCKET_CLIENT_PROXY_NEGOTIATED, connectable, connection); } else if (!g_hash_table_lookup_extended (client->priv->app_proxies, protocol, NULL, NULL)) @@ -751,13 +1110,54 @@ g_socket_client_connect (GSocketClient *client, g_object_unref (connection); connection = NULL; } + else + { + application_proxy = TRUE; + } + } + + if (!application_proxy && connection && client->priv->tls) + { + GIOStream *tlsconn; + + tlsconn = g_tls_client_connection_new (connection, connectable, &last_error); + g_object_unref (connection); + connection = tlsconn; + + if (tlsconn) + { + g_tls_client_connection_set_validation_flags (G_TLS_CLIENT_CONNECTION (tlsconn), + client->priv->tls_validation_flags); + g_socket_client_emit_event (client, G_SOCKET_CLIENT_TLS_HANDSHAKING, connectable, connection); + if (g_tls_connection_handshake (G_TLS_CONNECTION (tlsconn), + cancellable, &last_error)) + { + g_socket_client_emit_event (client, G_SOCKET_CLIENT_TLS_HANDSHAKED, connectable, connection); + } + else + { + g_object_unref (tlsconn); + connection = NULL; + } + } } + if (connection && !G_IS_SOCKET_CONNECTION (connection)) + { + GSocketConnection *wrapper_connection; + + wrapper_connection = g_tcp_wrapper_connection_new (connection, socket); + g_object_unref (connection); + connection = (GIOStream *)wrapper_connection; + } + + g_object_unref (socket); g_object_unref (address); } g_object_unref (enumerator); - return connection; + g_socket_client_emit_event (client, G_SOCKET_CLIENT_COMPLETE, connectable, connection); + return G_SOCKET_CONNECTION (connection); } /** @@ -765,14 +1165,14 @@ g_socket_client_connect (GSocketClient *client, * @client: a #GSocketClient * @host_and_port: the name and optionally port of the host to connect to * @default_port: the default port to connect to - * @cancellable: a #GCancellable, or %NULL + * @cancellable: (allow-none): a #GCancellable, or %NULL * @error: a pointer to a #GError, or %NULL * * This is a helper function for g_socket_client_connect(). * * Attempts to create a TCP connection to the named host. * - * @host_and_port may be in any of a number of recognised formats; an IPv6 + * @host_and_port may be in any of a number of recognized formats; an IPv6 * address, an IPv4 address, or a domain name (in which case a DNS * lookup is performed). Quoting with [] is supported for all address * types. A port override may be specified in the usual way with a @@ -783,7 +1183,7 @@ g_socket_client_connect (GSocketClient *client, * used as the port number to connect to. * * In general, @host_and_port is expected to be provided by the user (allowing - * them to give the hostname, and a port overide if necessary) and + * them to give the hostname, and a port override if necessary) and * @default_port is expected to be provided by the application. * * In the case that an IP address is given, a single connection @@ -829,9 +1229,8 @@ g_socket_client_connect_to_host (GSocketClient *client, * @client: a #GSocketConnection * @domain: a domain name * @service: the name of the service to connect to - * @cancellable: a #GCancellable, or %NULL + * @cancellable: (allow-none): a #GCancellable, or %NULL * @error: a pointer to a #GError, or %NULL - * @returns: (transfer full): a #GSocketConnection if successful, or %NULL on error * * Attempts to create a TCP connection to a service. * @@ -847,6 +1246,8 @@ g_socket_client_connect_to_host (GSocketClient *client, * In the event of any failure (DNS error, service not found, no hosts * connectable) %NULL is returned and @error (if non-%NULL) is set * accordingly. + * + * Returns: (transfer full): a #GSocketConnection if successful, or %NULL on error */ GSocketConnection * g_socket_client_connect_to_service (GSocketClient *client, @@ -871,7 +1272,7 @@ g_socket_client_connect_to_service (GSocketClient *client, * @client: a #GSocketClient * @uri: A network URI * @default_port: the default port to connect to - * @cancellable: a #GCancellable, or %NULL + * @cancellable: (allow-none): a #GCancellable, or %NULL * @error: a pointer to a #GError, or %NULL * * This is a helper function for g_socket_client_connect(). @@ -880,7 +1281,9 @@ g_socket_client_connect_to_service (GSocketClient *client, * * @uri may be any valid URI containing an "authority" (hostname/port) * component. If a port is not specified in the URI, @default_port - * will be used. + * will be used. TLS will be negotiated if #GSocketClient:tls is %TRUE. + * (#GSocketClient does not know to automatically assume TLS for + * certain URI schemes.) * * Using this rather than g_socket_client_connect() or * g_socket_client_connect_to_host() allows #GSocketClient to @@ -921,45 +1324,53 @@ g_socket_client_connect_to_uri (GSocketClient *client, typedef struct { - GSimpleAsyncResult *result; - GCancellable *cancellable; + GTask *task; GSocketClient *client; + GSocketConnectable *connectable; GSocketAddressEnumerator *enumerator; GProxyAddress *proxy_addr; + GSocketAddress *current_addr; GSocket *current_socket; - GSocketConnection *connection; + GIOStream *connection; GError *last_error; } GSocketClientAsyncConnectData; static void +g_socket_client_async_connect_data_free (GSocketClientAsyncConnectData *data) +{ + g_clear_object (&data->connectable); + g_clear_object (&data->enumerator); + g_clear_object (&data->proxy_addr); + g_clear_object (&data->current_addr); + g_clear_object (&data->current_socket); + g_clear_object (&data->connection); + + g_clear_error (&data->last_error); + + g_slice_free (GSocketClientAsyncConnectData, data); +} + +static void g_socket_client_async_connect_complete (GSocketClientAsyncConnectData *data) { - if (data->last_error) - { - g_simple_async_result_set_from_error (data->result, data->last_error); - g_error_free (data->last_error); - } - else + g_assert (data->connection); + + if (!G_IS_SOCKET_CONNECTION (data->connection)) { - g_assert (data->connection); + GSocketConnection *wrapper_connection; - g_simple_async_result_set_op_res_gpointer (data->result, - data->connection, - g_object_unref); + wrapper_connection = g_tcp_wrapper_connection_new (data->connection, + data->current_socket); + g_object_unref (data->connection); + data->connection = (GIOStream *)wrapper_connection; } - g_simple_async_result_complete (data->result); - g_object_unref (data->result); - g_object_unref (data->enumerator); - if (data->cancellable) - g_object_unref (data->cancellable); - if (data->current_socket) - g_object_unref (data->current_socket); - if (data->proxy_addr) - g_object_unref (data->proxy_addr); - g_slice_free (GSocketClientAsyncConnectData, data); + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_COMPLETE, data->connectable, data->connection); + g_task_return_pointer (data->task, data->connection, g_object_unref); + data->connection = NULL; + g_object_unref (data->task); } @@ -979,53 +1390,142 @@ set_last_error (GSocketClientAsyncConnectData *data, static void enumerator_next_async (GSocketClientAsyncConnectData *data) { + /* We need to cleanup the state */ + g_clear_object (&data->current_socket); + g_clear_object (&data->current_addr); + g_clear_object (&data->proxy_addr); + g_clear_object (&data->connection); + + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_RESOLVING, data->connectable, NULL); g_socket_address_enumerator_next_async (data->enumerator, - data->cancellable, + g_task_get_cancellable (data->task), g_socket_client_enumerator_callback, data); } static void -g_socket_client_proxy_connect_callback (GObject *object, +g_socket_client_tls_handshake_callback (GObject *object, GAsyncResult *result, gpointer user_data) { GSocketClientAsyncConnectData *data = user_data; - GIOStream *io_stream; - GTcpConnection *old_connection = G_TCP_CONNECTION (data->connection); - io_stream = g_proxy_connect_finish (G_PROXY (object), - result, - &data->last_error); + if (g_tls_connection_handshake_finish (G_TLS_CONNECTION (object), + result, + &data->last_error)) + { + g_object_unref (data->connection); + data->connection = G_IO_STREAM (object); - if (io_stream) + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_TLS_HANDSHAKED, data->connectable, data->connection); + g_socket_client_async_connect_complete (data); + } + else { - if (G_IS_SOCKET_CONNECTION (io_stream)) - data->connection = G_SOCKET_CONNECTION (g_object_ref (io_stream)); - else - data->connection = _g_proxy_connection_new (old_connection, - io_stream); - g_object_unref (io_stream); + g_object_unref (object); + enumerator_next_async (data); + } +} + +static void +g_socket_client_tls_handshake (GSocketClientAsyncConnectData *data) +{ + GIOStream *tlsconn; + + if (!data->client->priv->tls) + { + g_socket_client_async_connect_complete (data); + return; + } + + tlsconn = g_tls_client_connection_new (data->connection, + data->connectable, + &data->last_error); + if (tlsconn) + { + g_tls_client_connection_set_validation_flags (G_TLS_CLIENT_CONNECTION (tlsconn), + data->client->priv->tls_validation_flags); + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_TLS_HANDSHAKING, data->connectable, G_IO_STREAM (tlsconn)); + g_tls_connection_handshake_async (G_TLS_CONNECTION (tlsconn), + G_PRIORITY_DEFAULT, + g_task_get_cancellable (data->task), + g_socket_client_tls_handshake_callback, + data); } else { - data->connection = NULL; + enumerator_next_async (data); } +} + +static void +g_socket_client_proxy_connect_callback (GObject *object, + GAsyncResult *result, + gpointer user_data) +{ + GSocketClientAsyncConnectData *data = user_data; - g_object_unref (old_connection); + g_object_unref (data->connection); + data->connection = g_proxy_connect_finish (G_PROXY (object), + result, + &data->last_error); + if (data->connection) + { + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_PROXY_NEGOTIATED, data->connectable, data->connection); + } + else + { + enumerator_next_async (data); + return; + } - g_socket_client_async_connect_complete (data); + g_socket_client_tls_handshake (data); } static void -g_socket_client_proxy_connect (GSocketClientAsyncConnectData *data) +g_socket_client_connected_callback (GObject *source, + GAsyncResult *result, + gpointer user_data) { + GSocketClientAsyncConnectData *data = user_data; + GError *error = NULL; GProxy *proxy; - const gchar *protocol = g_proxy_address_get_protocol (data->proxy_addr); + const gchar *protocol; + + if (g_task_return_error_if_cancelled (data->task)) + { + g_object_unref (data->task); + return; + } + + if (!g_socket_connection_connect_finish (G_SOCKET_CONNECTION (source), + result, &error)) + { + clarify_connect_error (error, data->connectable, + data->current_addr); + set_last_error (data, error); + + /* try next one */ + enumerator_next_async (data); + return; + } + + g_socket_connection_set_cached_remote_address ((GSocketConnection*)data->connection, NULL); + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_CONNECTED, data->connectable, data->connection); + + /* wrong, but backward compatible */ + g_socket_set_blocking (data->current_socket, TRUE); + + if (!data->proxy_addr) + { + g_socket_client_tls_handshake (data); + return; + } + protocol = g_proxy_address_get_protocol (data->proxy_addr); proxy = g_proxy_get_default_for_protocol (protocol); - /* The connection should not be anything else then TCP Connection, + /* The connection should not be anything other than TCP, * but let's put a safety guard in case */ if (!G_IS_TCP_CONNECTION (data->connection)) @@ -1035,19 +1535,17 @@ g_socket_client_proxy_connect (GSocketClientAsyncConnectData *data) g_set_error_literal (&data->last_error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, - _("Trying to proxy over non-TCP connection is not supported.")); - - g_object_unref (data->connection); - data->connection = NULL; + _("Proxying over a non-TCP connection is not supported.")); enumerator_next_async (data); } else if (proxy) { + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_PROXY_NEGOTIATING, data->connectable, data->connection); g_proxy_connect_async (proxy, - G_IO_STREAM (data->connection), + data->connection, data->proxy_addr, - data->cancellable, + g_task_get_cancellable (data->task), g_socket_client_proxy_connect_callback, data); g_object_unref (proxy); @@ -1061,66 +1559,14 @@ g_socket_client_proxy_connect (GSocketClientAsyncConnectData *data) _("Proxy protocol '%s' is not supported."), protocol); - g_object_unref (data->connection); - data->connection = NULL; - enumerator_next_async (data); } -} - -static void -g_socket_client_socket_connected (GSocketClientAsyncConnectData *data) -{ - g_socket_set_blocking (data->current_socket, TRUE); - - data->connection = - g_socket_connection_factory_create_connection (data->current_socket); - g_object_unref (data->current_socket); - data->current_socket = NULL; - - if (data->proxy_addr) - g_socket_client_proxy_connect (data); else - g_socket_client_async_connect_complete (data); -} - -static gboolean -g_socket_client_socket_callback (GSocket *socket, - GIOCondition condition, - GSocketClientAsyncConnectData *data) -{ - GError *error = NULL; - - if (g_cancellable_is_cancelled (data->cancellable)) { - /* Cancelled, return done with last error being cancelled */ - g_clear_error (&data->last_error); - g_object_unref (data->current_socket); - data->current_socket = NULL; - g_cancellable_set_error_if_cancelled (data->cancellable, - &data->last_error); - + /* Simply complete the connection, we don't want to do TLS handshake + * as the application proxy handling may need proxy handshake first */ g_socket_client_async_connect_complete (data); - return FALSE; } - else - { - /* socket is ready for writing means connect done, did it succeed? */ - if (!g_socket_check_connect_result (data->current_socket, &error)) - { - set_last_error (data, error); - g_object_unref (data->current_socket); - data->current_socket = NULL; - - /* try next one */ - enumerator_next_async (data); - - return FALSE; - } - } - - g_socket_client_socket_connected (data); - return FALSE; } static void @@ -1131,31 +1577,40 @@ g_socket_client_enumerator_callback (GObject *object, GSocketClientAsyncConnectData *data = user_data; GSocketAddress *address = NULL; GSocket *socket; - GError *tmp_error = NULL; + GError *error = NULL; - if (g_cancellable_is_cancelled (data->cancellable)) + if (g_task_return_error_if_cancelled (data->task)) { - g_clear_error (&data->last_error); - g_cancellable_set_error_if_cancelled (data->cancellable, &data->last_error); - g_socket_client_async_connect_complete (data); + g_object_unref (data->task); return; } address = g_socket_address_enumerator_next_finish (data->enumerator, - result, &tmp_error); - + result, &error); if (address == NULL) { - if (tmp_error) - set_last_error (data, tmp_error); - else if (data->last_error == NULL) - g_set_error_literal (&data->last_error, G_IO_ERROR, G_IO_ERROR_FAILED, - _("Unknown error on connect")); - - g_socket_client_async_connect_complete (data); + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_COMPLETE, data->connectable, NULL); + if (!error) + { + if (data->last_error) + { + error = data->last_error; + data->last_error = NULL; + } + else + { + g_set_error_literal (&error, G_IO_ERROR, G_IO_ERROR_FAILED, + _("Unknown error on connect")); + } + } + g_task_return_error (data->task, error); + g_object_unref (data->task); return; } + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_RESOLVED, + data->connectable, NULL); + if (G_IS_PROXY_ADDRESS (address) && data->client->priv->enable_proxy) data->proxy_addr = g_object_ref (G_PROXY_ADDRESS (address)); @@ -1163,53 +1618,32 @@ g_socket_client_enumerator_callback (GObject *object, g_clear_error (&data->last_error); socket = create_socket (data->client, address, &data->last_error); - if (socket != NULL) + if (socket == NULL) { - g_socket_set_blocking (socket, FALSE); - if (g_socket_connect (socket, address, data->cancellable, &tmp_error)) - { - data->current_socket = socket; - g_socket_client_socket_connected (data); - - g_object_unref (address); - return; - } - else if (g_error_matches (tmp_error, G_IO_ERROR, G_IO_ERROR_PENDING)) - { - GSource *source; - - data->current_socket = socket; - g_error_free (tmp_error); - - source = g_socket_create_source (socket, G_IO_OUT, - data->cancellable); - g_source_set_callback (source, - (GSourceFunc) g_socket_client_socket_callback, - data, NULL); - g_source_attach (source, g_main_context_get_thread_default ()); - g_source_unref (source); - - g_object_unref (address); - return; - } - else - { - data->last_error = tmp_error; - g_object_unref (socket); - } + g_object_unref (address); + enumerator_next_async (data); + return; } - g_object_unref (address); - enumerator_next_async (data); + data->current_socket = socket; + data->current_addr = address; + data->connection = (GIOStream *) g_socket_connection_factory_create_connection (socket); + + g_socket_connection_set_cached_remote_address ((GSocketConnection*)data->connection, address); + g_socket_client_emit_event (data->client, G_SOCKET_CLIENT_CONNECTING, data->connectable, data->connection); + g_socket_connection_connect_async (G_SOCKET_CONNECTION (data->connection), + address, + g_task_get_cancellable (data->task), + g_socket_client_connected_callback, data); } /** * g_socket_client_connect_async: - * @client: a #GTcpClient + * @client: a #GSocketClient * @connectable: a #GSocketConnectable specifying the remote address. - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of g_socket_client_connect(). * @@ -1231,30 +1665,37 @@ g_socket_client_connect_async (GSocketClient *client, g_return_if_fail (G_IS_SOCKET_CLIENT (client)); data = g_slice_new0 (GSocketClientAsyncConnectData); - - data->result = g_simple_async_result_new (G_OBJECT (client), - callback, user_data, - g_socket_client_connect_async); data->client = client; - if (cancellable) - data->cancellable = g_object_ref (cancellable); + data->connectable = g_object_ref (connectable); if (can_use_proxy (client)) + { data->enumerator = g_socket_connectable_proxy_enumerate (connectable); + if (client->priv->proxy_resolver && + G_IS_PROXY_ADDRESS_ENUMERATOR (data->enumerator)) + { + g_object_set (G_OBJECT (data->enumerator), + "proxy-resolver", client->priv->proxy_resolver, + NULL); + } + } else - data->enumerator = g_socket_connectable_enumerate (connectable); + data->enumerator = g_socket_connectable_enumerate (connectable); + + data->task = g_task_new (client, cancellable, callback, user_data); + g_task_set_task_data (data->task, data, (GDestroyNotify)g_socket_client_async_connect_data_free); enumerator_next_async (data); } /** * g_socket_client_connect_to_host_async: - * @client: a #GTcpClient + * @client: a #GSocketClient * @host_and_port: the name and optionally the port of the host to connect to * @default_port: the default port to connect to - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of g_socket_client_connect_to_host(). * @@ -1280,9 +1721,9 @@ g_socket_client_connect_to_host_async (GSocketClient *client, &error); if (connectable == NULL) { - g_simple_async_report_gerror_in_idle (G_OBJECT (client), - callback, user_data, error); - g_error_free (error); + g_task_report_error (client, callback, user_data, + g_socket_client_connect_to_host_async, + error); } else { @@ -1298,9 +1739,9 @@ g_socket_client_connect_to_host_async (GSocketClient *client, * @client: a #GSocketClient * @domain: a domain name * @service: the name of the service to connect to - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of * g_socket_client_connect_to_service(). @@ -1329,9 +1770,9 @@ g_socket_client_connect_to_service_async (GSocketClient *client, * @client: a #GSocketClient * @uri: a network uri * @default_port: the default port to connect to - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of g_socket_client_connect_to_uri(). * @@ -1356,9 +1797,9 @@ g_socket_client_connect_to_uri_async (GSocketClient *client, connectable = g_network_address_parse_uri (uri, default_port, &error); if (connectable == NULL) { - g_simple_async_report_gerror_in_idle (G_OBJECT (client), - callback, user_data, error); - g_error_free (error); + g_task_report_error (client, callback, user_data, + g_socket_client_connect_to_uri_async, + error); } else { @@ -1374,7 +1815,7 @@ g_socket_client_connect_to_uri_async (GSocketClient *client, * g_socket_client_connect_finish: * @client: a #GSocketClient. * @result: a #GAsyncResult. - * @error: a #GError location to store the error occuring, or %NULL to + * @error: a #GError location to store the error occurring, or %NULL to * ignore. * * Finishes an async connect operation. See g_socket_client_connect_async() @@ -1388,19 +1829,16 @@ g_socket_client_connect_finish (GSocketClient *client, GAsyncResult *result, GError **error) { - GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result); - - if (g_simple_async_result_propagate_error (simple, error)) - return NULL; + g_return_val_if_fail (g_task_is_valid (result, client), NULL); - return g_object_ref (g_simple_async_result_get_op_res_gpointer (simple)); + return g_task_propagate_pointer (G_TASK (result), error); } /** * g_socket_client_connect_to_host_finish: * @client: a #GSocketClient. * @result: a #GAsyncResult. - * @error: a #GError location to store the error occuring, or %NULL to + * @error: a #GError location to store the error occurring, or %NULL to * ignore. * * Finishes an async connect operation. See g_socket_client_connect_to_host_async() @@ -1421,7 +1859,7 @@ g_socket_client_connect_to_host_finish (GSocketClient *client, * g_socket_client_connect_to_service_finish: * @client: a #GSocketClient. * @result: a #GAsyncResult. - * @error: a #GError location to store the error occuring, or %NULL to + * @error: a #GError location to store the error occurring, or %NULL to * ignore. * * Finishes an async connect operation. See g_socket_client_connect_to_service_async() @@ -1442,7 +1880,7 @@ g_socket_client_connect_to_service_finish (GSocketClient *client, * g_socket_client_connect_to_uri_finish: * @client: a #GSocketClient. * @result: a #GAsyncResult. - * @error: a #GError location to store the error occuring, or %NULL to + * @error: a #GError location to store the error occurring, or %NULL to * ignore. * * Finishes an async connect operation. See g_socket_client_connect_to_uri_async() @@ -1467,7 +1905,7 @@ g_socket_client_connect_to_uri_finish (GSocketClient *client, * Enable proxy protocols to be handled by the application. When the * indicated proxy protocol is returned by the #GProxyResolver, * #GSocketClient will consider this protocol as supported but will - * not try find a #GProxy instance to handle handshaking. The + * not try to find a #GProxy instance to handle handshaking. The * application must check for this case by calling * g_socket_connection_get_remote_address() on the returned * #GSocketConnection, and seeing if it's a #GProxyAddress of the @@ -1479,6 +1917,10 @@ g_socket_client_connect_to_uri_finish (GSocketClient *client, * proxy protocols that are reused between protocols. A good example * is HTTP. It can be used to proxy HTTP, FTP and Gopher and can also * be use as generic socket proxy through the HTTP CONNECT method. + * + * When the proxy is detected as being an application proxy, TLS handshake + * will be skipped. This is required to let the application do the proxy + * specific handshake. */ void g_socket_client_add_application_proxy (GSocketClient *client,