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_ADDRESS_UNIX family).
28 * For an easier way to send and receive credentials over
29 * stream-oriented UNIX sockets, see g_unix_connection_send_credentials() and
30 * g_unix_connection_receive_credentials().
35 /* ---------------------------------------------------------------------------------------------------- */
39 #include <sys/types.h>
40 #include <sys/socket.h>
44 #define G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED 1
47 /* TODO: please add support for your UNIX flavor */
48 #define G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED 0
51 /* ---------------------------------------------------------------------------------------------------- */
56 #include "gunixcredentialsmessage.h"
57 #include "gcredentials.h"
61 struct _GUnixCredentialsMessagePrivate
63 GCredentials *credentials;
72 G_DEFINE_TYPE (GUnixCredentialsMessage, g_unix_credentials_message, G_TYPE_SOCKET_CONTROL_MESSAGE);
75 g_unix_credentials_message_get_size (GSocketControlMessage *message)
78 return sizeof (struct ucred);
85 g_unix_credentials_message_get_level (GSocketControlMessage *message)
95 g_unix_credentials_message_get_msg_type (GSocketControlMessage *message)
98 return SCM_CREDENTIALS;
104 static GSocketControlMessage *
105 g_unix_credentials_message_deserialize (gint level,
110 GSocketControlMessage *message;
116 GCredentials *credentials;
119 if (level != SOL_SOCKET || type != SCM_CREDENTIALS)
122 if (size != sizeof (struct ucred))
124 g_warning ("Expected a struct ucred (%" G_GSIZE_FORMAT " bytes) but "
125 "got %" G_GSIZE_FORMAT " bytes of data",
126 sizeof (struct ucred),
133 credentials = g_credentials_new ();
134 g_credentials_set_native (credentials, ucred);
135 message = g_unix_credentials_message_new_with_credentials (credentials);
136 g_object_unref (credentials);
146 g_unix_credentials_message_serialize (GSocketControlMessage *_message,
149 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (_message);
151 memcpy (data, g_credentials_get_native (message->priv->credentials), sizeof (struct ucred));
156 g_unix_credentials_message_finalize (GObject *object)
158 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
160 if (message->priv->credentials != NULL)
161 g_object_unref (message->priv->credentials);
163 G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->finalize (object);
167 g_unix_credentials_message_init (GUnixCredentialsMessage *message)
169 message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message,
170 G_TYPE_UNIX_CREDENTIALS_MESSAGE,
171 GUnixCredentialsMessagePrivate);
175 g_unix_credentials_message_get_property (GObject *object,
180 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
184 case PROP_CREDENTIALS:
185 g_value_set_object (value, message->priv->credentials);
189 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
195 g_unix_credentials_message_set_property (GObject *object,
200 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
204 case PROP_CREDENTIALS:
205 message->priv->credentials = g_value_dup_object (value);
209 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
215 g_unix_credentials_message_constructed (GObject *object)
217 GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
219 if (message->priv->credentials == NULL)
220 message->priv->credentials = g_credentials_new ();
222 if (G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->constructed != NULL)
223 G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->constructed (object);
227 g_unix_credentials_message_class_init (GUnixCredentialsMessageClass *class)
229 GSocketControlMessageClass *scm_class;
230 GObjectClass *gobject_class;
232 g_type_class_add_private (class, sizeof (GUnixCredentialsMessagePrivate));
234 gobject_class = G_OBJECT_CLASS (class);
235 gobject_class->get_property = g_unix_credentials_message_get_property;
236 gobject_class->set_property = g_unix_credentials_message_set_property;
237 gobject_class->finalize = g_unix_credentials_message_finalize;
238 gobject_class->constructed = g_unix_credentials_message_constructed;
240 scm_class = G_SOCKET_CONTROL_MESSAGE_CLASS (class);
241 scm_class->get_size = g_unix_credentials_message_get_size;
242 scm_class->get_level = g_unix_credentials_message_get_level;
243 scm_class->get_type = g_unix_credentials_message_get_msg_type;
244 scm_class->serialize = g_unix_credentials_message_serialize;
245 scm_class->deserialize = g_unix_credentials_message_deserialize;
248 * GUnixCredentialsMessage:credentials:
250 * The credentials stored in the message.
254 g_object_class_install_property (gobject_class,
256 g_param_spec_object ("credentials",
258 P_("The credentials stored in the message"),
262 G_PARAM_CONSTRUCT_ONLY |
263 G_PARAM_STATIC_NAME |
264 G_PARAM_STATIC_BLURB |
265 G_PARAM_STATIC_NICK));
269 /* ---------------------------------------------------------------------------------------------------- */
272 * g_unix_credentials_message_is_supported:
274 * Checks if passing a #GCredential on a #GSocket is supported on this platform.
276 * Returns: %TRUE if supported, %FALSE otherwise
281 g_unix_credentials_message_is_supported (void)
283 return G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED;
286 /* ---------------------------------------------------------------------------------------------------- */
289 * g_unix_credentials_message_new:
291 * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
293 * Returns: a new #GUnixCredentialsMessage
297 GSocketControlMessage *
298 g_unix_credentials_message_new (void)
300 g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
301 return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
306 * g_unix_credentials_message_new_with_credentials:
307 * @credentials: A #GCredentials object.
309 * Creates a new #GUnixCredentialsMessage holding @credentials.
311 * Returns: a new #GUnixCredentialsMessage
315 GSocketControlMessage *
316 g_unix_credentials_message_new_with_credentials (GCredentials *credentials)
318 g_return_val_if_fail (G_IS_CREDENTIALS (credentials), NULL);
319 g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
320 return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
321 "credentials", credentials,
326 * g_unix_credentials_message_get_credentials:
327 * @message: A #GUnixCredentialsMessage.
329 * Gets the credentials stored in @message.
331 * Returns: A #GCredentials instance. Do not free, it is owned by @message.
336 g_unix_credentials_message_get_credentials (GUnixCredentialsMessage *message)
338 g_return_val_if_fail (G_IS_UNIX_CREDENTIALS_MESSAGE (message), NULL);
339 return message->priv->credentials;