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

.\" Man page generated from reStructuredText.
.
.TH "SASL_CHECKPASS" "3" "November 08, 2018" "2.1.27" "Cyrus SASL"
.SH NAME
sasl_checkpass \- 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_checkpass(sasl_conn_t *conn,
                 const char *user,
                 unsigned userlen,
                 const char *pass,
                 unsigned passlen);
.fi
.SH DESCRIPTION
.INDENT 0.0
.TP
.B int sasl_checkpass(sasl_conn_t *conn,
.TP
.B const char *user,
.TP
.B unsigned userlen,
.TP
.B const char *pass,
.TP
.B unsigned passlen)
\fBsasl_checkpass\fP  will check a plaintext password. This is
needed for protocols that had a login method  before  SASL
(for  example  the LOGIN command in IMAP). The password is
checked with the pwcheck_method. See sasl_callbacks(3)  for
information on how this parameter is set.
.UNINDENT
.SH RETURN VALUE
.sp
sasl_checkpass 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
.SH SEE ALSO
.sp
sasl(3), sasl_errors(3), sasl_callbacks(3),
sasl_setpass(3)
.SH AUTHOR
The Cyrus Team
.SH COPYRIGHT
1993-2016, The Cyrus Team
.\" Generated by docutils manpage writer.
.