gio/gunixcredentialsmessage.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2010 Red Hat, Inc.
   4  * Copyright (C) 2009 Codethink Limited
   5  *
   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.
  10  *
  11  * See the included COPYING file for more information.
  12  *
  13  * Authors: David Zeuthen <davidz@redhat.com>
  14  */
  15
  16 /**
  17  * SECTION:gunixcredentialsmessage
  18  * @title: GUnixCredentialsMessage
  19  * @short_description: A GSocketControlMessage containing credentials
  20  * @include: gio/gunixcredentialsmessage.h
  21  * @see_also: #GUnixConnection, #GSocketControlMessage
  22  *
  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).
  27  *
  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().
  34  */
  35
  36 #include "config.h"
  37
  38 /* ---------------------------------------------------------------------------------------------------- */
  39
  40 #include <fcntl.h>
  41 #include <errno.h>
  42 #include <string.h>
  43 #include <unistd.h>
  44
  45 #include "gunixcredentialsmessage.h"
  46 #include "gcredentials.h"
  47 #include "gcredentialsprivate.h"
  48 #include "gnetworking.h"
  49
  50 #include "glibintl.h"
  51
  52 struct _GUnixCredentialsMessagePrivate
  53 {
  54   GCredentials *credentials;
  55 };
  56
  57 enum
  58 {
  59   PROP_0,
  60   PROP_CREDENTIALS
  61 };
  62
  63 G_DEFINE_TYPE_WITH_PRIVATE (GUnixCredentialsMessage, g_unix_credentials_message, G_TYPE_SOCKET_CONTROL_MESSAGE)
  64
  65 static gsize
  66 g_unix_credentials_message_get_size (GSocketControlMessage *message)
  67 {
  68 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
  69   return G_CREDENTIALS_NATIVE_SIZE;
  70 #else
  71   return 0;
  72 #endif
  73 }
  74
  75 static int
  76 g_unix_credentials_message_get_level (GSocketControlMessage *message)
  77 {
  78 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
  79   return SOL_SOCKET;
  80 #else
  81   return 0;
  82 #endif
  83 }
  84
  85 static int
  86 g_unix_credentials_message_get_msg_type (GSocketControlMessage *message)
  87 {
  88 #if G_CREDENTIALS_USE_LINUX_UCRED
  89   return SCM_CREDENTIALS;
  90 #elif G_CREDENTIALS_USE_FREEBSD_CMSGCRED
  91   return SCM_CREDS;
  92 #elif G_CREDENTIALS_USE_SOLARIS_UCRED
  93   return SCM_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"
  96 #else
  97   return 0;
  98 #endif
  99 }
 100
 101 static GSocketControlMessage *
 102 g_unix_credentials_message_deserialize (gint     level,
 103                                         gint     type,
 104                                         gsize    size,
 105                                         gpointer data)
 106 {
 107 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
 108   GSocketControlMessage *message;
 109   GCredentials *credentials;
 110
 111   if (level != SOL_SOCKET || type != g_unix_credentials_message_get_msg_type (NULL))
 112     return NULL;
 113
 114   if (size != G_CREDENTIALS_NATIVE_SIZE)
 115     {
 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);
 119       return NULL;
 120     }
 121
 122   credentials = g_credentials_new ();
 123   g_credentials_set_native (credentials, G_CREDENTIALS_NATIVE_TYPE, data);
 124
 125   if (g_credentials_get_unix_user (credentials, NULL) == (uid_t) -1)
 126     {
 127       /* This happens on Linux if the remote side didn't pass the credentials */
 128       g_object_unref (credentials);
 129       return NULL;
 130     }
 131
 132   message = g_unix_credentials_message_new_with_credentials (credentials);
 133   g_object_unref (credentials);
 134
 135   return message;
 136
 137 #else /* !G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED */
 138
 139   return NULL;
 140 #endif
 141 }
 142
 143 static void
 144 g_unix_credentials_message_serialize (GSocketControlMessage *_message,
 145                                       gpointer               data)
 146 {
 147 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
 148   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (_message);
 149
 150   memcpy (data,
 151           g_credentials_get_native (message->priv->credentials,
 152                                     G_CREDENTIALS_NATIVE_TYPE),
 153           G_CREDENTIALS_NATIVE_SIZE);
 154 #endif
 155 }
 156
 157 static void
 158 g_unix_credentials_message_finalize (GObject *object)
 159 {
 160   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 161
 162   if (message->priv->credentials != NULL)
 163     g_object_unref (message->priv->credentials);
 164
 165   G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->finalize (object);
 166 }
 167
 168 static void
 169 g_unix_credentials_message_init (GUnixCredentialsMessage *message)
 170 {
 171   message->priv = g_unix_credentials_message_get_instance_private (message);
 172 }
 173
 174 static void
 175 g_unix_credentials_message_get_property (GObject    *object,
 176                                          guint       prop_id,
 177                                          GValue     *value,
 178                                          GParamSpec *pspec)
 179 {
 180   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 181
 182   switch (prop_id)
 183     {
 184     case PROP_CREDENTIALS:
 185       g_value_set_object (value, message->priv->credentials);
 186       break;
 187
 188     default:
 189       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 190       break;
 191     }
 192 }
 193
 194 static void
 195 g_unix_credentials_message_set_property (GObject      *object,
 196                                          guint         prop_id,
 197                                          const GValue *value,
 198                                          GParamSpec   *pspec)
 199 {
 200   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 201
 202   switch (prop_id)
 203     {
 204     case PROP_CREDENTIALS:
 205       message->priv->credentials = g_value_dup_object (value);
 206       break;
 207
 208     default:
 209       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 210       break;
 211     }
 212 }
 213
 214 static void
 215 g_unix_credentials_message_constructed (GObject *object)
 216 {
 217   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 218
 219   if (message->priv->credentials == NULL)
 220     message->priv->credentials = g_credentials_new ();
 221
 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);
 224 }
 225
 226 static void
 227 g_unix_credentials_message_class_init (GUnixCredentialsMessageClass *class)
 228 {
 229   GSocketControlMessageClass *scm_class;
 230   GObjectClass *gobject_class;
 231
 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;
 237
 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;
 244
 245   /**
 246    * GUnixCredentialsMessage:credentials:
 247    *
 248    * The credentials stored in the message.
 249    *
 250    * Since: 2.26
 251    */
 252   g_object_class_install_property (gobject_class,
 253                                    PROP_CREDENTIALS,
 254                                    g_param_spec_object ("credentials",
 255                                                         P_("Credentials"),
 256                                                         P_("The credentials stored in the message"),
 257                                                         G_TYPE_CREDENTIALS,
 258                                                         G_PARAM_READABLE |
 259                                                         G_PARAM_WRITABLE |
 260                                                         G_PARAM_CONSTRUCT_ONLY |
 261                                                         G_PARAM_STATIC_NAME |
 262                                                         G_PARAM_STATIC_BLURB |
 263                                                         G_PARAM_STATIC_NICK));
 264
 265 }
 266
 267 /* ---------------------------------------------------------------------------------------------------- */
 268
 269 /**
 270  * g_unix_credentials_message_is_supported:
 271  *
 272  * Checks if passing #GCredentials on a #GSocket is supported on this platform.
 273  *
 274  * Returns: %TRUE if supported, %FALSE otherwise
 275  *
 276  * Since: 2.26
 277  */
 278 gboolean
 279 g_unix_credentials_message_is_supported (void)
 280 {
 281 #if G_CREDENTIALS_UNIX_CREDENTIALS_MESSAGE_SUPPORTED
 282   return TRUE;
 283 #else
 284   return FALSE;
 285 #endif
 286 }
 287
 288 /* ---------------------------------------------------------------------------------------------------- */
 289
 290 /**
 291  * g_unix_credentials_message_new:
 292  *
 293  * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
 294  *
 295  * Returns: a new #GUnixCredentialsMessage
 296  *
 297  * Since: 2.26
 298  */
 299 GSocketControlMessage *
 300 g_unix_credentials_message_new (void)
 301 {
 302   g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
 303   return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 304                        NULL);
 305 }
 306
 307 /**
 308  * g_unix_credentials_message_new_with_credentials:
 309  * @credentials: A #GCredentials object.
 310  *
 311  * Creates a new #GUnixCredentialsMessage holding @credentials.
 312  *
 313  * Returns: a new #GUnixCredentialsMessage
 314  *
 315  * Since: 2.26
 316  */
 317 GSocketControlMessage *
 318 g_unix_credentials_message_new_with_credentials (GCredentials *credentials)
 319 {
 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,
 324                        NULL);
 325 }
 326
 327 /**
 328  * g_unix_credentials_message_get_credentials:
 329  * @message: A #GUnixCredentialsMessage.
 330  *
 331  * Gets the credentials stored in @message.
 332  *
 333  * Returns: (transfer none): A #GCredentials instance. Do not free, it is owned by @message.
 334  *
 335  * Since: 2.26
 336  */
 337 GCredentials *
 338 g_unix_credentials_message_get_credentials (GUnixCredentialsMessage *message)
 339 {
 340   g_return_val_if_fail (G_IS_UNIX_CREDENTIALS_MESSAGE (message), NULL);
 341   return message->priv->credentials;
 342 }