Document net admin capabilities
[freeradius.git] / raddb / sites-available / dhcp
1 # -*- text -*-
2 ######################################################################
3 #
4 #       This is a virtual server that handles DHCP.
5 #
6 #               !!!! WARNING !!!!
7 #
8 #       This code is experimental, and SHOULD NOT be used in a
9 #       production system.  It is intended for validation and
10 #       experimentation ONLY.
11 #
12 #       In order for this to work, you will need to run configure:
13 #
14 #               $ ./configure --with-dhcp
15 #               $ make
16 #               $ vi share/dictionary
17 #
18 #       ## Un-comment the line containing $INCLUDE dictionary.dhcp
19 #       ## Then, save the file.
20 #
21 #               $ make install
22 #
23 #       DHCP is NOT enabled by default.
24 #
25 #       The goal of this effort is to get the code in front of
26 #       people who are interested in another DHCP server.
27 #       We NEED FEEDBACK, patches, bug reports, etc.  Especially patches!
28 #
29 #       Please contribute, or this work will be nothing more than
30 #       a curiosity.
31 #
32 #
33 #       Q: What does it do?
34 #       A: It allows the server to receive DHCP packets, and to
35 #          respond with static, pre-configured DHCP responses.
36 #
37 #       Q: Does it do static/dynamic IP assignment?
38 #       A: No.  Or, maybe.  Try it and see.
39 #
40 #       Q: Does it read ISC configuration or lease files?
41 #       A: No.  Please submit patches.
42 #
43 #       Q: Does it have DHCP feature X?
44 #       A: No.  Please submit patches.
45 #
46 #       Q: Does it support option 82?
47 #       A: Yes.
48 #
49 #       Q: Does it support other options?
50 #       A: Maybe.  See dictionary.dhcp.  Please submit patches.
51 #
52 #       Q: It doesn't seem to do much of anything!
53 #       A: Exactly.
54 #
55 #       $Id$
56 #
57 ######################################################################
58
59 #
60 #  The DHCP functionality goes into a virtual server.
61 #
62 server dhcp {
63
64 #  Define a DHCP socket.
65 #
66 #  The default port below is 6700, so you don't break your network.
67 #  If you want it to do real DHCP, change this to 67, and good luck!
68 #
69 #  You can also bind the DHCP socket to an interface.
70 #  See below, and raddb/radiusd.conf for examples.
71 #
72 #  This lets you run *one* DHCP server instance and have it listen on
73 #  multiple interfaces, each with a separate policy.
74 #
75 #  If you have multiple interfaces, it is a good idea to bind the
76 #  listen section to an interface.  You will also need one listen
77 #  section per interface.
78 #
79 #  FreeBSD does *not* support binding sockets to interfaces.  Therefore,
80 #  if you have multiple interfaces, broadcasts may go out of the wrong
81 #  one, or even all interfaces.  The solution is to use the "setfib" command.
82 #  If you have a network "10.10.0/24" on LAN1, you will need to do:
83 #
84 #  Pick any IP on the 10.10.0/24 network
85 #       $ setfib 1 route add default 10.10.0.1
86 #
87 #  Edit /etc/rc.local, and add a line:
88 #       setfib 1 /path/to/radiusd
89 #
90 #  The kern must be built with the following options:
91 #       options    ROUTETABLES=2
92 #  or any value larger than 2.
93 #
94 # The other only solution is to update FreeRADIUS to use BPF sockets.
95 #
96 listen {
97         ipaddr = 127.0.0.1
98         port = 6700
99         type = dhcp
100 #       interface = lo0
101
102         # The DHCP server defaults to allowing broadcast packets.
103         # Set this to "no" only when the server receives *all* packets
104         # from a relay agent.  i.e. when *no* clients are on the same
105         # LAN as the DHCP server.
106         #
107         # It's set to "no" here for testing.
108         broadcast = no
109
110         # On Linux if you're running the server as non-root, you
111         # will need to do:
112         #
113         #       sudo setcap cap_net_admin=ei /path/to/radiusd
114         #
115         # This will allow the server to set ARP table entries
116         # for newly allocated IPs
117 }
118
119 #  Packets received on the socket will be processed through one
120 #  of the following sections, named after the DHCP packet type.
121 #  See dictionary.dhcp for the packet types.
122 dhcp DHCP-Discover {
123         update reply {
124                DHCP-Message-Type = DHCP-Offer
125         }
126
127         #  The contents here are invented.  Change them!
128         update reply {
129                 DHCP-Domain-Name-Server = 127.0.0.1
130                 DHCP-Domain-Name-Server = 127.0.0.2
131                 DHCP-Subnet-Mask = 255.255.255.0
132                 DHCP-Router-Address = 192.168.1.1
133                 DHCP-IP-Address-Lease-Time = 86400
134                 DHCP-DHCP-Server-Identifier = 192.168.1.1
135         }
136
137         #  Do a simple mapping of MAC to assigned IP.
138         #
139         #  See below for the definition of the "mac2ip"
140         #  module.
141         #
142         #mac2ip
143
144         #  If the MAC wasn't found in that list, do something else.
145         #  You could call a Perl, Python, or Java script here.
146
147         #if (notfound) {
148         # ...
149         #}
150
151         ok
152 }
153
154 dhcp DHCP-Request {
155         update reply {
156                DHCP-Message-Type = DHCP-Ack
157         }
158
159         #  The contents here are invented.  Change them!
160         update reply {
161                 DHCP-Domain-Name-Server = 127.0.0.1
162                 DHCP-Domain-Name-Server = 127.0.0.2
163                 DHCP-Subnet-Mask = 255.255.255.0
164                 DHCP-Router-Address = 192.168.1.1
165                 DHCP-IP-Address-Lease-Time = 86400
166                 DHCP-DHCP-Server-Identifier = 192.168.1.1
167         }
168
169         #  Do a simple mapping of MAC to assigned IP.
170         #
171         #  See below for the definition of the "mac2ip"
172         #  module.
173         #
174         #mac2ip
175
176         #  If the MAC wasn't found in that list, do something else.
177         #  You could call a Perl, Python, or Java script here.
178
179         #if (notfound) {
180         # ...
181         #}
182
183         ok
184 }
185
186 #  If there's no named section for the packet type, then the packet
187 #  is processed through this section.
188 dhcp {
189         # send a DHCP NAK.
190         reject
191 }
192
193
194 }
195
196 ######################################################################
197 #
198 #  This next section is a sample configuration for the "passwd"
199 #  module, that reads flat-text files.  It should go into
200 #  radiusd.conf, in the "modules" section.
201 #
202 #  The file is in the format <mac>,<ip>
203 #
204 #       00:01:02:03:04:05,192.168.1.100
205 #       01:01:02:03:04:05,192.168.1.101
206 #       02:01:02:03:04:05,192.168.1.102
207 #
208 #  This lets you perform simple static IP assignment.
209 #
210 ######################################################################
211
212 #passwd mac2ip {
213 #       filename = ${confdir}/mac2ip
214 #       format = "*DHCP-Client-Hardware-Address:=DHCP-Your-IP-Address"
215 #       delimiter = ","
216 #}