Blame gio/gsocketaddress.c

Packit ae235b
/* GIO - GLib Input, Output and Streaming Library
Packit ae235b
 *
Packit ae235b
 * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
Packit ae235b
 *
Packit ae235b
 * This library is free software; you can redistribute it and/or
Packit ae235b
 * modify it under the terms of the GNU Lesser General Public
Packit ae235b
 * License as published by the Free Software Foundation; either
Packit ae235b
 * version 2.1 of the License, or (at your option) any later version.
Packit ae235b
 *
Packit ae235b
 * This library is distributed in the hope that it will be useful,
Packit ae235b
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit ae235b
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit ae235b
 * Lesser General Public License for more details.
Packit ae235b
 *
Packit ae235b
 * You should have received a copy of the GNU Lesser General
Packit ae235b
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
Packit ae235b
 *
Packit ae235b
 * Authors: Christian Kellner <gicmo@gnome.org>
Packit ae235b
 *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
Packit ae235b
 */
Packit ae235b
Packit ae235b
#include <config.h>
Packit ae235b
#include <glib.h>
Packit ae235b
#include <string.h>
Packit ae235b
Packit ae235b
#include "gsocketaddress.h"
Packit ae235b
#include "ginetaddress.h"
Packit ae235b
#include "ginetsocketaddress.h"
Packit ae235b
#include "gnativesocketaddress.h"
Packit ae235b
#include "gnetworkingprivate.h"
Packit ae235b
#include "gproxyaddress.h"
Packit ae235b
#include "gproxyaddressenumerator.h"
Packit ae235b
#include "gsocketaddressenumerator.h"
Packit ae235b
#include "gsocketconnectable.h"
Packit ae235b
#include "glibintl.h"
Packit ae235b
#include "gioenumtypes.h"
Packit ae235b
Packit ae235b
#ifdef G_OS_UNIX
Packit ae235b
#include "gunixsocketaddress.h"
Packit ae235b
#endif
Packit ae235b
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * SECTION:gsocketaddress
Packit ae235b
 * @short_description: Abstract base class representing endpoints
Packit ae235b
 *     for socket communication
Packit ae235b
 * @include: gio/gio.h
Packit ae235b
 *
Packit ae235b
 * #GSocketAddress is the equivalent of struct sockaddr in the BSD
Packit ae235b
 * sockets API. This is an abstract class; use #GInetSocketAddress
Packit ae235b
 * for internet sockets, or #GUnixSocketAddress for UNIX domain sockets.
Packit ae235b
 */
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * GSocketAddress:
Packit ae235b
 *
Packit ae235b
 * A socket endpoint address, corresponding to struct sockaddr
Packit ae235b
 * or one of its subtypes.
Packit ae235b
 */
Packit ae235b
Packit ae235b
enum
Packit ae235b
{
Packit ae235b
  PROP_NONE,
Packit ae235b
  PROP_FAMILY
Packit ae235b
};
Packit ae235b
Packit ae235b
static void                      g_socket_address_connectable_iface_init       (GSocketConnectableIface *iface);
Packit ae235b
static GSocketAddressEnumerator *g_socket_address_connectable_enumerate	       (GSocketConnectable      *connectable);
Packit ae235b
static GSocketAddressEnumerator *g_socket_address_connectable_proxy_enumerate  (GSocketConnectable      *connectable);
Packit ae235b
Packit ae235b
G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GSocketAddress, g_socket_address, G_TYPE_OBJECT,
Packit ae235b
				  G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
Packit ae235b
							 g_socket_address_connectable_iface_init))
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_socket_address_get_family:
Packit ae235b
 * @address: a #GSocketAddress
Packit ae235b
 *
Packit ae235b
 * Gets the socket family type of @address.
Packit ae235b
 *
Packit ae235b
 * Returns: the socket family type of @address
Packit ae235b
 *
Packit ae235b
 * Since: 2.22
Packit ae235b
 */
Packit ae235b
GSocketFamily
Packit ae235b
g_socket_address_get_family (GSocketAddress *address)
Packit ae235b
{
Packit ae235b
  g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), 0);
Packit ae235b
Packit ae235b
  return G_SOCKET_ADDRESS_GET_CLASS (address)->get_family (address);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_socket_address_get_property (GObject *object, guint prop_id,
Packit ae235b
			       GValue *value, GParamSpec *pspec)
Packit ae235b
{
Packit ae235b
  GSocketAddress *address = G_SOCKET_ADDRESS (object);
Packit ae235b
Packit ae235b
  switch (prop_id)
Packit ae235b
    {
Packit ae235b
     case PROP_FAMILY:
Packit ae235b
      g_value_set_enum (value, g_socket_address_get_family (address));
Packit ae235b
      break;
Packit ae235b
Packit ae235b
     default:
Packit ae235b
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_socket_address_class_init (GSocketAddressClass *klass)
Packit ae235b
{
Packit ae235b
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Packit ae235b
Packit ae235b
  gobject_class->get_property = g_socket_address_get_property;
Packit ae235b
Packit ae235b
  g_object_class_install_property (gobject_class, PROP_FAMILY,
Packit ae235b
                                   g_param_spec_enum ("family",
Packit ae235b
						      P_("Address family"),
Packit ae235b
						      P_("The family of the socket address"),
Packit ae235b
						      G_TYPE_SOCKET_FAMILY,
Packit ae235b
						      G_SOCKET_FAMILY_INVALID,
Packit ae235b
						      G_PARAM_READABLE |
Packit ae235b
                                                      G_PARAM_STATIC_STRINGS));
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_socket_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
Packit ae235b
{
Packit ae235b
  connectable_iface->enumerate  = g_socket_address_connectable_enumerate;
Packit ae235b
  connectable_iface->proxy_enumerate  = g_socket_address_connectable_proxy_enumerate;
Packit ae235b
  /* to_string() is implemented by subclasses */
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_socket_address_init (GSocketAddress *address)
Packit ae235b
{
Packit ae235b
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_socket_address_get_native_size:
Packit ae235b
 * @address: a #GSocketAddress
Packit ae235b
 *
Packit ae235b
 * Gets the size of @address's native struct sockaddr.
Packit ae235b
 * You can use this to allocate memory to pass to
Packit ae235b
 * g_socket_address_to_native().
Packit ae235b
 *
Packit ae235b
 * Returns: the size of the native struct sockaddr that
Packit ae235b
 *     @address represents
Packit ae235b
 *
Packit ae235b
 * Since: 2.22
Packit ae235b
 */
Packit ae235b
gssize
Packit ae235b
g_socket_address_get_native_size (GSocketAddress *address)
Packit ae235b
{
Packit ae235b
  g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), -1);
Packit ae235b
Packit ae235b
  return G_SOCKET_ADDRESS_GET_CLASS (address)->get_native_size (address);
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_socket_address_to_native:
Packit ae235b
 * @address: a #GSocketAddress
Packit ae235b
 * @dest: a pointer to a memory location that will contain the native
Packit ae235b
 * struct sockaddr
Packit ae235b
 * @destlen: the size of @dest. Must be at least as large as
Packit ae235b
 *     g_socket_address_get_native_size()
Packit ae235b
 * @error: #GError for error reporting, or %NULL to ignore
Packit ae235b
 *
Packit ae235b
 * Converts a #GSocketAddress to a native struct sockaddr, which can
Packit ae235b
 * be passed to low-level functions like connect() or bind().
Packit ae235b
 *
Packit ae235b
 * If not enough space is available, a %G_IO_ERROR_NO_SPACE error
Packit ae235b
 * is returned. If the address type is not known on the system
Packit ae235b
 * then a %G_IO_ERROR_NOT_SUPPORTED error is returned.
Packit ae235b
 *
Packit ae235b
 * Returns: %TRUE if @dest was filled in, %FALSE on error
Packit ae235b
 *
Packit ae235b
 * Since: 2.22
Packit ae235b
 */
Packit ae235b
gboolean
Packit ae235b
g_socket_address_to_native (GSocketAddress  *address,
Packit ae235b
			    gpointer         dest,
Packit ae235b
			    gsize            destlen,
Packit ae235b
			    GError         **error)
Packit ae235b
{
Packit ae235b
  g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), FALSE);
Packit ae235b
Packit ae235b
  return G_SOCKET_ADDRESS_GET_CLASS (address)->to_native (address, dest, destlen, error);
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_socket_address_new_from_native:
Packit ae235b
 * @native: (not nullable): a pointer to a struct sockaddr
Packit ae235b
 * @len: the size of the memory location pointed to by @native
Packit ae235b
 *
Packit ae235b
 * Creates a #GSocketAddress subclass corresponding to the native
Packit ae235b
 * struct sockaddr @native.
Packit ae235b
 *
Packit ae235b
 * Returns: a new #GSocketAddress if @native could successfully
Packit ae235b
 *     be converted, otherwise %NULL
Packit ae235b
 *
Packit ae235b
 * Since: 2.22
Packit ae235b
 */
Packit ae235b
GSocketAddress *
Packit ae235b
g_socket_address_new_from_native (gpointer native,
Packit ae235b
				  gsize    len)
Packit ae235b
{
Packit ae235b
  gshort family;
Packit ae235b
Packit ae235b
  if (len < sizeof (gshort))
Packit ae235b
    return NULL;
Packit ae235b
Packit ae235b
  family = ((struct sockaddr *) native)->sa_family;
Packit ae235b
Packit ae235b
  if (family == AF_UNSPEC)
Packit ae235b
    return NULL;
Packit ae235b
Packit ae235b
  if (family == AF_INET)
Packit ae235b
    {
Packit ae235b
      struct sockaddr_in *addr = (struct sockaddr_in *) native;
Packit ae235b
      GInetAddress *iaddr;
Packit ae235b
      GSocketAddress *sockaddr;
Packit ae235b
Packit ae235b
      if (len < sizeof (*addr))
Packit ae235b
	return NULL;
Packit ae235b
Packit ae235b
      iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin_addr), AF_INET);
Packit ae235b
      sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin_port));
Packit ae235b
      g_object_unref (iaddr);
Packit ae235b
      return sockaddr;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  if (family == AF_INET6)
Packit ae235b
    {
Packit ae235b
      struct sockaddr_in6 *addr = (struct sockaddr_in6 *) native;
Packit ae235b
      GInetAddress *iaddr;
Packit ae235b
      GSocketAddress *sockaddr;
Packit ae235b
Packit ae235b
      if (len < sizeof (*addr))
Packit ae235b
	return NULL;
Packit ae235b
Packit ae235b
      if (IN6_IS_ADDR_V4MAPPED (&(addr->sin6_addr)))
Packit ae235b
	{
Packit ae235b
	  struct sockaddr_in sin_addr;
Packit ae235b
Packit ae235b
	  sin_addr.sin_family = AF_INET;
Packit ae235b
	  sin_addr.sin_port = addr->sin6_port;
Packit ae235b
	  memcpy (&(sin_addr.sin_addr.s_addr), addr->sin6_addr.s6_addr + 12, 4);
Packit ae235b
	  iaddr = g_inet_address_new_from_bytes ((guint8 *) &(sin_addr.sin_addr), AF_INET);
Packit ae235b
	}
Packit ae235b
      else
Packit ae235b
	{
Packit ae235b
	  iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin6_addr), AF_INET6);
Packit ae235b
	}
Packit ae235b
Packit ae235b
      sockaddr = g_object_new (G_TYPE_INET_SOCKET_ADDRESS,
Packit ae235b
			       "address", iaddr,
Packit ae235b
			       "port", g_ntohs (addr->sin6_port),
Packit ae235b
			       "flowinfo", addr->sin6_flowinfo,
Packit ae235b
			       "scope_id", addr->sin6_scope_id,
Packit ae235b
			       NULL);
Packit ae235b
      g_object_unref (iaddr);
Packit ae235b
      return sockaddr;
Packit ae235b
    }
Packit ae235b
Packit ae235b
#ifdef G_OS_UNIX
Packit ae235b
  if (family == AF_UNIX)
Packit ae235b
    {
Packit ae235b
      struct sockaddr_un *addr = (struct sockaddr_un *) native;
Packit ae235b
      gint path_len = len - G_STRUCT_OFFSET (struct sockaddr_un, sun_path);
Packit ae235b
Packit ae235b
      if (path_len == 0)
Packit ae235b
	{
Packit ae235b
	  return g_unix_socket_address_new_with_type ("", 0,
Packit ae235b
						      G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
Packit ae235b
	}
Packit ae235b
      else if (addr->sun_path[0] == 0)
Packit ae235b
	{
Packit ae235b
	  if (!g_unix_socket_address_abstract_names_supported ())
Packit ae235b
	    {
Packit ae235b
	      return g_unix_socket_address_new_with_type ("", 0,
Packit ae235b
							  G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
Packit ae235b
	    }
Packit ae235b
	  else if (len < sizeof (*addr))
Packit ae235b
	    {
Packit ae235b
	      return g_unix_socket_address_new_with_type (addr->sun_path + 1,
Packit ae235b
							  path_len - 1,
Packit ae235b
							  G_UNIX_SOCKET_ADDRESS_ABSTRACT);
Packit ae235b
	    }
Packit ae235b
	  else
Packit ae235b
	    {
Packit ae235b
	      return g_unix_socket_address_new_with_type (addr->sun_path + 1,
Packit ae235b
							  path_len - 1,
Packit ae235b
							  G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED);
Packit ae235b
	    }
Packit ae235b
	}
Packit ae235b
      else
Packit ae235b
	return g_unix_socket_address_new (addr->sun_path);
Packit ae235b
    }
Packit ae235b
#endif
Packit ae235b
Packit ae235b
  return g_native_socket_address_new (native, len);
Packit ae235b
}
Packit ae235b
Packit ae235b
Packit ae235b
#define G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (_g_socket_address_address_enumerator_get_type ())
Packit ae235b
#define G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, GSocketAddressAddressEnumerator))
Packit ae235b
Packit ae235b
typedef struct {
Packit ae235b
  GSocketAddressEnumerator parent_instance;
Packit ae235b
Packit ae235b
  GSocketAddress *sockaddr;
Packit ae235b
} GSocketAddressAddressEnumerator;
Packit ae235b
Packit ae235b
typedef struct {
Packit ae235b
  GSocketAddressEnumeratorClass parent_class;
Packit ae235b
Packit ae235b
} GSocketAddressAddressEnumeratorClass;
Packit ae235b
Packit ae235b
static GType _g_socket_address_address_enumerator_get_type (void);
Packit ae235b
G_DEFINE_TYPE (GSocketAddressAddressEnumerator, _g_socket_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_socket_address_address_enumerator_finalize (GObject *object)
Packit ae235b
{
Packit ae235b
  GSocketAddressAddressEnumerator *sockaddr_enum =
Packit ae235b
    G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (object);
Packit ae235b
Packit ae235b
  if (sockaddr_enum->sockaddr)
Packit ae235b
    g_object_unref (sockaddr_enum->sockaddr);
Packit ae235b
Packit ae235b
  G_OBJECT_CLASS (_g_socket_address_address_enumerator_parent_class)->finalize (object);
Packit ae235b
}
Packit ae235b
Packit ae235b
static GSocketAddress *
Packit ae235b
g_socket_address_address_enumerator_next (GSocketAddressEnumerator  *enumerator,
Packit ae235b
					  GCancellable              *cancellable,
Packit ae235b
					  GError                   **error)
Packit ae235b
{
Packit ae235b
  GSocketAddressAddressEnumerator *sockaddr_enum =
Packit ae235b
    G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
Packit ae235b
Packit ae235b
  if (sockaddr_enum->sockaddr)
Packit ae235b
    {
Packit ae235b
      GSocketAddress *ret = sockaddr_enum->sockaddr;
Packit ae235b
Packit ae235b
      sockaddr_enum->sockaddr = NULL;
Packit ae235b
      return ret;
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    return NULL;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
_g_socket_address_address_enumerator_init (GSocketAddressAddressEnumerator *enumerator)
Packit ae235b
{
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
_g_socket_address_address_enumerator_class_init (GSocketAddressAddressEnumeratorClass *sockaddrenum_class)
Packit ae235b
{
Packit ae235b
  GObjectClass *object_class = G_OBJECT_CLASS (sockaddrenum_class);
Packit ae235b
  GSocketAddressEnumeratorClass *enumerator_class =
Packit ae235b
    G_SOCKET_ADDRESS_ENUMERATOR_CLASS (sockaddrenum_class);
Packit ae235b
Packit ae235b
  enumerator_class->next = g_socket_address_address_enumerator_next;
Packit ae235b
  object_class->finalize = g_socket_address_address_enumerator_finalize;
Packit ae235b
}
Packit ae235b
Packit ae235b
static GSocketAddressEnumerator *
Packit ae235b
g_socket_address_connectable_enumerate (GSocketConnectable *connectable)
Packit ae235b
{
Packit ae235b
  GSocketAddressAddressEnumerator *sockaddr_enum;
Packit ae235b
Packit ae235b
  sockaddr_enum = g_object_new (G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, NULL);
Packit ae235b
  sockaddr_enum->sockaddr = g_object_ref (G_SOCKET_ADDRESS (connectable));
Packit ae235b
Packit ae235b
  return (GSocketAddressEnumerator *)sockaddr_enum;
Packit ae235b
}
Packit ae235b
Packit ae235b
static GSocketAddressEnumerator *
Packit ae235b
g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
Packit ae235b
{
Packit ae235b
  GSocketAddressEnumerator *addr_enum = NULL;
Packit ae235b
Packit ae235b
  g_assert (connectable != NULL);
Packit ae235b
Packit ae235b
  if (G_IS_INET_SOCKET_ADDRESS (connectable) &&
Packit ae235b
      !G_IS_PROXY_ADDRESS (connectable))
Packit ae235b
    {
Packit ae235b
      GInetAddress *addr;
Packit ae235b
      guint port;
Packit ae235b
      gchar *uri;
Packit ae235b
      gchar *ip;
Packit ae235b
Packit ae235b
      g_object_get (connectable, "address", &addr, "port", &port, NULL);
Packit ae235b
Packit ae235b
      ip = g_inet_address_to_string (addr);
Packit ae235b
      uri = _g_uri_from_authority ("none", ip, port, NULL);
Packit ae235b
Packit ae235b
      addr_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
Packit ae235b
      	       	       	       	"connectable", connectable,
Packit ae235b
      	       	       	       	"uri", uri,
Packit ae235b
      	       	       	       	NULL);
Packit ae235b
Packit ae235b
      g_object_unref (addr);
Packit ae235b
      g_free (ip);
Packit ae235b
      g_free (uri);
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      addr_enum = g_socket_address_connectable_enumerate (connectable);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  return addr_enum;
Packit ae235b
}