1GROUP.CONF(5)                  Linux-PAM Manual                  GROUP.CONF(5)
2
3
4

NAME

6       group.conf - configuration file for the pam_group module
7

DESCRIPTION

9       The pam_group PAM module does not authenticate the user, but instead it
10       grants group memberships (in the credential setting phase of the
11       authentication module) to the user. Such memberships are based on the
12       service they are applying for.
13
14       For this module to function correctly there must be a correctly
15       formatted /etc/security/group.conf file present. White spaces are
16       ignored and lines maybe extended with '\' (escaped newlines). Text
17       following a '#' is ignored to the end of the line.
18
19       The syntax of the lines is as follows:
20
21       services;ttys;users;times;groups
22
23       The first field, the services field, is a logic list of PAM service
24       names that the rule applies to.
25
26       The second field, the tty field, is a logic list of terminal names that
27       this rule applies to.
28
29       The third field, the users field, is a logic list of users, or a UNIX
30       group, or a netgroup of users to whom this rule applies. Group names
31       are preceded by a '%' symbol, while netgroup names are preceded by a
32       '@' symbol.
33
34       A logic list namely means individual tokens that are optionally
35       prefixed with '!' (logical not) and separated with '&' (logical and)
36       and '|' (logical or).
37
38       For these items the simple wildcard '*' may be used only once. With
39       UNIX groups or netgroups no wildcards or logic operators are allowed.
40
41       The times field is used to indicate "when" these groups are to be given
42       to the user. The format here is a logic list of day/time-range entries.
43       The days are specified by a sequence of two character entries, MoTuSa
44       for example is Monday Tuesday and Saturday. Note that repeated days are
45       unset MoMo = no day, and MoWk = all weekdays bar Monday. The two
46       character combinations accepted are Mo Tu We Th Fr Sa Su Wk Wd Al, the
47       last two being week-end days and all 7 days of the week respectively.
48       As a final example, AlFr means all days except Friday.
49
50       Each day/time-range can be prefixed with a '!' to indicate "anything
51       but". The time-range part is two 24-hour times HHMM, separated by a
52       hyphen, indicating the start and finish time (if the finish time is
53       smaller than the start time it is deemed to apply on the following
54       day).
55
56       The groups field is a comma or space separated list of groups that the
57       user inherits membership of. These groups are added if the previous
58       fields are satisfied by the user's request.
59
60       For a rule to be active, ALL of service+ttys+users must be satisfied by
61       the applying process.
62

EXAMPLES

64       These are some example lines which might be specified in
65       /etc/security/group.conf.
66
67       Running 'xsh' on tty* (any ttyXXX device), the user 'us' is given
68       access to the floppy (through membership of the floppy group)
69
70           xsh;tty*&!ttyp*;us;Al0000-2400;floppy
71
72       Running 'xsh' on tty* (any ttyXXX device), the users 'sword', 'pike'
73       and 'shield' are given access to games (through membership of the
74       floppy group) after work hours.
75
76           xsh; tty* ;sword|pike|shield;!Wk0900-1800;games, sound
77           xsh; tty* ;*;Al0900-1800;floppy
78
79
80       Any member of the group 'admin' running 'xsh' on tty*, is granted
81       access (at any time) to the group 'plugdev'
82
83           xsh; tty* ;%admin;Al0000-2400;plugdev
84
85

SEE ALSO

87       pam_group(8), pam.d(5), pam(8)
88

AUTHOR

90       pam_group was written by Andrew G. Morgan <morgan@kernel.org>.
91
92
93
94Linux-PAM Manual                  09/03/2021                     GROUP.CONF(5)
Impressum