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 /* ---------------------------------------------------------------------------------------------------- */
45 #include "gunixcredentialsmessage.h"
46 #include "gcredentials.h"
47 #include "gcredentialsprivate.h"
48 #include "gnetworking.h"
52 struct _GUnixCredentialsMessagePrivate
54 GCredentials
*credentials
;
63 G_DEFINE_TYPE_WITH_PRIVATE (GUnixCredentialsMessage
, g_unix_credentials_message
, G_TYPE_SOCKET_CONTROL_MESSAGE
)
66 g_unix_credentials_message_get_size (GSocketControlMessage
*message
)
68 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
69 return G_CREDENTIALS_NATIVE_SIZE
;
76 g_unix_credentials_message_get_level (GSocketControlMessage
*message
)
78 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
86 g_unix_credentials_message_get_msg_type (GSocketControlMessage
*message
)
88 #if G_CREDENTIALS_USE_LINUX_UCRED
89 return SCM_CREDENTIALS
;
90 #elif G_CREDENTIALS_USE_FREEBSD_CMSGCRED
92 #elif G_CREDENTIALS_USE_SOLARIS_UCRED
94 #elif G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
95 #error "G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED is set but there is no msg_type defined for this platform"
101 static GSocketControlMessage
*
102 g_unix_credentials_message_deserialize (gint level
,
107 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
108 GSocketControlMessage
*message
;
109 GCredentials
*credentials
;
111 if (level
!= SOL_SOCKET
|| type
!= g_unix_credentials_message_get_msg_type (NULL
))
114 if (size
!= G_CREDENTIALS_NATIVE_SIZE
)
116 g_warning ("Expected a credentials struct of %" G_GSIZE_FORMAT
" bytes but "
117 "got %" G_GSIZE_FORMAT
" bytes of data",
118 G_CREDENTIALS_NATIVE_SIZE
, size
);
122 credentials
= g_credentials_new ();
123 g_credentials_set_native (credentials
, G_CREDENTIALS_NATIVE_TYPE
, data
);
125 if (g_credentials_get_unix_user (credentials
, NULL
) == (uid_t
) -1)
127 /* This happens on Linux if the remote side didn't pass the credentials */
128 g_object_unref (credentials
);
132 message
= g_unix_credentials_message_new_with_credentials (credentials
);
133 g_object_unref (credentials
);
137 #else /* !G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED */
144 g_unix_credentials_message_serialize (GSocketControlMessage
*_message
,
147 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
148 GUnixCredentialsMessage
*message
= G_UNIX_CREDENTIALS_MESSAGE (_message
);
151 g_credentials_get_native (message
->priv
->credentials
,
152 G_CREDENTIALS_NATIVE_TYPE
),
153 G_CREDENTIALS_NATIVE_SIZE
);
158 g_unix_credentials_message_finalize (GObject
*object
)
160 GUnixCredentialsMessage
*message
= G_UNIX_CREDENTIALS_MESSAGE (object
);
162 if (message
->priv
->credentials
!= NULL
)
163 g_object_unref (message
->priv
->credentials
);
165 G_OBJECT_CLASS (g_unix_credentials_message_parent_class
)->finalize (object
);
169 g_unix_credentials_message_init (GUnixCredentialsMessage
*message
)
171 message
->priv
= g_unix_credentials_message_get_instance_private (message
);
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 gobject_class
= G_OBJECT_CLASS (class);
233 gobject_class
->get_property
= g_unix_credentials_message_get_property
;
234 gobject_class
->set_property
= g_unix_credentials_message_set_property
;
235 gobject_class
->finalize
= g_unix_credentials_message_finalize
;
236 gobject_class
->constructed
= g_unix_credentials_message_constructed
;
238 scm_class
= G_SOCKET_CONTROL_MESSAGE_CLASS (class);
239 scm_class
->get_size
= g_unix_credentials_message_get_size
;
240 scm_class
->get_level
= g_unix_credentials_message_get_level
;
241 scm_class
->get_type
= g_unix_credentials_message_get_msg_type
;
242 scm_class
->serialize
= g_unix_credentials_message_serialize
;
243 scm_class
->deserialize
= g_unix_credentials_message_deserialize
;
246 * GUnixCredentialsMessage:credentials:
248 * The credentials stored in the message.
252 g_object_class_install_property (gobject_class
,
254 g_param_spec_object ("credentials",
256 P_("The credentials stored in the message"),
260 G_PARAM_CONSTRUCT_ONLY
|
261 G_PARAM_STATIC_NAME
|
262 G_PARAM_STATIC_BLURB
|
263 G_PARAM_STATIC_NICK
));
267 /* ---------------------------------------------------------------------------------------------------- */
270 * g_unix_credentials_message_is_supported:
272 * Checks if passing #GCredentials on a #GSocket is supported on this platform.
274 * Returns: %TRUE if supported, %FALSE otherwise
279 g_unix_credentials_message_is_supported (void)
281 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
288 /* ---------------------------------------------------------------------------------------------------- */
291 * g_unix_credentials_message_new:
293 * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
295 * Returns: a new #GUnixCredentialsMessage
299 GSocketControlMessage
*
300 g_unix_credentials_message_new (void)
302 g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL
);
303 return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE
,
308 * g_unix_credentials_message_new_with_credentials:
309 * @credentials: A #GCredentials object.
311 * Creates a new #GUnixCredentialsMessage holding @credentials.
313 * Returns: a new #GUnixCredentialsMessage
317 GSocketControlMessage
*
318 g_unix_credentials_message_new_with_credentials (GCredentials
*credentials
)
320 g_return_val_if_fail (G_IS_CREDENTIALS (credentials
), NULL
);
321 g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL
);
322 return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE
,
323 "credentials", credentials
,
328 * g_unix_credentials_message_get_credentials:
329 * @message: A #GUnixCredentialsMessage.
331 * Gets the credentials stored in @message.
333 * Returns: (transfer none): A #GCredentials instance. Do not free, it is owned by @message.
338 g_unix_credentials_message_get_credentials (GUnixCredentialsMessage
*message
)
340 g_return_val_if_fail (G_IS_UNIX_CREDENTIALS_MESSAGE (message
), NULL
);
341 return message
->priv
->credentials
;