sasl_mech.h

Go to the documentation of this file.

#ifndef JABBERWERX_SASL_MECH_H
#define JABBERWERX_SASL_MECH_H

#include "util/htable.h"
#include "dom.h"


typedef enum
{
    JW_SASL_ERR_NONE                   =  0,
    JW_SASL_ERR_ABORTED                =  1,
    JW_SASL_ERR_ACCOUNT_DISABLED       =  2,
    JW_SASL_ERR_CREDENTIALS_EXPIRED    =  3,
    JW_SASL_ERR_ENCRYPTION_REQUIRED    =  4,
    JW_SASL_ERR_INCORRECT_ENCODING     =  5,
    JW_SASL_ERR_INVALID_AUTHZID        =  6,
    JW_SASL_ERR_INVALID_MECHANISM      =  7,
    JW_SASL_ERR_MALFORMED_REQUEST      =  8,
    JW_SASL_ERR_MECHANISM_TOO_WEAK     =  9,
    JW_SASL_ERR_NOT_AUTHORIZED         = 10,
    JW_SASL_ERR_TEMPORARY_AUTH_FAILURE = 11
} jw_sasl_error;

typedef struct _jw_sasl_mech jw_sasl_mech;

typedef struct _jw_sasl_mech_instance jw_sasl_mech_instance;

typedef bool (*jw_sasl_mech_init_fn)(
                        jw_sasl_mech_instance *instance,
                        jw_htable             *config,
                        jw_err                *err);

typedef void (*jw_sasl_mech_clean_fn)(jw_sasl_mech_instance *instance);

typedef void (*jw_sasl_mech_evaluate_complete_fn)(
                        jw_sasl_mech_instance *instance,
                        jw_dom_node           *out_auth_node,
                        bool                   done,
                        jw_sasl_error          sasl_err,
                        void                  *arg);

typedef void (*jw_sasl_mech_cdata_evaluate_complete_fn)(
                        jw_sasl_mech_instance *instance,
                        uint8_t               *out,
                        size_t                 out_len,
                        bool                   needs_base64_encoding,
                        bool                   done,
                        jw_sasl_error          sasl_err);

typedef bool (*jw_sasl_mech_cdata_evaluate_fn)(
                        jw_sasl_mech_instance                  *instance,
                        uint8_t                                *in,
                        size_t                                  in_len,
                        jw_sasl_mech_cdata_evaluate_complete_fn cb,
                        jw_err                                 *err);

typedef struct _jw_sasl_mech_fn_table
{
    jw_sasl_mech_init_fn init_fn;
    jw_sasl_mech_clean_fn clean_fn;
    jw_sasl_mech_cdata_evaluate_fn evaluate_start_fn;
    jw_sasl_mech_cdata_evaluate_fn evaluate_step_fn;
} jw_sasl_mech_fn_table;


#ifdef __cplusplus
extern "C"
{
#endif

JABBERWERX_API bool jw_sasl_mech_create(
                        const char            *name,
                        jw_sasl_mech_fn_table *fn_table,
                        jw_sasl_mech         **mech,
                        jw_err                *err);

JABBERWERX_API bool jw_sasl_mech_plain_create(jw_htable     *config,
                                              jw_sasl_mech **mech,
                                              jw_err        *err);

JABBERWERX_API bool jw_sasl_mech_external_create(jw_htable     *config,
                                                 jw_sasl_mech **mech,
                                                 jw_err        *err);

JABBERWERX_API bool jw_sasl_mech_copy(jw_sasl_mech  *mech,
                                      jw_sasl_mech **copy,
                                      jw_err        *err);

JABBERWERX_API void jw_sasl_mech_destroy(jw_sasl_mech *mech);

JABBERWERX_API const char* jw_sasl_mech_get_name(jw_sasl_mech *mech);


JABBERWERX_API bool jw_sasl_mech_instance_create(
                        jw_htable              *config,
                        jw_sasl_mech           *mech,
                        jw_sasl_mech_instance **instance,
                        jw_err                 *err);

JABBERWERX_API void jw_sasl_mech_instance_destroy(
                        jw_sasl_mech_instance *instance);

JABBERWERX_API bool jw_sasl_mech_instance_evaluate(
                        jw_sasl_mech_instance            *instance,
                        jw_dom_node                      *in_auth_node,
                        jw_sasl_mech_evaluate_complete_fn cb,
                        void                             *arg,
                        jw_err                           *err);

JABBERWERX_API jw_sasl_mech *jw_sasl_mech_instance_get_mech(
                        jw_sasl_mech_instance *instance);

JABBERWERX_API void jw_sasl_mech_instance_set_data(
                        jw_sasl_mech_instance *instance, void *data);

JABBERWERX_API void* jw_sasl_mech_instance_get_data(
                        jw_sasl_mech_instance *instance);

#ifdef __cplusplus
}
#endif

#endif /* JABBERWERX_SASL_MECH_H */