gio/gsocketaddress.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Authors: Christian Kellner <gicmo@gnome.org>
  21  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
  22  */
  23
  24 #include <config.h>
  25 #include <glib.h>
  26 #include <string.h>
  27
  28 #include "gsocketaddress.h"
  29 #include "ginetaddress.h"
  30 #include "ginetsocketaddress.h"
  31 #include "gnetworkingprivate.h"
  32 #include "gproxyaddress.h"
  33 #include "gproxyaddressenumerator.h"
  34 #include "gsocketaddressenumerator.h"
  35 #include "gsocketconnectable.h"
  36 #include "glibintl.h"
  37 #include "gioenumtypes.h"
  38
  39 #ifdef G_OS_UNIX
  40 #include "gunixsocketaddress.h"
  41 #endif
  42
  43
  44 /**
  45  * SECTION:gsocketaddress
  46  * @short_description: Abstract base class representing endpoints for
  47  * socket communication
  48  *
  49  * #GSocketAddress is the equivalent of <type>struct sockaddr</type>
  50  * in the BSD sockets API. This is an abstract class; use
  51  * #GInetSocketAddress for internet sockets, or #GUnixSocketAddress
  52  * for UNIX domain sockets.
  53  */
  54
  55 /**
  56  * GSocketAddress:
  57  *
  58  * A socket endpoint address, corresponding to <type>struct sockaddr</type>
  59  * or one of its subtypes.
  60  */
  61
  62 enum
  63 {
  64   PROP_NONE,
  65   PROP_FAMILY
  66 };
  67
  68 static void                      g_socket_address_connectable_iface_init       (GSocketConnectableIface *iface);
  69 static GSocketAddressEnumerator *g_socket_address_connectable_enumerate        (GSocketConnectable      *connectable);
  70 static GSocketAddressEnumerator *g_socket_address_connectable_proxy_enumerate  (GSocketConnectable      *connectable);
  71
  72 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GSocketAddress, g_socket_address, G_TYPE_OBJECT,
  73                                   G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
  74                                                          g_socket_address_connectable_iface_init))
  75
  76 /**
  77  * g_socket_address_get_family:
  78  * @address: a #GSocketAddress
  79  *
  80  * Gets the socket family type of @address.
  81  *
  82  * Returns: the socket family type of @address.
  83  *
  84  * Since: 2.22
  85  */
  86 GSocketFamily
  87 g_socket_address_get_family (GSocketAddress *address)
  88 {
  89   g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), 0);
  90
  91   return G_SOCKET_ADDRESS_GET_CLASS (address)->get_family (address);
  92 }
  93
  94 static void
  95 g_socket_address_get_property (GObject *object, guint prop_id,
  96                                GValue *value, GParamSpec *pspec)
  97 {
  98   GSocketAddress *address = G_SOCKET_ADDRESS (object);
  99
 100   switch (prop_id)
 101     {
 102      case PROP_FAMILY:
 103       g_value_set_enum (value, g_socket_address_get_family (address));
 104       break;
 105
 106      default:
 107       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 108     }
 109 }
 110
 111 static void
 112 g_socket_address_class_init (GSocketAddressClass *klass)
 113 {
 114   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 115
 116   gobject_class->get_property = g_socket_address_get_property;
 117
 118   g_object_class_install_property (gobject_class, PROP_FAMILY,
 119                                    g_param_spec_enum ("family",
 120                                                       P_("Address family"),
 121                                                       P_("The family of the socket address"),
 122                                                       G_TYPE_SOCKET_FAMILY,
 123                                                       G_SOCKET_FAMILY_INVALID,
 124                                                       G_PARAM_READABLE |
 125                                                       G_PARAM_STATIC_STRINGS));
 126 }
 127
 128 static void
 129 g_socket_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
 130 {
 131   connectable_iface->enumerate  = g_socket_address_connectable_enumerate;
 132   connectable_iface->proxy_enumerate  = g_socket_address_connectable_proxy_enumerate;
 133 }
 134
 135 static void
 136 g_socket_address_init (GSocketAddress *address)
 137 {
 138
 139 }
 140
 141 /**
 142  * g_socket_address_get_native_size:
 143  * @address: a #GSocketAddress
 144  *
 145  * Gets the size of @address's native <type>struct sockaddr</type>.
 146  * You can use this to allocate memory to pass to
 147  * g_socket_address_to_native().
 148  *
 149  * Returns: the size of the native <type>struct sockaddr</type> that
 150  *     @address represents
 151  *
 152  * Since: 2.22
 153  */
 154 gssize
 155 g_socket_address_get_native_size (GSocketAddress *address)
 156 {
 157   g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), -1);
 158
 159   return G_SOCKET_ADDRESS_GET_CLASS (address)->get_native_size (address);
 160 }
 161
 162 /**
 163  * g_socket_address_to_native:
 164  * @address: a #GSocketAddress
 165  * @dest: a pointer to a memory location that will contain the native
 166  * <type>struct sockaddr</type>.
 167  * @destlen: the size of @dest. Must be at least as large as
 168  * g_socket_address_get_native_size().
 169  * @error: #GError for error reporting, or %NULL to ignore.
 170  *
 171  * Converts a #GSocketAddress to a native <type>struct
 172  * sockaddr</type>, which can be passed to low-level functions like
 173  * connect() or bind().
 174  *
 175  * If not enough space is available, a %G_IO_ERROR_NO_SPACE error is
 176  * returned. If the address type is not known on the system
 177  * then a %G_IO_ERROR_NOT_SUPPORTED error is returned.
 178  *
 179  * Returns: %TRUE if @dest was filled in, %FALSE on error
 180  *
 181  * Since: 2.22
 182  */
 183 gboolean
 184 g_socket_address_to_native (GSocketAddress  *address,
 185                             gpointer         dest,
 186                             gsize            destlen,
 187                             GError         **error)
 188 {
 189   g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), FALSE);
 190
 191   return G_SOCKET_ADDRESS_GET_CLASS (address)->to_native (address, dest, destlen, error);
 192 }
 193
 194 /**
 195  * g_socket_address_new_from_native:
 196  * @native: a pointer to a <type>struct sockaddr</type>
 197  * @len: the size of the memory location pointed to by @native
 198  *
 199  * Creates a #GSocketAddress subclass corresponding to the native
 200  * <type>struct sockaddr</type> @native.
 201  *
 202  * Returns: a new #GSocketAddress if @native could successfully be converted,
 203  * otherwise %NULL.
 204  *
 205  * Since: 2.22
 206  */
 207 GSocketAddress *
 208 g_socket_address_new_from_native (gpointer native,
 209                                   gsize    len)
 210 {
 211   gshort family;
 212
 213   if (len < sizeof (gshort))
 214     return NULL;
 215
 216   family = ((struct sockaddr *) native)->sa_family;
 217
 218   if (family == AF_UNSPEC)
 219     return NULL;
 220
 221   if (family == AF_INET)
 222     {
 223       struct sockaddr_in *addr = (struct sockaddr_in *) native;
 224       GInetAddress *iaddr;
 225       GSocketAddress *sockaddr;
 226
 227       if (len < sizeof (*addr))
 228         return NULL;
 229
 230       iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin_addr), AF_INET);
 231       sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin_port));
 232       g_object_unref (iaddr);
 233       return sockaddr;
 234     }
 235
 236   if (family == AF_INET6)
 237     {
 238       struct sockaddr_in6 *addr = (struct sockaddr_in6 *) native;
 239       GInetAddress *iaddr;
 240       GSocketAddress *sockaddr;
 241
 242       if (len < sizeof (*addr))
 243         return NULL;
 244
 245       if (IN6_IS_ADDR_V4MAPPED (&(addr->sin6_addr)))
 246         {
 247           struct sockaddr_in sin_addr;
 248
 249           sin_addr.sin_family = AF_INET;
 250           sin_addr.sin_port = addr->sin6_port;
 251           memcpy (&(sin_addr.sin_addr.s_addr), addr->sin6_addr.s6_addr + 12, 4);
 252           iaddr = g_inet_address_new_from_bytes ((guint8 *) &(sin_addr.sin_addr), AF_INET);
 253         }
 254       else
 255         {
 256           iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin6_addr), AF_INET6);
 257         }
 258
 259       sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin6_port));
 260       g_object_unref (iaddr);
 261       return sockaddr;
 262     }
 263
 264 #ifdef G_OS_UNIX
 265   if (family == AF_UNIX)
 266     {
 267       struct sockaddr_un *addr = (struct sockaddr_un *) native;
 268       gint path_len = len - G_STRUCT_OFFSET (struct sockaddr_un, sun_path);
 269
 270       if (path_len == 0)
 271         {
 272           return g_unix_socket_address_new_with_type ("", 0,
 273                                                       G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
 274         }
 275       else if (addr->sun_path[0] == 0)
 276         {
 277           if (!g_unix_socket_address_abstract_names_supported ())
 278             {
 279               return g_unix_socket_address_new_with_type ("", 0,
 280                                                           G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
 281             }
 282           else if (len < sizeof (*addr))
 283             {
 284               return g_unix_socket_address_new_with_type (addr->sun_path + 1,
 285                                                           path_len - 1,
 286                                                           G_UNIX_SOCKET_ADDRESS_ABSTRACT);
 287             }
 288           else
 289             {
 290               return g_unix_socket_address_new_with_type (addr->sun_path + 1,
 291                                                           path_len - 1,
 292                                                           G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED);
 293             }
 294         }
 295       else
 296         return g_unix_socket_address_new (addr->sun_path);
 297     }
 298 #endif
 299
 300   return NULL;
 301 }
 302
 303
 304 #define G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (_g_socket_address_address_enumerator_get_type ())
 305 #define G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, GSocketAddressAddressEnumerator))
 306
 307 typedef struct {
 308   GSocketAddressEnumerator parent_instance;
 309
 310   GSocketAddress *sockaddr;
 311 } GSocketAddressAddressEnumerator;
 312
 313 typedef struct {
 314   GSocketAddressEnumeratorClass parent_class;
 315
 316 } GSocketAddressAddressEnumeratorClass;
 317
 318 G_DEFINE_TYPE (GSocketAddressAddressEnumerator, _g_socket_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
 319
 320 static void
 321 g_socket_address_address_enumerator_finalize (GObject *object)
 322 {
 323   GSocketAddressAddressEnumerator *sockaddr_enum =
 324     G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (object);
 325
 326   if (sockaddr_enum->sockaddr)
 327     g_object_unref (sockaddr_enum->sockaddr);
 328
 329   G_OBJECT_CLASS (_g_socket_address_address_enumerator_parent_class)->finalize (object);
 330 }
 331
 332 static GSocketAddress *
 333 g_socket_address_address_enumerator_next (GSocketAddressEnumerator  *enumerator,
 334                                           GCancellable              *cancellable,
 335                                           GError                   **error)
 336 {
 337   GSocketAddressAddressEnumerator *sockaddr_enum =
 338     G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
 339
 340   if (sockaddr_enum->sockaddr)
 341     {
 342       GSocketAddress *ret = sockaddr_enum->sockaddr;
 343
 344       sockaddr_enum->sockaddr = NULL;
 345       return ret;
 346     }
 347   else
 348     return NULL;
 349 }
 350
 351 static void
 352 _g_socket_address_address_enumerator_init (GSocketAddressAddressEnumerator *enumerator)
 353 {
 354 }
 355
 356 static void
 357 _g_socket_address_address_enumerator_class_init (GSocketAddressAddressEnumeratorClass *sockaddrenum_class)
 358 {
 359   GObjectClass *object_class = G_OBJECT_CLASS (sockaddrenum_class);
 360   GSocketAddressEnumeratorClass *enumerator_class =
 361     G_SOCKET_ADDRESS_ENUMERATOR_CLASS (sockaddrenum_class);
 362
 363   enumerator_class->next = g_socket_address_address_enumerator_next;
 364   object_class->finalize = g_socket_address_address_enumerator_finalize;
 365 }
 366
 367 static GSocketAddressEnumerator *
 368 g_socket_address_connectable_enumerate (GSocketConnectable *connectable)
 369 {
 370   GSocketAddressAddressEnumerator *sockaddr_enum;
 371
 372   sockaddr_enum = g_object_new (G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, NULL);
 373   sockaddr_enum->sockaddr = g_object_ref (connectable);
 374
 375   return (GSocketAddressEnumerator *)sockaddr_enum;
 376 }
 377
 378 static GSocketAddressEnumerator *
 379 g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
 380 {
 381   GSocketAddressEnumerator *addr_enum = NULL;
 382
 383   if (G_IS_INET_SOCKET_ADDRESS (connectable) &&
 384       !G_IS_PROXY_ADDRESS (connectable))
 385     {
 386       GInetAddress *addr;
 387       guint port;
 388       gchar *uri;
 389       gchar *ip;
 390
 391       g_object_get (connectable, "address", &addr, "port", &port, NULL);
 392
 393       ip = g_inet_address_to_string (addr);
 394       uri = _g_uri_from_authority ("none", ip, port, NULL);
 395
 396       addr_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
 397                                 "connectable", connectable,
 398                                 "uri", uri,
 399                                 NULL);
 400
 401       g_object_unref (addr);
 402       g_free (ip);
 403       g_free (uri);
 404     }
 405   else
 406     {
 407       addr_enum = g_socket_address_connectable_enumerate (connectable);
 408     }
 409
 410   return addr_enum;
 411 }