1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2010 Red Hat, Inc.
4 * Copyright (C) 2009 Codethink Limited
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation; either version 2 of the licence or (at
9 * your option) any later version.
11 * See the included COPYING file for more information.
13 * Authors: David Zeuthen <davidz@redhat.com>
17 * SECTION:gunixcredentialsmessage
18 * @title: GUnixCredentialsMessage
19 * @short_description: A GSocketControlMessage containing credentials
20 * @include: gio/gunixcredentialsmessage.h
21 * @see_also: #GUnixConnection, #GSocketControlMessage
23 * This #GSocketControlMessage contains a #GCredentials instance. It
24 * may be sent using g_socket_send_message() and received using
25 * g_socket_receive_message() over UNIX sockets (ie: sockets in the
26 * %G_SOCKET_FAMILY_UNIX family).
28 * For an easier way to send and receive credentials over
29 * stream-oriented UNIX sockets, see
30 * g_unix_connection_send_credentials() and
31 * g_unix_connection_receive_credentials(). To receive credentials of
32 * a foreign process connected to a socket, use
33 * g_socket_get_credentials().
38 /* ---------------------------------------------------------------------------------------------------- */
40 #include <sys/types.h>
41 #include <sys/socket.h>
45 #define G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED 1
47 #elif defined(__FreeBSD__)
48 #include <sys/types.h>
49 #include <sys/socket.h>
53 #define G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED 1
55 /* TODO: please add support for your UNIX flavor */
56 #define G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED 0
59 /* ---------------------------------------------------------------------------------------------------- */
64 #include "gunixcredentialsmessage.h"
65 #include "gcredentials.h"
69 struct _GUnixCredentialsMessagePrivate
71 GCredentials *credentials;
80 G_DEFINE_TYPE (GUnixCredentialsMessage, g_unix_credentials_message, G_TYPE_SOCKET_CONTROL_MESSAGE);
83 g_unix_credentials_message_get_size (GSocketControlMessage *message)
86 return sizeof (struct ucred);
87 #elif defined(__FreeBSD__)
88 return sizeof (struct cmsgcred);
95 g_unix_credentials_message_get_level (GSocketControlMessage *message)
99 #elif defined(__FreeBSD__)
107 g_unix_credentials_message_get_msg_type (GSocketControlMessage *message)
110 return SCM_CREDENTIALS;
111 #elif defined(__FreeBSD__)
118 static GSocketControlMessage *
119 g_unix_credentials_message_deserialize (gint level,
124 GSocketControlMessage *message;
130 GCredentials *credentials;
133 if (level != SOL_SOCKET || type != SCM_CREDENTIALS)
136 if (size != sizeof (struct ucred))
138 g_warning ("Expected a struct ucred (%" G_GSIZE_FORMAT " bytes) but "
139 "got %" G_GSIZE_FORMAT " bytes of data",
140 sizeof (struct ucred),
147 credentials = g_credentials_new ();
148 g_credentials_set_native (credentials, G_CREDENTIALS_TYPE_LINUX_UCRED, ucred);
149 message = g_unix_credentials_message_new_with_credentials (credentials);
150 g_object_unref (credentials);
154 #elif defined(__FreeBSD__)
156 GCredentials *credentials;
157 struct cmsgcred *cred;
159 if (level != SOL_SOCKET || type != SCM_CREDS)
163 if (size < CMSG_LEN (sizeof *cred))
165 g_warning ("Expected a struct cmsgcred (%" G_GSIZE_FORMAT " bytes) but "
166 "got %" G_GSIZE_FORMAT " bytes of data",
167 CMSG_LEN (sizeof *cred),
174 credentials = g_credentials_new ();
175 g_credentials_set_native (credentials, G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED, cred);
176 message = g_unix_credentials_message_new_with_credentials (credentials);
177 g_object_unref (credentials);
187 g_unix_credentials_message_serialize (GSocketControlMessage *_message,
190 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (_message);
193 g_credentials_get_native (message->priv->credentials,
194 G_CREDENTIALS_TYPE_LINUX_UCRED),
195 sizeof (struct ucred));
196 #elif defined(__FreeBSD__)
198 g_credentials_get_native (message->priv->credentials,
199 G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED),
200 sizeof (struct cmsgcred));
206 g_unix_credentials_message_finalize (GObject *object)
208 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
210 if (message->priv->credentials != NULL)
211 g_object_unref (message->priv->credentials);
213 G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->finalize (object);
217 g_unix_credentials_message_init (GUnixCredentialsMessage *message)
219 message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message,
220 G_TYPE_UNIX_CREDENTIALS_MESSAGE,
221 GUnixCredentialsMessagePrivate);
225 g_unix_credentials_message_get_property (GObject *object,
230 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
234 case PROP_CREDENTIALS:
235 g_value_set_object (value, message->priv->credentials);
239 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
245 g_unix_credentials_message_set_property (GObject *object,
250 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
254 case PROP_CREDENTIALS:
255 message->priv->credentials = g_value_dup_object (value);
259 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
265 g_unix_credentials_message_constructed (GObject *object)
267 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
269 if (message->priv->credentials == NULL)
270 message->priv->credentials = g_credentials_new ();
272 if (G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->constructed != NULL)
273 G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->constructed (object);
277 g_unix_credentials_message_class_init (GUnixCredentialsMessageClass *class)
279 GSocketControlMessageClass *scm_class;
280 GObjectClass *gobject_class;
282 g_type_class_add_private (class, sizeof (GUnixCredentialsMessagePrivate));
284 gobject_class = G_OBJECT_CLASS (class);
285 gobject_class->get_property = g_unix_credentials_message_get_property;
286 gobject_class->set_property = g_unix_credentials_message_set_property;
287 gobject_class->finalize = g_unix_credentials_message_finalize;
288 gobject_class->constructed = g_unix_credentials_message_constructed;
290 scm_class = G_SOCKET_CONTROL_MESSAGE_CLASS (class);
291 scm_class->get_size = g_unix_credentials_message_get_size;
292 scm_class->get_level = g_unix_credentials_message_get_level;
293 scm_class->get_type = g_unix_credentials_message_get_msg_type;
294 scm_class->serialize = g_unix_credentials_message_serialize;
295 scm_class->deserialize = g_unix_credentials_message_deserialize;
298 * GUnixCredentialsMessage:credentials:
300 * The credentials stored in the message.
304 g_object_class_install_property (gobject_class,
306 g_param_spec_object ("credentials",
308 P_("The credentials stored in the message"),
312 G_PARAM_CONSTRUCT_ONLY |
313 G_PARAM_STATIC_NAME |
314 G_PARAM_STATIC_BLURB |
315 G_PARAM_STATIC_NICK));
319 /* ---------------------------------------------------------------------------------------------------- */
322 * g_unix_credentials_message_is_supported:
324 * Checks if passing a #GCredential on a #GSocket is supported on this platform.
326 * Returns: %TRUE if supported, %FALSE otherwise
331 g_unix_credentials_message_is_supported (void)
333 return G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED;
336 /* ---------------------------------------------------------------------------------------------------- */
339 * g_unix_credentials_message_new:
341 * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
343 * Returns: a new #GUnixCredentialsMessage
347 GSocketControlMessage *
348 g_unix_credentials_message_new (void)
350 g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
351 return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
356 * g_unix_credentials_message_new_with_credentials:
357 * @credentials: A #GCredentials object.
359 * Creates a new #GUnixCredentialsMessage holding @credentials.
361 * Returns: a new #GUnixCredentialsMessage
365 GSocketControlMessage *
366 g_unix_credentials_message_new_with_credentials (GCredentials *credentials)
368 g_return_val_if_fail (G_IS_CREDENTIALS (credentials), NULL);
369 g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
370 return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
371 "credentials", credentials,
376 * g_unix_credentials_message_get_credentials:
377 * @message: A #GUnixCredentialsMessage.
379 * Gets the credentials stored in @message.
381 * Returns: (transfer none): A #GCredentials instance. Do not free, it is owned by @message.
386 g_unix_credentials_message_get_credentials (GUnixCredentialsMessage *message)
388 g_return_val_if_fail (G_IS_UNIX_CREDENTIALS_MESSAGE (message), NULL);
389 return message->priv->credentials;