tech-userlevel archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

RFC: SASL client library - API



Hello,

 I'm going to work with christos@ and agc@ on the SASL client library during the
Google Summer of Code, more detailed information about the project is avaiable
at [1]. Below I present draft of the API, I'd really appreciate yours comments
or suggestions on my proposal.

*snip*
NAME
     saslc_create, saslc_configure, saslc_getprop, saslc_setprop, saslc_cont,
     saslc_destroy, saslc_geterror â SASL client library

LIBRARY
     library âlibsaslcâ

SYNOPSIS
     #include <saslc.h>

     saslc_session_t
     saslc_create(void);

     int
     saslc_configure(saslc_session_t *sess, const char *mechs,
         const char *configuration);

     void *
     saslc_getprop(const saslc_session_t *sess, const char *attr);

     int
     saslc_setprop(saslc_session_t *sess, const char *attr, const void *var);

     int
     saslc_cont(saslc_session_t *sess, const void *in, const size_t inlen,
         void **out, size_t *outlen);

     void
     saslc_destroy(saslc_session_t *sess);

     const char *
     saslc_geterror(const saslc_session_t *sess);

DESCRIPTION
     The saslc_create() function creates a new SASL session. Function returns
     a pointer to a new session, or NULL if there was error.

     The saslc_configure() function configures sess to use one of the mechaâ
     nisms listed in mechs string which consists of a comma separated list of
     mechanism names.  Configuration options are defined in the configuration
     file, or NULL for the default settings. It returns 0 on success and -1 on
     failure.

     The saslc_getattr() function gets a property from the session. It returns
     pointer to a property on success, or NULL on failure.

     The saslc_setattr() function sets a property in the session. It returns 0
     on success and -1 on failure.

     The saslc_cont() function performs one step of the SASL authentication


Home | Main Index | Thread Index | Old Index