1.. saslman:: sasl_checkpass(3)
2
3.. _sasl-reference-manpages-library-sasl_checkpass:
4
5===============================================
6**sasl_checkpass** - Check a plaintext password
7===============================================
8
9Synopsis
10========
11
12.. code-block:: C
13
14    #include <sasl/sasl.h>
15
16    int sasl_checkpass(sasl_conn_t *conn,
17                     const char *user,
18                     unsigned userlen,
19                     const char *pass,
20                     unsigned passlen);
21
22Description
23===========
24
25.. c:function:: int sasl_checkpass(sasl_conn_t *conn,
26        const char *user,
27        unsigned userlen,
28        const char *pass,
29        unsigned passlen)
30
31        **sasl_checkpass**  will check a plaintext password. This is
32        needed for protocols that had a login method  before  SASL
33        (for  example  the LOGIN command in IMAP). The password is
34        checked with the pwcheck_method. See :saslman:`sasl_callbacks(3)`  for
35        information on how this parameter is set.
36
37
38Return value
39============
40
41sasl_checkpass returns an integer which corresponds to one
42of the following codes. :c:macro:`SASL_OK` indicates that the authentication  is  complete.  All  other  return codes indicate
43errors and should either be handled or the  authentication
44session  should  be quit.  See :saslman:`sasl_errors(3)` for meanings
45of return codes.
46
47Conforming to
48=============
49
50:rfc:`4422`
51
52See Also
53========
54
55:saslman:`sasl(3)`, :saslman:`sasl_errors(3)`, :saslman:`sasl_callbacks(3)`,
56:saslman:`sasl_setpass(3)`
57