1SASL_CHECKAPOP(3)                 Cyrus SASL                 SASL_CHECKAPOP(3)
2
3
4

NAME

6       sasl_checkapop - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_checkapop(sasl_conn_t *conn,
12                        const char *challenge,
13                        unsigned challen,
14                        const char *response,
15                        unsigned resplen)
16

DESCRIPTION

18       int sasl_checkapop(sasl_conn_t *conn,
19
20       const char *challenge,
21
22       unsigned challen,
23
24       const char *response,
25
26       unsigned resplen)
27              sasl_checkapop   will   check  an APOP challenge/response.  APOP
28              is an optional POP3  (RFC  1939)  authentication  command  which
29              uses   a   shared   secret (password). The password is stored in
30              the SASL secrets  database.   For   information   on  the   SASL
31              shared secrets database see the System Administrators Guide.
32
33              If  called  with  a  NULL challenge, sasl_checkapop() will check
34              to see if the APOP mechanism is enabled.
35

RETURN VALUE

37       sasl_checkapop returns an integer which corresponds to one of the  fol‐
38       lowing  codes.  SASL_OK  indicates that the authentication is complete.
39       All  other  return  codes  indicate errors  and should either  be  han‐
40       dled  or the authentication session should be quit.  See sasl_errors(3)
41       for  meanings of return codes.
42

CONFORMING TO

44       RFC 4422, RFC 1939
45

SEE ALSO

47       sasl(3), sasl_errors(3)
48

AUTHOR

50       The Cyrus Team
51

53       1993-2016, The Cyrus Team
54
55
56
57
582.1.28                         February 18, 2022             SASL_CHECKAPOP(3)
Impressum