]>
Commit | Line | Data |
---|---|---|
1848564d MT |
1 | #!/bin/bash |
2 | ############################################################################### | |
3 | # # | |
4 | # IPFire.org - A linux based firewall # | |
97cb552e | 5 | # Copyright (C) 2012 IPFire Network Development Team # |
1848564d MT |
6 | # # |
7 | # This program is free software: you can redistribute it and/or modify # | |
8 | # it under the terms of the GNU General Public License as published by # | |
9 | # the Free Software Foundation, either version 3 of the License, or # | |
10 | # (at your option) any later version. # | |
11 | # # | |
12 | # This program is distributed in the hope that it will be useful, # | |
13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of # | |
14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # | |
15 | # GNU General Public License for more details. # | |
16 | # # | |
17 | # You should have received a copy of the GNU General Public License # | |
18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. # | |
19 | # # | |
20 | ############################################################################### | |
21 | ||
f41fa3d7 | 22 | . /usr/lib/network/header-zone |
1848564d | 23 | |
97cb552e | 24 | HOOK_SETTINGS="HOOK ACCESS_CONCENTRATOR AUTH USERNAME PASSWORD" |
529141df | 25 | HOOK_SETTINGS="${HOOK_SETTINGS} SERVICE_NAME MTU IPV6 PREFIX_DELEGATION" |
1848564d | 26 | |
97cb552e MT |
27 | # User credentials for the dialin. |
28 | USERNAME="" | |
29 | PASSWORD="" | |
1848564d | 30 | |
97cb552e | 31 | # Set the authentication mechanism. |
1848564d | 32 | AUTH= |
97cb552e | 33 | |
97cb552e MT |
34 | # Access Concentrator. |
35 | ACCESS_CONCENTRATOR="" | |
36 | ||
37 | # Service name. | |
38 | SERVICE_NAME="" | |
39 | ||
40 | # Maximum Transmission Unit. | |
1dae8028 | 41 | MTU= |
1848564d | 42 | |
97cb552e | 43 | # This hook can work with all authentication methods supported by pppd. |
3a829636 | 44 | PPPOE_SUPPORTED_AUTH_METHODS="${PPP_SUPPORTED_AUTH_METHODS}" |
1848564d MT |
45 | PPPOE_PLUGIN="rp-pppoe.so" |
46 | ||
69e93b3c MT |
47 | # Request an IPv6 address. |
48 | IPV6="true" | |
49 | ||
08e40c8c | 50 | # Use IPv6 prefix delegation. |
4cee7a5d | 51 | PREFIX_DELEGATION="true" |
08e40c8c | 52 | |
1c6a4e30 | 53 | hook_check_settings() { |
97cb552e MT |
54 | assert isset USERNAME |
55 | assert isset PASSWORD | |
261132f9 | 56 | |
3a829636 | 57 | isset AUTH && assert isoneof AUTH ${PPPOE_SUPPORTED_AUTH_METHODS} |
261132f9 | 58 | |
69e93b3c | 59 | assert isset IPV6 |
08e40c8c | 60 | assert isset PREFIX_DELEGATION |
1848564d MT |
61 | } |
62 | ||
1c6a4e30 | 63 | hook_parse_cmdline() { |
1848564d | 64 | while [ $# -gt 0 ]; do |
97cb552e MT |
65 | case "${1}" in |
66 | --access-concentrator=*) | |
2212045f | 67 | ACCESS_CONCENTRATOR=$(cli_get_val "${1}") |
1848564d | 68 | ;; |
97cb552e | 69 | --auth=*) |
2212045f | 70 | AUTH=$(cli_get_val "${1}") |
1848564d | 71 | ;; |
69e93b3c MT |
72 | --ipv6=*) |
73 | local value="$(cli_get_val "${1}")" | |
74 | if enabled value; then | |
75 | IPV6="true" | |
76 | else | |
77 | IPV6="false" | |
78 | fi | |
79 | ;; | |
1848564d | 80 | --mtu=*) |
2212045f | 81 | MTU=$(cli_get_val "${1}") |
1848564d | 82 | ;; |
97cb552e | 83 | --password=*) |
2212045f | 84 | PASSWORD=$(cli_get_val "${1}") |
1848564d | 85 | ;; |
08e40c8c MT |
86 | --prefix-delegation=*) |
87 | PREFIX_DELEGATION="$(cli_get_bool "${1}")" | |
88 | ;; | |
97cb552e | 89 | --service-name=*) |
2212045f | 90 | SERVICE_NAME=$(cli_get_val "${1}") |
1848564d | 91 | ;; |
97cb552e | 92 | --username=*) |
2212045f | 93 | USERNAME=$(cli_get_val "${1}") |
201b7dff | 94 | ;; |
1848564d | 95 | *) |
97cb552e | 96 | warning "Unknown argument: ${1}" >&2 |
1848564d MT |
97 | ;; |
98 | esac | |
99 | shift | |
100 | done | |
1848564d MT |
101 | } |
102 | ||
1c6a4e30 | 103 | hook_up() { |
1848564d | 104 | local zone=${1} |
711ffac1 MT |
105 | assert isset zone |
106 | ||
ac694a6a MT |
107 | # If this zone's port is not set, we will return |
108 | # with EXIT_OK so that this zone will remain active, | |
109 | # but we cannot start pppd. | |
110 | local port=$(__hook_get_port "${zone}") | |
111 | if ! isset port || ! port_exists "${port}"; then | |
112 | log WARNING "Could not bring up zone '${zone}' because no port is attached" | |
113 | exit ${EXIT_OK} | |
114 | fi | |
115 | ||
1e6f187e | 116 | zone_settings_read "${zone}" |
2044f591 | 117 | |
3ab3292c SS |
118 | # Load the pppoe kernel module |
119 | module_load "pppoe" | |
120 | ||
2044f591 | 121 | # Bring up the port. |
529141df | 122 | port_up "${port}" |
2044f591 | 123 | |
97cb552e MT |
124 | # Start the ppp daemon. |
125 | pppd_start ${zone} | |
da453c33 | 126 | |
97cb552e | 127 | exit ${EXIT_OK} |
1848564d MT |
128 | } |
129 | ||
1c6a4e30 | 130 | hook_down() { |
1848564d | 131 | local zone=${1} |
97cb552e | 132 | assert isset zone |
1848564d | 133 | |
1e6f187e | 134 | zone_settings_read "${zone}" |
2044f591 | 135 | |
97cb552e MT |
136 | # Stop the ppp daemon. |
137 | pppd_stop ${zone} | |
1848564d | 138 | |
2044f591 | 139 | # Bring down the port. |
ebd29545 SS |
140 | local port=$(__hook_get_port "${zone}") |
141 | if isset port; then | |
142 | log DEBUG "Bringing down port '${port}'" | |
143 | port_down "${port}" | |
144 | fi | |
2044f591 | 145 | |
1848564d MT |
146 | exit ${EXIT_OK} |
147 | } | |
148 | ||
1c6a4e30 | 149 | hook_hotplug() { |
0994996d MT |
150 | local zone="${1}" |
151 | ||
152 | case "$(hotplug_action)" in | |
153 | add) | |
154 | if hotplug_event_interface_is_port_of_zone "${zone}"; then | |
155 | # Bring up the zone if it is enabled but not active, yet. | |
156 | zone_start_auto "${zone}" | |
157 | ||
158 | exit ${EXIT_OK} | |
159 | fi | |
160 | ;; | |
161 | remove) | |
162 | # PPPoE cannot work if the ethernet device has been removed | |
163 | if hotplug_event_interface_is_port_of_zone "${zone}"; then | |
164 | if zone_is_active "${zone}"; then | |
165 | zone_stop "${zone}" | |
166 | fi | |
167 | ||
168 | exit ${EXIT_OK} | |
169 | fi | |
170 | ;; | |
171 | esac | |
172 | ||
173 | exit ${EXIT_NOT_HANDLED} | |
174 | } | |
175 | ||
1c6a4e30 | 176 | hook_discover() { |
1848564d MT |
177 | local device=${1} |
178 | ||
5dfc94a8 MT |
179 | # This obviously only works on ethernet (or compatible) devices |
180 | if ! device_is_ethernet_compatible "${device}"; then | |
5b20e43a | 181 | exit ${EXIT_ERROR} |
1848564d MT |
182 | fi |
183 | ||
184 | local output | |
185 | output=$(pppoe-discovery -I ${device} -U $(uuid) 2>&1) | |
186 | ||
187 | # Exit if there was not output | |
188 | [ -z "${output}" ] && exit ${DISCOVER_ERROR} | |
189 | ||
190 | # Exit if PADI timed out | |
191 | grep -q "Timeout" <<<${output} && exit ${DISCOVER_ERROR} | |
192 | ||
193 | local ac | |
194 | while read line; do | |
195 | case "${line}" in | |
196 | Access-Concentrator:*) | |
197 | ac="${line#Access-Concentrator: }" | |
198 | ;; | |
199 | esac | |
200 | done <<<"${output}" | |
201 | ||
202 | echo "ACCESS_CONCENTRATOR=\"$ac\"" | |
203 | ||
204 | exit ${DISCOVER_OK} | |
205 | } | |
5b20e43a | 206 | |
1c6a4e30 | 207 | hook_status() { |
8eadf1da | 208 | local zone=${1} |
711ffac1 MT |
209 | assert isset zone |
210 | ||
3cb2fc42 | 211 | cli_device_headline ${zone} |
8eadf1da | 212 | |
1e6f187e | 213 | zone_settings_read "${zone}" |
711ffac1 | 214 | |
3cb2fc42 | 215 | cli_headline 2 "Configuration" |
97cb552e MT |
216 | cli_print_fmt1 2 "Username" "${USERNAME}" |
217 | cli_print_fmt1 2 "Password" "<hidden>" | |
529141df MT |
218 | |
219 | local port=$(__hook_get_port "${zone}") | |
220 | if isset port; then | |
221 | cli_print_fmt1 2 "Port" "${port}" | |
222 | fi | |
3cb2fc42 MT |
223 | cli_space |
224 | ||
8eadf1da MT |
225 | # Exit if zone is down |
226 | if ! zone_is_up ${zone}; then | |
227 | echo # Empty line | |
228 | exit ${EXIT_ERROR} | |
229 | fi | |
230 | ||
711ffac1 MT |
231 | # XXX display time since connection started |
232 | ||
3cb2fc42 | 233 | cli_headline 2 "Point-to-Point-over-Ethernet protocol" |
39cd231c SS |
234 | cli_print_fmt1 2 "MAC-Remote" "$(db_get "${zone}/remote-address")" |
235 | cli_space | |
236 | ||
201b7dff MT |
237 | local proto |
238 | for proto in ${IP_SUPPORTED_PROTOCOLS}; do | |
c041b631 | 239 | db_exists "${zone}/${proto}" || continue |
3cb2fc42 MT |
240 | |
241 | local headline | |
242 | case "${proto}" in | |
243 | ipv6) | |
244 | headline="Internet Protocol Version 6" | |
245 | ;; | |
246 | ipv4) | |
247 | headline="Internet Protocol Version 4" | |
248 | ;; | |
249 | *) | |
250 | headline="Unkown protocol" | |
251 | ;; | |
252 | esac | |
253 | cli_headline 3 "${headline}" | |
254 | ||
c041b631 MT |
255 | cli_print_fmt1 3 "IP address" "$(db_get "${zone}/${proto}/local-ip-address")" |
256 | cli_print_fmt1 3 "Gateway" "$(db_get "${zone}/${proto}/remote-ip-address")" | |
d64f0511 | 257 | cli_print_fmt1 3 "DNS servers" "$(db_get "${zone}/${proto}/domain-name-servers")" |
3cb2fc42 | 258 | cli_space |
201b7dff | 259 | done |
3cb2fc42 | 260 | |
8eadf1da MT |
261 | exit ${EXIT_OK} |
262 | } | |
263 | ||
1c6a4e30 | 264 | hook_ppp_write_config() { |
97cb552e MT |
265 | local zone=${1} |
266 | assert isset zone | |
267 | ||
268 | local file=${2} | |
269 | assert isset file | |
270 | ||
271 | # Read in the configuration files. | |
1e6f187e | 272 | zone_settings_read "${zone}" |
97cb552e | 273 | |
529141df MT |
274 | # A port has to be assigned for this action |
275 | local port=$(__hook_get_port "${zone}") | |
276 | if ! isset port; then | |
277 | error "No port assigned to pppoe hook of zone '${zone}'" | |
278 | exit ${EXIT_ERROR} | |
279 | fi | |
280 | ||
97cb552e MT |
281 | # Prepare the command line options for the pppoe plugin. |
282 | local plugin_options | |
283 | ||
284 | # Add the access concentrator (if any). | |
285 | if isset ACCESS_CONCENTRATOR; then | |
286 | plugin_options="${plugin_options} rp_pppoe_ac '${ACCESS_CONCENTRATOR}'" | |
711ffac1 MT |
287 | fi |
288 | ||
97cb552e MT |
289 | # Add the service name (if any). |
290 | if isset SERVICE_NAME; then | |
291 | plugin_options="${plugin_options} rp_pppoe_service '${SERVICE_NAME}'" | |
292 | fi | |
711ffac1 | 293 | |
97cb552e | 294 | # The last argument must be the interface. |
529141df | 295 | plugin_options="${plugin_options} ${port}" |
97cb552e MT |
296 | |
297 | pppd_write_config ${file} \ | |
298 | --interface="${zone}" \ | |
6c74a64c MT |
299 | --username="${USERNAME}" \ |
300 | --password="${PASSWORD}" \ | |
97cb552e MT |
301 | --mtu="${MTU}" \ |
302 | --auth="${AUTH}" \ | |
69e93b3c | 303 | --ipv6="${IPV6}" \ |
97cb552e MT |
304 | \ |
305 | --plugin="${PPPOE_PLUGIN}" \ | |
306 | --plugin-options="${plugin_options}" | |
307 | ||
6c74a64c | 308 | exit ${EXIT_OK} |
711ffac1 | 309 | } |
529141df | 310 | |
1c6a4e30 | 311 | __hook_get_port() { |
529141df MT |
312 | local zone="${1}" |
313 | ||
314 | local port | |
315 | for port in $(zone_get_ports "${zone}"); do | |
316 | echo "${port}" | |
317 | return ${EXIT_OK} | |
318 | done | |
319 | ||
320 | return ${EXIT_ERROR} | |
321 | } | |
322 | ||
1c6a4e30 | 323 | hook_port_attach() { |
529141df MT |
324 | # Excepting at least two arguments here |
325 | assert [ $# -ge 2 ] | |
326 | ||
327 | local zone="${1}" | |
328 | local port="${2}" | |
329 | shift 2 | |
330 | ||
331 | # PPPoE can only use one port | |
332 | local ports_num="$(zone_get_ports_num "${zone}")" | |
333 | if [ ${ports_num} -ge 1 ]; then | |
ac694a6a | 334 | local ports="$(zone_get_ports "${zone}")" |
529141df | 335 | error "The pppoe zone hook only supports assigning one port" |
ac694a6a | 336 | error " port '${ports}' has already been assigned to zone '${zone}'" |
529141df MT |
337 | return ${EXIT_ERROR} |
338 | fi | |
339 | ||
ac694a6a MT |
340 | if ! zone_port_settings_write "${zone}" "${port}"; then |
341 | exit ${EXIT_ERROR} | |
342 | fi | |
529141df MT |
343 | |
344 | exit ${EXIT_OK} | |
345 | } | |
346 | ||
1c6a4e30 | 347 | hook_port_detach() { |
529141df MT |
348 | assert [ $# -eq 2 ] |
349 | ||
350 | local zone="${1}" | |
351 | local port="${2}" | |
352 | ||
ac694a6a MT |
353 | # Shut down the entire zone here, because it cannot |
354 | # run without a port any way and removing the port would | |
355 | # create a hotplug event which will be processed after the | |
356 | # port has already been detached... | |
357 | zone_stop "${zone}" | |
529141df | 358 | |
ac694a6a MT |
359 | if ! zone_port_settings_remove "${zone}" "${port}"; then |
360 | exit ${EXIT_ERROR} | |
361 | fi | |
529141df MT |
362 | |
363 | exit ${EXIT_OK} | |
364 | } | |
4cee7a5d | 365 | |
1c6a4e30 | 366 | hook_ppp_ipv6_up() { |
4cee7a5d MT |
367 | local zone="${1}" |
368 | ||
369 | ppp_common_ipv6_up "${zone}" | |
370 | ||
371 | # Read configuration | |
372 | zone_settings_read "${zone}" | |
373 | ||
374 | if enabled PREFIX_DELEGATION; then | |
375 | dhclient_start "${zone}" ipv6 | |
376 | fi | |
377 | ||
378 | exit ${EXIT_OK} | |
379 | } | |
380 | ||
1c6a4e30 | 381 | hook_ppp_ipv6_down() { |
4cee7a5d MT |
382 | local zone="${1}" |
383 | ||
384 | ppp_common_ipv6_down "${zone}" | |
385 | ||
386 | # Read configuration | |
387 | zone_settings_read "${zone}" | |
388 | ||
389 | if enabled PREFIX_DELEGATION; then | |
390 | dhclient_stop "${zone}" ipv6 | |
391 | fi | |
392 | ||
393 | exit ${EXIT_OK} | |
394 | } |