dbus/dbus-auth.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-auth.h Authentication
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23 #ifndef DBUS_AUTH_H
  24 #define DBUS_AUTH_H
  25
  26 #include <dbus/dbus-macros.h>
  27 #include <dbus/dbus-errors.h>
  28 #include <dbus/dbus-string.h>
  29 #include <dbus/dbus-sysdeps.h>
  30
  31 DBUS_BEGIN_DECLS;
  32
  33 typedef struct DBusAuth DBusAuth;
  34
  35 typedef enum
  36 {
  37   DBUS_AUTH_STATE_WAITING_FOR_INPUT,
  38   DBUS_AUTH_STATE_WAITING_FOR_MEMORY,
  39   DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND,
  40   DBUS_AUTH_STATE_NEED_DISCONNECT,
  41   DBUS_AUTH_STATE_AUTHENTICATED_WITH_UNUSED_BYTES,
  42   DBUS_AUTH_STATE_AUTHENTICATED
  43 } DBusAuthState;
  44
  45 DBusAuth*     _dbus_auth_server_new          (void);
  46 DBusAuth*     _dbus_auth_client_new          (void);
  47 void          _dbus_auth_ref                 (DBusAuth               *auth);
  48 void          _dbus_auth_unref               (DBusAuth               *auth);
  49 dbus_bool_t   _dbus_auth_set_mechanisms      (DBusAuth               *auth,
  50                                               const char            **mechanisms);
  51 DBusAuthState _dbus_auth_do_work             (DBusAuth               *auth);
  52 dbus_bool_t   _dbus_auth_get_bytes_to_send   (DBusAuth               *auth,
  53                                               const DBusString      **str);
  54 void          _dbus_auth_bytes_sent          (DBusAuth               *auth,
  55                                               int                     bytes_sent);
  56 void          _dbus_auth_get_buffer          (DBusAuth               *auth,
  57                                               DBusString            **buffer);
  58 void          _dbus_auth_return_buffer       (DBusAuth               *auth,
  59                                               DBusString             *buffer,
  60                                               int                     bytes_read);
  61 void          _dbus_auth_get_unused_bytes    (DBusAuth               *auth,
  62                                               const DBusString      **str);
  63 void          _dbus_auth_delete_unused_bytes (DBusAuth               *auth);
  64 dbus_bool_t   _dbus_auth_needs_encoding      (DBusAuth               *auth);
  65 dbus_bool_t   _dbus_auth_encode_data         (DBusAuth               *auth,
  66                                               const DBusString       *plaintext,
  67                                               DBusString             *encoded);
  68 dbus_bool_t   _dbus_auth_needs_decoding      (DBusAuth               *auth);
  69 dbus_bool_t   _dbus_auth_decode_data         (DBusAuth               *auth,
  70                                               const DBusString       *encoded,
  71                                               DBusString             *plaintext);
  72 void          _dbus_auth_set_credentials     (DBusAuth               *auth,
  73                                               const DBusCredentials  *credentials);
  74 void          _dbus_auth_get_identity        (DBusAuth               *auth,
  75                                               DBusCredentials        *credentials);
  76 dbus_bool_t   _dbus_auth_set_context         (DBusAuth               *auth,
  77                                               const DBusString       *context);
  78
  79
  80 DBUS_END_DECLS;
  81
  82 #endif /* DBUS_AUTH_H */