1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
5 * SPDX-License-Identifier: LGPL-2.1-or-later
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.1 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, see <http://www.gnu.org/licenses/>.
20 * Authors: Christian Kellner <gicmo@gnome.org>
21 * Samuel Cormier-Iijima <sciyoshi@gmail.com>
28 #include "gsocketaddress.h"
29 #include "ginetaddress.h"
30 #include "ginetsocketaddress.h"
31 #include "gnativesocketaddress.h"
32 #include "gnetworkingprivate.h"
33 #include "gproxyaddress.h"
34 #include "gproxyaddressenumerator.h"
35 #include "gsocketaddressenumerator.h"
36 #include "gsocketconnectable.h"
38 #include "gioenumtypes.h"
40 #include "gunixsocketaddress.h"
43 #include "giowin32-afunix.h"
48 * SECTION:gsocketaddress
49 * @short_description: Abstract base class representing endpoints
50 * for socket communication
53 * #GSocketAddress is the equivalent of struct sockaddr in the BSD
54 * sockets API. This is an abstract class; use #GInetSocketAddress
55 * for internet sockets, or #GUnixSocketAddress for UNIX domain sockets.
61 * A socket endpoint address, corresponding to struct sockaddr
62 * or one of its subtypes.
71 static void g_socket_address_connectable_iface_init (GSocketConnectableIface *iface);
72 static GSocketAddressEnumerator *g_socket_address_connectable_enumerate (GSocketConnectable *connectable);
73 static GSocketAddressEnumerator *g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable);
75 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GSocketAddress, g_socket_address, G_TYPE_OBJECT,
76 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
77 g_socket_address_connectable_iface_init))
80 * g_socket_address_get_family:
81 * @address: a #GSocketAddress
83 * Gets the socket family type of @address.
85 * Returns: the socket family type of @address
90 g_socket_address_get_family (GSocketAddress *address)
92 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), 0);
94 return G_SOCKET_ADDRESS_GET_CLASS (address)->get_family (address);
98 g_socket_address_get_property (GObject *object, guint prop_id,
99 GValue *value, GParamSpec *pspec)
101 GSocketAddress *address = G_SOCKET_ADDRESS (object);
106 g_value_set_enum (value, g_socket_address_get_family (address));
110 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
115 g_socket_address_class_init (GSocketAddressClass *klass)
117 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
119 gobject_class->get_property = g_socket_address_get_property;
121 g_object_class_install_property (gobject_class, PROP_FAMILY,
122 g_param_spec_enum ("family",
123 P_("Address family"),
124 P_("The family of the socket address"),
125 G_TYPE_SOCKET_FAMILY,
126 G_SOCKET_FAMILY_INVALID,
128 G_PARAM_STATIC_STRINGS));
132 g_socket_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
134 connectable_iface->enumerate = g_socket_address_connectable_enumerate;
135 connectable_iface->proxy_enumerate = g_socket_address_connectable_proxy_enumerate;
136 /* to_string() is implemented by subclasses */
140 g_socket_address_init (GSocketAddress *address)
146 * g_socket_address_get_native_size:
147 * @address: a #GSocketAddress
149 * Gets the size of @address's native struct sockaddr.
150 * You can use this to allocate memory to pass to
151 * g_socket_address_to_native().
153 * Returns: the size of the native struct sockaddr that
154 * @address represents
159 g_socket_address_get_native_size (GSocketAddress *address)
161 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), -1);
163 return G_SOCKET_ADDRESS_GET_CLASS (address)->get_native_size (address);
167 * g_socket_address_to_native:
168 * @address: a #GSocketAddress
169 * @dest: a pointer to a memory location that will contain the native
171 * @destlen: the size of @dest. Must be at least as large as
172 * g_socket_address_get_native_size()
173 * @error: #GError for error reporting, or %NULL to ignore
175 * Converts a #GSocketAddress to a native struct sockaddr, which can
176 * be passed to low-level functions like connect() or bind().
178 * If not enough space is available, a %G_IO_ERROR_NO_SPACE error
179 * is returned. If the address type is not known on the system
180 * then a %G_IO_ERROR_NOT_SUPPORTED error is returned.
182 * Returns: %TRUE if @dest was filled in, %FALSE on error
187 g_socket_address_to_native (GSocketAddress *address,
192 g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), FALSE);
194 return G_SOCKET_ADDRESS_GET_CLASS (address)->to_native (address, dest, destlen, error);
198 * g_socket_address_new_from_native:
199 * @native: (not nullable): a pointer to a struct sockaddr
200 * @len: the size of the memory location pointed to by @native
202 * Creates a #GSocketAddress subclass corresponding to the native
203 * struct sockaddr @native.
205 * Returns: a new #GSocketAddress if @native could successfully
206 * be converted, otherwise %NULL
211 g_socket_address_new_from_native (gpointer native,
216 if (len < sizeof (gshort))
219 family = ((struct sockaddr *) native)->sa_family;
221 if (family == AF_UNSPEC)
224 if (family == AF_INET)
226 struct sockaddr_in *addr = (struct sockaddr_in *) native;
228 GSocketAddress *sockaddr;
230 if (len < sizeof (*addr))
233 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin_addr), AF_INET);
234 sockaddr = g_inet_socket_address_new (iaddr, g_ntohs (addr->sin_port));
235 g_object_unref (iaddr);
239 if (family == AF_INET6)
241 struct sockaddr_in6 *addr = (struct sockaddr_in6 *) native;
243 GSocketAddress *sockaddr;
245 if (len < sizeof (*addr))
248 if (IN6_IS_ADDR_V4MAPPED (&(addr->sin6_addr)))
250 struct sockaddr_in sin_addr;
252 sin_addr.sin_family = AF_INET;
253 sin_addr.sin_port = addr->sin6_port;
254 memcpy (&(sin_addr.sin_addr.s_addr), addr->sin6_addr.s6_addr + 12, 4);
255 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(sin_addr.sin_addr), AF_INET);
259 iaddr = g_inet_address_new_from_bytes ((guint8 *) &(addr->sin6_addr), AF_INET6);
262 sockaddr = g_object_new (G_TYPE_INET_SOCKET_ADDRESS,
264 "port", g_ntohs (addr->sin6_port),
265 "flowinfo", addr->sin6_flowinfo,
266 "scope_id", addr->sin6_scope_id,
268 g_object_unref (iaddr);
272 if (family == AF_UNIX)
274 struct sockaddr_un *addr = (struct sockaddr_un *) native;
275 gint path_len = len - G_STRUCT_OFFSET (struct sockaddr_un, sun_path);
279 return g_unix_socket_address_new_with_type ("", 0,
280 G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
282 else if (addr->sun_path[0] == 0)
284 if (!g_unix_socket_address_abstract_names_supported ())
286 return g_unix_socket_address_new_with_type ("", 0,
287 G_UNIX_SOCKET_ADDRESS_ANONYMOUS);
289 else if (len < sizeof (*addr))
291 return g_unix_socket_address_new_with_type (addr->sun_path + 1,
293 G_UNIX_SOCKET_ADDRESS_ABSTRACT);
297 return g_unix_socket_address_new_with_type (addr->sun_path + 1,
299 G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED);
303 return g_unix_socket_address_new (addr->sun_path);
306 return g_native_socket_address_new (native, len);
310 #define G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (_g_socket_address_address_enumerator_get_type ())
311 #define G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, GSocketAddressAddressEnumerator))
314 GSocketAddressEnumerator parent_instance;
316 GSocketAddress *sockaddr;
317 } GSocketAddressAddressEnumerator;
320 GSocketAddressEnumeratorClass parent_class;
322 } GSocketAddressAddressEnumeratorClass;
324 static GType _g_socket_address_address_enumerator_get_type (void);
325 G_DEFINE_TYPE (GSocketAddressAddressEnumerator, _g_socket_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
328 g_socket_address_address_enumerator_finalize (GObject *object)
330 GSocketAddressAddressEnumerator *sockaddr_enum =
331 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (object);
333 if (sockaddr_enum->sockaddr)
334 g_object_unref (sockaddr_enum->sockaddr);
336 G_OBJECT_CLASS (_g_socket_address_address_enumerator_parent_class)->finalize (object);
339 static GSocketAddress *
340 g_socket_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
341 GCancellable *cancellable,
344 GSocketAddressAddressEnumerator *sockaddr_enum =
345 G_SOCKET_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
347 if (sockaddr_enum->sockaddr)
349 GSocketAddress *ret = sockaddr_enum->sockaddr;
351 sockaddr_enum->sockaddr = NULL;
359 _g_socket_address_address_enumerator_init (GSocketAddressAddressEnumerator *enumerator)
364 _g_socket_address_address_enumerator_class_init (GSocketAddressAddressEnumeratorClass *sockaddrenum_class)
366 GObjectClass *object_class = G_OBJECT_CLASS (sockaddrenum_class);
367 GSocketAddressEnumeratorClass *enumerator_class =
368 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (sockaddrenum_class);
370 enumerator_class->next = g_socket_address_address_enumerator_next;
371 object_class->finalize = g_socket_address_address_enumerator_finalize;
374 static GSocketAddressEnumerator *
375 g_socket_address_connectable_enumerate (GSocketConnectable *connectable)
377 GSocketAddressAddressEnumerator *sockaddr_enum;
379 sockaddr_enum = g_object_new (G_TYPE_SOCKET_ADDRESS_ADDRESS_ENUMERATOR, NULL);
380 sockaddr_enum->sockaddr = g_object_ref (G_SOCKET_ADDRESS (connectable));
382 return (GSocketAddressEnumerator *)sockaddr_enum;
385 static GSocketAddressEnumerator *
386 g_socket_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
388 GSocketAddressEnumerator *addr_enum = NULL;
390 g_assert (connectable != NULL);
392 if (G_IS_INET_SOCKET_ADDRESS (connectable) &&
393 !G_IS_PROXY_ADDRESS (connectable))
400 g_object_get (connectable, "address", &addr, "port", &port, NULL);
402 ip = g_inet_address_to_string (addr);
403 uri = g_uri_join (G_URI_FLAGS_NONE, "none", NULL, ip, port, "", NULL, NULL);
405 addr_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
406 "connectable", connectable,
410 g_object_unref (addr);
416 addr_enum = g_socket_address_connectable_enumerate (connectable);