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  * @see_also: #GUnixConnection, #GSocketControlMessage
  21  *
  22  * This #GSocketControlMessage contains a #GCredentials instance.  It
  23  * may be sent using g_socket_send_message() and received using
  24  * g_socket_receive_message() over UNIX sockets (ie: sockets in the
  25  * %G_SOCKET_ADDRESS_UNIX family).
  26  *
  27  * For an easier way to send and receive credentials over
  28  * stream-oriented UNIX sockets, see g_unix_connection_send_credentials() and
  29  * g_unix_connection_receive_credentials().
  30  **/
  31
  32 #include "config.h"
  33
  34 /* ---------------------------------------------------------------------------------------------------- */
  35 #ifdef __linux__
  36
  37 #define _GNU_SOURCE
  38 #define __USE_GNU
  39 #include <sys/types.h>
  40 #include <sys/socket.h>
  41 #include <sys/un.h>
  42 #include <unistd.h>
  43 #include <fcntl.h>
  44 #define G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED 1
  45
  46 #else
  47 /* TODO: please add support for your UNIX flavor */
  48 #define G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED 0
  49 #endif
  50
  51 /* ---------------------------------------------------------------------------------------------------- */
  52
  53 #include <string.h>
  54 #include <errno.h>
  55
  56 #include "gunixcredentialsmessage.h"
  57 #include "gcredentials.h"
  58
  59 #include "glibintl.h"
  60 #include "gioalias.h"
  61
  62 struct _GUnixCredentialsMessagePrivate
  63 {
  64   GCredentials *credentials;
  65 };
  66
  67 enum
  68 {
  69   PROP_0,
  70   PROP_CREDENTIALS
  71 };
  72
  73 G_DEFINE_TYPE (GUnixCredentialsMessage, g_unix_credentials_message, G_TYPE_SOCKET_CONTROL_MESSAGE);
  74
  75 static gsize
  76 g_unix_credentials_message_get_size (GSocketControlMessage *message)
  77 {
  78 #ifdef __linux__
  79   return sizeof (struct ucred);
  80 #else
  81   return 0;
  82 #endif
  83 }
  84
  85 static int
  86 g_unix_credentials_message_get_level (GSocketControlMessage *message)
  87 {
  88   return SOL_SOCKET;
  89 }
  90
  91 static int
  92 g_unix_credentials_message_get_msg_type (GSocketControlMessage *message)
  93 {
  94 #ifdef __linux__
  95   return SCM_CREDENTIALS;
  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   GSocketControlMessage *message;
 108
 109   message = NULL;
 110
 111 #ifdef __linux__
 112   {
 113     GCredentials *credentials;
 114     struct ucred *ucred;
 115
 116     if (level != SOL_SOCKET || type != SCM_CREDENTIALS)
 117       goto out;
 118
 119     if (size != sizeof (struct ucred))
 120       {
 121         g_warning ("Expected a struct ucred (%" G_GSIZE_FORMAT " bytes) but "
 122                    "got %" G_GSIZE_FORMAT " bytes of data",
 123                    sizeof (struct ucred),
 124                    size);
 125         goto out;
 126       }
 127
 128     ucred = data;
 129
 130     credentials = g_credentials_new ();
 131     g_credentials_set_unix_user (credentials, ucred->uid);
 132     g_credentials_set_unix_group (credentials, ucred->gid);
 133     g_credentials_set_unix_process (credentials, ucred->pid);
 134     message = g_unix_credentials_message_new_with_credentials (credentials);
 135     g_object_unref (credentials);
 136  out:
 137     ;
 138   }
 139 #endif
 140
 141   return message;
 142 }
 143
 144 static void
 145 g_unix_credentials_message_serialize (GSocketControlMessage *_message,
 146                                       gpointer               data)
 147 {
 148   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (_message);
 149 #ifdef __linux__
 150   {
 151     struct ucred *ucred = data;
 152     ucred->uid = g_credentials_get_unix_user (message->priv->credentials);
 153     ucred->gid = g_credentials_get_unix_group (message->priv->credentials);
 154     ucred->pid = g_credentials_get_unix_process (message->priv->credentials);
 155   }
 156 #endif
 157 }
 158
 159 static void
 160 g_unix_credentials_message_finalize (GObject *object)
 161 {
 162   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 163
 164   if (message->priv->credentials != NULL)
 165     g_object_unref (message->priv->credentials);
 166
 167   if (G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->finalize != NULL)
 168     G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->finalize (object);
 169 }
 170
 171 static void
 172 g_unix_credentials_message_init (GUnixCredentialsMessage *message)
 173 {
 174   message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message,
 175                                                G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 176                                                GUnixCredentialsMessagePrivate);
 177 }
 178
 179 static void
 180 g_unix_credentials_message_get_property (GObject    *object,
 181                                          guint       prop_id,
 182                                          GValue     *value,
 183                                          GParamSpec *pspec)
 184 {
 185   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 186
 187   switch (prop_id)
 188     {
 189     case PROP_CREDENTIALS:
 190       g_value_set_object (value, message->priv->credentials);
 191       break;
 192
 193     default:
 194       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 195       break;
 196     }
 197 }
 198
 199 static void
 200 g_unix_credentials_message_set_property (GObject      *object,
 201                                          guint         prop_id,
 202                                          const GValue *value,
 203                                          GParamSpec   *pspec)
 204 {
 205   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 206
 207   switch (prop_id)
 208     {
 209     case PROP_CREDENTIALS:
 210       message->priv->credentials = g_value_dup_object (value);
 211       break;
 212
 213     default:
 214       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 215       break;
 216     }
 217 }
 218
 219 static void
 220 g_unix_credentials_message_constructed (GObject *object)
 221 {
 222   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 223
 224   if (message->priv->credentials == NULL)
 225     message->priv->credentials = g_credentials_new_for_process ();
 226
 227   if (G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->constructed != NULL)
 228     G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->constructed (object);
 229 }
 230
 231 static void
 232 g_unix_credentials_message_class_init (GUnixCredentialsMessageClass *class)
 233 {
 234   GSocketControlMessageClass *scm_class;
 235   GObjectClass *gobject_class;
 236
 237   g_type_class_add_private (class, sizeof (GUnixCredentialsMessagePrivate));
 238
 239   gobject_class = G_OBJECT_CLASS (class);
 240   gobject_class->get_property = g_unix_credentials_message_get_property;
 241   gobject_class->set_property = g_unix_credentials_message_set_property;
 242   gobject_class->finalize = g_unix_credentials_message_finalize;
 243   gobject_class->constructed = g_unix_credentials_message_constructed;
 244
 245   scm_class = G_SOCKET_CONTROL_MESSAGE_CLASS (class);
 246   scm_class->get_size = g_unix_credentials_message_get_size;
 247   scm_class->get_level = g_unix_credentials_message_get_level;
 248   scm_class->get_type = g_unix_credentials_message_get_msg_type;
 249   scm_class->serialize = g_unix_credentials_message_serialize;
 250   scm_class->deserialize = g_unix_credentials_message_deserialize;
 251
 252   /**
 253    * GUnixCredentialsMessage:credentials:
 254    *
 255    * The credentials stored in the message.
 256    *
 257    * Since: 2.26
 258    */
 259   g_object_class_install_property (gobject_class,
 260                                    PROP_CREDENTIALS,
 261                                    g_param_spec_object ("credentials",
 262                                                         _("Credentials"),
 263                                                         _("The credentials stored in the message"),
 264                                                         G_TYPE_CREDENTIALS,
 265                                                         G_PARAM_READABLE |
 266                                                         G_PARAM_WRITABLE |
 267                                                         G_PARAM_CONSTRUCT_ONLY |
 268                                                         G_PARAM_STATIC_NAME |
 269                                                         G_PARAM_STATIC_BLURB |
 270                                                         G_PARAM_STATIC_NICK));
 271
 272 }
 273
 274 /* ---------------------------------------------------------------------------------------------------- */
 275
 276 /**
 277  * g_unix_credentials_message_is_supported:
 278  *
 279  * Checks if passing a #GCredential on a #GSocket is supported on this platform.
 280  *
 281  * Returns: %TRUE if supported, %FALSE otherwise
 282  *
 283  * Since: 2.26
 284  */
 285 gboolean
 286 g_unix_credentials_message_is_supported (void)
 287 {
 288   return G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED;
 289 }
 290
 291 /* ---------------------------------------------------------------------------------------------------- */
 292
 293 /**
 294  * g_unix_credentials_message_new:
 295  *
 296  * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
 297  *
 298  * Returns: a new #GUnixCredentialsMessage
 299  *
 300  * Since: 2.26
 301  */
 302 GSocketControlMessage *
 303 g_unix_credentials_message_new (void)
 304 {
 305   g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
 306   return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 307                        NULL);
 308 }
 309
 310 /**
 311  * g_unix_credentials_message_new:
 312  * @credentials: A #GCredentials object.
 313  *
 314  * Creates a new #GUnixCredentialsMessage holding @credentials.
 315  *
 316  * Returns: a new #GUnixCredentialsMessage
 317  *
 318  * Since: 2.26
 319  */
 320 GSocketControlMessage *
 321 g_unix_credentials_message_new_with_credentials (GCredentials *credentials)
 322 {
 323   g_return_val_if_fail (G_IS_CREDENTIALS (credentials), NULL);
 324   g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
 325   return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 326                        "credentials", credentials,
 327                        NULL);
 328 }
 329
 330 /**
 331  * g_unix_credentials_message_get_credentials:
 332  * @message: A #GUnixCredentialsMessage.
 333  *
 334  * Gets the credentials stored in @message.
 335  *
 336  * Returns: A #GCredentials instance. Do not free, it is owned by @message.
 337  *
 338  * Since: 2.26
 339  */
 340 GCredentials *
 341 g_unix_credentials_message_get_credentials (GUnixCredentialsMessage *message)
 342 {
 343   g_return_val_if_fail (G_IS_UNIX_CREDENTIALS_MESSAGE (message), NULL);
 344   return message->priv->credentials;
 345 }
 346
 347
 348 #define __G_UNIX_CREDENTIALS_MESSAGE_C__
 349 #include "gioaliasdef.c"