share/man/man5/pam_smb_passwd.5

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH PAM_SMB_PASSWD 5 "Apr 29, 2008"
   7 .SH NAME
   8 pam_smb_passwd \- SMB password management module
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBpam_smb_passwd.so.1\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBpam_smb_passwd\fR module enhances the PAM password management stack.
  19 This functionality supports the changing or adding of SMB passwords for local
  20 Solaris users. The Solaris CIFS server uses SMB passwords to authenticate
  21 connected Solaris users. This module includes the \fBpam_sm_chauthtok\fR(3PAM)
  22 function.
  23 .sp
  24 .LP
  25 The \fBpam_sm_chauthtok()\fR function accepts the following flags:
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fBPAM_PRELIM_CHECK\fR\fR
  30 .ad
  31 .sp .6
  32 .RS 4n
  33 Always returns \fBPAM_IGNORE\fR.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fBPAM_SILENT\fR\fR
  40 .ad
  41 .sp .6
  42 .RS 4n
  43 Suppresses messages.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBPAM_UPDATE_AUTHTOK\fR\fR
  50 .ad
  51 .sp .6
  52 .RS 4n
  53 Updates or creates a new \fBCIFS\fR local \fBLM\fR/\fBNTLM\fR hash for the user
  54 that is specified in \fBPAM_USER\fR by using the authentication information
  55 found in \fBPAM_AUTHTOK\fR. The \fBLM\fR hash is only created if the
  56 \fBsmbd/lmauth_level\fR property value of the \fBsmb/server\fR service is set
  57 to 3 or less. \fBPAM_IGNORE\fR is returned if the user is not in the local
  58 \fB/etc/passwd\fR repository.
  59 .RE
  60
  61 .sp
  62 .LP
  63 The following options can be passed to the \fBpam_smb_passwd\fR module:
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBdebug\fR\fR
  68 .ad
  69 .sp .6
  70 .RS 4n
  71 Produces \fBsyslog\fR(3C) debugging information at the \fBLOG_AUTH\fR or
  72 \fBLOG_DEBUG\fR level.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBnowarn\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 Suppresses warning messages.
  83 .RE
  84
  85 .SH FILES
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB/var/smb/smbpasswd\fR\fR
  90 .ad
  91 .sp .6
  92 .RS 4n
  93 Stores SMB passwords for Solaris users.
  94 .RE
  95
  96 .SH ERRORS
  97 .sp
  98 .LP
  99 Upon successful completion of \fBpam_sm_chauthtok()\fR, \fBPAM_SUCCESS\fR is
 100 returned. The following error codes are returned upon error:
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBPAM_AUTHTOK_ERR\fR\fR
 105 .ad
 106 .sp .6
 107 .RS 4n
 108 Authentication token manipulation error
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBPAM_AUTHTOK_LOCK_BUSY\fR\fR
 115 .ad
 116 .sp .6
 117 .RS 4n
 118 \fBSMB\fR password file is locked
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBPAM_PERM_DENIED\fR\fR
 125 .ad
 126 .sp .6
 127 .RS 4n
 128 Permissions are insufficient for accessing the \fBSMB\fR password file
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBPAM_SYSTEM_ERR\fR\fR
 135 .ad
 136 .sp .6
 137 .RS 4n
 138 System error
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fBPAM_USER_UNKNOWN\fR\fR
 145 .ad
 146 .sp .6
 147 .RS 4n
 148 User is unknown
 149 .RE
 150
 151 .SH ATTRIBUTES
 152 .sp
 153 .LP
 154 See the \fBattributes\fR(5) man page for descriptions of the following
 155 attributes:
 156 .sp
 157
 158 .sp
 159 .TS
 160 box;
 161 c | c
 162 l | l .
 163 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 164 _
 165 Interface Stability     Committed
 166 _
 167 MT Level        MT-Safe with exceptions
 168 .TE
 169
 170 .SH SEE ALSO
 171 .sp
 172 .LP
 173 \fBsmbd\fR(8), \fBsyslog\fR(3C), \fBlibpam\fR(3LIB), \fBpam\fR(3PAM),
 174 \fBpam_chauthtok\fR(3PAM), \fBpam_sm\fR(3PAM), \fBpam_sm_chauthtok\fR(3PAM),
 175 \fBpam.conf\fR(4), \fBattributes\fR(5)
 176 .SH NOTES
 177 .sp
 178 .LP
 179 The interfaces in \fBlibpam\fR(3LIB) are MT-Safe \fBonly\fR if each thread
 180 within the multi-threaded application uses its own PAM handle.
 181 .sp
 182 .LP
 183 The \fBpam_smb_passwd.so.1\fR module should be stacked following all password
 184 qualification modules in the \fBPAM\fR password stack.