usr/src/man/man3sasl/sasl_server_userdb_checkpass_t.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_SERVER_USERDB_CHECKPASS_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_server_userdb_checkpass_t \- plaintext password verification callback
  11 function
  12 .SH SYNOPSIS
  13 .LP
  14 .nf
  15 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  16 #include <sasl/sasl.h>
  17
  18 \fBint\fR \fBsasl_sasl_server_userdb_checkpass_t\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBvoid *\fR\fIcontext\fR,
  19      \fBconst char *\fR\fIuser\fR, \fBconst char *\fR\fIpass\fR, \fBunsigned\fR \fIpasslen\fR, \fBstruct propctx *\fR\fIpropctx\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 Use the \fBsasl_sasl_server_userdb_checkpass_t()\fR callback function to verify
  26 a plaintext password against the callback supplier's user database.
  27 Verification allows additional ways to encode the \fBuserPassword\fR property.
  28 .SH PARAMETERS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIconn\fR\fR
  33 .ad
  34 .RS 11n
  35 The SASL connection context.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIcontext\fR\fR
  42 .ad
  43 .RS 11n
  44 The context from the callback record.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIuser\fR\fR
  51 .ad
  52 .RS 11n
  53 A null-terminated user name with \fBuser@realm\fR syntax.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIpass\fR\fR
  60 .ad
  61 .RS 11n
  62 The password to check. This string cannot be null-terminated.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fIpasslen\fR\fR
  69 .ad
  70 .RS 11n
  71 The length of \fIpass\fR.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fIpropctx\fR\fR
  78 .ad
  79 .RS 11n
  80 The property context to fill in with \fBuserPassword\fR.
  81 .RE
  82
  83 .SH RETURN VALUES
  84 .sp
  85 .LP
  86 Like other SASL callback functions, \fBsasl_server_userdb_checkpass_t()\fR
  87 returns an integer that corresponds to a SASL error code. See <\fBsasl.h\fR>
  88 for a complete list of SASL error codes.
  89 .SH ERRORS
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBSASL_OK\fR\fR
  94 .ad
  95 .RS 11n
  96 The call to \fBsasl_server_userdb_checkpass_t()\fR was successful.
  97 .RE
  98
  99 .sp
 100 .LP
 101 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 102 .SH ATTRIBUTES
 103 .sp
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 c | c
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Evolving
 116 _
 117 MT-Level        MT-Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)