usr/src/man/man3sasl/sasl_setpass.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_SETPASS 3SASL "Oct 15, 2003"
   9 .SH NAME
  10 sasl_setpass \- set the password for a user
  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_setpass\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst char *\fR\fIuser\fR, \fBconst char *\fR\fIpass\fR,
  18      \fBunsigned\fR \fIpasslen\fR, \fBconst char *\fR\fIoldpass\fR, \fBunsigned\fR \fIoldpasslen\fR,
  19      \fBunsigned\fR \fIflags\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 Use the \fBsasl_setpass()\fR interface to set passwords. \fBsasl_setpass()\fR
  26 uses the \fBSASL_CB_SERVER_USERDB_SETPASS\fR callback, if one is supplied.
  27 Additionally, if any server mechanism plugins supply a setpass callback, the
  28 setpass callback would be called. None of the server mechanism plugins
  29 currently supply a setpass callback.
  30 .SH PARAMETERS
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIconn\fR\fR
  35 .ad
  36 .RS 14n
  37 The SASL connection context
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fIuser\fR\fR
  44 .ad
  45 .RS 14n
  46 The username for which the password is set
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fIpass\fR\fR
  53 .ad
  54 .RS 14n
  55 The password to set
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fIpasslen\fR\fR
  62 .ad
  63 .RS 14n
  64 The length of \fIpass\fR
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fIoldpass\fR\fR
  71 .ad
  72 .RS 14n
  73 The old password, which is optional
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fIoldpasslen\fR\fR
  80 .ad
  81 .RS 14n
  82 The length of \fIoldpass\fR, which is optional
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fIflags\fR\fR
  89 .ad
  90 .RS 14n
  91 Refers to flags, including, \fBSASL_SET_CREATE\fR and \fBSASL_SET_DISABLE\fR.
  92 Use these flags to create and disable accounts.
  93 .RE
  94
  95 .SH RETURN VALUES
  96 .sp
  97 .LP
  98 \fBsasl_setpass()\fR returns an integer that corresponds to a SASL error code.
  99 .SH ERRORS
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBSASL_OK\fR\fR
 104 .ad
 105 .RS 11n
 106 The call to \fBsasl_setpass()\fR was successful.
 107 .RE
 108
 109 .sp
 110 .LP
 111 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 112 .SH ATTRIBUTES
 113 .sp
 114 .LP
 115 See \fBattributes\fR(5) for descriptions of the following attributes:
 116 .sp
 117
 118 .sp
 119 .TS
 120 box;
 121 c | c
 122 l | l .
 123 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 124 _
 125 Interface Stability     Evolving
 126 _
 127 MT-Level        MT-Safe
 128 .TE
 129
 130 .SH SEE ALSO
 131 .sp
 132 .LP
 133 \fBsasl_errors\fR(3SASL), \fBsasl_getprop\fR(3SASL), \fBattributes\fR(5)