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

.\" Man page generated from reStructuredText.
.
.TH "SASL_SETPASS" "3" "November 08, 2018" "2.1.27" "Cyrus SASL"
.SH NAME
sasl_setpass \- 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_setpass(sasl_conn_t *conn,
                 const char *user,
                 const char *pass, unsigned passlen,
                  const char *oldpass, unsigned oldpasslen,
                  unsigned flags)
.fi
.SH DESCRIPTION
.INDENT 0.0
.TP
.B int sasl_setpass(sasl_conn_t *conn,
.TP
.B const char *user,
.TP
.B const char *pass, unsigned passlen,
.TP
.B const char *oldpass, unsigned oldpasslen,
.TP
.B unsigned flags)
\fBsasl_setpass\fP will set passwords in the sasldb, and trigger the setpass
callbacks for all available mechanisms.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconn\fP – is the SASL connection context
.IP \(bu 2
\fBuser\fP – is the username to set the password for
.IP \(bu 2
\fBpass\fP – the password to set
.IP \(bu 2
\fBpasslen\fP – length of the password to set (\fIpass\fP)
.IP \(bu 2
\fBoldpass\fP – optional. The old password.
.IP \(bu 2
\fBoldpasslen\fP – optional. The old password length.
.IP \(bu 2
\fBflags\fP – 
.sp
are flags including \fISASL_SET_CREATE\fP and
\fISASL_SET_DISABLE\fP (to cause the creating of nonexistent accounts and the
disabling of an account, respectively)
.sp
\fIoldpass\fP and \fIoldpasslen\fP are unused in the Cyrus SASL implementation, though
are passed on to any mechanisms that may require them.

.UNINDENT
.UNINDENT
.UNINDENT
.SH RETURN VALUE
.sp
SASL  callback  functions should return SASL return codes.
See sasl.h for a complete list. \fBSASL_OK\fP indicates success.
.sp
Other return codes indicate errors and should be handled.
.SH SEE ALSO
.sp
\fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_errors(3),
sasl_checkpass(3)
.SH AUTHOR
The Cyrus Team
.SH COPYRIGHT
1993-2016, The Cyrus Team
.\" Generated by docutils manpage writer.
.