Main Page   Modules   Data Structures   File List   Data Fields   Related Pages  

Authentication implementation details
[D-BUS internal implementation details]

DBusAuth implementation details. More...

Data Structures

struct  DBusAuth
 Internal members of DBusAuth. More...

struct  DBusAuthClient
 "Subclass" of DBusAuth for client side. More...

struct  DBusAuthCommandName
 Mapping from command name to enum. More...

struct  DBusAuthMechanismHandler
 Virtual table representing a particular auth mechanism. More...

struct  DBusAuthServer
 "Subclass" of DBusAuth for server side. More...

struct  DBusAuthStateData
 Information about a auth state. More...


Defines

#define DBUS_AUTH_IS_SERVER(auth)   ((auth)->side == auth_side_server)
#define DBUS_AUTH_IS_CLIENT(auth)   ((auth)->side == auth_side_client)
#define DBUS_AUTH_CLIENT(auth)   ((DBusAuthClient*)(auth))
#define DBUS_AUTH_SERVER(auth)   ((DBusAuthServer*)(auth))
#define DBUS_AUTH_NAME(auth)   ((auth)->side)
 The name of the auth ("client" or "server"). More...

#define N_CHALLENGE_BYTES   (128/8)
 http://www.ietf.org/rfc/rfc2831.txt suggests at least 64 bits of entropy, we use 128. More...


Typedefs

typedef dbus_bool_t(* DBusInitialResponseFunction )(DBusAuth *auth, DBusString *response)
 This function appends an initial client response to the given string.

typedef dbus_bool_t(* DBusAuthDataFunction )(DBusAuth *auth, const DBusString *data)
 This function processes a block of data received from the peer. More...

typedef dbus_bool_t(* DBusAuthEncodeFunction )(DBusAuth *auth, const DBusString *data, DBusString *encoded)
 This function encodes a block of data from the peer.

typedef dbus_bool_t(* DBusAuthDecodeFunction )(DBusAuth *auth, const DBusString *data, DBusString *decoded)
 This function decodes a block of data from the peer.

typedef void(* DBusAuthShutdownFunction )(DBusAuth *auth)
 This function is called when the mechanism is abandoned.

typedef dbus_bool_t(* DBusAuthStateFunction )(DBusAuth *auth, DBusAuthCommand command, const DBusString *args)
 Auth state function, determines the reaction to incoming events for a particular state. More...


Enumerations

enum  DBusAuthCommand {
  DBUS_AUTH_COMMAND_AUTH, DBUS_AUTH_COMMAND_CANCEL, DBUS_AUTH_COMMAND_DATA, DBUS_AUTH_COMMAND_BEGIN,
  DBUS_AUTH_COMMAND_REJECTED, DBUS_AUTH_COMMAND_OK, DBUS_AUTH_COMMAND_ERROR, DBUS_AUTH_COMMAND_UNKNOWN
}
 Enumeration for the known authentication commands.


Detailed Description

DBusAuth implementation details.

Private details of authentication code.


Define Documentation

#define DBUS_AUTH_CLIENT auth       ((DBusAuthClient*)(auth))
 

Parameters:
auth  the auth conversation
Returns:
auth cast to DBusAuthClient

Definition at line 308 of file dbus-auth.c.

#define DBUS_AUTH_IS_CLIENT auth       ((auth)->side == auth_side_client)
 

Parameters:
auth  the auth conversation
Returns:
TRUE if the conversation is the client side

Definition at line 303 of file dbus-auth.c.

#define DBUS_AUTH_IS_SERVER auth       ((auth)->side == auth_side_server)
 

Parameters:
auth  the auth conversation
Returns:
TRUE if the conversation is the server side

Definition at line 298 of file dbus-auth.c.

#define DBUS_AUTH_NAME auth       ((auth)->side)
 

The name of the auth ("client" or "server").

Parameters:
auth  the auth conversation
Returns:
a string

Definition at line 320 of file dbus-auth.c.

#define DBUS_AUTH_SERVER auth       ((DBusAuthServer*)(auth))
 

Parameters:
auth  the auth conversation
Returns:
auth cast to DBusAuthServer

Definition at line 313 of file dbus-auth.c.

#define N_CHALLENGE_BYTES   (128/8)
 

http://www.ietf.org/rfc/rfc2831.txt suggests at least 64 bits of entropy, we use 128.

This is the number of bytes in the random challenge.

Definition at line 479 of file dbus-auth.c.


Typedef Documentation

typedef dbus_bool_t(* DBusAuthDataFunction)(DBusAuth *auth, const DBusString *data)
 

This function processes a block of data received from the peer.

i.e. handles a DATA command.

Definition at line 78 of file dbus-auth.c.

typedef dbus_bool_t(* DBusAuthStateFunction)(DBusAuth *auth, DBusAuthCommand command, const DBusString *args)
 

Auth state function, determines the reaction to incoming events for a particular state.

Returns whether we had enough memory to complete the operation.

Definition at line 136 of file dbus-auth.c.


Generated on Wed Jun 9 05:01:27 2004 for D-BUS by doxygen1.2.15