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