man/sasl_errors.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2001 Carnegie Mellon University.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\"
  17 .\" 3. The name "Carnegie Mellon University" must not be used to
  18 .\"    endorse or promote products derived from this software without
  19 .\"    prior written permission. For permission or any other legal
  20 .\"    details, please contact
  21 .\"      Office of Technology Transfer
  22 .\"      Carnegie Mellon University
  23 .\"      5000 Forbes Avenue
  24 .\"      Pittsburgh, PA  15213-3890
  25 .\"      (412) 268-4387, fax: (412) 268-7395
  26 .\"      tech-transfer@andrew.cmu.edu
  27 .\"
  28 .\" 4. Redistributions of any form whatsoever must retain the following
  29 .\"    acknowledgment:
  30 .\"    "This product includes software developed by Computing Services
  31 .\"     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
  32 .\"
  33 .\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  34 .\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  35 .\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  36 .\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  37 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  38 .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  39 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  40 .\"
  41 .TH sasl_errors "10 July 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_errors \- SASL error codes
  44
  45 .SH SYNOPSIS
  46 .nf
  47 .B #include <sasl/sasl.h>
  48
  49 .fi
  50 .SH DESCRIPTION
  51
  52 The following are the general error codes that may be returned by
  53 calls into the SASL library, and their meanings (that may vary
  54 slightly based on context):
  55
  56 .SH Common Result Codes
  57 .TP 0.8i
  58 SASL_OK
  59 Success
  60 .TP 0.8i
  61 SASL_CONTINUE
  62 Another step is needed in authentication
  63 .TP 0.8i
  64 SASL_FAIL
  65 Generic Failure
  66 .TP 0.8i
  67 SASL_NOMEM
  68 Memory shortage failure
  69 .TP 0.8i
  70 SASL_BUFOVER
  71 Overflowed buffer
  72 .TP 0.8i
  73 SASL_NOMECH
  74 Mechanism not supported / No mechanisms matched requirements
  75 .TP 0.8i
  76 SASL_BADPROT
  77 Bad / Invalid Protocol or Protocol cancel
  78 .TP 0.8i
  79 SASL_NOTDONE
  80 Can't request information / Not applicable until later in exchange
  81 .TP 0.8i
  82 SASL_BADPARAM
  83 Invalid Parameter Supplied
  84 .TP 0.8i
  85 SASL_TRYAGAIN
  86 Transient Failure (e.g. weak key)
  87 .TP 0.8i
  88 SASL_BADMAC
  89 Integrity Check Failed
  90 .TP 0.8i
  91 SASL_NOTINIT
  92 SASL library not initialized
  93
  94 .SH Client-only Result Codes
  95 .TP 0.8i
  96 SASL_INTERACT
  97 Needs user interaction
  98 .TP 0.8i
  99 SASL_BADSERV
 100 Server failed mutual authentication step
 101 .TP 0.8i
 102 SASL_WRONGMECH
 103 Mechanism does not support requested feature
 104
 105 .SH Server-only Result Codes
 106 .TP 0.8i
 107 SASL_BADAUTH
 108 Authentication Failure
 109 .TP 0.8i
 110 SASL_NOAUTHZ
 111 Authorization Failure
 112 .TP 0.8i
 113 SASL_TOOWEAK
 114 Mechanism too weak for this user
 115 .TP 0.8i
 116 SASL_ENCRYPT
 117 Encryption needed to use mechanism
 118 .TP 0.8i
 119 SASL_TRANS
 120 One time use of a plaintext password will enable requested mechanism for user
 121 .TP 0.8i
 122 SASL_EXPIRED
 123 Passphrase expired, must be reset
 124 .TP 0.8i
 125 SASL_DISABLED
 126 Account Disabled
 127 .TP 0.8i
 128 SASL_NOUSER
 129 User Not Found
 130 .TP 0.8i
 131 SASL_BADVERS
 132 Version mismatch with plug-in
 133 .TP 0.8i
 134 SASL_NOVERIFY
 135 USer exists, but no verifier for user
 136
 137 .SH Password Setting Result Codes
 138 .TP 0.8i
 139 SASL_PWLOCK
 140 Passphrase locked
 141 .TP 0.8i
 142 SASL_NOCHANGE
 143 Requested change was not needed
 144 .TP 0.8i
 145 SASL_WEAKPASS
 146 Passphrase is too week for security policy.
 147 .TP 0.8i
 148 SASL_NOUSERPASS
 149 User supplied passwords are not permitted
 150
 151 .SH "CONFORMING TO"
 152 RFC 2222
 153
 154 .SH "SEE ALSO"
 155 sasl(3)