usr/src/man/man5/pam_smbfs_login.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_SMBFS_LOGIN 5 "Sep 25, 2008"
   7 .SH NAME
   8 pam_smbfs_login \- PAM user credential authentication module for SMB/CIFS
   9 client login
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 pam_smb_cred.so.1
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBpam_smbfs_login\fR module  implements \fBpam_sm_setcred\fR(3PAM) to
  20 provide functions that act equivalently to the \fBsmbutil\fR(1) login command.
  21 .sp
  22 .LP
  23 This optional functionality is meant  to be used only in environments  that  do
  24 not run Active Directory or Kerberos, but which synchronize passwords between
  25 Solaris clients and their CIFS/SMB servers.
  26 .sp
  27 .LP
  28 This module permits the login password to be stored as if the \fBsmbutil\fR(1)
  29 login command was used to store a password for PAM_USER in the user or system
  30 default  domain. The choice of default domain is the first of the following:
  31 .br
  32 .in +2
  33 -Domain entry specified in the  default  section of the \fB$HOME/.nsmbrc\fR
  34 file, if readable.
  35 .in -2
  36 .br
  37 .in +2
  38 -Domain entry specified in the default section shown by the sharectl get smbfs
  39 command.
  40 .in -2
  41 .br
  42 .in +2
  43 -String WORKGROUP.
  44 .in -2
  45 .sp
  46 .LP
  47 Because \fBpam_smbfs_login\fR runs as root during the login process, a
  48 \fB$HOME/.nsmbrc\fR file accessed through NFS may only be readable if the file
  49 permits reads by others. This conflicts with the requirement that passwords
  50 stored in \fB$HOME/.nsmbrc\fR are ignored when permissions are open.
  51 .sp
  52 .LP
  53 To use this functionality,  add the following line to the \fB/etc/pam.conf\fR
  54 file:
  55 .sp
  56 .in +2
  57 .nf
  58 login  auth optional    pam_smbfs_login.so.1
  59 .fi
  60 .in -2
  61
  62 .sp
  63 .LP
  64 Authentication service modules must implement both
  65 \fBpam_sm_authenticate\fR(3PAM) and \fBpam_sm_setcred\fR(3PAM). In this module,
  66 \fBpam_sm_authenticate\fR(3PAM) always returns \fBPAM_IGNORE\fR.
  67 .sp
  68 .LP
  69 The \fBpam_sm_setcred\fR(3PAM) function accepts the following flags:
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBPAM_REFRESH_CRED\fR\fR
  74 .ad
  75 .sp .6
  76 .RS 4n
  77 Returns PAM_IGNORE.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBPAM_SILENT\fR\fR
  84 .ad
  85 .sp .6
  86 .RS 4n
  87 Suppresses messages.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBPAM_ESTABLISH_CRED\fR\fR
  94 .ad
  95 .br
  96 .na
  97 \fB\fBPAM_REINITIALIZE_CRED\fR\fR
  98 .ad
  99 .sp .6
 100 .RS 4n
 101 Stores the authentication token for PAM_USER in the same manner as the
 102 \fBsmbutil\fR(1) login command.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBPAM_DELETE_CRED\fR\fR
 109 .ad
 110 .sp .6
 111 .RS 4n
 112 Deletes the stored password for PAM_USER in the same manner as the
 113 \fBsmbutil\fR(1) logout command.
 114 .RE
 115
 116 .sp
 117 .LP
 118 The following options can be passed to the \fBpam_smbfs_login\fR module:
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBdebug\fR\fR
 123 .ad
 124 .sp .6
 125 .RS 4n
 126 Produces \fBsyslog\fR(3C) debugging information at the LOG_AUTH or LOG_DEBUG
 127 level.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fBnowarn\fR\fR
 134 .ad
 135 .sp .6
 136 .RS 4n
 137 Suppresses warning messages.
 138 .RE
 139
 140 .SH FILES
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fB$HOME/.nsmbrc\fR\fR
 145 .ad
 146 .RS 28n
 147 Find default domain, if present.
 148 .RE
 149
 150 .SH ERRORS
 151 .sp
 152 .LP
 153 Upon successful completion of \fBpam_sm_setcred\fR(3PAM), \fBPAM_SUCCESS\fR is
 154 returned. The  following  error codes are returned upon error:
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBPAM_USER_UNKNOWN\fR\fR
 159 .ad
 160 .sp .6
 161 .RS 4n
 162 User is unknown.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBPAM_AUTHTOK_ERR\fR\fR
 169 .ad
 170 .sp .6
 171 .RS 4n
 172 Password is bad.
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fBPAM_AUTH_ERR\fR\fR
 179 .ad
 180 .sp .6
 181 .RS 4n
 182 Domain is bad.
 183 .RE
 184
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fBPAM_SYSTEM_ERR\fR\fR
 189 .ad
 190 .sp .6
 191 .RS 4n
 192 System error.
 193 .RE
 194
 195 .SH ATTRIBUTES
 196 .sp
 197 .LP
 198 See \fBattributes\fR(5) for descriptions of the following attribute:
 199 .sp
 200
 201 .sp
 202 .TS
 203 box;
 204 c | c
 205 l | l .
 206 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 207 _
 208 Interface Stability     Committed
 209 _
 210 MT Level        MT-Safe with exceptions
 211 .TE
 212
 213 .SH SEE ALSO
 214 .sp
 215 .LP
 216 \fBsmbutil\fR(1), \fBsyslog\fR(3C), \fBlibpam\fR(3LIB), \fBpam\fR(3PAM),
 217 \fBpam_setcred\fR(3PAM), \fBpam_sm\fR(3PAM), \fBpam_sm_authenticate\fR(3PAM),
 218 \fBpam_sm_chauthtok\fR(3PAM), \fBpam_sm_setcred\fR(3PAM), \fBpam.conf\fR(4),
 219 \fBattributes\fR(5), \fBsmbfs\fR(7FS)
 220 .SH NOTES
 221 .sp
 222 .LP
 223 The interfaces in \fBlibpam\fR(3LIB) are MT-Safe only  if each thread within
 224 the multi-threaded application uses its own PAM handle.