Current File : //usr/man/man3sasl/sasl_server_userdb_setpass_t.3sasl

'\" te
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.TH sasl_server_userdb_setpass_t 3SASL "27 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
.SH NAME
sasl_server_userdb_setpass_t \- user database plaintext password setting callback function
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
#include <sasl/sasl.h>

\fBint\fR \fBsasl_server_userdb_setpass_t\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBvoid *\fR\fIcontext\fR,
     \fBconst char *\fR\fIuser\fR, \fBconst char *\fR\fIpass\fR, \fBunsigned\fR \fIpasslen\fR, \fBstruct propctx *\fR\fIpropctx\fR,
     \fBunsigned\fR \fIflags\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Use the \fBsasl_server_userdb_setpass_t()\fR callback function to store or change a a plaintext password in the callback supplier's user database. 
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIconn\fR\fR
.ad
.RS 11n
.rt  
The SASL connection context.
.RE

.sp
.ne 2
.mk
.na
\fB\fIcontext\fR\fR
.ad
.RS 11n
.rt  
The context from the callback record.
.RE

.sp
.ne 2
.mk
.na
\fB\fIuser\fR\fR
.ad
.RS 11n
.rt  
A null-terminated user name with \fBuser@realm\fR syntax.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpass\fR\fR
.ad
.RS 11n
.rt  
The password to check. This string cannot be null-terminated.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpasslen\fR\fR
.ad
.RS 11n
.rt  
The length of \fIpass\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpropctx\fR\fR
.ad
.RS 11n
.rt  
Auxiliary properties. The value of \fIpropctx\fR is not stored.
.RE

.sp
.ne 2
.mk
.na
\fB\fIflags\fR\fR
.ad
.RS 11n
.rt  
See \fBsasl_setpass\fR(3SASL). \fBsasl_server_userdb_setpass_t()\fR uses the same \fIflags\fR that are passed to \fBsasl_setpass()\fR.
.RE

.SH RETURN VALUES
.sp
.LP
Like other SASL callback functions, \fBsasl_server_userdb_setpass_t()\fR returns an integer that corresponds to a SASL error code. See <\fBsasl.h\fR> for a complete list of SASL error codes.
.SH ERRORS
.sp
.ne 2
.mk
.na
\fB\fBSASL_OK\fR\fR
.ad
.RS 11n
.rt  
The call to \fBsasl_server_userdb_setpass_t()\fR was successful.
.RE

.sp
.LP
See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitysystem/library/security/libsasl
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBsasl_errors\fR(3SASL), \fBsasl_setpass\fR(3SASL), \fBattributes\fR(5)