.\" -*- nroff -*-
.\" 
.\" Copyright (c) 2001 Carnegie Mellon University.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer. 
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" 3. The name "Carnegie Mellon University" must not be used to
.\"    endorse or promote products derived from this software without
.\"    prior written permission. For permission or any other legal
.\"    details, please contact  
.\"      Office of Technology Transfer
.\"      Carnegie Mellon University
.\"      5000 Forbes Avenue
.\"      Pittsburgh, PA  15213-3890
.\"      (412) 268-4387, fax: (412) 268-7395
.\"      tech-transfer@andrew.cmu.edu
.\"
.\" 4. Redistributions of any form whatsoever must retain the following
.\"    acknowledgment:
.\"    "This product includes software developed by Computing Services
.\"     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
.\"
.\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
.\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
.\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
.\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
.\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
.\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\" 
.TH sasl_errors 3 "10 July 2001" SASL "SASL man pages"
.SH NAME
sasl_errors \- SASL error codes

.SH SYNOPSIS
.nf
.B #include <sasl/sasl.h>

.fi
.SH DESCRIPTION

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):

.SH Common Result Codes
.TP 0.8i
SASL_OK
Success
.TP 0.8i
SASL_CONTINUE
Another step is needed in authentication
.TP 0.8i
SASL_FAIL
Generic Failure
.TP 0.8i
SASL_NOMEM
Memory shortage failure
.TP 0.8i
SASL_BUFOVER
Overflowed buffer
.TP 0.8i
SASL_NOMECH
Mechanism not supported / No mechanisms matched requirements
.TP 0.8i
SASL_BADPROT
Bad / Invalid Protocol or Protocol cancel
.TP 0.8i
SASL_NOTDONE
Can't request information / Not applicable until later in exchange
.TP 0.8i
SASL_BADPARAM
Invalid Parameter Supplied
.TP 0.8i
SASL_TRYAGAIN
Transient Failure (e.g. weak key)
.TP 0.8i
SASL_BADMAC
Integrity Check Failed
.TP 0.8i
SASL_NOTINIT
SASL library not initialized

.SH Client-only Result Codes
.TP 0.8i
SASL_INTERACT
Needs user interaction
.TP 0.8i
SASL_BADSERV
Server failed mutual authentication step
.TP 0.8i
SASL_WRONGMECH
Mechanism does not support requested feature

.SH Server-only Result Codes
.TP 0.8i
SASL_BADAUTH
Authentication Failure
.TP 0.8i
SASL_NOAUTHZ
Authorization Failure
.TP 0.8i
SASL_TOOWEAK
Mechanism too weak for this user
.TP 0.8i
SASL_ENCRYPT
Encryption needed to use mechanism
.TP 0.8i
SASL_TRANS
One time use of a plaintext password will enable requested mechanism for user
.TP 0.8i
SASL_EXPIRED
Passphrase expired, must be reset
.TP 0.8i
SASL_DISABLED
Account Disabled
.TP 0.8i
SASL_NOUSER
User Not Found 
.TP 0.8i
SASL_BADVERS
Version mismatch with plug-in
.TP 0.8i
SASL_NOVERIFY
USer exists, but no verifier for user

.SH Password Setting Result Codes
.TP 0.8i
SASL_PWLOCK
Passphrase locked
.TP 0.8i
SASL_NOCHANGE
Requested change was not needed
.TP 0.8i
SASL_WEAKPASS
Passphrase is too week for security policy.
.TP 0.8i
SASL_NOUSERPASS
User supplied passwords are not permitted

.SH "CONFORMING TO"
RFC 4422

.SH "SEE ALSO"
sasl(3)