| 1 | '\" t
|
|---|
| 2 | .\" Title: pam_winbind
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 10/25/2016
|
|---|
| 6 | .\" Manual: 8
|
|---|
| 7 | .\" Source: Samba 4.4
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "PAM_WINBIND" "8" "10/25/2016" "Samba 4\&.4" "8"
|
|---|
| 11 | .\" -----------------------------------------------------------------
|
|---|
| 12 | .\" * Define some portability stuff
|
|---|
| 13 | .\" -----------------------------------------------------------------
|
|---|
| 14 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 15 | .\" http://bugs.debian.org/507673
|
|---|
| 16 | .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|---|
| 17 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 18 | .ie \n(.g .ds Aq \(aq
|
|---|
| 19 | .el .ds Aq '
|
|---|
| 20 | .\" -----------------------------------------------------------------
|
|---|
| 21 | .\" * set default formatting
|
|---|
| 22 | .\" -----------------------------------------------------------------
|
|---|
| 23 | .\" disable hyphenation
|
|---|
| 24 | .nh
|
|---|
| 25 | .\" disable justification (adjust text to left margin only)
|
|---|
| 26 | .ad l
|
|---|
| 27 | .\" -----------------------------------------------------------------
|
|---|
| 28 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 29 | .\" -----------------------------------------------------------------
|
|---|
| 30 | .SH "NAME"
|
|---|
| 31 | pam_winbind \- PAM module for Winbind
|
|---|
| 32 | .SH "DESCRIPTION"
|
|---|
| 33 | .PP
|
|---|
| 34 | This tool is part of the
|
|---|
| 35 | \fBsamba\fR(7)
|
|---|
| 36 | suite\&.
|
|---|
| 37 | .PP
|
|---|
| 38 | pam_winbind is a PAM module that can authenticate users against the local domain by talking to the Winbind daemon\&.
|
|---|
| 39 | .SH "SYNOPSIS"
|
|---|
| 40 | .PP
|
|---|
| 41 | Edit the PAM system config /etc/pam\&.d/service and modify it as the following example shows:
|
|---|
| 42 | .sp
|
|---|
| 43 | .if n \{\
|
|---|
| 44 | .RS 4
|
|---|
| 45 | .\}
|
|---|
| 46 | .nf
|
|---|
| 47 | \&.\&.\&.
|
|---|
| 48 | auth required pam_env\&.so
|
|---|
| 49 | auth sufficient pam_unix2\&.so
|
|---|
| 50 | +++ auth required pam_winbind\&.so use_first_pass
|
|---|
| 51 | account requisite pam_unix2\&.so
|
|---|
| 52 | +++ account required pam_winbind\&.so use_first_pass
|
|---|
| 53 | +++ password sufficient pam_winbind\&.so
|
|---|
| 54 | password requisite pam_pwcheck\&.so cracklib
|
|---|
| 55 | password required pam_unix2\&.so use_authtok
|
|---|
| 56 | session required pam_unix2\&.so
|
|---|
| 57 | +++ session required pam_winbind\&.so
|
|---|
| 58 | \&.\&.\&.
|
|---|
| 59 |
|
|---|
| 60 | .fi
|
|---|
| 61 | .if n \{\
|
|---|
| 62 | .RE
|
|---|
| 63 | .\}
|
|---|
| 64 | .sp
|
|---|
| 65 | Make sure that pam_winbind is one of the first modules in the session part\&. It may retrieve kerberos tickets which are needed by other modules\&.
|
|---|
| 66 | .SH "OPTIONS"
|
|---|
| 67 | .PP
|
|---|
| 68 | pam_winbind supports several options which can either be set in the PAM configuration files or in the pam_winbind configuration file situated at
|
|---|
| 69 | /etc/security/pam_winbind\&.conf\&. Options from the PAM configuration file take precedence to those from the configuration file\&. See
|
|---|
| 70 | \fBpam_winbind.conf\fR(5)
|
|---|
| 71 | for further details\&.
|
|---|
| 72 | .PP
|
|---|
| 73 | debug
|
|---|
| 74 | .RS 4
|
|---|
| 75 | Gives debugging output to syslog\&.
|
|---|
| 76 | .RE
|
|---|
| 77 | .PP
|
|---|
| 78 | debug_state
|
|---|
| 79 | .RS 4
|
|---|
| 80 | Gives detailed PAM state debugging output to syslog\&.
|
|---|
| 81 | .RE
|
|---|
| 82 | .PP
|
|---|
| 83 | require_membership_of=[SID or NAME]
|
|---|
| 84 | .RS 4
|
|---|
| 85 | If this option is set, pam_winbind will only succeed if the user is a member of the given SID or NAME\&. A SID can be either a group\-SID, an alias\-SID or even an user\-SID\&. It is also possible to give a NAME instead of the SID\&. That name must have the form:
|
|---|
| 86 | \fIMYDOMAIN\e\emygroup\fR
|
|---|
| 87 | or
|
|---|
| 88 | \fIMYDOMAIN\e\emyuser\fR\&. pam_winbind will, in that case, lookup the SID internally\&. Note that NAME may not contain any spaces\&. It is thus recommended to only use SIDs\&. You can verify the list of SIDs a user is a member of with
|
|---|
| 89 | wbinfo \-\-user\-sids=SID\&.
|
|---|
| 90 | .sp
|
|---|
| 91 | This option must only be specified on a auth module declaration, as it only operates in conjunction with password authentication\&.
|
|---|
| 92 | .RE
|
|---|
| 93 | .PP
|
|---|
| 94 | use_first_pass
|
|---|
| 95 | .RS 4
|
|---|
| 96 | By default, pam_winbind tries to get the authentication token from a previous module\&. If no token is available it asks the user for the old password\&. With this option, pam_winbind aborts with an error if no authentication token from a previous module is available\&.
|
|---|
| 97 | .RE
|
|---|
| 98 | .PP
|
|---|
| 99 | try_first_pass
|
|---|
| 100 | .RS 4
|
|---|
| 101 | Same as the use_first_pass option (previous item), except that if the primary password is not valid, PAM will prompt for a password\&.
|
|---|
| 102 | .RE
|
|---|
| 103 | .PP
|
|---|
| 104 | use_authtok
|
|---|
| 105 | .RS 4
|
|---|
| 106 | Set the new password to the one provided by the previously stacked password module\&. If this option is not set pam_winbind will ask the user for the new password\&.
|
|---|
| 107 | .RE
|
|---|
| 108 | .PP
|
|---|
| 109 | krb5_auth
|
|---|
| 110 | .RS 4
|
|---|
| 111 | pam_winbind can authenticate using Kerberos when winbindd is talking to an Active Directory domain controller\&. Kerberos authentication must be enabled with this parameter\&. When Kerberos authentication can not succeed (e\&.g\&. due to clock skew), winbindd will fallback to samlogon authentication over MSRPC\&. When this parameter is used in conjunction with
|
|---|
| 112 | \fIwinbind refresh tickets\fR, winbind will keep your Ticket Granting Ticket (TGT) uptodate by refreshing it whenever necessary\&.
|
|---|
| 113 | .RE
|
|---|
| 114 | .PP
|
|---|
| 115 | krb5_ccache_type=[type]
|
|---|
| 116 | .RS 4
|
|---|
| 117 | When pam_winbind is configured to try kerberos authentication by enabling the
|
|---|
| 118 | \fIkrb5_auth\fR
|
|---|
| 119 | option, it can store the retrieved Ticket Granting Ticket (TGT) in a credential cache\&. The type of credential cache can be set with this option\&. Currently the only supported value is:
|
|---|
| 120 | \fIFILE\fR\&. In that case a credential cache in the form of /tmp/krb5cc_UID will be created, where UID is replaced with the numeric user id\&. Leave empty to just do kerberos authentication without having a ticket cache after the logon has succeeded\&.
|
|---|
| 121 | .RE
|
|---|
| 122 | .PP
|
|---|
| 123 | cached_login
|
|---|
| 124 | .RS 4
|
|---|
| 125 | Winbind allows one to logon using cached credentials when
|
|---|
| 126 | \fIwinbind offline logon\fR
|
|---|
| 127 | is enabled\&. To use this feature from the PAM module this option must be set\&.
|
|---|
| 128 | .RE
|
|---|
| 129 | .PP
|
|---|
| 130 | silent
|
|---|
| 131 | .RS 4
|
|---|
| 132 | Do not emit any messages\&.
|
|---|
| 133 | .RE
|
|---|
| 134 | .PP
|
|---|
| 135 | mkhomedir
|
|---|
| 136 | .RS 4
|
|---|
| 137 | Create homedirectory for a user on\-the\-fly, option is valid in PAM session block\&.
|
|---|
| 138 | .RE
|
|---|
| 139 | .PP
|
|---|
| 140 | warn_pwd_expire
|
|---|
| 141 | .RS 4
|
|---|
| 142 | Defines number of days before pam_winbind starts to warn about passwords that are going to expire\&. Defaults to 14 days\&.
|
|---|
| 143 | .RE
|
|---|
| 144 | .SH "PAM DATA EXPORTS"
|
|---|
| 145 | .PP
|
|---|
| 146 | This section describes the data exported in the PAM stack which could be used in other PAM modules\&.
|
|---|
| 147 | .PP
|
|---|
| 148 | PAM_WINBIND_HOMEDIR
|
|---|
| 149 | .RS 4
|
|---|
| 150 | This is the Windows Home Directory set in the profile tab in the user settings on the Active Directory Server\&. This could be a local path or a directory on a share mapped to a drive\&.
|
|---|
| 151 | .RE
|
|---|
| 152 | .PP
|
|---|
| 153 | PAM_WINBIND_LOGONSCRIPT
|
|---|
| 154 | .RS 4
|
|---|
| 155 | The path to the logon script which should be executed if a user logs in\&. This is normally a relative path to the script stored on the server\&.
|
|---|
| 156 | .RE
|
|---|
| 157 | .PP
|
|---|
| 158 | PAM_WINBIND_LOGONSERVER
|
|---|
| 159 | .RS 4
|
|---|
| 160 | This exports the Active Directory server we are authenticating against\&. This can be used as a variable later\&.
|
|---|
| 161 | .RE
|
|---|
| 162 | .PP
|
|---|
| 163 | PAM_WINBIND_PROFILEPATH
|
|---|
| 164 | .RS 4
|
|---|
| 165 | This is the profile path set in the profile tab in the user settings\&. Normally the home directory is synced with this directory on a share\&.
|
|---|
| 166 | .RE
|
|---|
| 167 | .SH "SEE ALSO"
|
|---|
| 168 | .PP
|
|---|
| 169 | \fBpam_winbind.conf\fR(5),
|
|---|
| 170 | \fBwbinfo\fR(1),
|
|---|
| 171 | \fBwinbindd\fR(8),
|
|---|
| 172 | \fBsmb.conf\fR(5)
|
|---|
| 173 | .SH "VERSION"
|
|---|
| 174 | .PP
|
|---|
| 175 | This man page is correct for version 3 of Samba\&.
|
|---|
| 176 | .SH "AUTHOR"
|
|---|
| 177 | .PP
|
|---|
| 178 | The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
|
|---|
| 179 | .PP
|
|---|
| 180 | This manpage was written by Jelmer Vernooij and Guenther Deschner\&.
|
|---|
