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

.\" Man page generated from reStructuredText.
.
.TH "SASL_ERRORS" "3" "November 08, 2018" "2.1.27" "Cyrus SASL"
.SH NAME
sasl_errors \- 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>
.fi
.SH DESCRIPTION
.sp
The  following  are  the  general  error codes that may be
returned by calls into the SASL library, and  their  meanings (that may vary slightly based on context).
.SS Common Result Codes
.INDENT 0.0
.TP
.B SASL_OK
Success
.UNINDENT
.INDENT 0.0
.TP
.B SASL_CONTINUE
Another step is needed in authentication
.UNINDENT
.INDENT 0.0
.TP
.B SASL_FAIL
Generic Failure
.UNINDENT
.INDENT 0.0
.TP
.B SASL_NOMEM
Memory shortage failure
.UNINDENT
.INDENT 0.0
.TP
.B SASL_BUFOVER
Overflowed buffer
.UNINDENT
.INDENT 0.0
.TP
.B SASL_NOMECH
Mechanism  not  supported  / No mechanisms matched
requirements
.UNINDENT
.INDENT 0.0
.TP
.B SASL_BADPROT
Bad / Invalid Protocol or Protocol cancel
.UNINDENT
.INDENT 0.0
.TP
.B SASL_NOTDONE
Cannot request information / Not  applicable  until
later in exchange
.UNINDENT
.INDENT 0.0
.TP
.B SASL_BADPARAM
Invalid Parameter Supplied
.UNINDENT
.INDENT 0.0
.TP
.B SASL_TRYAGAIN
Transient Failure (e.g. weak key)
.UNINDENT
.INDENT 0.0
.TP
.B SASL_BADMAC
Integrity Check Failed
.UNINDENT
.INDENT 0.0
.TP
.B SASL_NOTINIT
SASL library not initialized
.UNINDENT
.SS Client\-only Result Codes
.INDENT 0.0
.TP
.B SASL_INTERACT
Needs user interaction
.UNINDENT
.INDENT 0.0
.TP
.B SASL_BADSERV
Server failed mutual authentication step
.UNINDENT
.INDENT 0.0
.TP
.B SASL_WRONGMECH
Mechanism does not support requested feature
.UNINDENT
.SS Server\-only Result Codes
.INDENT 0.0
.TP
.B SASL_BADAUTH
Authentication Failure
.UNINDENT
.INDENT 0.0
.TP
.B SASL_NOAUTHZ
Authorization Failure
.UNINDENT
.INDENT 0.0
.TP
.B SASL_TOOWEAK
Mechanism too weak for this user
.UNINDENT
.INDENT 0.0
.TP
.B SASL_ENCRYPT
Encryption needed to use mechanism
.UNINDENT
.INDENT 0.0
.TP
.B SASL_TRANS
One  time  use of a plaintext password will enable
requested mechanism for user
.UNINDENT
.INDENT 0.0
.TP
.B SASL_EXPIRED
Passphrase expired, must be reset
.UNINDENT
.INDENT 0.0
.TP
.B SASL_DISABLED
Account Disabled
.UNINDENT
.INDENT 0.0
.TP
.B SASL_NOUSER
User Not Found
.UNINDENT
.INDENT 0.0
.TP
.B SASL_BADVERS
Version mismatch with plug\-in
.UNINDENT
.INDENT 0.0
.TP
.B SASL_NOVERIFY
User exists, but no verifier for user
.UNINDENT
.SS Password Setting Result Codes
.INDENT 0.0
.TP
.B SASL_PWLOCK
Passphrase locked
.UNINDENT
.INDENT 0.0
.TP
.B SASL_NOCHANGE
Requested change was not needed
.UNINDENT
.INDENT 0.0
.TP
.B SASL_WEAKPASS
Passphrase is too week for security policy.
.UNINDENT
.INDENT 0.0
.TP
.B SASL_NOUSERPASS
User supplied passwords are not permitted
.UNINDENT
.SH CONFORMING TO
.sp
\fI\%RFC 4422\fP
.SH SEE ALSO
.sp
sasl(3)
.SH AUTHOR
The Cyrus Team
.SH COPYRIGHT
1993-2016, The Cyrus Team
.\" Generated by docutils manpage writer.
.