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