| /* GDBus - GLib D-Bus Library |
| * |
| * Copyright (C) 2008-2010 Red Hat, Inc. |
| * |
| * 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 |
| * version 2 of the License, or (at your option) any later version. |
| * |
| * 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 |
| * Public License along with this library; if not, write to the |
| * Free Software Foundation, Inc., 59 Temple Place, Suite 330, |
| * Boston, MA 02111-1307, USA. |
| * |
| * Author: David Zeuthen <davidz@redhat.com> |
| */ |
| |
| #include "config.h" |
| |
| #ifdef __FreeBSD__ |
| #include <sys/types.h> |
| #include <sys/socket.h> |
| #include <string.h> |
| #endif |
| #ifdef __OpenBSD__ |
| #include <sys/types.h> |
| #include <sys/socket.h> |
| #include <string.h> |
| #endif |
| #include <stdlib.h> |
| |
| #include <gobject/gvaluecollector.h> |
| |
| #include "gcredentials.h" |
| #include "gnetworkingprivate.h" |
| #include "gioerror.h" |
| |
| #include "glibintl.h" |
| |
| /** |
| * SECTION:gcredentials |
| * @short_description: An object containing credentials |
| * @include: gio/gio.h |
| * |
| * The #GCredentials type is a reference-counted wrapper for native |
| * credentials. This information is typically used for identifying, |
| * authenticating and authorizing other processes. |
| * |
| * Some operating systems supports looking up the credentials of the |
| * remote peer of a communication endpoint - see e.g. |
| * g_socket_get_credentials(). |
| * |
| * Some operating systems supports securely sending and receiving |
| * credentials over a Unix Domain Socket, see |
| * #GUnixCredentialsMessage, g_unix_connection_send_credentials() and |
| * g_unix_connection_receive_credentials() for details. |
| * |
| * On Linux, the native credential type is a <type>struct ucred</type> |
| * - see the |
| * <citerefentry><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry> |
| * man page for details. This corresponds to |
| * %G_CREDENTIALS_TYPE_LINUX_UCRED. |
| * |
| * On FreeBSD, the native credential type is a <type>struct cmsgcred</type>. |
| * This corresponds to %G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED. |
| * |
| * On OpenBSD, the native credential type is a <type>struct sockpeercred</type>. |
| * This corresponds to %G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED. |
| */ |
| |
| /** |
| * GCredentials: |
| * |
| * The #GCredentials structure contains only private data and |
| * should only be accessed using the provided API. |
| * |
| * Since: 2.26 |
| */ |
| struct _GCredentials |
| { |
| /*< private >*/ |
| GObject parent_instance; |
| |
| #ifdef __linux__ |
| struct ucred native; |
| #elif defined(__FreeBSD__) |
| struct cmsgcred native; |
| #elif defined(__OpenBSD__) |
| struct sockpeercred native; |
| #else |
| #ifdef __GNUC__ |
| #warning Please add GCredentials support for your OS |
| #endif |
| #endif |
| }; |
| |
| /** |
| * GCredentialsClass: |
| * |
| * Class structure for #GCredentials. |
| * |
| * Since: 2.26 |
| */ |
| struct _GCredentialsClass |
| { |
| /*< private >*/ |
| GObjectClass parent_class; |
| }; |
| |
| G_DEFINE_TYPE (GCredentials, g_credentials, G_TYPE_OBJECT); |
| |
| static void |
| g_credentials_finalize (GObject *object) |
| { |
| G_GNUC_UNUSED GCredentials *credentials = G_CREDENTIALS (object); |
| |
| 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) |
| { |
| #ifdef __linux__ |
| credentials->native.pid = getpid (); |
| credentials->native.uid = geteuid (); |
| credentials->native.gid = getegid (); |
| #elif defined(__FreeBSD__) |
| memset (&credentials->native, 0, sizeof (struct cmsgcred)); |
| credentials->native.cmcred_pid = getpid (); |
| credentials->native.cmcred_euid = geteuid (); |
| credentials->native.cmcred_gid = getegid (); |
| #elif defined(__OpenBSD__) |
| credentials->native.pid = getpid (); |
| credentials->native.uid = geteuid (); |
| credentials->native.gid = getegid (); |
| #endif |
| } |
| |
| /* ---------------------------------------------------------------------------------------------------- */ |
| |
| /** |
| * g_credentials_new: |
| * |
| * Creates a new #GCredentials object with credentials matching the |
| * the current process. |
| * |
| * Returns: A #GCredentials. Free with g_object_unref(). |
| * |
| * Since: 2.26 |
| */ |
| GCredentials * |
| g_credentials_new (void) |
| { |
| return g_object_new (G_TYPE_CREDENTIALS, NULL); |
| } |
| |
| /* ---------------------------------------------------------------------------------------------------- */ |
| |
| /** |
| * g_credentials_to_string: |
| * @credentials: A #GCredentials object. |
| * |
| * 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. |
| * |
| * Returns: A string that should be freed with g_free(). |
| * |
| * Since: 2.26 |
| */ |
| gchar * |
| g_credentials_to_string (GCredentials *credentials) |
| { |
| GString *ret; |
| |
| g_return_val_if_fail (G_IS_CREDENTIALS (credentials), NULL); |
| |
| ret = g_string_new ("GCredentials:"); |
| #ifdef __linux__ |
| 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); |
| if (ret->str[ret->len - 1] == ',') |
| ret->str[ret->len - 1] = '\0'; |
| #elif defined(__FreeBSD__) |
| 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); |
| #elif defined(__OpenBSD__) |
| 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'; |
| #else |
| g_string_append (ret, "unknown"); |
| #endif |
| |
| return g_string_free (ret, FALSE); |
| } |
| |
| /* ---------------------------------------------------------------------------------------------------- */ |
| |
| /** |
| * g_credentials_is_same_user: |
| * @credentials: A #GCredentials. |
| * @other_credentials: A #GCredentials. |
| * @error: Return location for error or %NULL. |
| * |
| * Checks if @credentials and @other_credentials is the same user. |
| * |
| * 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. |
| * |
| * Since: 2.26 |
| */ |
| gboolean |
| g_credentials_is_same_user (GCredentials *credentials, |
| GCredentials *other_credentials, |
| GError **error) |
| { |
| gboolean ret; |
| |
| g_return_val_if_fail (G_IS_CREDENTIALS (credentials), FALSE); |
| g_return_val_if_fail (G_IS_CREDENTIALS (other_credentials), FALSE); |
| g_return_val_if_fail (error == NULL || *error == NULL, FALSE); |
| |
| ret = FALSE; |
| #ifdef __linux__ |
| if (credentials->native.uid == other_credentials->native.uid) |
| ret = TRUE; |
| #elif defined(__FreeBSD__) |
| if (credentials->native.cmcred_euid == other_credentials->native.cmcred_euid) |
| ret = TRUE; |
| #elif defined(__OpenBSD__) |
| if (credentials->native.uid == other_credentials->native.uid) |
| ret = TRUE; |
| #else |
| g_set_error_literal (error, |
| G_IO_ERROR, |
| G_IO_ERROR_NOT_SUPPORTED, |
| _("GCredentials is not implemented on this OS")); |
| #endif |
| |
| return ret; |
| } |
| |
| /** |
| * g_credentials_get_native: (skip) |
| * @credentials: A #GCredentials. |
| * @native_type: The type of native credentials to get. |
| * |
| * Gets a pointer to native credentials of type @native_type from |
| * @credentials. |
| * |
| * 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. |
| * |
| * Since: 2.26 |
| */ |
| gpointer |
| g_credentials_get_native (GCredentials *credentials, |
| GCredentialsType native_type) |
| { |
| gpointer ret; |
| |
| g_return_val_if_fail (G_IS_CREDENTIALS (credentials), NULL); |
| |
| ret = NULL; |
| |
| #ifdef __linux__ |
| if (native_type != G_CREDENTIALS_TYPE_LINUX_UCRED) |
| { |
| g_warning ("g_credentials_get_native: Trying to get credentials of type %d but only " |
| "G_CREDENTIALS_TYPE_LINUX_UCRED is supported.", |
| native_type); |
| } |
| else |
| { |
| ret = &credentials->native; |
| } |
| #elif defined(__FreeBSD__) |
| if (native_type != G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED) |
| { |
| g_warning ("g_credentials_get_native: Trying to get credentials of type %d but only " |
| "G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED is supported.", |
| native_type); |
| } |
| else |
| { |
| ret = &credentials->native; |
| } |
| #elif defined(__OpenBSD__) |
| if (native_type != G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED) |
| { |
| g_warning ("g_credentials_get_native: Trying to get credentials of type %d but only " |
| "G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED is supported.", |
| native_type); |
| } |
| else |
| { |
| ret = &credentials->native; |
| } |
| #else |
| g_warning ("g_credentials_get_native: Trying to get credentials but GLib has no support " |
| "for the native credentials type. Please add support."); |
| #endif |
| |
| return ret; |
| } |
| |
| /** |
| * g_credentials_set_native: |
| * @credentials: A #GCredentials. |
| * @native_type: The type of native credentials to set. |
| * @native: A pointer to native credentials. |
| * |
| * Copies the native credentials of type @native_type from @native |
| * into @credentials. |
| * |
| * 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. |
| * |
| * Since: 2.26 |
| */ |
| void |
| g_credentials_set_native (GCredentials *credentials, |
| GCredentialsType native_type, |
| gpointer native) |
| { |
| #ifdef __linux__ |
| if (native_type != G_CREDENTIALS_TYPE_LINUX_UCRED) |
| { |
| g_warning ("g_credentials_set_native: Trying to set credentials of type %d " |
| "but only G_CREDENTIALS_TYPE_LINUX_UCRED is supported.", |
| native_type); |
| } |
| else |
| { |
| memcpy (&credentials->native, native, sizeof (struct ucred)); |
| } |
| #elif defined(__FreeBSD__) |
| if (native_type != G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED) |
| { |
| g_warning ("g_credentials_set_native: Trying to set credentials of type %d " |
| "but only G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED is supported.", |
| native_type); |
| } |
| else |
| { |
| memcpy (&credentials->native, native, sizeof (struct cmsgcred)); |
| } |
| #elif defined(__OpenBSD__) |
| if (native_type != G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED) |
| { |
| g_warning ("g_credentials_set_native: Trying to set credentials of type %d " |
| "but only G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED is supported.", |
| native_type); |
| } |
| else |
| { |
| memcpy (&credentials->native, native, sizeof (struct sockpeercred)); |
| } |
| #else |
| g_warning ("g_credentials_set_native: Trying to set credentials but GLib has no support " |
| "for the native credentials type. Please add support."); |
| #endif |
| } |
| |
| /* ---------------------------------------------------------------------------------------------------- */ |
| |
| #ifdef G_OS_UNIX |
| /** |
| * g_credentials_get_unix_user: |
| * @credentials: A #GCredentials |
| * @error: Return location for error or %NULL. |
| * |
| * Tries to get the UNIX user 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 user. |
| * |
| * Returns: The UNIX user identifier or -1 if @error is set. |
| * |
| * Since: 2.26 |
| */ |
| uid_t |
| g_credentials_get_unix_user (GCredentials *credentials, |
| GError **error) |
| { |
| uid_t ret; |
| |
| g_return_val_if_fail (G_IS_CREDENTIALS (credentials), -1); |
| g_return_val_if_fail (error == NULL || *error == NULL, -1); |
| |
| #ifdef __linux__ |
| ret = credentials->native.uid; |
| #elif defined(__FreeBSD__) |
| ret = credentials->native.cmcred_euid; |
| #elif defined(__OpenBSD__) |
| ret = credentials->native.uid; |
| #else |
| ret = -1; |
| g_set_error_literal (error, |
| G_IO_ERROR, |
| G_IO_ERROR_NOT_SUPPORTED, |
| _("There is no GCredentials support for your platform")); |
| #endif |
| |
| return ret; |
| } |
| |
| /** |
| * g_credentials_set_unix_user: |
| * @credentials: A #GCredentials. |
| * @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. |
| * |
| * 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. |
| * |
| * Returns: %TRUE if @uid was set, %FALSE if error is set. |
| * |
| * Since: 2.26 |
| */ |
| gboolean |
| g_credentials_set_unix_user (GCredentials *credentials, |
| uid_t uid, |
| GError **error) |
| { |
| gboolean ret; |
| |
| g_return_val_if_fail (G_IS_CREDENTIALS (credentials), FALSE); |
| g_return_val_if_fail (uid != -1, FALSE); |
| g_return_val_if_fail (error == NULL || *error == NULL, FALSE); |
| |
| ret = FALSE; |
| #ifdef __linux__ |
| credentials->native.uid = uid; |
| ret = TRUE; |
| #elif defined(__FreeBSD__) |
| credentials->native.cmcred_euid = uid; |
| ret = TRUE; |
| #elif defined(__OpenBSD__) |
| credentials->native.uid = uid; |
| ret = TRUE; |
| #else |
| g_set_error_literal (error, |
| G_IO_ERROR, |
| G_IO_ERROR_NOT_SUPPORTED, |
| _("GCredentials is not implemented on this OS")); |
| #endif |
| |
| return ret; |
| } |
| #endif /* G_OS_UNIX */ |