← Back to branch summary

~ubuntu-branches/ubuntu/breezy/pam/breezy

« back to all changes in this revision

Viewing changes to Linux-PAM/doc/modules/pam_access.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Sam Hartman
  • Date: 2004-06-28 14:28:08 UTC
  • mfrom: (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20040628142808-adikk7vtfg3pzcjw
Tags: 0.76-22
http://bugs.debian.org/254904
* Add uploaders
* Document location of repository
* Fix options containing arguments in pam_unix, Closes: #254904

Show diffs side-by-side

added added

removed removed

Lines of Context:
Linux-PAM/doc/modules/pam_access.sgml
 
1
<!--
 
2
   
 
3
   pam_access module docs added by Tim Berger <timb@transmeta.com>
 
4
 
 
5
-->
 
6
 
 
7
<sect1> The access module
 
8
 
 
9
<sect2>Synopsis
 
10
 
 
11
<p>
 
12
<descrip>
 
13
 
 
14
<tag><bf>Module Name:</bf></tag>
 
15
 
 
16
<tt>pam_access</tt>
 
17
 
 
18
 
 
19
<tag><bf>Author[s]:</bf></tag>
 
20
 
 
21
Alexei Nogin &lt;alexei@nogin.dnttm.ru&gt;
 
22
 
 
23
<tag><bf>Maintainer:</bf></tag>
 
24
        
 
25
<tag><bf>Management groups provided:</bf></tag>
 
26
 
 
27
account
 
28
 
 
29
<tag><bf>Cryptographically sensitive:</bf></tag>
 
30
 
 
31
<tag><bf>Security rating:</bf></tag>
 
32
 
 
33
<tag><bf>Clean code base:</bf></tag>
 
34
 
 
35
<tag><bf>System dependencies:</bf></tag> 
 
36
Requires a configuration file. By default 
 
37
<tt>/etc/security/access.conf</tt> is used but this can be overridden. 
 
38
 
 
39
<tag><bf>Network aware:</bf></tag>
 
40
 
 
41
Through <tt/PAM_TTY/ if set, otherwise attempts getting tty name of
 
42
the stdin file descriptor with <tt/ttyname()/.  Standard
 
43
gethostname(), <tt/yp_get_default_domain()/, <tt/gethostbyname()/
 
44
calls.  <bf/NIS/ is used for netgroup support.
 
45
 
 
46
</descrip>
 
47
 
 
48
<sect2>Overview of module
 
49
 
 
50
<p>
 
51
Provides logdaemon style login access control.
 
52
 
 
53
<sect2> Account component
 
54
 
 
55
<p>
 
56
<descrip>
 
57
 
 
58
<tag><bf>Recognized arguments:</bf></tag>
 
59
 
 
60
<tt>accessfile=<it>/path/to/file.conf</it></tt>;
 
61
<tt>fieldsep=<it>separators</it></tt>
 
62
 
 
63
<tag><bf>Description:</bf></tag>
 
64
 
 
65
This module provides logdaemon style login access control based on
 
66
login names and on host (or domain) names, internet addresses (or
 
67
network numbers), or on terminal line names in case of non-networked
 
68
logins. Diagnostics are reported through <tt/syslog(3)/.  Wietse
 
69
Venema's <tt/login_access.c/ from <em/logdaemon-5.6/ is used with
 
70
several changes by A. Nogin.
 
71
 
 
72
<p> 
 
73
The behavior of this module can be modified with the following 
 
74
arguments: 
 
75
<itemize> 
 
76
 
 
77
<item><tt>accessfile=/path/to/file.conf</tt> - 
 
78
indicate an alternative <em/access/ configuration file to override 
 
79
the default. This can be useful when different services need different 
 
80
access lists. 
 
81
 
 
82
<item><tt>fieldsep=<it>separators</it></tt> -
 
83
this option modifies the field separator character that
 
84
<tt/pam_access/ will recognize when parsing the access configuration
 
85
file. For example: <tt>fieldsep=|</tt> will cause the default `:'
 
86
character to be treated as part of a field value and `|' becomes the
 
87
field separator. Doing this is useful in conjuction with a system that
 
88
wants to use pam_access with X based applications, since the
 
89
<tt/PAM_TTY/ item is likely to be of the form "hostname:0" which
 
90
includes a `:' character in its value.
 
91
 
 
92
</itemize> 
 
93
 
 
94
<tag><bf>Examples/suggested usage:</bf></tag>
 
95
 
 
96
Use of module is recommended, for example, on administrative machines
 
97
such as <bf/NIS/ servers and mail servers where you need several accounts
 
98
active but don't want them all to have login capability.
 
99
 
 
100
For <tt>/etc/pam.d</tt> style configurations where your modules live
 
101
in <tt>/lib/security</tt>, start by adding the following line to
 
102
<tt>/etc/pam.d/login</tt>, <tt>/etc/pam.d/rlogin</tt>,
 
103
<tt>/etc/pam.d/rsh</tt> and <tt>/etc/pam.d/ftp</tt>:
 
104
 
 
105
<tscreen>
 
106
<verb>
 
107
account  required       /lib/security/pam_access.so
 
108
</verb>
 
109
</tscreen>
 
110
 
 
111
Note that use of this module is not effective unless your system ignores
 
112
<tt>.rhosts</tt> files.  See the the pam_rhosts_auth documentation.
 
113
 
 
114
A sample <tt>access.conf</tt> configuration file is included with the
 
115
distribution.
 
116
 
 
117
</descrip>