X-Git-Url: https://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/8d138742ae268344f406cb75d79aa6bf853f9d87..refs/tags/upstream/0.66.1:/auth_sasl.html diff --git a/auth_sasl.html b/auth_sasl.html index 2826e10..4b56a60 100644 --- a/auth_sasl.html +++ b/auth_sasl.html @@ -1,19 +1,19 @@ -auth_sasl

Name

auth_sasl, auth_sasl_ex — SASL implementation

Synopsis


+-->

Name

auth_sasl, auth_sasl_ex — SASL implementation

Synopsis


#include <courierauthsasl.h>
-

int rc=auth_sasl(const char * method,
 const char * initialresponse,
 char * (*conversation_func)(const char *, void *)),
 void * callback_arg,
 char ** authtype_ret,
 char ** authdata_ret);
int rc=auth_sasl_ex(const char * method,
 const char * initialresponse,
 const char * externalauth,
 char * (*conversation_func)(const char *, void *)),
 void * callback_arg,
 char ** authtype_ret,
 char ** authdata_ret);

DESCRIPTION

+

int rc=auth_sasl(const char *method,
 const char *initialresponse,
 char *(*conversation_func)(const char *, void *)),
 void *callback_arg,
 char **authtype_ret,
 char **authdata_ret);
 
int rc=auth_sasl_ex(const char *method,
 const char *initialresponse,
 const char *externalauth,
 char *(*conversation_func)(const char *, void *)),
 void *callback_arg,
 char **authtype_ret,
 char **authdata_ret);
 

DESCRIPTION

auth_sasl is a generic SASL server implementation. method is the requested SASL method. At this time auth_sasl -knows how to handle the following SASL methods:

  • LOGIN

  • PLAIN

  • CRAM-MD5

  • CRAM-SHA1

+knows how to handle the following SASL methods:

  • LOGIN

  • PLAIN

  • CRAM-MD5

  • CRAM-SHA1

initialresponse is a base64-encoded initial response provided in the client's SASL request. @@ -54,7 +54,7 @@ ignored. Otherwise, if method is *authdata_ret accordingly, so that the subsequent invocation of auth_generic() returns authentication information for the login ID specified by -externalauth.

RETURNS

+externalauth.

RETURNS

If the SASL conversation succesfully completes, auth_sasl or auth_sasl_ex initializes *authtype_ret and @@ -73,10 +73,10 @@ returns *authtype_ret and *authdata_ret are succesfully assembled. Any other return indicates an error condition. -Right now two error conditions are defined:

AUTHSASL_ABORTED

+Right now two error conditions are defined:

AUTHSASL_ABORTED

The SASL conversation was aborted by the client.

AUTHSASL_ERROR

General error (insufficient memory, or some other reason). -Check errno for any clues.

SEE ALSO

+Check errno for any clues.