1  /* GDBus - GLib D-Bus Library
       2   *
       3   * Copyright (C) 2008-2010 Red Hat, Inc.
       4   *
       5   * SPDX-License-Identifier: LGPL-2.1-or-later
       6   *
       7   * This library is free software; you can redistribute it and/or
       8   * modify it under the terms of the GNU Lesser General Public
       9   * License as published by the Free Software Foundation; either
      10   * version 2.1 of the License, or (at your option) any later version.
      11   *
      12   * This library is distributed in the hope that it will be useful,
      13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
      14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      15   * Lesser General Public License for more details.
      16   *
      17   * You should have received a copy of the GNU Lesser General
      18   * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
      19   *
      20   * Author: David Zeuthen <davidz@redhat.com>
      21   */
      22  
      23  #ifndef __G_DBUS_AUTH_H__
      24  #define __G_DBUS_AUTH_H__
      25  
      26  #if !defined (GIO_COMPILATION)
      27  #error "gdbusauth.h is a private header file."
      28  #endif
      29  
      30  #include <gio/giotypes.h>
      31  
      32  G_BEGIN_DECLS
      33  
      34  #define G_TYPE_DBUS_AUTH         (_g_dbus_auth_get_type ())
      35  #define G_DBUS_AUTH(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_AUTH, GDBusAuth))
      36  #define G_DBUS_AUTH_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DBUS_AUTH, GDBusAuthClass))
      37  #define G_DBUS_AUTH_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DBUS_AUTH, GDBusAuthClass))
      38  #define G_IS_DBUS_AUTH(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_AUTH))
      39  #define G_IS_DBUS_AUTH_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DBUS_AUTH))
      40  
      41  typedef struct _GDBusAuth        GDBusAuth;
      42  typedef struct _GDBusAuthClass   GDBusAuthClass;
      43  typedef struct _GDBusAuthPrivate GDBusAuthPrivate;
      44  
      45  struct _GDBusAuthClass
      46  {
      47    /*< private >*/
      48    GObjectClass parent_class;
      49  };
      50  
      51  struct _GDBusAuth
      52  {
      53    GObject parent_instance;
      54    GDBusAuthPrivate *priv;
      55  };
      56  
      57  GType       _g_dbus_auth_get_type (void) G_GNUC_CONST;
      58  GDBusAuth  *_g_dbus_auth_new      (GIOStream *stream);
      59  
      60  /* TODO: need a way to set allowed authentication mechanisms */
      61  
      62  /* TODO: need a way to convey credentials etc. */
      63  
      64  /* TODO: need a way to convey negotiated features (e.g. returning flags from e.g. GDBusConnectionFeatures) */
      65  
      66  /* TODO: need to expose encode()/decode() from the AuthMechanism (and whether it is needed at all) */
      67  
      68  gboolean    _g_dbus_auth_run_server (GDBusAuth             *auth,
      69                                       GDBusAuthObserver     *observer,
      70                                       const gchar           *guid,
      71                                       gboolean               allow_anonymous,
      72                                       gboolean               require_same_user,
      73                                       GDBusCapabilityFlags   offered_capabilities,
      74                                       GDBusCapabilityFlags  *out_negotiated_capabilities,
      75                                       GCredentials         **out_received_credentials,
      76                                       GCancellable          *cancellable,
      77                                       GError               **error);
      78  
      79  gchar      *_g_dbus_auth_run_client (GDBusAuth     *auth,
      80                                       GDBusAuthObserver     *observer,
      81                                       GDBusConnectionFlags   conn_flags,
      82                                       GDBusCapabilityFlags offered_capabilities,
      83                                       GDBusCapabilityFlags *out_negotiated_capabilities,
      84                                       GCancellable  *cancellable,
      85                                       GError       **error);
      86  
      87  G_END_DECLS
      88  
      89  #endif /* __G_DBUS_AUTH_H__ */