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 #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
  61 struct _GUnixCredentialsMessagePrivate
  62 {
  63   GCredentials *credentials;
  64 };
  65
  66 enum
  67 {
  68   PROP_0,
  69   PROP_CREDENTIALS
  70 };
  71
  72 G_DEFINE_TYPE (GUnixCredentialsMessage, g_unix_credentials_message, G_TYPE_SOCKET_CONTROL_MESSAGE);
  73
  74 static gsize
  75 g_unix_credentials_message_get_size (GSocketControlMessage *message)
  76 {
  77 #ifdef __linux__
  78   return sizeof (struct ucred);
  79 #else
  80   return 0;
  81 #endif
  82 }
  83
  84 static int
  85 g_unix_credentials_message_get_level (GSocketControlMessage *message)
  86 {
  87 #ifdef __linux__
  88   return SOL_SOCKET;
  89 #else
  90   return 0;
  91 #endif
  92 }
  93
  94 static int
  95 g_unix_credentials_message_get_msg_type (GSocketControlMessage *message)
  96 {
  97 #ifdef __linux__
  98   return SCM_CREDENTIALS;
  99 #else
 100   return 0;
 101 #endif
 102 }
 103
 104 static GSocketControlMessage *
 105 g_unix_credentials_message_deserialize (gint     level,
 106                                         gint     type,
 107                                         gsize    size,
 108                                         gpointer data)
 109 {
 110   GSocketControlMessage *message;
 111
 112   message = NULL;
 113
 114 #ifdef __linux__
 115   {
 116     GCredentials *credentials;
 117     struct ucred *ucred;
 118
 119     if (level != SOL_SOCKET || type != SCM_CREDENTIALS)
 120       goto out;
 121
 122     if (size != sizeof (struct ucred))
 123       {
 124         g_warning ("Expected a struct ucred (%" G_GSIZE_FORMAT " bytes) but "
 125                    "got %" G_GSIZE_FORMAT " bytes of data",
 126                    sizeof (struct ucred),
 127                    size);
 128         goto out;
 129       }
 130
 131     ucred = data;
 132
 133     credentials = g_credentials_new ();
 134     g_credentials_set_native (credentials, ucred);
 135     message = g_unix_credentials_message_new_with_credentials (credentials);
 136     g_object_unref (credentials);
 137  out:
 138     ;
 139   }
 140 #endif
 141
 142   return message;
 143 }
 144
 145 static void
 146 g_unix_credentials_message_serialize (GSocketControlMessage *_message,
 147                                       gpointer               data)
 148 {
 149   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (_message);
 150 #ifdef __linux__
 151   memcpy (data, g_credentials_get_native (message->priv->credentials), sizeof (struct ucred));
 152 #endif
 153 }
 154
 155 static void
 156 g_unix_credentials_message_finalize (GObject *object)
 157 {
 158   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 159
 160   if (message->priv->credentials != NULL)
 161     g_object_unref (message->priv->credentials);
 162
 163   G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->finalize (object);
 164 }
 165
 166 static void
 167 g_unix_credentials_message_init (GUnixCredentialsMessage *message)
 168 {
 169   message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message,
 170                                                G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 171                                                GUnixCredentialsMessagePrivate);
 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   g_type_class_add_private (class, sizeof (GUnixCredentialsMessagePrivate));
 233
 234   gobject_class = G_OBJECT_CLASS (class);
 235   gobject_class->get_property = g_unix_credentials_message_get_property;
 236   gobject_class->set_property = g_unix_credentials_message_set_property;
 237   gobject_class->finalize = g_unix_credentials_message_finalize;
 238   gobject_class->constructed = g_unix_credentials_message_constructed;
 239
 240   scm_class = G_SOCKET_CONTROL_MESSAGE_CLASS (class);
 241   scm_class->get_size = g_unix_credentials_message_get_size;
 242   scm_class->get_level = g_unix_credentials_message_get_level;
 243   scm_class->get_type = g_unix_credentials_message_get_msg_type;
 244   scm_class->serialize = g_unix_credentials_message_serialize;
 245   scm_class->deserialize = g_unix_credentials_message_deserialize;
 246
 247   /**
 248    * GUnixCredentialsMessage:credentials:
 249    *
 250    * The credentials stored in the message.
 251    *
 252    * Since: 2.26
 253    */
 254   g_object_class_install_property (gobject_class,
 255                                    PROP_CREDENTIALS,
 256                                    g_param_spec_object ("credentials",
 257                                                         P_("Credentials"),
 258                                                         P_("The credentials stored in the message"),
 259                                                         G_TYPE_CREDENTIALS,
 260                                                         G_PARAM_READABLE |
 261                                                         G_PARAM_WRITABLE |
 262                                                         G_PARAM_CONSTRUCT_ONLY |
 263                                                         G_PARAM_STATIC_NAME |
 264                                                         G_PARAM_STATIC_BLURB |
 265                                                         G_PARAM_STATIC_NICK));
 266
 267 }
 268
 269 /* ---------------------------------------------------------------------------------------------------- */
 270
 271 /**
 272  * g_unix_credentials_message_is_supported:
 273  *
 274  * Checks if passing a #GCredential on a #GSocket is supported on this platform.
 275  *
 276  * Returns: %TRUE if supported, %FALSE otherwise
 277  *
 278  * Since: 2.26
 279  */
 280 gboolean
 281 g_unix_credentials_message_is_supported (void)
 282 {
 283   return G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED;
 284 }
 285
 286 /* ---------------------------------------------------------------------------------------------------- */
 287
 288 /**
 289  * g_unix_credentials_message_new:
 290  *
 291  * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
 292  *
 293  * Returns: a new #GUnixCredentialsMessage
 294  *
 295  * Since: 2.26
 296  */
 297 GSocketControlMessage *
 298 g_unix_credentials_message_new (void)
 299 {
 300   g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
 301   return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 302                        NULL);
 303 }
 304
 305 /**
 306  * g_unix_credentials_message_new_with_credentials:
 307  * @credentials: A #GCredentials object.
 308  *
 309  * Creates a new #GUnixCredentialsMessage holding @credentials.
 310  *
 311  * Returns: a new #GUnixCredentialsMessage
 312  *
 313  * Since: 2.26
 314  */
 315 GSocketControlMessage *
 316 g_unix_credentials_message_new_with_credentials (GCredentials *credentials)
 317 {
 318   g_return_val_if_fail (G_IS_CREDENTIALS (credentials), NULL);
 319   g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
 320   return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 321                        "credentials", credentials,
 322                        NULL);
 323 }
 324
 325 /**
 326  * g_unix_credentials_message_get_credentials:
 327  * @message: A #GUnixCredentialsMessage.
 328  *
 329  * Gets the credentials stored in @message.
 330  *
 331  * Returns: A #GCredentials instance. Do not free, it is owned by @message.
 332  *
 333  * Since: 2.26
 334  */
 335 GCredentials *
 336 g_unix_credentials_message_get_credentials (GUnixCredentialsMessage *message)
 337 {
 338   g_return_val_if_fail (G_IS_UNIX_CREDENTIALS_MESSAGE (message), NULL);
 339   return message->priv->credentials;
 340 }