2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2012 IPFire Network Development Team #
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. #
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. #
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/>. #
20 ###############################################################################
22 .
/usr
/lib
/network
/header-zone
24 HOOK_SETTINGS
="HOOK ACCESS_CONCENTRATOR AUTH USERNAME PASSWORD"
25 HOOK_SETTINGS
="${HOOK_SETTINGS} SERVICE_NAME MTU IPV6 PREFIX_DELEGATION"
27 # User credentials for the dialin.
31 # Set the authentication mechanism.
34 # Access Concentrator.
35 ACCESS_CONCENTRATOR
=""
40 # Maximum Transmission Unit.
41 # 1492 is a very common value for that.
44 # This hook can work with all authentication methods supported by pppd.
45 PPPOE_SUPPORTED_AUTH_METHODS
="${PPP_SUPPORTED_AUTH_METHODS}"
46 PPPOE_PLUGIN
="rp-pppoe.so"
48 # Request an IPv6 address.
51 # Use IPv6 prefix delegation.
52 PREFIX_DELEGATION
="false"
54 function hook_check
() {
58 isset AUTH
&& assert isoneof AUTH
${PPPOE_SUPPORTED_AUTH_METHODS}
61 assert isset PREFIX_DELEGATION
64 function hook_parse_cmdline
() {
65 while [ $# -gt 0 ]; do
67 --access-concentrator=*)
68 ACCESS_CONCENTRATOR
=$
(cli_get_val
${1})
71 AUTH
=$
(cli_get_val
${1})
74 local value
="$(cli_get_val "${1}")"
75 if enabled value
; then
82 MTU
=$
(cli_get_val
${1})
85 PASSWORD
=$
(cli_get_val
${1})
87 --prefix-delegation=*)
88 PREFIX_DELEGATION
="$(cli_get_bool "${1}")"
91 SERVICE_NAME
=$
(cli_get_val
${1})
94 USERNAME
=$
(cli_get_val
${1})
97 warning
"Unknown argument: ${1}" >&2
108 zone_settings_read
"${zone}" ${HOOK_SETTINGS}
111 local port
=$
(__hook_get_port
"${zone}")
114 # Start the ppp daemon.
120 function hook_down
() {
124 zone_settings_read
"${zone}" ${HOOK_SETTINGS}
126 # Stop the ppp daemon.
129 # Bring down the port.
130 log DEBUG
"Bringing down port '${PORT}'."
136 function hook_discover
() {
139 # This obviously only works on ethernet (or compatible) devices
140 if ! device_is_ethernet_compatible
"${device}"; then
145 output
=$
(pppoe-discovery
-I ${device} -U $
(uuid
) 2>&1)
147 # Exit if there was not output
148 [ -z "${output}" ] && exit ${DISCOVER_ERROR}
150 # Exit if PADI timed out
151 grep -q "Timeout" <<<${output} && exit ${DISCOVER_ERROR}
156 Access-Concentrator
:*)
157 ac
="${line#Access-Concentrator: }"
162 echo "ACCESS_CONCENTRATOR=\"$ac\""
167 function hook_status
() {
171 cli_device_headline
${zone}
173 zone_settings_read
"${zone}" ${HOOK_SETTINGS}
175 cli_headline
2 "Configuration"
176 cli_print_fmt1
2 "Username" "${USERNAME}"
177 cli_print_fmt1
2 "Password" "<hidden>"
179 local port
=$
(__hook_get_port
"${zone}")
181 cli_print_fmt1
2 "Port" "${port}"
185 # Exit if zone is down
186 if ! zone_is_up
${zone}; then
191 # XXX display time since connection started
193 cli_headline
2 "Point-to-Point-over-Ethernet protocol"
195 for proto
in ${IP_SUPPORTED_PROTOCOLS}; do
196 routing_db_exists
${zone} ${proto} ||
continue
201 headline
="Internet Protocol Version 6"
204 headline
="Internet Protocol Version 4"
207 headline
="Unkown protocol"
210 cli_headline
3 "${headline}"
212 cli_print_fmt1
3 "IP address" "$(routing_db_get ${zone} ${proto} local-ip-address)"
213 cli_print_fmt1
3 "Gateway" "$(routing_db_get ${zone} ${proto} remote-ip-address)"
214 cli_print_fmt1
3 "DNS servers" "$(routing_db_get ${zone} ${proto} dns)"
216 cli_print_fmt1
3 "MAC-Remote" "$(routing_db_get ${zone} ${proto} remote-address)"
223 function hook_ppp_write_config
() {
230 # Read in the configuration files.
231 zone_settings_read
"${zone}" ${HOOK_SETTINGS}
233 # A port has to be assigned for this action
234 local port
=$
(__hook_get_port
"${zone}")
235 if ! isset port
; then
236 error
"No port assigned to pppoe hook of zone '${zone}'"
240 # Prepare the command line options for the pppoe plugin.
243 # Add the access concentrator (if any).
244 if isset ACCESS_CONCENTRATOR
; then
245 plugin_options
="${plugin_options} rp_pppoe_ac '${ACCESS_CONCENTRATOR}'"
248 # Add the service name (if any).
249 if isset SERVICE_NAME
; then
250 plugin_options
="${plugin_options} rp_pppoe_service '${SERVICE_NAME}'"
253 # The last argument must be the interface.
254 plugin_options
="${plugin_options} ${port}"
256 pppd_write_config
${file} \
257 --interface="${zone}" \
258 --username="${USERNAME}" \
259 --password="${PASSWORD}" \
264 --plugin="${PPPOE_PLUGIN}" \
265 --plugin-options="${plugin_options}"
270 function __hook_get_port
() {
274 for port
in $
(zone_get_ports
"${zone}"); do
282 function hook_port_add
() {
283 # Excepting at least two arguments here
290 # PPPoE can only use one port
291 local ports_num
="$(zone_get_ports_num "${zone}")"
292 if [ ${ports_num} -ge 1 ]; then
293 local port
=$
(__hook_get_port
"${zone}")
294 error
"The pppoe zone hook only supports assigning one port"
295 error
" port '${port}' has already been assigned to zone '${zone}'"
299 zone_port_settings_write
"${zone}" "${port}"
300 log INFO
"Port '${port}' has been added to zone '${zone}'"
305 function hook_port_remove
() {
311 # Shut down the port (if possible)
314 log INFO
"Port '${port}' has been removed from zone '${zone}'"
315 zone_port_settings_remove
"${zone}" "${port}"