| wocky Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Prerequisites | ||||
WockyAuthHandler; gboolean (*WockyAuthInitialResponseFunc) (WockyAuthHandler *handler,GString **initial_data,GError **error); gboolean (*WockyAuthAuthDataFunc) (WockyAuthHandler *handler,const GString *data,GString **response,GError **error); gboolean (*WockyAuthSuccessFunc) (WockyAuthHandler *handler,GError **error); void wocky_auth_handler_free (WockyAuthHandler *handler); const gchar * wocky_auth_handler_get_mechanism (WockyAuthHandler *handler); gboolean wocky_auth_handler_is_plain (WockyAuthHandler *handler); gboolean wocky_auth_handler_get_initial_response (WockyAuthHandler *handler,GString **initial_data,GError **error); gboolean wocky_auth_handler_handle_auth_data (WockyAuthHandler *handler,const GString *data,GString **response,GError **error); gboolean wocky_auth_handler_handle_success (WockyAuthHandler *handler,GError **error); WockyAuthHandlerIface;
gboolean (*WockyAuthInitialResponseFunc) (WockyAuthHandler *handler,GString **initial_data,GError **error);
Called when authentication begins, if the mechanism allows a response to an implicit challenge during AUTH initiation (which, in XMPP, corresponds to sending the <auth></auth> stanza to the server).
The function should return TRUE on success and optionally set the initial_data to a string (allocated using g_malloc) if there is initial data to send. On error it should return FALSE and set the error
|
|
|
|
|
|
Returns : |
gboolean (*WockyAuthAuthDataFunc) (WockyAuthHandler *handler,const GString *data,GString **response,GError **error);
|
|
|
|
|
|
|
|
Returns : |
gboolean (*WockyAuthSuccessFunc) (WockyAuthHandler *handler,GError **error);
Called when a <success></success> stanza is received during authentication. If no error is returned, then authentication is considered finished. (Typically, an error is only raised if the <success></success> stanza was received earlier than expected)
|
|
|
|
Returns : |
const gchar * wocky_auth_handler_get_mechanism (WockyAuthHandler *handler);
|
|
Returns : |
gboolean wocky_auth_handler_is_plain (WockyAuthHandler *handler);
|
|
Returns : |
gboolean wocky_auth_handler_get_initial_response (WockyAuthHandler *handler,GString **initial_data,GError **error);
|
|
|
|
|
|
Returns : |
gboolean wocky_auth_handler_handle_auth_data (WockyAuthHandler *handler,const GString *data,GString **response,GError **error);
|
|
|
|
|
|
|
|
Returns : |
gboolean wocky_auth_handler_handle_success (WockyAuthHandler *handler,GError **error);
|
|
|
|
Returns : |
typedef struct {
GTypeInterface parent;
gchar *mechanism;
gboolean plain;
WockyAuthInitialResponseFunc initial_response_func;
WockyAuthAuthDataFunc auth_data_func;
WockyAuthSuccessFunc success_func;
} WockyAuthHandlerIface;
GTypeInterface |
The parent interface. |
gchar * |
The AUTH mechanism which this handler responds to challenges for. |
gboolean |
Whether the mechanism this handler handles sends secrets in plaintext. |
WockyAuthInitialResponseFunc |
Called when the initial <auth></auth> stanza is generated |
WockyAuthAuthDataFunc |
Called when any authentication data from the server is received |
WockyAuthSuccessFunc |
Called when a <success></success> stanza is received. |