Main Page | Modules | Data Structures | File List | Data Fields | Related Pages

dbus-auth.h

00001 /* -*- mode: C; c-file-style: "gnu" -*- */
00002 /* dbus-auth.h Authentication
00003  *
00004  * Copyright (C) 2002  Red Hat Inc.
00005  *
00006  * Licensed under the Academic Free License version 2.0
00007  * 
00008  * This program is free software; you can redistribute it and/or modify
00009  * it under the terms of the GNU General Public License as published by
00010  * the Free Software Foundation; either version 2 of the License, or
00011  * (at your option) any later version.
00012  *
00013  * This program is distributed in the hope that it will be useful,
00014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016  * GNU General Public License for more details.
00017  * 
00018  * You should have received a copy of the GNU General Public License
00019  * along with this program; if not, write to the Free Software
00020  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00021  *
00022  */
00023 #ifndef DBUS_AUTH_H
00024 #define DBUS_AUTH_H
00025 
00026 #include <dbus/dbus-macros.h>
00027 #include <dbus/dbus-errors.h>
00028 #include <dbus/dbus-string.h>
00029 #include <dbus/dbus-sysdeps.h>
00030 
00031 DBUS_BEGIN_DECLS;
00032 
00033 typedef struct DBusAuth DBusAuth;
00034 
00035 typedef enum
00036 {
00037   DBUS_AUTH_STATE_WAITING_FOR_INPUT,
00038   DBUS_AUTH_STATE_WAITING_FOR_MEMORY,
00039   DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND,
00040   DBUS_AUTH_STATE_NEED_DISCONNECT,
00041   DBUS_AUTH_STATE_AUTHENTICATED_WITH_UNUSED_BYTES,
00042   DBUS_AUTH_STATE_AUTHENTICATED
00043 } DBusAuthState;
00044 
00045 DBusAuth*     _dbus_auth_server_new          (void);
00046 DBusAuth*     _dbus_auth_client_new          (void);
00047 DBusAuth*     _dbus_auth_ref                 (DBusAuth               *auth);
00048 void          _dbus_auth_unref               (DBusAuth               *auth);
00049 dbus_bool_t   _dbus_auth_set_mechanisms      (DBusAuth               *auth,
00050                                               const char            **mechanisms);
00051 DBusAuthState _dbus_auth_do_work             (DBusAuth               *auth);
00052 dbus_bool_t   _dbus_auth_get_bytes_to_send   (DBusAuth               *auth,
00053                                               const DBusString      **str);
00054 void          _dbus_auth_bytes_sent          (DBusAuth               *auth,
00055                                               int                     bytes_sent);
00056 void          _dbus_auth_get_buffer          (DBusAuth               *auth,
00057                                               DBusString            **buffer);
00058 void          _dbus_auth_return_buffer       (DBusAuth               *auth,
00059                                               DBusString             *buffer,
00060                                               int                     bytes_read);
00061 void          _dbus_auth_get_unused_bytes    (DBusAuth               *auth,
00062                                               const DBusString      **str);
00063 void          _dbus_auth_delete_unused_bytes (DBusAuth               *auth);
00064 dbus_bool_t   _dbus_auth_needs_encoding      (DBusAuth               *auth);
00065 dbus_bool_t   _dbus_auth_encode_data         (DBusAuth               *auth,
00066                                               const DBusString       *plaintext,
00067                                               DBusString             *encoded);
00068 dbus_bool_t   _dbus_auth_needs_decoding      (DBusAuth               *auth);
00069 dbus_bool_t   _dbus_auth_decode_data         (DBusAuth               *auth,
00070                                               const DBusString       *encoded,
00071                                               DBusString             *plaintext);
00072 void          _dbus_auth_set_credentials     (DBusAuth               *auth,
00073                                               const DBusCredentials  *credentials);
00074 void          _dbus_auth_get_identity        (DBusAuth               *auth,
00075                                               DBusCredentials        *credentials);
00076 dbus_bool_t   _dbus_auth_set_context         (DBusAuth               *auth,
00077                                               const DBusString       *context);
00078 
00079 
00080 DBUS_END_DECLS;
00081 
00082 #endif /* DBUS_AUTH_H */

Generated on Sun Mar 21 03:52:04 2004 for D-BUS by doxygen 1.3.6-20040222