1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
|
.. saslman:: sasl_checkapop(3)
.. _sasl-reference-manpages-library-sasl_checkapop:
=====================================================
**sasl_checkapop** - Check an APOP challenge/response
=====================================================
Synopsis
========
.. code-block:: C
#include <sasl/sasl.h>
int sasl_checkapop(sasl_conn_t *conn,
const char *challenge,
unsigned challen,
const char *response,
unsigned resplen)
Description
===========
.. c:function:: int sasl_checkapop(sasl_conn_t *conn,
const char *challenge,
unsigned challen,
const char *response,
unsigned resplen)
**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 :ref:`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. :c:macro:`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 :saslman:`sasl_errors(3)` for meanings
of return codes.
Conforming to
=============
:rfc:`4422`, :rfc:`1939`
See Also
========
:saslman:`sasl(3)`, :saslman:`sasl_errors(3)`
|