Update the comments as per the latest documentation.
[freeradius.git] / raddb / users
1 #
2 #       Please read the documentation file ../doc/processing_users_file,
3 #       or 'man users' (after installing the server) for more information.
4 #
5 #       This file contains security and configuration information
6 #       for each user.  The first field is the user's name and
7 #       can be up to 253 characters in length.  This is followed (on
8 #       the same line) with the list of authentication requirements
9 #       for that user.  This can include password, comm server name,
10 #       comm server port number, protocol type (perhaps set by the "hints"
11 #       file), and huntgroup name (set by the "huntgroups" file).
12 #
13 #       If you are not sure why a particular reply is being sent by the
14 #       server, then run the server in debugging mode (radiusd -X), and
15 #       you will see which entries in this file are matched.
16 #
17 #       When an authentication request is received from the comm server,
18 #       these values are tested. Only the first match is used unless the
19 #       "Fall-Through" variable is set to "Yes".
20 #
21 #       A special user named "DEFAULT" matches on all usernames.
22 #       You can have several DEFAULT entries. All entries are processed
23 #       in the order they appear in this file. The first entry that
24 #       matches the login-request will stop processing unless you use
25 #       the Fall-Through variable.
26 #
27 #       If you use the database support to turn this file into a .db or .dbm
28 #       file, the DEFAULT entries _have_ to be at the end of this file and
29 #       you can't have multiple entries for one username.
30 #
31 #       You don't need to specify a password if you set Auth-Type += System
32 #       on the list of authentication requirements. The RADIUS server
33 #       will then check the system password file.
34 #
35 #       Indented (with the tab character) lines following the first
36 #       line indicate the configuration values to be passed back to
37 #       the comm server to allow the initiation of a user session.
38 #       This can include things like the PPP configuration values
39 #       or the host to log the user onto.
40 #
41 #       You can include another `users' file with `$INCLUDE users.other'
42 #
43
44 #
45
46 #
47 # Deny access for a specific user.  Note that this entry MUST
48 # be before any other 'Auth-Type' attribute which results in the user
49 # being authenticated.
50 #
51 # Note that there is NO 'Fall-Through' attribute, so the user will not
52 # be given any additional resources.
53 #
54 #lameuser       Auth-Type := Reject
55 #               Reply-Message = "Your account has been disabled."
56
57 #
58 # Deny access for a group of users.
59 #
60 # Note that there is NO 'Fall-Through' attribute, so the user will not
61 # be given any additional resources.
62 #
63 #DEFAULT        Group == "disabled", Auth-Type := Reject
64 #               Reply-Message = "Your account has been disabled."
65 #
66
67 #
68 # This is a complete entry for "steve". Note that there is no Fall-Through
69 # entry so that no DEFAULT entry will be used, and the user will NOT
70 # get any attributes in addition to the ones listed here.
71 #
72 #steve  Auth-Type := Local, Password == "testing"
73 #       Service-Type = Framed-User,
74 #       Framed-Protocol = PPP,
75 #       Framed-IP-Address = 172.16.3.33,
76 #       Framed-IP-Netmask = 255.255.255.0,
77 #       Framed-Routing = Broadcast-Listen,
78 #       Framed-Filter-Id = "std.ppp",
79 #       Framed-MTU = 1500,
80 #       Framed-Compression = Van-Jacobsen-TCP-IP
81
82 #
83 # This is an entry for a user with a space in their name.
84 # Note the double quotes surrounding the name.
85 #
86 #"John Doe"     Auth-Type := Local, Password == "hello"
87 #               Reply-Message = "Hello, %u"
88
89 #
90 # Dial user back and telnet to the default host for that port
91 #
92 #Deg    Auth-Type := Local, Password == "ge55ged"
93 #       Service-Type = Callback-Login-User,
94 #       Login-IP-Host = 0.0.0.0,
95 #       Callback-Number = "9,5551212",
96 #       Login-Service = Telnet,
97 #       Login-TCP-Port = Telnet
98
99 #
100 # Another complete entry. After the user "dialbk" has logged in, the
101 # connection will be broken and the user will be dialed back after which
102 # he will get a connection to the host "timeshare1".
103 #
104 #dialbk Auth-Type := Local, Password == "callme"
105 #       Service-Type = Callback-Login-User,
106 #       Login-IP-Host = timeshare1,
107 #       Login-Service = PortMaster,
108 #       Callback-Number = "9,1-800-555-1212"
109
110 #
111 # user "swilson" will only get a static IP number if he logs in with
112 # a framed protocol on a terminal server in Alphen (see the huntgroups file).
113 #
114 # Note that by setting "Fall-Through", other attributes will be added from
115 # the following DEFAULT entries
116 #
117 #swilson        Service-Type == Framed-User, Huntgroup-Name == "alphen"
118 #               Framed-IP-Address = 192.168.1.65,
119 #               Fall-Through = Yes
120
121 #
122 # If the user logs in as 'username.shell', then authenticate them
123 # against the system database, give them shell access, and stop processing
124 # the rest of the file.
125 #
126 #DEFAULT        Suffix == ".shell", Auth-Type := System
127 #               Service-Type = Login-User,
128 #               Login-Service = Telnet,
129 #               Login-IP-Host = your.shell.machine
130
131
132 #
133 # The rest of this file contains the several DEFAULT entries.
134 # DEFAULT entries match with all login names.
135 # Note that DEFAULT entries can also Fall-Through (see first entry).
136 # A name-value pair from a DEFAULT entry will _NEVER_ override
137 # an already existing name-value pair.
138 #
139
140 #
141 # First setup all accounts to be checked against the UNIX /etc/passwd.
142 # (Unless a password was already given earlier in this file).
143 #
144 DEFAULT Auth-Type := System
145         Fall-Through = 1
146
147 #
148 # Set up different IP address pools for the terminal servers.
149 # Note that the "+" behind the IP address means that this is the "base"
150 # IP address. The Port-Id (S0, S1 etc) will be added to it.
151 #
152 #DEFAULT        Service-Type == Framed-User, Huntgroup-Name == "alphen"
153 #               Framed-IP-Address = 192.168.1.32+,
154 #               Fall-Through = Yes
155
156 #DEFAULT        Service-Type == Framed-User, Huntgroup-Name == "delft"
157 #               Framed-IP-Address = 192.168.2.32+,
158 #               Fall-Through = Yes
159
160 #
161 # Defaults for all framed connections.
162 #
163 DEFAULT Service-Type == Framed-User
164         Framed-IP-Address = 255.255.255.254,
165         Framed-MTU = 576,
166         Service-Type = Framed-User,
167         Fall-Through = Yes
168
169 #
170 # Default for PPP: dynamic IP address, PPP mode, VJ-compression.
171 # NOTE: we do not use Hint = "PPP", since PPP might also be auto-detected
172 #       by the terminal server in which case there may not be a "P" suffix.
173 #       The terminal server sends "Framed-Protocol = PPP" for auto PPP.
174 #
175 DEFAULT Framed-Protocol == PPP
176         Framed-Protocol = PPP,
177         Framed-Compression = Van-Jacobson-TCP-IP
178
179 #
180 # Default for CSLIP: dynamic IP address, SLIP mode, VJ-compression.
181 #
182 DEFAULT Hint == "CSLIP"
183         Framed-Protocol = SLIP,
184         Framed-Compression = Van-Jacobson-TCP-IP
185
186 #
187 # Default for SLIP: dynamic IP address, SLIP mode.
188 #
189 DEFAULT Hint == "SLIP"
190         Framed-Protocol = SLIP
191
192 #
193 # Last default: rlogin to our main server.
194 #
195 #DEFAULT
196 #       Service-Type = Login-User,
197 #       Login-Service = Rlogin,
198 #       Login-IP-Host = shellbox.ispdomain.com
199
200 # #
201 # # Last default: shell on the local terminal server.
202 # #
203 # DEFAULT
204 #       Service-Type = Shell-User
205
206 # On no match, the user is denied access.