|
Packit |
ae235b |
/* GDBus - GLib D-Bus Library
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Copyright (C) 2008-2010 Red Hat, Inc.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* This library is free software; you can redistribute it and/or
|
|
Packit |
ae235b |
* modify it under the terms of the GNU Lesser General Public
|
|
Packit |
ae235b |
* License as published by the Free Software Foundation; either
|
|
Packit |
ae235b |
* version 2.1 of the License, or (at your option) any later version.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* This library is distributed in the hope that it will be useful,
|
|
Packit |
ae235b |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Packit |
ae235b |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Packit |
ae235b |
* Lesser General Public License for more details.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* You should have received a copy of the GNU Lesser General
|
|
Packit |
ae235b |
* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Author: David Zeuthen <davidz@redhat.com>
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
#include "config.h"
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
#include "gdbusauthobserver.h"
|
|
Packit |
ae235b |
#include "gcredentials.h"
|
|
Packit |
ae235b |
#include "gioenumtypes.h"
|
|
Packit |
ae235b |
#include "giostream.h"
|
|
Packit |
ae235b |
#include "gdbusprivate.h"
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
#include "glibintl.h"
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* SECTION:gdbusauthobserver
|
|
Packit |
ae235b |
* @short_description: Object used for authenticating connections
|
|
Packit |
ae235b |
* @include: gio/gio.h
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* The #GDBusAuthObserver type provides a mechanism for participating
|
|
Packit |
ae235b |
* in how a #GDBusServer (or a #GDBusConnection) authenticates remote
|
|
Packit |
ae235b |
* peers. Simply instantiate a #GDBusAuthObserver and connect to the
|
|
Packit |
ae235b |
* signals you are interested in. Note that new signals may be added
|
|
Packit |
ae235b |
* in the future
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* ## Controlling Authentication # {#auth-observer}
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* For example, if you only want to allow D-Bus connections from
|
|
Packit |
ae235b |
* processes owned by the same uid as the server, you would use a
|
|
Packit |
ae235b |
* signal handler like the following:
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* |[
|
|
Packit |
ae235b |
* static gboolean
|
|
Packit |
ae235b |
* on_authorize_authenticated_peer (GDBusAuthObserver *observer,
|
|
Packit |
ae235b |
* GIOStream *stream,
|
|
Packit |
ae235b |
* GCredentials *credentials,
|
|
Packit |
ae235b |
* gpointer user_data)
|
|
Packit |
ae235b |
* {
|
|
Packit |
ae235b |
* gboolean authorized;
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* authorized = FALSE;
|
|
Packit |
ae235b |
* if (credentials != NULL)
|
|
Packit |
ae235b |
* {
|
|
Packit |
ae235b |
* GCredentials *own_credentials;
|
|
Packit |
ae235b |
* own_credentials = g_credentials_new ();
|
|
Packit |
ae235b |
* if (g_credentials_is_same_user (credentials, own_credentials, NULL))
|
|
Packit |
ae235b |
* authorized = TRUE;
|
|
Packit |
ae235b |
* g_object_unref (own_credentials);
|
|
Packit |
ae235b |
* }
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* return authorized;
|
|
Packit |
ae235b |
* }
|
|
Packit |
ae235b |
* ]|
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
typedef struct _GDBusAuthObserverClass GDBusAuthObserverClass;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* GDBusAuthObserverClass:
|
|
Packit |
ae235b |
* @authorize_authenticated_peer: Signal class handler for the #GDBusAuthObserver::authorize-authenticated-peer signal.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Class structure for #GDBusAuthObserverClass.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
struct _GDBusAuthObserverClass
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
/*< private >*/
|
|
Packit |
ae235b |
GObjectClass parent_class;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/*< public >*/
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/* Signals */
|
|
Packit |
ae235b |
gboolean (*authorize_authenticated_peer) (GDBusAuthObserver *observer,
|
|
Packit |
ae235b |
GIOStream *stream,
|
|
Packit |
ae235b |
GCredentials *credentials);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gboolean (*allow_mechanism) (GDBusAuthObserver *observer,
|
|
Packit |
ae235b |
const gchar *mechanism);
|
|
Packit |
ae235b |
};
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* GDBusAuthObserver:
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* The #GDBusAuthObserver structure contains only private data and
|
|
Packit |
ae235b |
* should only be accessed using the provided API.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
struct _GDBusAuthObserver
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
GObject parent_instance;
|
|
Packit |
ae235b |
};
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
enum
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
AUTHORIZE_AUTHENTICATED_PEER_SIGNAL,
|
|
Packit |
ae235b |
ALLOW_MECHANISM_SIGNAL,
|
|
Packit |
ae235b |
LAST_SIGNAL,
|
|
Packit |
ae235b |
};
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
static guint signals[LAST_SIGNAL] = { 0 };
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
G_DEFINE_TYPE (GDBusAuthObserver, g_dbus_auth_observer, G_TYPE_OBJECT)
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/* ---------------------------------------------------------------------------------------------------- */
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
static void
|
|
Packit |
ae235b |
g_dbus_auth_observer_finalize (GObject *object)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
G_OBJECT_CLASS (g_dbus_auth_observer_parent_class)->finalize (object);
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
static gboolean
|
|
Packit |
ae235b |
g_dbus_auth_observer_authorize_authenticated_peer_real (GDBusAuthObserver *observer,
|
|
Packit |
ae235b |
GIOStream *stream,
|
|
Packit |
ae235b |
GCredentials *credentials)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
return TRUE;
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
static gboolean
|
|
Packit |
ae235b |
g_dbus_auth_observer_allow_mechanism_real (GDBusAuthObserver *observer,
|
|
Packit |
ae235b |
const gchar *mechanism)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
return TRUE;
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
static void
|
|
Packit |
ae235b |
g_dbus_auth_observer_class_init (GDBusAuthObserverClass *klass)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gobject_class->finalize = g_dbus_auth_observer_finalize;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
klass->authorize_authenticated_peer = g_dbus_auth_observer_authorize_authenticated_peer_real;
|
|
Packit |
ae235b |
klass->allow_mechanism = g_dbus_auth_observer_allow_mechanism_real;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* GDBusAuthObserver::authorize-authenticated-peer:
|
|
Packit |
ae235b |
* @observer: The #GDBusAuthObserver emitting the signal.
|
|
Packit |
ae235b |
* @stream: A #GIOStream for the #GDBusConnection.
|
|
Packit |
ae235b |
* @credentials: (nullable): Credentials received from the peer or %NULL.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Emitted to check if a peer that is successfully authenticated
|
|
Packit |
ae235b |
* is authorized.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Returns: %TRUE if the peer is authorized, %FALSE if not.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
signals[AUTHORIZE_AUTHENTICATED_PEER_SIGNAL] =
|
|
Packit |
ae235b |
g_signal_new (I_("authorize-authenticated-peer"),
|
|
Packit |
ae235b |
G_TYPE_DBUS_AUTH_OBSERVER,
|
|
Packit |
ae235b |
G_SIGNAL_RUN_LAST,
|
|
Packit |
ae235b |
G_STRUCT_OFFSET (GDBusAuthObserverClass, authorize_authenticated_peer),
|
|
Packit |
ae235b |
_g_signal_accumulator_false_handled,
|
|
Packit |
ae235b |
NULL, /* accu_data */
|
|
Packit |
ae235b |
NULL,
|
|
Packit |
ae235b |
G_TYPE_BOOLEAN,
|
|
Packit |
ae235b |
2,
|
|
Packit |
ae235b |
G_TYPE_IO_STREAM,
|
|
Packit |
ae235b |
G_TYPE_CREDENTIALS);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* GDBusAuthObserver::allow-mechanism:
|
|
Packit |
ae235b |
* @observer: The #GDBusAuthObserver emitting the signal.
|
|
Packit |
ae235b |
* @mechanism: The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Emitted to check if @mechanism is allowed to be used.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Returns: %TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.34
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
signals[ALLOW_MECHANISM_SIGNAL] =
|
|
Packit |
ae235b |
g_signal_new (I_("allow-mechanism"),
|
|
Packit |
ae235b |
G_TYPE_DBUS_AUTH_OBSERVER,
|
|
Packit |
ae235b |
G_SIGNAL_RUN_LAST,
|
|
Packit |
ae235b |
G_STRUCT_OFFSET (GDBusAuthObserverClass, allow_mechanism),
|
|
Packit |
ae235b |
_g_signal_accumulator_false_handled,
|
|
Packit |
ae235b |
NULL, /* accu_data */
|
|
Packit |
ae235b |
NULL,
|
|
Packit |
ae235b |
G_TYPE_BOOLEAN,
|
|
Packit |
ae235b |
1,
|
|
Packit |
ae235b |
G_TYPE_STRING);
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
static void
|
|
Packit |
ae235b |
g_dbus_auth_observer_init (GDBusAuthObserver *observer)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* g_dbus_auth_observer_new:
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Creates a new #GDBusAuthObserver object.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Returns: A #GDBusAuthObserver. Free with g_object_unref().
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
GDBusAuthObserver *
|
|
Packit |
ae235b |
g_dbus_auth_observer_new (void)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
return g_object_new (G_TYPE_DBUS_AUTH_OBSERVER, NULL);
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/* ---------------------------------------------------------------------------------------------------- */
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* g_dbus_auth_observer_authorize_authenticated_peer:
|
|
Packit |
ae235b |
* @observer: A #GDBusAuthObserver.
|
|
Packit |
ae235b |
* @stream: A #GIOStream for the #GDBusConnection.
|
|
Packit |
ae235b |
* @credentials: (nullable): Credentials received from the peer or %NULL.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Emits the #GDBusAuthObserver::authorize-authenticated-peer signal on @observer.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Returns: %TRUE if the peer is authorized, %FALSE if not.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
g_dbus_auth_observer_authorize_authenticated_peer (GDBusAuthObserver *observer,
|
|
Packit |
ae235b |
GIOStream *stream,
|
|
Packit |
ae235b |
GCredentials *credentials)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
gboolean denied;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
denied = FALSE;
|
|
Packit |
ae235b |
g_signal_emit (observer,
|
|
Packit |
ae235b |
signals[AUTHORIZE_AUTHENTICATED_PEER_SIGNAL],
|
|
Packit |
ae235b |
0,
|
|
Packit |
ae235b |
stream,
|
|
Packit |
ae235b |
credentials,
|
|
Packit |
ae235b |
&denied);
|
|
Packit |
ae235b |
return denied;
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* g_dbus_auth_observer_allow_mechanism:
|
|
Packit |
ae235b |
* @observer: A #GDBusAuthObserver.
|
|
Packit |
ae235b |
* @mechanism: The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Emits the #GDBusAuthObserver::allow-mechanism signal on @observer.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Returns: %TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.34
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
g_dbus_auth_observer_allow_mechanism (GDBusAuthObserver *observer,
|
|
Packit |
ae235b |
const gchar *mechanism)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
gboolean ret;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
ret = FALSE;
|
|
Packit |
ae235b |
g_signal_emit (observer,
|
|
Packit |
ae235b |
signals[ALLOW_MECHANISM_SIGNAL],
|
|
Packit |
ae235b |
0,
|
|
Packit |
ae235b |
mechanism,
|
|
Packit |
ae235b |
&ret;;
|
|
Packit |
ae235b |
return ret;
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|