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_native (credentials, ucred);
 132     message = g_unix_credentials_message_new_with_credentials (credentials);
 133     g_object_unref (credentials);
 134  out:
 135     ;
 136   }
 137 #endif
 138
 139   return message;
 140 }
 141
 142 static void
 143 g_unix_credentials_message_serialize (GSocketControlMessage *_message,
 144                                       gpointer               data)
 145 {
 146   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (_message);
 147 #ifdef __linux__
 148   memcpy (data, g_credentials_get_native (message->priv->credentials), sizeof (struct ucred));
 149 #endif
 150 }
 151
 152 static void
 153 g_unix_credentials_message_finalize (GObject *object)
 154 {
 155   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 156
 157   if (message->priv->credentials != NULL)
 158     g_object_unref (message->priv->credentials);
 159
 160   G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->finalize (object);
 161 }
 162
 163 static void
 164 g_unix_credentials_message_init (GUnixCredentialsMessage *message)
 165 {
 166   message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message,
 167                                                G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 168                                                GUnixCredentialsMessagePrivate);
 169 }
 170
 171 static void
 172 g_unix_credentials_message_get_property (GObject    *object,
 173                                          guint       prop_id,
 174                                          GValue     *value,
 175                                          GParamSpec *pspec)
 176 {
 177   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 178
 179   switch (prop_id)
 180     {
 181     case PROP_CREDENTIALS:
 182       g_value_set_object (value, message->priv->credentials);
 183       break;
 184
 185     default:
 186       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 187       break;
 188     }
 189 }
 190
 191 static void
 192 g_unix_credentials_message_set_property (GObject      *object,
 193                                          guint         prop_id,
 194                                          const GValue *value,
 195                                          GParamSpec   *pspec)
 196 {
 197   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 198
 199   switch (prop_id)
 200     {
 201     case PROP_CREDENTIALS:
 202       message->priv->credentials = g_value_dup_object (value);
 203       break;
 204
 205     default:
 206       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 207       break;
 208     }
 209 }
 210
 211 static void
 212 g_unix_credentials_message_constructed (GObject *object)
 213 {
 214   GUnixCredentialsMessage *message = G_UNIX_CREDENTIALS_MESSAGE (object);
 215
 216   if (message->priv->credentials == NULL)
 217     message->priv->credentials = g_credentials_new ();
 218
 219   if (G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->constructed != NULL)
 220     G_OBJECT_CLASS (g_unix_credentials_message_parent_class)->constructed (object);
 221 }
 222
 223 static void
 224 g_unix_credentials_message_class_init (GUnixCredentialsMessageClass *class)
 225 {
 226   GSocketControlMessageClass *scm_class;
 227   GObjectClass *gobject_class;
 228
 229   g_type_class_add_private (class, sizeof (GUnixCredentialsMessagePrivate));
 230
 231   gobject_class = G_OBJECT_CLASS (class);
 232   gobject_class->get_property = g_unix_credentials_message_get_property;
 233   gobject_class->set_property = g_unix_credentials_message_set_property;
 234   gobject_class->finalize = g_unix_credentials_message_finalize;
 235   gobject_class->constructed = g_unix_credentials_message_constructed;
 236
 237   scm_class = G_SOCKET_CONTROL_MESSAGE_CLASS (class);
 238   scm_class->get_size = g_unix_credentials_message_get_size;
 239   scm_class->get_level = g_unix_credentials_message_get_level;
 240   scm_class->get_type = g_unix_credentials_message_get_msg_type;
 241   scm_class->serialize = g_unix_credentials_message_serialize;
 242   scm_class->deserialize = g_unix_credentials_message_deserialize;
 243
 244   /**
 245    * GUnixCredentialsMessage:credentials:
 246    *
 247    * The credentials stored in the message.
 248    *
 249    * Since: 2.26
 250    */
 251   g_object_class_install_property (gobject_class,
 252                                    PROP_CREDENTIALS,
 253                                    g_param_spec_object ("credentials",
 254                                                         P_("Credentials"),
 255                                                         P_("The credentials stored in the message"),
 256                                                         G_TYPE_CREDENTIALS,
 257                                                         G_PARAM_READABLE |
 258                                                         G_PARAM_WRITABLE |
 259                                                         G_PARAM_CONSTRUCT_ONLY |
 260                                                         G_PARAM_STATIC_NAME |
 261                                                         G_PARAM_STATIC_BLURB |
 262                                                         G_PARAM_STATIC_NICK));
 263
 264 }
 265
 266 /* ---------------------------------------------------------------------------------------------------- */
 267
 268 /**
 269  * g_unix_credentials_message_is_supported:
 270  *
 271  * Checks if passing a #GCredential on a #GSocket is supported on this platform.
 272  *
 273  * Returns: %TRUE if supported, %FALSE otherwise
 274  *
 275  * Since: 2.26
 276  */
 277 gboolean
 278 g_unix_credentials_message_is_supported (void)
 279 {
 280   return G_UNIX_CREDENTIALS_MESSAGE_SUPPORTED;
 281 }
 282
 283 /* ---------------------------------------------------------------------------------------------------- */
 284
 285 /**
 286  * g_unix_credentials_message_new:
 287  *
 288  * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
 289  *
 290  * Returns: a new #GUnixCredentialsMessage
 291  *
 292  * Since: 2.26
 293  */
 294 GSocketControlMessage *
 295 g_unix_credentials_message_new (void)
 296 {
 297   g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
 298   return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 299                        NULL);
 300 }
 301
 302 /**
 303  * g_unix_credentials_message_new_with_credentials:
 304  * @credentials: A #GCredentials object.
 305  *
 306  * Creates a new #GUnixCredentialsMessage holding @credentials.
 307  *
 308  * Returns: a new #GUnixCredentialsMessage
 309  *
 310  * Since: 2.26
 311  */
 312 GSocketControlMessage *
 313 g_unix_credentials_message_new_with_credentials (GCredentials *credentials)
 314 {
 315   g_return_val_if_fail (G_IS_CREDENTIALS (credentials), NULL);
 316   g_return_val_if_fail (g_unix_credentials_message_is_supported (), NULL);
 317   return g_object_new (G_TYPE_UNIX_CREDENTIALS_MESSAGE,
 318                        "credentials", credentials,
 319                        NULL);
 320 }
 321
 322 /**
 323  * g_unix_credentials_message_get_credentials:
 324  * @message: A #GUnixCredentialsMessage.
 325  *
 326  * Gets the credentials stored in @message.
 327  *
 328  * Returns: A #GCredentials instance. Do not free, it is owned by @message.
 329  *
 330  * Since: 2.26
 331  */
 332 GCredentials *
 333 g_unix_credentials_message_get_credentials (GUnixCredentialsMessage *message)
 334 {
 335   g_return_val_if_fail (G_IS_UNIX_CREDENTIALS_MESSAGE (message), NULL);
 336   return message->priv->credentials;
 337 }
 338
 339
 340 #define __G_UNIX_CREDENTIALS_MESSAGE_C__
 341 #include "gioaliasdef.c"