sasl_checkapop(3) [osx man page]

sasl_checkapop(29 June 2001)											      sasl_checkapop(29 June 2001)

NAME

       sasl_checkapop - Check an APOP challenge/response

SYNOPSIS

       #include <sasl/sasl.h>

       int sasl_checkapop(sasl_conn_t *conn,
			const char *challenge,
			unsigned challen,
			const char *response,
			unsigned resplen);

DESCRIPTION

       sasl_checkapop()  will  check  an  APOP challenge/response.  APOP is an optional POP3 (RFC 1939) authentication command which uses a shared
       secret (password). The password is stored in the SASL secrets database.	For information on the SASL shared secrets database see the System
       Administrators Guide in the doc/ directory of the SASL distribution.

       If called with a NULL challenge, sasl_checkapop() will check to see if the APOP mechanism is enabled.

RETURN VALUE

       sasl_checkapop  returns	an integer which corresponds to one of the following codes. SASL_OK indicates that the authentication is complete.
       All other return codes indicate errors and should either be handled or the authentication session should be quit.  See  sasl_errors(3)  for
       meanings of return codes.

CONFORMING TO

       RFC 2222, RFC 1939

SEE ALSO

       sasl(3), sasl_errors(3)

SASL man pages							       SASL					      sasl_checkapop(29 June 2001)

sasl_checkapop(3SASL)			      Simple Authentication Security Layer Library Functions			     sasl_checkapop(3SASL)

NAME

       sasl_checkapop - check an APOP challenge or response

SYNOPSIS

       cc [ flag ... ] file ... -lsasl	 [ library ... ]
       #include <sasl/sasl.h>

       int sasl_checkapop(sasl_conn_t *conn, const char *challenge,
	    unsigned challen, const char *response, unsigned resplen);

DESCRIPTION

       The  sasl_checkapop()  interface  checks  an  APOP  challenge or response. APOP is an option POP3 authentication command that uses a shared
       secret password. See RFC 1939.

       If sasl_checkapop() is called with a NULL challenge, sasl_checkapop() will check to see if the APOP mechanism is enabled.

PARAMETERS

       conn	    The sasl_conn_t for which the request is being made

       challenge    The challenge sent to the client

       challen	    The length of challenge

       response     The client response

       resplens     The length of response

RETURN VALUES

       sasl_checkapop() returns an integer that corresponds to a SASL error code.

ERRORS

       SASL_OK	  Indicates that the authentication is complete

       All other  error  codes	indicate  an  error  situation	that  must  be	handled,  or  the  authentication  session  should  be	quit.  See
       sasl_errors(3SASL) for information on SASL error codes.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |SUNWlibsasl		   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Obsolete			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       sasl_errors(3SASL), attributes(5)

       Meyers, J. and Rose, M. RFC 1939, Post Office Protocol - Version 3. Network Working Group. May 1996.

SunOS 5.11							    14 Oct 2003 					     sasl_checkapop(3SASL)