man pages section 3: Networking Library Functions

Exit Print View

Updated: July 2014
 
 

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
Availability
system/library/security/libsasl
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.