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