usr/src/man/man3sasl/sasl_checkpass.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_CHECKPASS 3SASL "Oct 14, 2003"
   9 .SH NAME
  10 sasl_checkpass \- check a plaintext password
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBint\fR \fBsasl_checkpass\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst char *\fR\fIuser\fR, \fBunsigned\fR \fIuserlen\fR,
  18      \fBconst char *\fR\fIpass\fR, \fBunsigned\fR \fIpasslen\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBsasl_checkpass()\fR interface checks a plaintext password. The
  25 \fBsasl_checkpass()\fR interface is used for protocols that had a login method
  26 before SASL, for example, the \fBLOGIN\fR command in IMAP. The password is
  27 checked with the \fBpwcheck_method\fR.
  28 .sp
  29 .LP
  30 The \fBsasl_checkpass()\fR interface is a server interface. You cannot use it
  31 to check passwords from a client.
  32 .sp
  33 .LP
  34 The \fBsasl_checkpass()\fR interface checks the posible repositories until it
  35 succeeds or there are no more repositories. If
  36 \fBsasl_server_userdb_checkpass_t\fR is registered, \fBsasl_checkpass()\fR
  37 tries it first.
  38 .sp
  39 .LP
  40 Use the \fBpwcheck_method\fR SASL option to specify which \fBpwcheck\fR methods
  41 to use.
  42 .sp
  43 .LP
  44 The \fBsasl_checkpass()\fR interface supports the transition of passwords if
  45 the SASL option \fBauto_transition\fR is on.
  46 .sp
  47 .LP
  48 If \fIuser\fR is \fINULL\fR, check is plaintext passwords are enabled.
  49 .SH PARAMETERS
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fIconn\fR\fR
  54 .ad
  55 .RS 11n
  56 The \fBsasl_conn_t\fR for which the request is being made
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIpass\fR\fR
  63 .ad
  64 .RS 11n
  65 Plaintext password to check
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fIpasslen\fR\fR
  72 .ad
  73 .RS 11n
  74 The length of \fIpass\fR
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fIuser\fR\fR
  81 .ad
  82 .RS 11n
  83 User to query in current \fBuser_domain\fR
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fIuserlen\fR\fR
  90 .ad
  91 .RS 11n
  92 The length of username.
  93 .RE
  94
  95 .SH RETURN VALUES
  96 .sp
  97 .LP
  98 \fBsasl_checkpass()\fR returns an integer that corresponds to a SASL error
  99 code.
 100 .SH ERRORS
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBSASL_OK\fR\fR
 105 .ad
 106 .RS 11n
 107 Indicates that the authentication is complete
 108 .RE
 109
 110 .sp
 111 .LP
 112 All other error codes indicate an error situation that must be handled, or the
 113 authentication session should be quit. See \fBsasl_errors\fR(3SASL) for
 114 information on SASL error codes.
 115 .SH ATTRIBUTES
 116 .sp
 117 .LP
 118 See \fBattributes\fR(5) for descriptions of the following attributes:
 119 .sp
 120
 121 .sp
 122 .TS
 123 box;
 124 c | c
 125 l | l .
 126 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 127 _
 128 Interface Stability     Evolving
 129 _
 130 MT-Level        Safe
 131 .TE
 132
 133 .SH SEE ALSO
 134 .sp
 135 .LP
 136 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)