Current File : //opt/alt/cyrus-sasl/share/man/man3/sasl_checkapop.3

.\" Man page generated from reStructuredText.
.
.TH "SASL_CHECKAPOP" "3" "November 08, 2018" "2.1.27" "Cyrus SASL"
.SH NAME
sasl_checkapop \- Cyrus SASL documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
.nf
#include <sasl/sasl.h>

int sasl_checkapop(sasl_conn_t *conn,
                 const char *challenge,
                 unsigned challen,
                 const char *response,
                 unsigned resplen)
.fi
.SH DESCRIPTION
.INDENT 0.0
.TP
.B int sasl_checkapop(sasl_conn_t *conn,
.TP
.B const char *challenge,
.TP
.B unsigned challen,
.TP
.B const char *response,
.TP
.B unsigned resplen)
\fBsasl_checkapop\fP  will  check  an APOP challenge/response.
APOP is an optional POP3 (\fI\%RFC 1939\fP) 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\&.
.sp
If  called  with  a  NULL challenge, sasl_checkapop() will
check to see if the APOP mechanism is enabled.
.UNINDENT
.SH RETURN VALUE
.sp
sasl_checkapop returns an integer which corresponds to one
of the following codes. \fBSASL_OK\fP 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)  for  meanings
of return codes.
.SH CONFORMING TO
.sp
\fI\%RFC 4422\fP, \fI\%RFC 1939\fP
.SH SEE ALSO
.sp
sasl(3), sasl_errors(3)
.SH AUTHOR
The Cyrus Team
.SH COPYRIGHT
1993-2016, The Cyrus Team
.\" Generated by docutils manpage writer.
.