1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
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.
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.
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.
20 * Authors: Christian Kellner <gicmo@gnome.org>
21 * Samuel Cormier-Iijima <sciyoshi@gmail.com>
28 #include "gunixsocketaddress.h"
30 #include "gnetworking.h"
34 * SECTION:gunixsocketaddress
35 * @short_description: UNIX GSocketAddress
36 * @include: gio/gunixsocketaddress.h
38 * Support for UNIX-domain (also known as local) sockets.
40 * UNIX domain sockets are generally visible in the filesystem.
41 * However, some systems support abstract socket names which are not
42 * visible in the filesystem and not affected by the filesystem
43 * permissions, visibility, etc. Currently this is only supported
44 * under Linux. If you attempt to use abstract sockets on other
45 * systems, function calls may return %G_IO_ERROR_NOT_SUPPORTED
46 * errors. You can use g_unix_socket_address_abstract_names_supported()
47 * to see if abstract names are supported.
49 * Note that <filename><gio/gunixsocketaddress.h></filename> belongs to
50 * the UNIX-specific GIO interfaces, thus you have to use the
51 * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
57 * A UNIX-domain (local) socket address, corresponding to a
58 * <type>struct sockaddr_un</type>.
70 #define UNIX_PATH_MAX sizeof (((struct sockaddr_un *) 0)->sun_path)
72 struct _GUnixSocketAddressPrivate
74 char path
[UNIX_PATH_MAX
]; /* Not including the initial zero in abstract case, so
75 we can guarantee zero termination of abstract
76 pathnames in the get_path() API */
77 gsize path_len
; /* Not including any terminating zeros */
78 GUnixSocketAddressType address_type
;
81 G_DEFINE_TYPE_WITH_PRIVATE (GUnixSocketAddress
, g_unix_socket_address
, G_TYPE_SOCKET_ADDRESS
)
84 g_unix_socket_address_set_property (GObject
*object
,
89 GUnixSocketAddress
*address
= G_UNIX_SOCKET_ADDRESS (object
);
97 str
= g_value_get_string (value
);
100 g_strlcpy (address
->priv
->path
, str
,
101 sizeof (address
->priv
->path
));
102 address
->priv
->path_len
= strlen (address
->priv
->path
);
106 case PROP_PATH_AS_ARRAY
:
107 array
= g_value_get_boxed (value
);
111 /* Clip to fit in UNIX_PATH_MAX with zero termination or first byte */
112 len
= MIN (array
->len
, UNIX_PATH_MAX
-1);
114 memcpy (address
->priv
->path
, array
->data
, len
);
115 address
->priv
->path
[len
] = 0; /* Ensure null-terminated */
116 address
->priv
->path_len
= len
;
121 /* Only set it if it's not the default... */
122 if (g_value_get_boolean (value
))
123 address
->priv
->address_type
= G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
;
126 case PROP_ADDRESS_TYPE
:
127 /* Only set it if it's not the default... */
128 if (g_value_get_enum (value
) != G_UNIX_SOCKET_ADDRESS_PATH
)
129 address
->priv
->address_type
= g_value_get_enum (value
);
133 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
138 g_unix_socket_address_get_property (GObject
*object
,
143 GUnixSocketAddress
*address
= G_UNIX_SOCKET_ADDRESS (object
);
149 g_value_set_string (value
, address
->priv
->path
);
152 case PROP_PATH_AS_ARRAY
:
153 array
= g_byte_array_sized_new (address
->priv
->path_len
);
154 g_byte_array_append (array
, (guint8
*)address
->priv
->path
, address
->priv
->path_len
);
155 g_value_take_boxed (value
, array
);
159 g_value_set_boolean (value
, (address
->priv
->address_type
== G_UNIX_SOCKET_ADDRESS_ABSTRACT
||
160 address
->priv
->address_type
== G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
));
164 case PROP_ADDRESS_TYPE
:
165 g_value_set_enum (value
, address
->priv
->address_type
);
169 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
174 g_unix_socket_address_get_family (GSocketAddress
*address
)
176 g_assert (PF_UNIX
== G_SOCKET_FAMILY_UNIX
);
178 return G_SOCKET_FAMILY_UNIX
;
182 g_unix_socket_address_get_native_size (GSocketAddress
*address
)
184 GUnixSocketAddress
*addr
= G_UNIX_SOCKET_ADDRESS (address
);
186 switch (addr
->priv
->address_type
)
188 case G_UNIX_SOCKET_ADDRESS_ANONYMOUS
:
189 return G_STRUCT_OFFSET(struct sockaddr_un
, sun_path
);
190 case G_UNIX_SOCKET_ADDRESS_ABSTRACT
:
191 return G_STRUCT_OFFSET(struct sockaddr_un
, sun_path
) + addr
->priv
->path_len
+ 1;
193 return sizeof (struct sockaddr_un
);
198 g_unix_socket_address_to_native (GSocketAddress
*address
,
203 GUnixSocketAddress
*addr
= G_UNIX_SOCKET_ADDRESS (address
);
204 struct sockaddr_un
*sock
;
207 socklen
= g_unix_socket_address_get_native_size (address
);
208 if (destlen
< socklen
)
210 g_set_error_literal (error
, G_IO_ERROR
, G_IO_ERROR_NO_SPACE
,
211 _("Not enough space for socket address"));
215 sock
= (struct sockaddr_un
*) dest
;
216 memset (sock
, 0, socklen
);
217 sock
->sun_family
= AF_UNIX
;
219 switch (addr
->priv
->address_type
)
221 case G_UNIX_SOCKET_ADDRESS_INVALID
:
222 case G_UNIX_SOCKET_ADDRESS_ANONYMOUS
:
225 case G_UNIX_SOCKET_ADDRESS_PATH
:
226 strcpy (sock
->sun_path
, addr
->priv
->path
);
229 case G_UNIX_SOCKET_ADDRESS_ABSTRACT
:
230 case G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
:
231 if (!g_unix_socket_address_abstract_names_supported ())
233 g_set_error_literal (error
, G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
234 _("Abstract UNIX domain socket addresses not supported on this system"));
238 sock
->sun_path
[0] = 0;
239 memcpy (sock
->sun_path
+1, addr
->priv
->path
, addr
->priv
->path_len
);
247 g_unix_socket_address_class_init (GUnixSocketAddressClass
*klass
)
249 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
250 GSocketAddressClass
*gsocketaddress_class
= G_SOCKET_ADDRESS_CLASS (klass
);
252 gobject_class
->set_property
= g_unix_socket_address_set_property
;
253 gobject_class
->get_property
= g_unix_socket_address_get_property
;
255 gsocketaddress_class
->get_family
= g_unix_socket_address_get_family
;
256 gsocketaddress_class
->to_native
= g_unix_socket_address_to_native
;
257 gsocketaddress_class
->get_native_size
= g_unix_socket_address_get_native_size
;
259 g_object_class_install_property (gobject_class
,
261 g_param_spec_string ("path",
263 P_("UNIX socket path"),
266 G_PARAM_CONSTRUCT_ONLY
|
267 G_PARAM_STATIC_STRINGS
));
268 g_object_class_install_property (gobject_class
, PROP_PATH_AS_ARRAY
,
269 g_param_spec_boxed ("path-as-array",
271 P_("UNIX socket path, as byte array"),
274 G_PARAM_CONSTRUCT_ONLY
|
275 G_PARAM_STATIC_STRINGS
));
277 * GUnixSocketAddress:abstract:
279 * Whether or not this is an abstract address
281 * Deprecated: Use #GUnixSocketAddress:address-type, which
282 * distinguishes between zero-padded and non-zero-padded
283 * abstract addresses.
285 g_object_class_install_property (gobject_class
, PROP_ABSTRACT
,
286 g_param_spec_boolean ("abstract",
288 P_("Whether or not this is an abstract address"),
291 G_PARAM_CONSTRUCT_ONLY
|
292 G_PARAM_STATIC_STRINGS
));
293 g_object_class_install_property (gobject_class
, PROP_ADDRESS_TYPE
,
294 g_param_spec_enum ("address-type",
296 P_("The type of UNIX socket address"),
297 G_TYPE_UNIX_SOCKET_ADDRESS_TYPE
,
298 G_UNIX_SOCKET_ADDRESS_PATH
,
300 G_PARAM_CONSTRUCT_ONLY
|
301 G_PARAM_STATIC_STRINGS
));
305 g_unix_socket_address_init (GUnixSocketAddress
*address
)
307 address
->priv
= g_unix_socket_address_get_instance_private (address
);
309 memset (address
->priv
->path
, 0, sizeof (address
->priv
->path
));
310 address
->priv
->path_len
= -1;
311 address
->priv
->address_type
= G_UNIX_SOCKET_ADDRESS_PATH
;
315 * g_unix_socket_address_new:
316 * @path: the socket path
318 * Creates a new #GUnixSocketAddress for @path.
320 * To create abstract socket addresses, on systems that support that,
321 * use g_unix_socket_address_new_abstract().
323 * Returns: a new #GUnixSocketAddress
328 g_unix_socket_address_new (const gchar
*path
)
330 return g_object_new (G_TYPE_UNIX_SOCKET_ADDRESS
,
337 * g_unix_socket_address_new_abstract:
338 * @path: (array length=path_len) (element-type gchar): the abstract name
339 * @path_len: the length of @path, or -1
341 * Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
342 * #GUnixSocketAddress for @path.
344 * Returns: a new #GUnixSocketAddress
346 * Deprecated: Use g_unix_socket_address_new_with_type().
349 g_unix_socket_address_new_abstract (const gchar
*path
,
352 return g_unix_socket_address_new_with_type (path
, path_len
,
353 G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
);
357 * g_unix_socket_address_new_with_type:
358 * @path: (array length=path_len) (element-type gchar): the name
359 * @path_len: the length of @path, or -1
360 * @type: a #GUnixSocketAddressType
362 * Creates a new #GUnixSocketAddress of type @type with name @path.
364 * If @type is %G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to
365 * calling g_unix_socket_address_new().
367 * If @path_type is %G_UNIX_SOCKET_ADDRESS_ABSTRACT, then @path_len
368 * bytes of @path will be copied to the socket's path, and only those
369 * bytes will be considered part of the name. (If @path_len is -1,
370 * then @path is assumed to be NUL-terminated.) For example, if @path
371 * was "test", then calling g_socket_address_get_native_size() on the
372 * returned socket would return 7 (2 bytes of overhead, 1 byte for the
373 * abstract-socket indicator byte, and 4 bytes for the name "test").
375 * If @path_type is %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED, then
376 * @path_len bytes of @path will be copied to the socket's path, the
377 * rest of the path will be padded with 0 bytes, and the entire
378 * zero-padded buffer will be considered the name. (As above, if
379 * @path_len is -1, then @path is assumed to be NUL-terminated.) In
380 * this case, g_socket_address_get_native_size() will always return
381 * the full size of a <literal>struct sockaddr_un</literal>, although
382 * g_unix_socket_address_get_path_len() will still return just the
385 * %G_UNIX_SOCKET_ADDRESS_ABSTRACT is preferred over
386 * %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED for new programs. Of course,
387 * when connecting to a server created by another process, you must
388 * use the appropriate type corresponding to how that process created
389 * its listening socket.
391 * Returns: a new #GUnixSocketAddress
396 g_unix_socket_address_new_with_type (const gchar
*path
,
398 GUnixSocketAddressType type
)
400 GSocketAddress
*address
;
403 if (type
== G_UNIX_SOCKET_ADDRESS_ANONYMOUS
)
405 else if (path_len
== -1)
406 path_len
= strlen (path
);
408 array
= g_byte_array_sized_new (path_len
);
410 g_byte_array_append (array
, (guint8
*)path
, path_len
);
412 address
= g_object_new (G_TYPE_UNIX_SOCKET_ADDRESS
,
413 "path-as-array", array
,
414 "address-type", type
,
417 g_byte_array_unref (array
);
423 * g_unix_socket_address_get_path:
424 * @address: a #GInetSocketAddress
426 * Gets @address's path, or for abstract sockets the "name".
428 * Guaranteed to be zero-terminated, but an abstract socket
429 * may contain embedded zeros, and thus you should use
430 * g_unix_socket_address_get_path_len() to get the true length
433 * Returns: the path for @address
438 g_unix_socket_address_get_path (GUnixSocketAddress
*address
)
440 return address
->priv
->path
;
444 * g_unix_socket_address_get_path_len:
445 * @address: a #GInetSocketAddress
447 * Gets the length of @address's path.
449 * For details, see g_unix_socket_address_get_path().
451 * Returns: the length of the path
456 g_unix_socket_address_get_path_len (GUnixSocketAddress
*address
)
458 return address
->priv
->path_len
;
462 * g_unix_socket_address_get_address_type:
463 * @address: a #GInetSocketAddress
465 * Gets @address's type.
467 * Returns: a #GUnixSocketAddressType
471 GUnixSocketAddressType
472 g_unix_socket_address_get_address_type (GUnixSocketAddress
*address
)
474 return address
->priv
->address_type
;
478 * g_unix_socket_address_get_is_abstract:
479 * @address: a #GInetSocketAddress
481 * Tests if @address is abstract.
483 * Returns: %TRUE if the address is abstract, %FALSE otherwise
487 * Deprecated: Use g_unix_socket_address_get_address_type()
490 g_unix_socket_address_get_is_abstract (GUnixSocketAddress
*address
)
492 return (address
->priv
->address_type
== G_UNIX_SOCKET_ADDRESS_ABSTRACT
||
493 address
->priv
->address_type
== G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
);
497 * g_unix_socket_address_abstract_names_supported:
499 * Checks if abstract UNIX domain socket names are supported.
501 * Returns: %TRUE if supported, %FALSE otherwise
506 g_unix_socket_address_abstract_names_supported (void)