|
Packit Service |
d3d246 |
/* GIO - GLib Input, Output and Streaming Library
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Copyright (C) 2010 Collabora Ltd.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* This library is free software; you can redistribute it and/or
|
|
Packit Service |
d3d246 |
* modify it under the terms of the GNU Lesser General Public
|
|
Packit Service |
d3d246 |
* License as published by the Free Software Foundation; either
|
|
Packit Service |
d3d246 |
* version 2.1 of the License, or (at your option) any later version.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* This library is distributed in the hope that it will be useful,
|
|
Packit Service |
d3d246 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Packit Service |
d3d246 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Packit Service |
d3d246 |
* Lesser General Public License for more details.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* You should have received a copy of the GNU Lesser General
|
|
Packit Service |
d3d246 |
* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Author: Nicolas Dufresne <nicolas.dufresne@collabora.co.uk>
|
|
Packit Service |
d3d246 |
*/
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
#include "config.h"
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
#include "gproxy.h"
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
#include "giomodule.h"
|
|
Packit Service |
d3d246 |
#include "giomodule-priv.h"
|
|
Packit Service |
d3d246 |
#include "glibintl.h"
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
/**
|
|
Packit Service |
d3d246 |
* SECTION:gproxy
|
|
Packit Service |
d3d246 |
* @short_description: Interface for proxy handling
|
|
Packit Service |
d3d246 |
* @include: gio/gio.h
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* A #GProxy handles connecting to a remote host via a given type of
|
|
Packit Service |
d3d246 |
* proxy server. It is implemented by the 'gio-proxy' extension point.
|
|
Packit Service |
d3d246 |
* The extensions are named after their proxy protocol name. As an
|
|
Packit Service |
d3d246 |
* example, a SOCKS5 proxy implementation can be retrieved with the
|
|
Packit Service |
d3d246 |
* name 'socks5' using the function
|
|
Packit Service |
d3d246 |
* g_io_extension_point_get_extension_by_name().
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Since: 2.26
|
|
Packit Service |
d3d246 |
**/
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
G_DEFINE_INTERFACE (GProxy, g_proxy, G_TYPE_OBJECT)
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
static void
|
|
Packit Service |
d3d246 |
g_proxy_default_init (GProxyInterface *iface)
|
|
Packit Service |
d3d246 |
{
|
|
Packit Service |
d3d246 |
}
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
/**
|
|
Packit Service |
d3d246 |
* g_proxy_get_default_for_protocol:
|
|
Packit Service |
d3d246 |
* @protocol: the proxy protocol name (e.g. http, socks, etc)
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Lookup "gio-proxy" extension point for a proxy implementation that supports
|
|
Packit Service |
d3d246 |
* specified protocol.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Returns: (transfer full): return a #GProxy or NULL if protocol
|
|
Packit Service |
d3d246 |
* is not supported.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Since: 2.26
|
|
Packit Service |
d3d246 |
**/
|
|
Packit Service |
d3d246 |
GProxy *
|
|
Packit Service |
d3d246 |
g_proxy_get_default_for_protocol (const gchar *protocol)
|
|
Packit Service |
d3d246 |
{
|
|
Packit Service |
d3d246 |
GIOExtensionPoint *ep;
|
|
Packit Service |
d3d246 |
GIOExtension *extension;
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
/* Ensure proxy modules loaded */
|
|
Packit Service |
d3d246 |
_g_io_modules_ensure_loaded ();
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
ep = g_io_extension_point_lookup (G_PROXY_EXTENSION_POINT_NAME);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
extension = g_io_extension_point_get_extension_by_name (ep, protocol);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
if (extension)
|
|
Packit Service |
d3d246 |
return g_object_new (g_io_extension_get_type (extension), NULL);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
return NULL;
|
|
Packit Service |
d3d246 |
}
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
/**
|
|
Packit Service |
d3d246 |
* g_proxy_connect:
|
|
Packit Service |
d3d246 |
* @proxy: a #GProxy
|
|
Packit Service |
d3d246 |
* @connection: a #GIOStream
|
|
Packit Service |
d3d246 |
* @proxy_address: a #GProxyAddress
|
|
Packit Service |
d3d246 |
* @cancellable: (nullable): a #GCancellable
|
|
Packit Service |
d3d246 |
* @error: return #GError
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Given @connection to communicate with a proxy (eg, a
|
|
Packit Service |
d3d246 |
* #GSocketConnection that is connected to the proxy server), this
|
|
Packit Service |
d3d246 |
* does the necessary handshake to connect to @proxy_address, and if
|
|
Packit Service |
d3d246 |
* required, wraps the #GIOStream to handle proxy payload.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Returns: (transfer full): a #GIOStream that will replace @connection. This might
|
|
Packit Service |
d3d246 |
* be the same as @connection, in which case a reference
|
|
Packit Service |
d3d246 |
* will be added.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Since: 2.26
|
|
Packit Service |
d3d246 |
*/
|
|
Packit Service |
d3d246 |
GIOStream *
|
|
Packit Service |
d3d246 |
g_proxy_connect (GProxy *proxy,
|
|
Packit Service |
d3d246 |
GIOStream *connection,
|
|
Packit Service |
d3d246 |
GProxyAddress *proxy_address,
|
|
Packit Service |
d3d246 |
GCancellable *cancellable,
|
|
Packit Service |
d3d246 |
GError **error)
|
|
Packit Service |
d3d246 |
{
|
|
Packit Service |
d3d246 |
GProxyInterface *iface;
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
g_return_val_if_fail (G_IS_PROXY (proxy), NULL);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
iface = G_PROXY_GET_IFACE (proxy);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
return (* iface->connect) (proxy,
|
|
Packit Service |
d3d246 |
connection,
|
|
Packit Service |
d3d246 |
proxy_address,
|
|
Packit Service |
d3d246 |
cancellable,
|
|
Packit Service |
d3d246 |
error);
|
|
Packit Service |
d3d246 |
}
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
/**
|
|
Packit Service |
d3d246 |
* g_proxy_connect_async:
|
|
Packit Service |
d3d246 |
* @proxy: a #GProxy
|
|
Packit Service |
d3d246 |
* @connection: a #GIOStream
|
|
Packit Service |
d3d246 |
* @proxy_address: a #GProxyAddress
|
|
Packit Service |
d3d246 |
* @cancellable: (nullable): a #GCancellable
|
|
Packit Service |
d3d246 |
* @callback: (scope async): a #GAsyncReadyCallback
|
|
Packit Service |
d3d246 |
* @user_data: (closure): callback data
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Asynchronous version of g_proxy_connect().
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Since: 2.26
|
|
Packit Service |
d3d246 |
*/
|
|
Packit Service |
d3d246 |
void
|
|
Packit Service |
d3d246 |
g_proxy_connect_async (GProxy *proxy,
|
|
Packit Service |
d3d246 |
GIOStream *connection,
|
|
Packit Service |
d3d246 |
GProxyAddress *proxy_address,
|
|
Packit Service |
d3d246 |
GCancellable *cancellable,
|
|
Packit Service |
d3d246 |
GAsyncReadyCallback callback,
|
|
Packit Service |
d3d246 |
gpointer user_data)
|
|
Packit Service |
d3d246 |
{
|
|
Packit Service |
d3d246 |
GProxyInterface *iface;
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
g_return_if_fail (G_IS_PROXY (proxy));
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
iface = G_PROXY_GET_IFACE (proxy);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
(* iface->connect_async) (proxy,
|
|
Packit Service |
d3d246 |
connection,
|
|
Packit Service |
d3d246 |
proxy_address,
|
|
Packit Service |
d3d246 |
cancellable,
|
|
Packit Service |
d3d246 |
callback,
|
|
Packit Service |
d3d246 |
user_data);
|
|
Packit Service |
d3d246 |
}
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
/**
|
|
Packit Service |
d3d246 |
* g_proxy_connect_finish:
|
|
Packit Service |
d3d246 |
* @proxy: a #GProxy
|
|
Packit Service |
d3d246 |
* @result: a #GAsyncResult
|
|
Packit Service |
d3d246 |
* @error: return #GError
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* See g_proxy_connect().
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Returns: (transfer full): a #GIOStream.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Since: 2.26
|
|
Packit Service |
d3d246 |
*/
|
|
Packit Service |
d3d246 |
GIOStream *
|
|
Packit Service |
d3d246 |
g_proxy_connect_finish (GProxy *proxy,
|
|
Packit Service |
d3d246 |
GAsyncResult *result,
|
|
Packit Service |
d3d246 |
GError **error)
|
|
Packit Service |
d3d246 |
{
|
|
Packit Service |
d3d246 |
GProxyInterface *iface;
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
g_return_val_if_fail (G_IS_PROXY (proxy), NULL);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
iface = G_PROXY_GET_IFACE (proxy);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
return (* iface->connect_finish) (proxy, result, error);
|
|
Packit Service |
d3d246 |
}
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
/**
|
|
Packit Service |
d3d246 |
* g_proxy_supports_hostname:
|
|
Packit Service |
d3d246 |
* @proxy: a #GProxy
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Some proxy protocols expect to be passed a hostname, which they
|
|
Packit Service |
d3d246 |
* will resolve to an IP address themselves. Others, like SOCKS4, do
|
|
Packit Service |
d3d246 |
* not allow this. This function will return %FALSE if @proxy is
|
|
Packit Service |
d3d246 |
* implementing such a protocol. When %FALSE is returned, the caller
|
|
Packit Service |
d3d246 |
* should resolve the destination hostname first, and then pass a
|
|
Packit Service |
d3d246 |
* #GProxyAddress containing the stringified IP address to
|
|
Packit Service |
d3d246 |
* g_proxy_connect() or g_proxy_connect_async().
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Returns: %TRUE if hostname resolution is supported.
|
|
Packit Service |
d3d246 |
*
|
|
Packit Service |
d3d246 |
* Since: 2.26
|
|
Packit Service |
d3d246 |
*/
|
|
Packit Service |
d3d246 |
gboolean
|
|
Packit Service |
d3d246 |
g_proxy_supports_hostname (GProxy *proxy)
|
|
Packit Service |
d3d246 |
{
|
|
Packit Service |
d3d246 |
GProxyInterface *iface;
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
g_return_val_if_fail (G_IS_PROXY (proxy), FALSE);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
iface = G_PROXY_GET_IFACE (proxy);
|
|
Packit Service |
d3d246 |
|
|
Packit Service |
d3d246 |
return (* iface->supports_hostname) (proxy);
|
|
Packit Service |
d3d246 |
}
|