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