modules/pam_rhosts/pam_rhosts.8

   1 .\"     Title: pam_rhosts
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 06/21/2011
   5 .\"    Manual: Linux-PAM Manual
   6 .\"    Source: Linux-PAM Manual
   7 .\"  Language: English
   8 .\"
   9 .TH "PAM_RHOSTS" "8" "06/21/2011" "Linux-PAM Manual" "Linux\-PAM Manual"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 pam_rhosts \- The rhosts PAM module
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBpam_rhosts\&.so\fR\ 'u
 174 \fBpam_rhosts\&.so\fR
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 This module performs the standard network authentication for services, as used by traditional implementations of
 179 \fBrlogin\fR
 180 and
 181 \fBrsh\fR
 182 etc\&.
 183 .PP
 184 The authentication mechanism of this module is based on the contents of two files;
 185 \FC/etc/hosts\&.equiv\F[]
 186 (or and
 187 \FC~/\&.rhosts\F[]\&. Firstly, hosts listed in the former file are treated as equivalent to the localhost\&. Secondly, entries in the user\'s own copy of the latter file is used to map "\fIremote\-host remote\-user\fR" pairs to that user\'s account on the current host\&. Access is granted to the user if their host is present in
 188 \FC/etc/hosts\&.equiv\F[]
 189 and their remote account is identical to their local one, or if their remote account has an entry in their personal configuration file\&.
 190 .PP
 191 The module authenticates a remote user (internally specified by the item
 192 \fIPAM_RUSER\fR
 193 connecting from the remote host (internally specified by the item
 194 \fBPAM_RHOST\fR)\&. Accordingly, for applications to be compatible this authentication module they must set these items prior to calling
 195 \fBpam_authenticate()\fR\&. The module is not capable of independently probing the network connection for such information\&.
 196 .SH "OPTIONS"
 197 .PP
 198 \fBdebug\fR
 199 .RS 4
 200 Print debug information\&.
 201 .RE
 202 .PP
 203 \fBsilent\fR
 204 .RS 4
 205 Don\'t print informative messages\&.
 206 .RE
 207 .PP
 208 \fBsuperuser=\fR\fB\fIaccount\fR\fR
 209 .RS 4
 210 Handle
 211 \fIaccount\fR
 212 as root\&.
 213 .RE
 214 .SH "MODULE TYPES PROVIDED"
 215 .PP
 216 Only the
 217 \fBauth\fR
 218 module type is provided\&.
 219 .SH "RETURN VALUES"
 220 .PP
 221 PAM_AUTH_ERR
 222 .RS 4
 223 The remote host, remote user name or the local user name couldn\'t be determined or access was denied by
 224 \FC\&.rhosts\F[]
 225 file\&.
 226 .RE
 227 .PP
 228 PAM_USER_UNKNOWN
 229 .RS 4
 230 User is not known to system\&.
 231 .RE
 232 .SH "EXAMPLES"
 233 .PP
 234 To grant a remote user access by
 235 \FC/etc/hosts\&.equiv\F[]
 236 or
 237 \FC\&.rhosts\F[]
 238 for
 239 \fBrsh\fR
 240 add the following lines to
 241 \FC/etc/pam\&.d/rsh\F[]:
 242 .sp
 243 .if n \{\
 244 .RS 4
 245 .\}
 246 .fam C
 247 .ps -1
 248 .nf
 249 .if t \{\
 250 .sp -1
 251 .\}
 252 .BB lightgray adjust-for-leading-newline
 253 .sp -1
 254
 255 #%PAM\-1\&.0
 256 #
 257 auth     required       pam_rhosts\&.so
 258 auth     required       pam_nologin\&.so
 259 auth     required       pam_env\&.so
 260 auth     required       pam_unix\&.so
 261
 262 .EB lightgray adjust-for-leading-newline
 263 .if t \{\
 264 .sp 1
 265 .\}
 266 .fi
 267 .fam
 268 .ps +1
 269 .if n \{\
 270 .RE
 271 .\}
 272 .sp
 273 .SH "SEE ALSO"
 274 .PP
 275
 276 \fBrootok\fR(3),
 277 \fBhosts.equiv\fR(5),
 278 \fBrhosts\fR(5),
 279 \fBpam.conf\fR(5),
 280 \fBpam.d\fR(5),
 281 \fBpam\fR(8)
 282 .SH "AUTHOR"
 283 .PP
 284 pam_rhosts was written by Thorsten Kukuk <kukuk@thkukuk\&.de>