Scroll to navigation

SASL_CHECKAPOP(3) Cyrus SASL SASL_CHECKAPOP(3)

NAME

sasl_checkapop - Cyrus SASL documentation

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 <https://datatracker.ietf.org/doc/html/rfc1939.html>) 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 <#sysadmin>.

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 <#c.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) <#std-saslman-sasl_errors-3> for meanings of return codes.

CONFORMING TO

RFC 4422 <https://datatracker.ietf.org/doc/html/rfc4422.html>, RFC 1939 <https://datatracker.ietf.org/doc/html/rfc1939.html>

SEE ALSO

sasl(3) <#std-saslman-sasl-3>, sasl_errors(3) <#std-saslman-sasl_errors-3>

Author

The Cyrus Team

Copyright

1993-2016, The Cyrus Team

2026-04-04 2.1.28