gcredentials.c 18.1 KB
Newer Older
1 2
/* GDBus - GLib D-Bus Library
 *
3
 * Copyright (C) 2008-2010 Red Hat, Inc.
4 5 6 7
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
8
 * version 2.1 of the License, or (at your option) any later version.
9 10 11 12 13 14 15
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
16
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 18 19 20 21 22 23
 *
 * Author: David Zeuthen <davidz@redhat.com>
 */

#include "config.h"

#include <stdlib.h>
Dan Winship's avatar
Dan Winship committed
24
#include <string.h>
25

Matthias Clasen's avatar
Matthias Clasen committed
26 27 28
#include <gobject/gvaluecollector.h>

#include "gcredentials.h"
29
#include "gcredentialsprivate.h"
Dan Winship's avatar
Dan Winship committed
30
#include "gnetworking.h"
Matthias Clasen's avatar
Matthias Clasen committed
31
#include "gioerror.h"
32
#include "gioenumtypes.h"
Matthias Clasen's avatar
Matthias Clasen committed
33

David Zeuthen's avatar
David Zeuthen committed
34 35
#include "glibintl.h"

36 37
/**
 * SECTION:gcredentials
David Zeuthen's avatar
David Zeuthen committed
38 39
 * @short_description: An object containing credentials
 * @include: gio/gio.h
40
 *
41 42 43
 * The #GCredentials type is a reference-counted wrapper for native
 * credentials. This information is typically used for identifying,
 * authenticating and authorizing other processes.
44 45 46 47
 *
 * Some operating systems supports looking up the credentials of the
 * remote peer of a communication endpoint - see e.g.
 * g_socket_get_credentials().
48
 *
49 50
 * Some operating systems supports securely sending and receiving
 * credentials over a Unix Domain Socket, see
51 52
 * #GUnixCredentialsMessage, g_unix_connection_send_credentials() and
 * g_unix_connection_receive_credentials() for details.
53
 *
54 55
 * On Linux, the native credential type is a struct ucred - see the
 * unix(7) man page for details. This corresponds to
56
 * %G_CREDENTIALS_TYPE_LINUX_UCRED.
57
 *
58
 * On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native
59
 * credential type is a struct cmsgcred. This corresponds
60
 * to %G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED.
61
 *
62 63 64
 * On NetBSD, the native credential type is a struct unpcbid.
 * This corresponds to %G_CREDENTIALS_TYPE_NETBSD_UNPCBID.
 *
65
 * On OpenBSD, the native credential type is a struct sockpeercred.
66
 * This corresponds to %G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED.
67 68
 *
 * On Solaris (including OpenSolaris and its derivatives), the native
69
 * credential type is a ucred_t. This corresponds to
70
 * %G_CREDENTIALS_TYPE_SOLARIS_UCRED.
71 72
 */

73 74 75 76 77 78 79 80 81
/**
 * GCredentials:
 *
 * The #GCredentials structure contains only private data and
 * should only be accessed using the provided API.
 *
 * Since: 2.26
 */
struct _GCredentials
82
{
83 84 85
  /*< private >*/
  GObject parent_instance;

86
#if G_CREDENTIALS_USE_LINUX_UCRED
87
  struct ucred native;
88
#elif G_CREDENTIALS_USE_FREEBSD_CMSGCRED
89
  struct cmsgcred native;
90 91
#elif G_CREDENTIALS_USE_NETBSD_UNPCBID
  struct unpcbid native;
92
#elif G_CREDENTIALS_USE_OPENBSD_SOCKPEERCRED
93
  struct sockpeercred native;
94 95
#elif G_CREDENTIALS_USE_SOLARIS_UCRED
  ucred_t *native;
96
#else
97
  #ifdef __GNUC__
98 99
  #pragma GCC diagnostic push
  #pragma GCC diagnostic warning "-Wcpp"
100
  #warning Please add GCredentials support for your OS
101
  #pragma GCC diagnostic pop
102
  #endif
103
#endif
104 105
};

106 107 108 109 110 111 112 113 114 115 116 117 118
/**
 * GCredentialsClass:
 *
 * Class structure for #GCredentials.
 *
 * Since: 2.26
 */
struct _GCredentialsClass
{
  /*< private >*/
  GObjectClass parent_class;
};

119
G_DEFINE_TYPE (GCredentials, g_credentials, G_TYPE_OBJECT)
120 121 122 123

static void
g_credentials_finalize (GObject *object)
{
124 125 126 127 128
#if G_CREDENTIALS_USE_SOLARIS_UCRED
  GCredentials *credentials = G_CREDENTIALS (object);

  ucred_free (credentials->native);
#endif
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146

  if (G_OBJECT_CLASS (g_credentials_parent_class)->finalize != NULL)
    G_OBJECT_CLASS (g_credentials_parent_class)->finalize (object);
}


static void
g_credentials_class_init (GCredentialsClass *klass)
{
  GObjectClass *gobject_class;

  gobject_class = G_OBJECT_CLASS (klass);
  gobject_class->finalize = g_credentials_finalize;
}

static void
g_credentials_init (GCredentials *credentials)
{
147
#if G_CREDENTIALS_USE_LINUX_UCRED
148
  credentials->native.pid = getpid ();
149 150
  credentials->native.uid = geteuid ();
  credentials->native.gid = getegid ();
151
#elif G_CREDENTIALS_USE_FREEBSD_CMSGCRED
152 153 154 155
  memset (&credentials->native, 0, sizeof (struct cmsgcred));
  credentials->native.cmcred_pid  = getpid ();
  credentials->native.cmcred_euid = geteuid ();
  credentials->native.cmcred_gid  = getegid ();
156 157 158 159
#elif G_CREDENTIALS_USE_NETBSD_UNPCBID
  credentials->native.unp_pid = getpid ();
  credentials->native.unp_euid = geteuid ();
  credentials->native.unp_egid = getegid ();
160
#elif G_CREDENTIALS_USE_OPENBSD_SOCKPEERCRED
161 162 163
  credentials->native.pid = getpid ();
  credentials->native.uid = geteuid ();
  credentials->native.gid = getegid ();
164 165
#elif G_CREDENTIALS_USE_SOLARIS_UCRED
  credentials->native = ucred_get (P_MYID);
166
#endif
167 168 169 170 171 172 173
}

/* ---------------------------------------------------------------------------------------------------- */

/**
 * g_credentials_new:
 *
174 175
 * Creates a new #GCredentials object with credentials matching the
 * the current process.
176 177
 *
 * Returns: A #GCredentials. Free with g_object_unref().
178 179
 *
 * Since: 2.26
180 181 182 183 184 185 186 187 188 189 190 191 192
 */
GCredentials *
g_credentials_new (void)
{
  return g_object_new (G_TYPE_CREDENTIALS, NULL);
}

/* ---------------------------------------------------------------------------------------------------- */

/**
 * g_credentials_to_string:
 * @credentials: A #GCredentials object.
 *
193 194 195
 * Creates a human-readable textual representation of @credentials
 * that can be used in logging and debug messages. The format of the
 * returned string may change in future GLib release.
196 197
 *
 * Returns: A string that should be freed with g_free().
198 199
 *
 * Since: 2.26
200 201 202 203 204 205 206 207 208
 */
gchar *
g_credentials_to_string (GCredentials *credentials)
{
  GString *ret;

  g_return_val_if_fail (G_IS_CREDENTIALS (credentials), NULL);

  ret = g_string_new ("GCredentials:");
209
#if G_CREDENTIALS_USE_LINUX_UCRED
210 211 212 213 214 215 216
  g_string_append (ret, "linux-ucred:");
  if (credentials->native.pid != -1)
    g_string_append_printf (ret, "pid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.pid);
  if (credentials->native.uid != -1)
    g_string_append_printf (ret, "uid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.uid);
  if (credentials->native.gid != -1)
    g_string_append_printf (ret, "gid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.gid);
217 218
  if (ret->str[ret->len - 1] == ',')
    ret->str[ret->len - 1] = '\0';
219
#elif G_CREDENTIALS_USE_FREEBSD_CMSGCRED
220 221 222 223 224 225 226
  g_string_append (ret, "freebsd-cmsgcred:");
  if (credentials->native.cmcred_pid != -1)
    g_string_append_printf (ret, "pid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.cmcred_pid);
  if (credentials->native.cmcred_euid != -1)
    g_string_append_printf (ret, "uid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.cmcred_euid);
  if (credentials->native.cmcred_gid != -1)
    g_string_append_printf (ret, "gid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.cmcred_gid);
227 228 229 230 231 232 233 234 235
#elif G_CREDENTIALS_USE_NETBSD_UNPCBID
  g_string_append (ret, "netbsd-unpcbid:");
  if (credentials->native.unp_pid != -1)
    g_string_append_printf (ret, "pid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.unp_pid);
  if (credentials->native.unp_euid != -1)
    g_string_append_printf (ret, "uid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.unp_euid);
  if (credentials->native.unp_egid != -1)
    g_string_append_printf (ret, "gid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.unp_egid);
  ret->str[ret->len - 1] = '\0';
236
#elif G_CREDENTIALS_USE_OPENBSD_SOCKPEERCRED
237 238 239 240 241 242 243 244 245
  g_string_append (ret, "openbsd-sockpeercred:");
  if (credentials->native.pid != -1)
    g_string_append_printf (ret, "pid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.pid);
  if (credentials->native.uid != -1)
    g_string_append_printf (ret, "uid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.uid);
  if (credentials->native.gid != -1)
    g_string_append_printf (ret, "gid=%" G_GINT64_FORMAT ",", (gint64) credentials->native.gid);
  if (ret->str[ret->len - 1] == ',')
    ret->str[ret->len - 1] = '\0';
246 247 248 249 250 251 252 253 254 255 256 257 258
#elif G_CREDENTIALS_USE_SOLARIS_UCRED
  g_string_append (ret, "solaris-ucred:");
  {
    id_t id;
    if ((id = ucred_getpid (credentials->native)) != -1)
      g_string_append_printf (ret, "pid=%" G_GINT64_FORMAT ",", (gint64) id);
    if ((id = ucred_geteuid (credentials->native)) != -1)
      g_string_append_printf (ret, "uid=%" G_GINT64_FORMAT ",", (gint64) id);
    if ((id = ucred_getegid (credentials->native)) != -1)
      g_string_append_printf (ret, "gid=%" G_GINT64_FORMAT ",", (gint64) id);
    if (ret->str[ret->len - 1] == ',')
      ret->str[ret->len - 1] = '\0';
  }
259 260 261
#else
  g_string_append (ret, "unknown");
#endif
262 263 264 265 266 267 268

  return g_string_free (ret, FALSE);
}

/* ---------------------------------------------------------------------------------------------------- */

/**
269
 * g_credentials_is_same_user:
270
 * @credentials: A #GCredentials.
271 272
 * @other_credentials: A #GCredentials.
 * @error: Return location for error or %NULL.
273
 *
274
 * Checks if @credentials and @other_credentials is the same user.
275
 *
276 277 278 279 280
 * This operation can fail if #GCredentials is not supported on the
 * the OS.
 *
 * Returns: %TRUE if @credentials and @other_credentials has the same
 * user, %FALSE otherwise or if @error is set.
281 282
 *
 * Since: 2.26
283 284
 */
gboolean
285 286 287
g_credentials_is_same_user (GCredentials  *credentials,
                            GCredentials  *other_credentials,
                            GError       **error)
288
{
289 290
  gboolean ret;

291
  g_return_val_if_fail (G_IS_CREDENTIALS (credentials), FALSE);
292 293
  g_return_val_if_fail (G_IS_CREDENTIALS (other_credentials), FALSE);
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
294

295
  ret = FALSE;
296
#if G_CREDENTIALS_USE_LINUX_UCRED
297
  if (credentials->native.uid == other_credentials->native.uid)
298
    ret = TRUE;
299
#elif G_CREDENTIALS_USE_FREEBSD_CMSGCRED
300 301
  if (credentials->native.cmcred_euid == other_credentials->native.cmcred_euid)
    ret = TRUE;
302 303 304
#elif G_CREDENTIALS_USE_NETBSD_UNPCBID
  if (credentials->native.unp_euid == other_credentials->native.unp_euid)
    ret = TRUE;
305
#elif G_CREDENTIALS_USE_OPENBSD_SOCKPEERCRED
306 307
  if (credentials->native.uid == other_credentials->native.uid)
    ret = TRUE;
308 309 310
#elif G_CREDENTIALS_USE_SOLARIS_UCRED
  if (ucred_geteuid (credentials->native) == ucred_geteuid (other_credentials->native))
    ret = TRUE;
311 312 313 314 315 316
#else
  g_set_error_literal (error,
                       G_IO_ERROR,
                       G_IO_ERROR_NOT_SUPPORTED,
                       _("GCredentials is not implemented on this OS"));
#endif
317

318
  return ret;
319 320
}

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
static gboolean
credentials_native_type_check (GCredentialsType  requested_type,
                               const char       *op)
{
  GEnumClass *enum_class;
  GEnumValue *requested;
#if G_CREDENTIALS_SUPPORTED
  GEnumValue *supported;
#endif

#if G_CREDENTIALS_SUPPORTED
  if (requested_type == G_CREDENTIALS_NATIVE_TYPE)
    return TRUE;
#endif

  enum_class = g_type_class_ref (g_credentials_type_get_type ());
  requested = g_enum_get_value (enum_class, requested_type);

#if G_CREDENTIALS_SUPPORTED
  supported = g_enum_get_value (enum_class, G_CREDENTIALS_NATIVE_TYPE);
341
  g_assert (supported);
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
  g_warning ("g_credentials_%s_native: Trying to %s credentials of type %s "
             "but only %s is supported on this platform.",
             op, op,
             requested ? requested->value_name : "(unknown)",
             supported->value_name);
#else
  g_warning ("g_credentials_%s_native: Trying to %s credentials of type %s "
             "but there is no support for GCredentials on this platform.",
             op, op,
             requested ? requested->value_name : "(unknown)");
#endif

  g_type_class_unref (enum_class);
  return FALSE;
}

358
/**
359
 * g_credentials_get_native: (skip)
360
 * @credentials: A #GCredentials.
361
 * @native_type: The type of native credentials to get.
362
 *
363
 * Gets a pointer to native credentials of type @native_type from
364
 * @credentials.
365
 *
366 367 368 369 370 371 372 373 374
 * It is a programming error (which will cause an warning to be
 * logged) to use this method if there is no #GCredentials support for
 * the OS or if @native_type isn't supported by the OS.
 *
 * Returns: The pointer to native credentials or %NULL if the
 * operation there is no #GCredentials support for the OS or if
 * @native_type isn't supported by the OS. Do not free the returned
 * data, it is owned by @credentials.
 *
375
 * Since: 2.26
376
 */
377
gpointer
378 379
g_credentials_get_native (GCredentials     *credentials,
                          GCredentialsType  native_type)
380
{
381
  g_return_val_if_fail (G_IS_CREDENTIALS (credentials), NULL);
382

383 384 385
  if (!credentials_native_type_check (native_type, "get"))
    return NULL;

386 387 388
#if G_CREDENTIALS_USE_SOLARIS_UCRED
  return credentials->native;
#elif G_CREDENTIALS_SUPPORTED
389
  return &credentials->native;
390
#else
391
  g_assert_not_reached ();
392
#endif
393 394 395
}

/**
396
 * g_credentials_set_native:
397
 * @credentials: A #GCredentials.
398
 * @native_type: The type of native credentials to set.
399
 * @native: (not nullable): A pointer to native credentials.
400
 *
401 402
 * Copies the native credentials of type @native_type from @native
 * into @credentials.
403 404 405
 *
 * It is a programming error (which will cause an warning to be
 * logged) to use this method if there is no #GCredentials support for
406
 * the OS or if @native_type isn't supported by the OS.
407 408
 *
 * Since: 2.26
409 410
 */
void
411 412 413
g_credentials_set_native (GCredentials     *credentials,
                          GCredentialsType  native_type,
                          gpointer          native)
414
{
415 416 417
  if (!credentials_native_type_check (native_type, "set"))
    return;

418 419 420
#if G_CREDENTIALS_USE_SOLARIS_UCRED
  memcpy (credentials->native, native, ucred_size ());
#elif G_CREDENTIALS_SUPPORTED
421
  memcpy (&credentials->native, native, sizeof (credentials->native));
422
#else
423
  g_assert_not_reached ();
424
#endif
425 426 427 428
}

/* ---------------------------------------------------------------------------------------------------- */

429
#ifdef G_OS_UNIX
430
/**
431 432 433
 * g_credentials_get_unix_user:
 * @credentials: A #GCredentials
 * @error: Return location for error or %NULL.
434
 *
435 436
 * Tries to get the UNIX user identifier from @credentials. This
 * method is only available on UNIX platforms.
437
 *
438 439 440
 * This operation can fail if #GCredentials is not supported on the
 * OS or if the native credentials type does not contain information
 * about the UNIX user.
441
 *
442
 * Returns: The UNIX user identifier or -1 if @error is set.
443 444
 *
 * Since: 2.26
445
 */
446 447 448
uid_t
g_credentials_get_unix_user (GCredentials    *credentials,
                             GError         **error)
449
{
450 451
  uid_t ret;

452
  g_return_val_if_fail (G_IS_CREDENTIALS (credentials), -1);
453
  g_return_val_if_fail (error == NULL || *error == NULL, -1);
454

455
#if G_CREDENTIALS_USE_LINUX_UCRED
456
  ret = credentials->native.uid;
457
#elif G_CREDENTIALS_USE_FREEBSD_CMSGCRED
458
  ret = credentials->native.cmcred_euid;
459 460
#elif G_CREDENTIALS_USE_NETBSD_UNPCBID
  ret = credentials->native.unp_euid;
461
#elif G_CREDENTIALS_USE_OPENBSD_SOCKPEERCRED
462
  ret = credentials->native.uid;
463 464
#elif G_CREDENTIALS_USE_SOLARIS_UCRED
  ret = ucred_geteuid (credentials->native);
465 466 467 468 469
#else
  ret = -1;
  g_set_error_literal (error,
                       G_IO_ERROR,
                       G_IO_ERROR_NOT_SUPPORTED,
470
                       _("There is no GCredentials support for your platform"));
471
#endif
472

473 474
  return ret;
}
475

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
/**
 * g_credentials_get_unix_pid:
 * @credentials: A #GCredentials
 * @error: Return location for error or %NULL.
 *
 * Tries to get the UNIX process identifier from @credentials. This
 * method is only available on UNIX platforms.
 *
 * This operation can fail if #GCredentials is not supported on the
 * OS or if the native credentials type does not contain information
 * about the UNIX process ID.
 *
 * Returns: The UNIX process ID, or -1 if @error is set.
 *
 * Since: 2.36
 */
pid_t
g_credentials_get_unix_pid (GCredentials    *credentials,
                            GError         **error)
{
  pid_t ret;

  g_return_val_if_fail (G_IS_CREDENTIALS (credentials), -1);
  g_return_val_if_fail (error == NULL || *error == NULL, -1);

501
#if G_CREDENTIALS_USE_LINUX_UCRED
502
  ret = credentials->native.pid;
503
#elif G_CREDENTIALS_USE_FREEBSD_CMSGCRED
504
  ret = credentials->native.cmcred_pid;
505 506
#elif G_CREDENTIALS_USE_NETBSD_UNPCBID
  ret = credentials->native.unp_pid;
507
#elif G_CREDENTIALS_USE_OPENBSD_SOCKPEERCRED
508
  ret = credentials->native.pid;
509 510
#elif G_CREDENTIALS_USE_SOLARIS_UCRED
  ret = ucred_getpid (credentials->native);
511 512 513 514 515 516 517 518 519 520 521
#else
  ret = -1;
  g_set_error_literal (error,
                       G_IO_ERROR,
                       G_IO_ERROR_NOT_SUPPORTED,
                       _("GCredentials does not contain a process ID on this OS"));
#endif

  return ret;
}

522
/**
523
 * g_credentials_set_unix_user:
524
 * @credentials: A #GCredentials.
525 526 527 528 529
 * @uid: The UNIX user identifier to set.
 * @error: Return location for error or %NULL.
 *
 * Tries to set the UNIX user identifier on @credentials. This method
 * is only available on UNIX platforms.
530
 *
531 532
 * This operation can fail if #GCredentials is not supported on the
 * OS or if the native credentials type does not contain information
533 534
 * about the UNIX user. It can also fail if the OS does not allow the
 * use of "spoofed" credentials.
535
 *
536
 * Returns: %TRUE if @uid was set, %FALSE if error is set.
537 538
 *
 * Since: 2.26
539 540
 */
gboolean
541 542 543
g_credentials_set_unix_user (GCredentials    *credentials,
                             uid_t            uid,
                             GError         **error)
544
{
545 546
  gboolean ret;

547
  g_return_val_if_fail (G_IS_CREDENTIALS (credentials), FALSE);
548 549
  g_return_val_if_fail (uid != -1, FALSE);
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
550

551
  ret = FALSE;
552
#if G_CREDENTIALS_USE_LINUX_UCRED
553
  credentials->native.uid = uid;
554
  ret = TRUE;
555
#elif G_CREDENTIALS_USE_FREEBSD_CMSGCRED
556 557
  credentials->native.cmcred_euid = uid;
  ret = TRUE;
558 559 560
#elif G_CREDENTIALS_USE_NETBSD_UNPCBID
  credentials->native.unp_euid = uid;
  ret = TRUE;
561
#elif G_CREDENTIALS_USE_OPENBSD_SOCKPEERCRED
562 563
  credentials->native.uid = uid;
  ret = TRUE;
564 565 566 567 568 569
#elif !G_CREDENTIALS_SPOOFING_SUPPORTED
  g_set_error_literal (error,
                       G_IO_ERROR,
                       G_IO_ERROR_PERMISSION_DENIED,
                       _("Credentials spoofing is not possible on this OS"));
  ret = FALSE;
570 571 572 573 574
#else
  g_set_error_literal (error,
                       G_IO_ERROR,
                       G_IO_ERROR_NOT_SUPPORTED,
                       _("GCredentials is not implemented on this OS"));
575
  ret = FALSE;
576
#endif
577

578
  return ret;
579
}
580

581
#endif /* G_OS_UNIX */